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