add keyboard.[ch] to libobt. these are for tracking modifier keys, and translating...
[dana/openbox.git] / openbox / openbox.c
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    openbox.c for the Openbox window manager
4    Copyright (c) 2006        Mikael Magnusson
5    Copyright (c) 2003-2007   Dana Jansens
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    See the COPYING file for a copy of the GNU General Public License.
18 */
19
20 #include "debug.h"
21 #include "openbox.h"
22 #include "session.h"
23 #include "dock.h"
24 #include "event.h"
25 #include "menu.h"
26 #include "client.h"
27 #include "screen.h"
28 #include "actions.h"
29 #include "startupnotify.h"
30 #include "focus.h"
31 #include "focus_cycle.h"
32 #include "focus_cycle_indicator.h"
33 #include "focus_cycle_popup.h"
34 #include "moveresize.h"
35 #include "frame.h"
36 #include "keyboard.h"
37 #include "mouse.h"
38 #include "menuframe.h"
39 #include "grab.h"
40 #include "group.h"
41 #include "config.h"
42 #include "ping.h"
43 #include "mainloop.h"
44 #include "gettext.h"
45 #include "parser/parse.h"
46 #include "render/render.h"
47 #include "render/theme.h"
48 #include "obt/display.h"
49 #include "obt/prop.h"
50
51 #ifdef HAVE_FCNTL_H
52 #  include <fcntl.h>
53 #endif
54 #ifdef HAVE_SIGNAL_H
55 #  include <signal.h>
56 #endif
57 #ifdef HAVE_STDLIB_H
58 #  include <stdlib.h>
59 #endif
60 #ifdef HAVE_LOCALE_H
61 #  include <locale.h>
62 #endif
63 #ifdef HAVE_SYS_STAT_H
64 #  include <sys/stat.h>
65 #  include <sys/types.h>
66 #endif
67 #ifdef HAVE_SYS_WAIT_H
68 #  include <sys/types.h>
69 #  include <sys/wait.h>
70 #endif
71 #ifdef HAVE_UNISTD_H
72 #  include <unistd.h>
73 #endif
74 #include <errno.h>
75
76 #include <X11/cursorfont.h>
77 #if USE_XCURSOR
78 #include <X11/Xcursor/Xcursor.h>
79 #endif
80
81 #include <X11/Xlib.h>
82 #include <X11/keysym.h>
83
84 RrInstance  *ob_rr_inst;
85 RrTheme     *ob_rr_theme;
86 ObtMainLoop *ob_main_loop;
87 gint         ob_screen;
88 gboolean     ob_replace_wm = FALSE;
89 gboolean     ob_sm_use = TRUE;
90 gchar       *ob_sm_id = NULL;
91 gchar       *ob_sm_save_file = NULL;
92 gboolean     ob_sm_restore = TRUE;
93 gboolean     ob_debug_xinerama = FALSE;
94
95 static ObState   state;
96 static gboolean  xsync = FALSE;
97 static gboolean  reconfigure = FALSE;
98 static gboolean  restart = FALSE;
99 static gchar    *restart_path = NULL;
100 static Cursor    cursors[OB_NUM_CURSORS];
101 static KeyCode   keys[OB_NUM_KEYS];
102 static gint      exitcode = 0;
103 static guint     remote_control = 0;
104 static gboolean  being_replaced = FALSE;
105
106 static void signal_handler(gint signal, gpointer data);
107 static void remove_args(gint *argc, gchar **argv, gint index, gint num);
108 static void parse_env();
109 static void parse_args(gint *argc, gchar **argv);
110 static Cursor load_cursor(const gchar *name, guint fontval);
111
112 gint main(gint argc, gchar **argv)
113 {
114     gchar *program_name;
115
116     state = OB_STATE_STARTING;
117
118     /* initialize the locale */
119     if (!setlocale(LC_ALL, ""))
120         g_message("Couldn't set locale from environment.");
121     bindtextdomain(PACKAGE_NAME, LOCALEDIR);
122     bind_textdomain_codeset(PACKAGE_NAME, "UTF-8");
123     textdomain(PACKAGE_NAME);
124
125     if (chdir(g_get_home_dir()) == -1)
126         g_message(_("Unable to change to home directory '%s': %s"),
127                   g_get_home_dir(), g_strerror(errno));
128
129     /* parse the command line args, which can change the argv[0] */
130     parse_args(&argc, argv);
131     /* parse the environment variables */
132     parse_env();
133
134     program_name = g_path_get_basename(argv[0]);
135     g_set_prgname(program_name);
136
137     if (!remote_control) {
138         parse_paths_startup();
139
140         session_startup(argc, argv);
141     }
142
143     if (!obt_display_open(NULL))
144         ob_exit_with_error(_("Failed to open the display from the DISPLAY environment variable."));
145
146     if (remote_control) {
147         /* Send client message telling the OB process to:
148          * remote_control = 1 -> reconfigure
149          * remote_control = 2 -> restart */
150         OBT_PROP_MSG(ob_screen, RootWindow(obt_display, ob_screen),
151                      OB_CONTROL, remote_control, 0, 0, 0, 0);
152         obt_display_close(obt_display);
153         exit(EXIT_SUCCESS);
154     }
155
156     ob_main_loop = obt_main_loop_new(obt_display);
157
158     /* set up signal handler */
159     obt_main_loop_signal_add(ob_main_loop, SIGUSR1, signal_handler, NULL,NULL);
160     obt_main_loop_signal_add(ob_main_loop, SIGUSR2, signal_handler, NULL,NULL);
161     obt_main_loop_signal_add(ob_main_loop, SIGTERM, signal_handler, NULL,NULL);
162     obt_main_loop_signal_add(ob_main_loop, SIGINT, signal_handler,  NULL,NULL);
163     obt_main_loop_signal_add(ob_main_loop, SIGHUP, signal_handler,  NULL,NULL);
164     obt_main_loop_signal_add(ob_main_loop, SIGPIPE, signal_handler, NULL,NULL);
165     obt_main_loop_signal_add(ob_main_loop, SIGCHLD, signal_handler, NULL,NULL);
166
167     ob_screen = DefaultScreen(obt_display);
168
169     ob_rr_inst = RrInstanceNew(obt_display, ob_screen);
170     if (ob_rr_inst == NULL)
171         ob_exit_with_error(_("Failed to initialize the obrender library."));
172
173     XSynchronize(obt_display, xsync);
174
175     /* check for locale support */
176     if (!XSupportsLocale())
177         g_message(_("X server does not support locale."));
178     if (!XSetLocaleModifiers(""))
179         g_message(_("Cannot set locale modifiers for the X server."));
180
181     /* set the DISPLAY environment variable for any lauched children, to the
182        display we're using, so they open in the right place. */
183     putenv(g_strdup_printf("DISPLAY=%s", DisplayString(obt_display)));
184
185     /* create available cursors */
186     cursors[OB_CURSOR_NONE] = None;
187     cursors[OB_CURSOR_POINTER] = load_cursor("left_ptr", XC_left_ptr);
188     cursors[OB_CURSOR_BUSYPOINTER] = load_cursor("left_ptr_watch",XC_left_ptr);
189     cursors[OB_CURSOR_BUSY] = load_cursor("watch", XC_watch);
190     cursors[OB_CURSOR_MOVE] = load_cursor("fleur", XC_fleur);
191     cursors[OB_CURSOR_NORTH] = load_cursor("top_side", XC_top_side);
192     cursors[OB_CURSOR_NORTHEAST] = load_cursor("top_right_corner",
193                                                XC_top_right_corner);
194     cursors[OB_CURSOR_EAST] = load_cursor("right_side", XC_right_side);
195     cursors[OB_CURSOR_SOUTHEAST] = load_cursor("bottom_right_corner",
196                                                XC_bottom_right_corner);
197     cursors[OB_CURSOR_SOUTH] = load_cursor("bottom_side", XC_bottom_side);
198     cursors[OB_CURSOR_SOUTHWEST] = load_cursor("bottom_left_corner",
199                                                XC_bottom_left_corner);
200     cursors[OB_CURSOR_WEST] = load_cursor("left_side", XC_left_side);
201     cursors[OB_CURSOR_NORTHWEST] = load_cursor("top_left_corner",
202                                                XC_top_left_corner);
203
204     if (screen_annex()) { /* it will be ours! */
205         do {
206             if (reconfigure) obt_keyboard_reload();
207
208             /* get the keycodes for keys we use */
209             keys[OB_KEY_RETURN] = modkeys_sym_to_code(XK_Return);
210             keys[OB_KEY_ESCAPE] = modkeys_sym_to_code(XK_Escape);
211             keys[OB_KEY_LEFT] = modkeys_sym_to_code(XK_Left);
212             keys[OB_KEY_RIGHT] = modkeys_sym_to_code(XK_Right);
213             keys[OB_KEY_UP] = modkeys_sym_to_code(XK_Up);
214             keys[OB_KEY_DOWN] = modkeys_sym_to_code(XK_Down);
215
216             {
217                 ObParseInst *i;
218                 xmlDocPtr doc;
219                 xmlNodePtr node;
220
221                 /* startup the parsing so everything can register sections
222                    of the rc */
223                 i = parse_startup();
224
225                 /* register all the available actions */
226                 actions_startup(reconfigure);
227                 /* start up config which sets up with the parser */
228                 config_startup(i);
229
230                 /* parse/load user options */
231                 if (parse_load_rc(NULL, &doc, &node)) {
232                     parse_tree(i, doc, node->xmlChildrenNode);
233                     parse_close(doc);
234                 } else
235                     g_message(_("Unable to find a valid config file, using some simple defaults"));
236
237 /*
238                 if (config_type != NULL)
239                     PROP_SETS(RootWindow(obt_display, ob_screen),
240                               ob_config, config_type);
241 */
242
243                 /* we're done with parsing now, kill it */
244                 parse_shutdown(i);
245             }
246
247             /* load the theme specified in the rc file */
248             {
249                 RrTheme *theme;
250                 if ((theme = RrThemeNew(ob_rr_inst, config_theme, TRUE,
251                                         config_font_activewindow,
252                                         config_font_inactivewindow,
253                                         config_font_menutitle,
254                                         config_font_menuitem,
255                                         config_font_osd)))
256                 {
257                     RrThemeFree(ob_rr_theme);
258                     ob_rr_theme = theme;
259                 }
260                 if (ob_rr_theme == NULL)
261                     ob_exit_with_error(_("Unable to load a theme."));
262
263                 OBT_PROP_SETS(RootWindow(obt_display, ob_screen),
264                               OB_THEME, utf8, ob_rr_theme->name);
265             }
266
267             if (reconfigure) {
268                 GList *it;
269
270                 /* update all existing windows for the new theme */
271                 for (it = client_list; it; it = g_list_next(it)) {
272                     ObClient *c = it->data;
273                     frame_adjust_theme(c->frame);
274                 }
275             }
276             event_startup(reconfigure);
277             /* focus_backup is used for stacking, so this needs to come before
278                anything that calls stacking_add */
279             sn_startup(reconfigure);
280             window_startup(reconfigure);
281             focus_startup(reconfigure);
282             focus_cycle_startup(reconfigure);
283             focus_cycle_indicator_startup(reconfigure);
284             focus_cycle_popup_startup(reconfigure);
285             screen_startup(reconfigure);
286             grab_startup(reconfigure);
287             group_startup(reconfigure);
288             ping_startup(reconfigure);
289             client_startup(reconfigure);
290             dock_startup(reconfigure);
291             moveresize_startup(reconfigure);
292             keyboard_startup(reconfigure);
293             mouse_startup(reconfigure);
294             menu_frame_startup(reconfigure);
295             menu_startup(reconfigure);
296
297             if (!reconfigure) {
298                 guint32 xid;
299                 ObWindow *w;
300
301                 /* get all the existing windows */
302                 client_manage_all();
303                 focus_nothing();
304
305                 /* focus what was focused if a wm was already running */
306                 if (OBT_PROP_GET32(RootWindow(obt_display, ob_screen),
307                                    NET_ACTIVE_WINDOW, WINDOW, &xid) &&
308                     (w = g_hash_table_lookup(window_map, &xid)) &&
309                     WINDOW_IS_CLIENT(w))
310                 {
311                     client_focus(WINDOW_AS_CLIENT(w));
312                 }
313             } else {
314                 GList *it;
315
316                 /* redecorate all existing windows */
317                 for (it = client_list; it; it = g_list_next(it)) {
318                     ObClient *c = it->data;
319
320                     /* the new config can change the window's decorations */
321                     client_setup_decor_and_functions(c, FALSE);
322                     /* redraw the frames */
323                     frame_adjust_area(c->frame, TRUE, TRUE, FALSE);
324                     /* the decor sizes may have changed, so the windows may
325                        end up in new positions */
326                     client_reconfigure(c, FALSE);
327                 }
328             }
329
330             reconfigure = FALSE;
331
332             state = OB_STATE_RUNNING;
333             obt_main_loop_run(ob_main_loop);
334             state = OB_STATE_EXITING;
335
336             if (!reconfigure) {
337                 dock_remove_all();
338                 client_unmanage_all();
339             }
340
341             menu_shutdown(reconfigure);
342             menu_frame_shutdown(reconfigure);
343             mouse_shutdown(reconfigure);
344             keyboard_shutdown(reconfigure);
345             moveresize_shutdown(reconfigure);
346             dock_shutdown(reconfigure);
347             client_shutdown(reconfigure);
348             ping_shutdown(reconfigure);
349             group_shutdown(reconfigure);
350             grab_shutdown(reconfigure);
351             screen_shutdown(reconfigure);
352             focus_cycle_popup_shutdown(reconfigure);
353             focus_cycle_indicator_shutdown(reconfigure);
354             focus_cycle_shutdown(reconfigure);
355             focus_shutdown(reconfigure);
356             window_shutdown(reconfigure);
357             sn_shutdown(reconfigure);
358             event_shutdown(reconfigure);
359             config_shutdown();
360             actions_shutdown(reconfigure);
361         } while (reconfigure);
362     }
363
364     XSync(obt_display, FALSE);
365
366     RrThemeFree(ob_rr_theme);
367     RrInstanceFree(ob_rr_inst);
368
369     session_shutdown(being_replaced);
370
371     obt_display_close(obt_display);
372
373     parse_paths_shutdown();
374
375     if (restart) {
376         if (restart_path != NULL) {
377             gint argcp;
378             gchar **argvp;
379             GError *err = NULL;
380
381             /* run other window manager */
382             if (g_shell_parse_argv(restart_path, &argcp, &argvp, &err)) {
383                 execvp(argvp[0], argvp);
384                 g_strfreev(argvp);
385             } else {
386                 g_message(
387                     _("Restart failed to execute new executable '%s': %s"),
388                     restart_path, err->message);
389                 g_error_free(err);
390             }
391         }
392
393         /* we remove the session arguments from argv, so put them back,
394            also don't restore the session on restart */
395         if (ob_sm_save_file != NULL || ob_sm_id != NULL) {
396             gchar **nargv;
397             gint i, l;
398
399             l = argc + 1 +
400                 (ob_sm_save_file != NULL ? 2 : 0) +
401                 (ob_sm_id != NULL ? 2 : 0);
402             nargv = g_new0(gchar*, l+1);
403             for (i = 0; i < argc; ++i)
404                 nargv[i] = argv[i];
405
406             if (ob_sm_save_file != NULL) {
407                 nargv[i++] = g_strdup("--sm-save-file");
408                 nargv[i++] = ob_sm_save_file;
409             }
410             if (ob_sm_id != NULL) {
411                 nargv[i++] = g_strdup("--sm-client-id");
412                 nargv[i++] = ob_sm_id;
413             }
414             nargv[i++] = g_strdup("--sm-no-load");
415             g_assert(i == l);
416             argv = nargv;
417         }
418
419         /* re-run me */
420         execvp(argv[0], argv); /* try how we were run */
421         execlp(argv[0], program_name, (gchar*)NULL); /* last resort */
422     }
423
424     /* free stuff passed in from the command line or environment */
425     g_free(ob_sm_save_file);
426     g_free(ob_sm_id);
427     g_free(program_name);
428
429     return exitcode;
430 }
431
432 static void signal_handler(gint signal, gpointer data)
433 {
434     switch (signal) {
435     case SIGUSR1:
436         ob_debug("Caught signal %d. Restarting.\n", signal);
437         ob_restart();
438         break;
439     case SIGUSR2:
440         ob_debug("Caught signal %d. Reconfiguring.\n", signal);
441         ob_reconfigure();
442         break;
443     case SIGCHLD:
444         /* reap children */
445         while (waitpid(-1, NULL, WNOHANG) > 0);
446         break;
447     default:
448         ob_debug("Caught signal %d. Exiting.\n", signal);
449         /* TERM and INT return a 0 code */
450         ob_exit(!(signal == SIGTERM || signal == SIGINT));
451     }
452 }
453
454 static void print_version()
455 {
456     g_print("Openbox %s\n", PACKAGE_VERSION);
457     g_print(_("Copyright (c)"));
458     g_print(" 2008        Mikael Magnusson\n");
459     g_print(_("Copyright (c)"));
460     g_print(" 2003-2006   Dana Jansens\n\n");
461     g_print("This program comes with ABSOLUTELY NO WARRANTY.\n");
462     g_print("This is free software, and you are welcome to redistribute it\n");
463     g_print("under certain conditions. See the file COPYING for details.\n\n");
464 }
465
466 static void print_help()
467 {
468     g_print(_("Syntax: openbox [options]\n"));
469     g_print(_("\nOptions:\n"));
470     g_print(_("  --help              Display this help and exit\n"));
471     g_print(_("  --version           Display the version and exit\n"));
472     g_print(_("  --replace           Replace the currently running window manager\n"));
473     g_print(_("  --sm-disable        Disable connection to the session manager\n"));
474     g_print(_("\nPassing messages to a running Openbox instance:\n"));
475     g_print(_("  --reconfigure       Reload Openbox's configuration\n"));
476     g_print(_("  --restart           Restart Openbox\n"));
477     g_print(_("  --exit              Exit Openbox\n"));
478     g_print(_("\nDebugging options:\n"));
479     g_print(_("  --sync              Run in synchronous mode\n"));
480     g_print(_("  --debug             Display debugging output\n"));
481     g_print(_("  --debug-focus       Display debugging output for focus handling\n"));
482     g_print(_("  --debug-xinerama    Split the display into fake xinerama screens\n"));
483     g_print(_("\nPlease report bugs at %s\n"), PACKAGE_BUGREPORT);
484 }
485
486 static void remove_args(gint *argc, gchar **argv, gint index, gint num)
487 {
488     gint i;
489
490     for (i = index; i < *argc - num; ++i)
491         argv[i] = argv[i+num];
492     for (; i < *argc; ++i)
493         argv[i] = NULL;
494     *argc -= num;
495 }
496
497 static void parse_env()
498 {
499     /* unset this so we don't pass it on unknowingly */
500     gchar *s = g_strdup("DESKTOP_STARTUP_ID");
501     putenv(s);
502     g_free(s);
503 }
504
505 static void parse_args(gint *argc, gchar **argv)
506 {
507     gint i;
508
509     for (i = 1; i < *argc; ++i) {
510         if (!strcmp(argv[i], "--version")) {
511             print_version();
512             exit(0);
513         }
514         else if (!strcmp(argv[i], "--help")) {
515             print_help();
516             exit(0);
517         }
518         else if (!strcmp(argv[i], "--g-fatal-warnings")) {
519             g_log_set_always_fatal(G_LOG_LEVEL_CRITICAL);
520         }
521         else if (!strcmp(argv[i], "--replace")) {
522             ob_replace_wm = TRUE;
523             remove_args(argc, argv, i, 1);
524             --i; /* this arg was removed so go back */
525         }
526         else if (!strcmp(argv[i], "--sync")) {
527             xsync = TRUE;
528         }
529         else if (!strcmp(argv[i], "--debug")) {
530             ob_debug_show_output(TRUE);
531             ob_debug_enable(OB_DEBUG_SM, TRUE);
532             ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
533         }
534         else if (!strcmp(argv[i], "--debug-focus")) {
535             ob_debug_show_output(TRUE);
536             ob_debug_enable(OB_DEBUG_SM, TRUE);
537             ob_debug_enable(OB_DEBUG_APP_BUGS, TRUE);
538             ob_debug_enable(OB_DEBUG_FOCUS, TRUE);
539         }
540         else if (!strcmp(argv[i], "--debug-xinerama")) {
541             ob_debug_xinerama = TRUE;
542         }
543         else if (!strcmp(argv[i], "--reconfigure")) {
544             remote_control = 1;
545         }
546         else if (!strcmp(argv[i], "--restart")) {
547             remote_control = 2;
548         }
549         else if (!strcmp(argv[i], "--exit")) {
550             remote_control = 3;
551         }
552         else if (!strcmp(argv[i], "--sm-save-file")) {
553             if (i == *argc - 1) /* no args left */
554                 /* not translated cuz it's sekret */
555                 g_printerr("--sm-save-file requires an argument\n");
556             else {
557                 ob_sm_save_file = g_strdup(argv[i+1]);
558                 remove_args(argc, argv, i, 2);
559                 --i; /* this arg was removed so go back */
560                 ob_debug_type(OB_DEBUG_SM, "--sm-save-file %s\n",
561                               ob_sm_save_file);
562             }
563         }
564         else if (!strcmp(argv[i], "--sm-client-id")) {
565             if (i == *argc - 1) /* no args left */
566                 /* not translated cuz it's sekret */
567                 g_printerr("--sm-client-id requires an argument\n");
568             else {
569                 ob_sm_id = g_strdup(argv[i+1]);
570                 remove_args(argc, argv, i, 2);
571                 --i; /* this arg was removed so go back */
572                 ob_debug_type(OB_DEBUG_SM, "--sm-client-id %s\n", ob_sm_id);
573             }
574         }
575         else if (!strcmp(argv[i], "--sm-disable")) {
576             ob_sm_use = FALSE;
577         }
578         else if (!strcmp(argv[i], "--sm-no-load")) {
579             ob_sm_restore = FALSE;
580             remove_args(argc, argv, i, 1);
581             --i; /* this arg was removed so go back */
582         }
583         else {
584             /* this is a memleak.. oh well.. heh */
585             gchar *err = g_strdup_printf
586                 (_("Invalid command line argument '%s'\n"), argv[i]);
587             ob_exit_with_error(err);
588         }
589     }
590 }
591
592 static Cursor load_cursor(const gchar *name, guint fontval)
593 {
594     Cursor c = None;
595
596 #if USE_XCURSOR
597     c = XcursorLibraryLoadCursor(obt_display, name);
598 #endif
599     if (c == None)
600         c = XCreateFontCursor(obt_display, fontval);
601     return c;
602 }
603
604 void ob_exit_with_error(const gchar *msg)
605 {
606     g_message(msg);
607     session_shutdown(TRUE);
608     exit(EXIT_FAILURE);
609 }
610
611 void ob_restart_other(const gchar *path)
612 {
613     restart_path = g_strdup(path);
614     ob_restart();
615 }
616
617 void ob_restart()
618 {
619     restart = TRUE;
620     ob_exit(0);
621 }
622
623 void ob_reconfigure()
624 {
625     reconfigure = TRUE;
626     ob_exit(0);
627 }
628
629 void ob_exit(gint code)
630 {
631     exitcode = code;
632     obt_main_loop_exit(ob_main_loop);
633 }
634
635 void ob_exit_replace()
636 {
637     exitcode = 0;
638     being_replaced = TRUE;
639     obt_main_loop_exit(ob_main_loop);
640 }
641
642 Cursor ob_cursor(ObCursor cursor)
643 {
644     g_assert(cursor < OB_NUM_CURSORS);
645     return cursors[cursor];
646 }
647
648 KeyCode ob_keycode(ObKey key)
649 {
650     g_assert(key < OB_NUM_KEYS);
651     return keys[key];
652 }
653
654 ObState ob_state()
655 {
656     return state;
657 }