Merge pull request #197 from DaveDavenport/signalhandler

Signalhandler

doc/rofi-manpage.markdown

@@ -595,6 +595,21 @@ This way it can be used as a drop-in replacement for dmenu. just copy or symlink
 
     ln -s /usr/bin/dmenu /usr/bin/rofi
 
+## SIGNALS
+
+`HUP`
+
+If in daemon mode, reload the configuration from Xresources. (commandline arguments still -override
+Xresources).  This will also reload configured key-bindings.
+
+`INT`
+
+If in daemon mode, quits **rofi**.
+
+`USR1`
+
+If in daemon mode, dumps the current configuration to stdout. Similar to `-xresources-dump`
+
 ## THEMING
 
 With **rofi** 0.15.4 we have a new way of specifying colors, the old settings still apply (for now).

doc/rofi.1

@@ -1071,6 +1071,24 @@ ln \-s /usr/bin/dmenu /usr/bin/rofi
 .
 .IP "" 0
 .
+.SH "SIGNALS"
+\fBHUP\fR
+.
+.P
+If in daemon mode, reload the configuration from Xresources\. (commandline arguments still \-override Xresources)\. This will also reload configured key\-bindings\.
+.
+.P
+\fBINT\fR
+.
+.P
+If in daemon mode, quits \fBrofi\fR\.
+.
+.P
+\fBUSR1\fR
+.
+.P
+If in daemon mode, dumps the current configuration to stdout\. Similar to \fB\-xresources\-dump\fR
+.
 .SH "THEMING"
 With \fBrofi\fR 0\.15\.4 we have a new way of specifying colors, the old settings still apply (for now)\. To enable the new setup, set \fBrofi\.color\-enabled\fR to true\. The new setup allows you to specify colors per state, similar to \fBi3\fR Currently 3 states exists:
 .

include/rofi.h

@@ -300,4 +300,8 @@ struct _Switcher
 #define  color_blue_bold       "\033[1;34m"
 #define  color_magenta_bold    "\033[1;35m"
 #define  color_cyan_bold       "\033[1;36m"
+
+
+
+void show_error_message ( const char *msg, int markup );
 #endif

include/x11-helper.h

@@ -92,6 +92,15 @@ int take_keyboard ( Display *display, Window w );
  */
 void x11_grab_key ( Display *display, unsigned int modmask, KeySym key );
 
+/**
+ * @param display Connection to the X server.
+ * @param modmask Modifier mask.
+ * @param key     Key.
+ *
+ * Ungrab key on display.
+ */
+void x11_ungrab_key ( Display *display, unsigned int modmask, KeySym key );
+
 /**
  * @param combo String representing the key combo
  * @param mod [out]  The modifier specified (or AnyModifier if not specified)

source/helper.c

@@ -148,11 +148,7 @@ int helper_parse_setup ( char * string, char ***output, int *length, ... )
     if ( error ) {
         char *msg = g_strdup_printf ( "Failed to parse: '%s'\nError: '%s'", string,
                                       error->message );
-#ifdef error_dialog
-        error_dialog ( msg );
-#else
-        fputs ( msg, stderr );
-#endif
+        error_dialog ( msg, FALSE );
         g_free ( msg );
         // print error.
         g_error_free ( error );
@@ -396,11 +392,7 @@ int execute_generator ( const char * cmd )
     if ( error != NULL ) {
         char *msg = g_strdup_printf ( "Failed to execute: '%s'\nError: '%s'", cmd,
                                       error->message );
-#ifdef error_dialog
-        error_dialog ( msg );
-#else
-        fputs ( msg, stderr );
-#endif
+        error_dialog ( msg, FALSE );
         g_free ( msg );
         // print error.
         g_error_free ( error );
@@ -464,23 +456,37 @@ void config_sanity_check (  )
                   "Please see the manpage: %s -help for the correct syntax.", stored_argv[0] );
         exit ( EXIT_FAILURE );
     }
+    int     found_error = FALSE;
+    GString *msg        = g_string_new ( "<big><b>The configuration failed to validate:</b></big>\n" );
     if ( config.element_height < 1 ) {
-        fprintf ( stderr, "config.element_height is invalid. It needs to be atleast 1 line high.\n" );
-        exit ( 1 );
+        g_string_append_printf ( msg, "\t<b>config.element_height</b>=%d is invalid. An element needs to be atleast 1 line high.\n",
+                                 config.element_height );
+        config.element_height = 1;
+        found_error           = TRUE;
     }
     if ( config.menu_columns == 0 ) {
-        fprintf ( stderr, "config.menu_columns is invalid. You need at least one visible column.\n" );
-        exit ( 1 );
+        g_string_append_printf ( msg, "\t<b>config.menu_columns</b>=%d is invalid. You need at least one visible column.\n",
+                                 config.menu_columns );
+        config.menu_columns = 1;
+        found_error         = TRUE;
     }
     if ( config.menu_width == 0 ) {
-        fprintf ( stderr, "config.menu_width is invalid. You cannot have a window with no width.\n" );
-        exit ( 1 );
+        show_error_message ( "<b>config.menu_width</b>=0 is invalid. You cannot have a window with no width.", TRUE );
+        config.menu_columns = 50;
+        found_error         = TRUE;
     }
     if ( !( config.location >= WL_CENTER && config.location <= WL_WEST ) ) {
-        fprintf ( stderr, "config.location is invalid. ( %d >= %d >= %d) does not hold.\n",
-                  WL_WEST, config.location, WL_CENTER );
-        exit ( 1 );
+        g_string_append_printf ( msg, "\t<b>config.location</b>=%d is invalid. Value should be between %d and %d.\n",
+                                 config.location, WL_CENTER, WL_WEST );
+        config.location = WL_CENTER;
+        found_error     = 1;
     }
+    if ( found_error ) {
+        g_string_append ( msg, "Please update your configuration." );
+        show_error_message ( msg->str, TRUE );
+    }
+
+    g_string_free ( msg, TRUE );
     // If alternative row is not set, copy the normal background color.
     if ( config.menu_bg_alt == NULL ) {
         config.menu_bg_alt = config.menu_bg;

source/rofi.c

@@ -1479,35 +1479,32 @@ static int run_dmenu ()
     // Cleanup font setup.
     textbox_cleanup ( );
 
+    // Release the window.
+    release_keyboard ( display );
+    if ( main_window != None ) {
+        XUnmapWindow ( display, main_window );
+        XDestroyWindow ( display, main_window );
+        main_window = None;
+        XFreeGC ( display, gc );
+        gc = NULL;
+    }
     if ( map != None ) {
         XFreeColormap ( display, map );
         map = None;
     }
+    // Cleanup pid file.
+    if ( pidfile ) {
+        unlink ( pidfile );
+    }
     return ret_state;
 }
 
-static void run_switcher ( int do_fork, SwitcherMode mode )
+static void run_switcher ( SwitcherMode mode )
 {
-    // we fork because it's technically possible to have multiple window
-    // lists up at once on a zaphod multihead X setup.
-    // this also happens to isolate the Xft font stuff in a child process
-    // that gets cleaned up every time. That library shows some valgrind
-    // strangeness...
-    if ( do_fork == TRUE ) {
-        if ( fork () ) {
-            return;
-        }
-
-        display = XOpenDisplay ( display_str );
-        XSync ( display, True );
-    }
     // Create pid file to avoid multiple instances.
     create_pid_file ( pidfile );
     // Create the colormap and the main visual.
     create_visual_and_colormap ( display );
-
-    // Because of the above fork, we want to do this here.
-    // Make sure this is isolated to its own thread.
     textbox_setup ( &vinfo, map );
     // Otherwise check if requested mode is enabled.
     char *input = NULL;
@@ -1548,13 +1545,23 @@ static void run_switcher ( int do_fork, SwitcherMode mode )
 
     // Cleanup font setup.
     textbox_cleanup ( );
+
+    // Release the window.
+    release_keyboard ( display );
+    if ( main_window != None ) {
+        XUnmapWindow ( display, main_window );
+        XDestroyWindow ( display, main_window );
+        main_window = None;
+        XFreeGC ( display, gc );
+        gc = NULL;
+    }
     if ( map != None ) {
         XFreeColormap ( display, map );
         map = None;
     }
-
-    if ( do_fork == TRUE ) {
-        exit ( EXIT_SUCCESS );
+    // Cleanup pid file.
+    if ( pidfile ) {
+        unlink ( pidfile );
     }
 }
 
@@ -1568,7 +1575,7 @@ static void handle_keypress ( XEvent *ev )
     KeySym key = XkbKeycodeToKeysym ( display, ev->xkey.keycode, 0, 0 );
     index = locate_switcher ( key, ev->xkey.state );
     if ( index >= 0 ) {
-        run_switcher ( TRUE, index );
+        run_switcher ( index );
     }
     else {
         fprintf ( stderr, "Warning: Unhandled keypress in global keyhandler, keycode = %u mask = %u\n", ev->xkey.keycode, ev->xkey.state );
@@ -1598,16 +1605,17 @@ static void cleanup ()
     // Cleanup
     if ( display != NULL ) {
         if ( main_window != None ) {
+            // We should never hit this code.
             release_keyboard ( display );
             XFreeGC ( display, gc );
+            gc = NULL;
             XDestroyWindow ( display, main_window );
-            XCloseDisplay ( display );
+            main_window = None;
         }
+        XCloseDisplay ( display );
+        display = NULL;
     }
-    // Cleanup pid file.
-    if ( pidfile ) {
-        unlink ( pidfile );
-    }
+
 
     // Cleaning up memory allocated by the Xresources file.
     config_xresource_free ();
@@ -1716,7 +1724,7 @@ static inline void load_configuration_dynamic ( Display *display )
 }
 
 
-static void show_error_message ( const char *msg, int markup )
+void show_error_message ( const char *msg, int markup )
 {
     // Create pid file
     create_pid_file ( pidfile );
@@ -1726,10 +1734,156 @@ static void show_error_message ( const char *msg, int markup )
     textbox_setup ( &vinfo, map );
     error_dialog ( msg, markup );
     textbox_cleanup ( );
+    //
+    // Cleanup font setup.
+    textbox_cleanup ( );
+
+    // Release the window.
+    release_keyboard ( display );
+    if ( main_window != None ) {
+        XUnmapWindow ( display, main_window );
+        XDestroyWindow ( display, main_window );
+        main_window = None;
+        XFreeGC ( display, gc );
+        gc = NULL;
+    }
     if ( map != None ) {
         XFreeColormap ( display, map );
         map = None;
     }
+    // Cleanup pid file.
+    if ( pidfile ) {
+        unlink ( pidfile );
+    }
+}
+
+/**
+ * Separate thread that handles signals being send to rofi.
+ * Currently it listens for three signals:
+ *  * HUP: reload the configuration.
+ *  * INT: Quit the program.
+ *  * USR1: Dump the current configuration to stdout.
+ *
+ *  These messages are relayed to the main thread via a pipe, the write side of the pipe is passed
+ *  as argument to this thread.
+ *  When receiving a sig-int the thread quits.
+ */
+static gpointer pthread_signal_process ( gpointer arg )
+{
+    int pfd = *( (int *) arg );
+
+    // Create same mask again.
+    sigset_t set;
+    sigemptyset ( &set );
+    sigaddset ( &set, SIGHUP );
+    sigaddset ( &set, SIGINT );
+    sigaddset ( &set, SIGUSR1 );
+    // loop forever.
+    while ( 1 ) {
+        siginfo_t info;
+        int       sig = sigwaitinfo ( &set, &info );
+        if ( sig < 0 ) {
+            perror ( "sigwaitinfo failed" );
+        }
+        else {
+            // Send message to main thread.
+            if ( sig == SIGHUP ) {
+                write ( pfd, "c", 1 );
+            }
+            if ( sig == SIGUSR1 ) {
+                write ( pfd, "i", 1 );
+            }
+            else if ( sig == SIGINT ) {
+                write ( pfd, "q", 1 );
+                // Close my end and exit.
+                g_thread_exit ( NULL );
+            }
+        }
+    }
+}
+
+static void release_global_keybindings ()
+{
+    for ( unsigned int i = 0; i < num_switchers; i++ ) {
+        if ( switchers[i]->keystr != NULL ) {
+            // No need to parse key, this should be done when grabbing.
+            if ( switchers[i]->keysym != NoSymbol ) {
+                x11_ungrab_key ( display, switchers[i]->modmask, switchers[i]->keysym );
+            }
+        }
+    }
+}
+static int grab_global_keybindings ()
+{
+    int key_bound = FALSE;
+    for ( unsigned int i = 0; i < num_switchers; i++ ) {
+        if ( switchers[i]->keystr != NULL ) {
+            x11_parse_key ( switchers[i]->keystr, &( switchers[i]->modmask ), &( switchers[i]->keysym ) );
+            if ( switchers[i]->keysym != NoSymbol ) {
+                x11_grab_key ( display, switchers[i]->modmask, switchers[i]->keysym );
+                key_bound = TRUE;
+            }
+        }
+    }
+    return key_bound;
+}
+static void print_global_keybindings ()
+{
+    fprintf ( stdout, "listening to the following keys:\n" );
+    for ( unsigned int i = 0; i < num_switchers; i++ ) {
+        if ( switchers[i]->keystr != NULL ) {
+            fprintf ( stdout, "\t* "color_bold "%s"color_reset " on %s\n",
+                      switchers[i]->name, switchers[i]->keystr );
+        }
+        else {
+            fprintf ( stdout, "\t* "color_bold "%s"color_reset " on <unspecified>\n",
+                      switchers[i]->name );
+        }
+    }
+}
+
+static void reload_configuration ()
+{
+    if ( find_arg ( "-no-config" ) < 0 ) {
+        // We need to open a new connection to X11, otherwise we get old
+        // configuration
+        Display *temp_display = XOpenDisplay ( display_str );
+        if ( temp_display ) {
+            load_configuration ( temp_display );
+            load_configuration_dynamic ( temp_display );
+
+            // Sanity check
+            config_sanity_check ( );
+            parse_keys_abe ();
+            XCloseDisplay ( temp_display );
+        }
+        else {
+            fprintf ( stderr, "Failed to get a new connection to the X11 server. No point in continuing.\n" );
+            abort ();
+        }
+    }
+}
+
+/**
+ * Setup signal handling.
+ * Block all the signals, start a signal processor thread to handle these events.
+ */
+static GThread *setup_signal_thread ( int *fd )
+{
+    // Block all HUP,INT,USR1 signals.
+    // In this and other child (they inherit mask)
+    sigset_t set;
+    sigemptyset ( &set );
+    sigaddset ( &set, SIGHUP );
+    sigaddset ( &set, SIGINT );
+    sigaddset ( &set, SIGUSR1 );
+    sigprocmask ( SIG_BLOCK, &set, NULL );
+    // Create signal handler process.
+    // This will use sigwaitinfo to read signals and forward them back to the main thread again.
+    return g_thread_new (
+               "signal_process",
+               pthread_signal_process,
+               (void *) fd );
 }
 
 int main ( int argc, char *argv[] )
@@ -1816,6 +1970,15 @@ int main ( int argc, char *argv[] )
         // Reload for dynamic part.
         load_configuration_dynamic ( display );
     }
+
+    // Set up X interaction.
+    const struct sigaction sigchld_action = {
+        .sa_handler = catch_exit
+    };
+    sigaction ( SIGCHLD, &sigchld_action, NULL );
+
+    x11_setup ( display );
+
     // Sanity check
     config_sanity_check ( );
     // Dump.
@@ -1826,14 +1989,6 @@ int main ( int argc, char *argv[] )
     // Parse the keybindings.
     parse_keys_abe ();
 
-    // Set up X interaction.
-    const struct sigaction sigchld_action = {
-        .sa_handler = catch_exit
-    };
-    sigaction ( SIGCHLD, &sigchld_action, NULL );
-
-    x11_setup ( display );
-
     char *msg = NULL;
     if ( find_arg_str (  "-e", &( msg ) ) ) {
         int markup = FALSE;
@@ -1866,67 +2021,116 @@ int main ( int argc, char *argv[] )
     if ( find_arg_str ( "-show", &sname ) == TRUE ) {
         int index = switcher_get ( sname );
         if ( index >= 0 ) {
-            run_switcher ( FALSE, index );
+            run_switcher ( index );
         }
         else {
             fprintf ( stderr, "The %s switcher has not been enabled\n", sname );
         }
     }
     else{
-        int          key_bound  = FALSE;
-        unsigned int key_length = 0;
         // Daemon mode, Listen to key presses..
-        for ( unsigned int i = 0; i < num_switchers; i++ ) {
-            key_length = MAX ( key_length, strlen ( switchers[i]->name ) );
-            if ( switchers[i]->keystr != NULL ) {
-                x11_parse_key ( switchers[i]->keystr, &( switchers[i]->modmask ), &( switchers[i]->keysym ) );
-                x11_grab_key ( display, switchers[i]->modmask, switchers[i]->keysym );
-                key_bound = TRUE;
-            }
-        }
-        if ( !key_bound ) {
+        if ( !grab_global_keybindings () ) {
             fprintf ( stderr, "Rofi was launched in daemon mode, but no key-binding was specified.\n" );
             fprintf ( stderr, "Please check the manpage on how to specify a key-binding.\n" );
             fprintf ( stderr, "The following modi are enabled and keys can be specified:\n" );
             for ( unsigned int i = 0; i < num_switchers; i++ ) {
-                fprintf ( stderr, "\t* "color_bold "%*s"color_reset ": -key-%s <key>\n",
-                          key_length, switchers[i]->name, switchers[i]->name );
+                fprintf ( stderr, "\t* "color_bold "%s"color_reset ": -key-%s <key>\n",
+                          switchers[i]->name, switchers[i]->name );
             }
             return EXIT_FAILURE;
         }
         if ( !quiet ) {
             fprintf ( stdout, "Rofi is launched in daemon mode.\n" );
-            fprintf ( stdout, "listening to the following keys:\n" );
-            for ( unsigned int i = 0; i < num_switchers; i++ ) {
-                if ( switchers[i]->keystr != NULL ) {
-                    fprintf ( stdout, "\t* "color_bold "%*s"color_reset " on %s\n",
-                              key_length, switchers[i]->name, switchers[i]->keystr );
-                }
-                else {
-                    fprintf ( stdout, "\t* "color_bold "%*s"color_reset " on <unspecified>\n",
-                              key_length, switchers[i]->name );
-                }
-            }
+            print_global_keybindings ();
         }
 
+
+        // Create a pipe to communicate between signal thread an main thread.
+        int pfds[2];
+        if ( pipe ( pfds ) != 0 ) {
+            char * msg = g_strdup_printf ( "Failed to start rofi: '<i>%s</i>'", strerror ( errno ) );
+            show_error_message ( msg, TRUE );
+            g_free ( msg );
+            exit ( EXIT_FAILURE );
+        }
+        GThread *pid_signal_proc = setup_signal_thread ( &( pfds[1] ) );
+
         // Application Main loop.
         // This listens in the background for any events on the Xserver
         // catching global key presses.
+        // It also listens from messages from the signal process.
+        XSelectInput ( display, DefaultRootWindow ( display ), KeyPressMask );
+        XFlush ( display );
+        int x11_fd = ConnectionNumber ( display );
         for (;; ) {
-            XEvent ev;
+            fd_set in_fds;
+            // Create a File Description Set containing x11_fd
+            FD_ZERO ( &in_fds );
+            FD_SET ( x11_fd, &in_fds );
+            FD_SET ( pfds[0], &in_fds );
 
-            // block and wait for something
-            XNextEvent ( display, &ev );
-            // If we get an event that does not belong to a window:
-            // Ignore it.
-            if ( ev.xany.window == None ) {
-                continue;
-            }
-            // If keypress, handle it.
-            if ( ev.type == KeyPress ) {
-                handle_keypress ( &ev );
+            // Wait for X Event or a Timer
+            if ( select ( MAX ( x11_fd, pfds[0] ) + 1, &in_fds, 0, 0, NULL ) >= 0 ) {
+                if ( FD_ISSET ( x11_fd, &in_fds ) ) {
+                    // X11 produced an event. Consume them.
+                    XEvent ev;
+                    while ( XPending ( display ) ) {
+                        // block and wait for something
+                        XNextEvent ( display, &ev );
+                        // If we get an event that does not belong to a window:
+                        // Ignore it.
+                        if ( ev.xany.window == None ) {
+                            continue;
+                        }
+                        // If keypress, handle it.
+                        if ( ev.type == KeyPress ) {
+                            handle_keypress ( &ev );
+                        }
+                    }
+                }
+                if ( FD_ISSET ( pfds[0], &in_fds ) ) {
+                    // The signal thread send us a message. Process it.
+                    char c;
+                    read ( pfds[0], &c, 1 );
+                    // Reload configuration.
+                    if ( c == 'c' ) {
+                        if ( !quiet ) {
+                            fprintf ( stdout, "Reload configuration\n" );
+                        }
+                        // Release the keybindings.
+                        release_global_keybindings ();
+                        // Reload config
+                        reload_configuration ();
+                        // Grab the possibly new keybindings.
+                        grab_global_keybindings ();
+                        if ( !quiet ) {
+                            print_global_keybindings ();
+                        }
+                        XFlush ( display );
+                    }
+                    // Got message to quit.
+                    else if ( c == 'q' ) {
+                        // Break out of loop.
+                        break;
+                    }
+                    // Got message to print info
+                    else if ( c == 'i' ) {
+                        xresource_dump ();
+                    }
+                }
             }
         }
+
+        release_global_keybindings ();
+        // Join the signal process thread. (at this point it should have exited).
+        // this also unrefs (de-allocs) the GThread object.
+        g_thread_join ( pid_signal_proc );
+        // Close pipe
+        close ( pfds[0] );
+        close ( pfds[1] );
+        if(!quiet) {
+            fprintf ( stdout, "Quit from daemon mode.\n" );
+        }
     }
 
     return EXIT_SUCCESS;

source/x11-helper.c

@@ -276,6 +276,21 @@ void x11_grab_key ( Display *display, unsigned int modmask, KeySym key )
     }
 }
 
+void x11_ungrab_key ( Display *display, unsigned int modmask, KeySym key )
+{
+    Screen  *screen = DefaultScreenOfDisplay ( display );
+    Window  root    = RootWindow ( display, XScreenNumberOfScreen ( screen ) );
+    KeyCode keycode = XKeysymToKeycode ( display, key );
+
+    // unbind to combinations of mod and lock masks, so caps and numlock don't confuse people
+    XUngrabKey ( display, keycode, modmask, root );
+    XUngrabKey ( display, keycode, modmask | LockMask, root );
+
+    if ( NumlockMask ) {
+        XUngrabKey ( display, keycode, modmask | NumlockMask, root );
+        XUngrabKey ( display, keycode, modmask | NumlockMask | LockMask, root );
+    }
+}
 /**
  * @param display The connection to the X server.
  *
@@ -345,8 +360,8 @@ void x11_parse_key ( char *combo, unsigned int *mod, KeySym *key )
     KeySym sym = XStringToKeysym ( combo + i );
 
     if ( sym == NoSymbol || ( !modmask && ( strchr ( combo, '-' ) || strchr ( combo, '+' ) ) ) ) {
+        // TODO popup
         fprintf ( stderr, "sorry, cannot understand key combination: %s\n", combo );
-        exit ( EXIT_FAILURE );
     }
 
     *key = sym;

test/helper-test.c

@@ -10,6 +10,17 @@ static int test = 0;
         assert ( a );                                    \
         printf ( "Test %i passed (%s)\n", ++test, # a ); \
 }
+
+void error_dialog ( const char *msg, G_GNUC_UNUSED int markup )
+{
+    fputs ( msg, stderr );
+}
+
+void show_error_message ( const char *msg, int markup )
+{
+    error_dialog ( msg, markup );
+}
+
 int main ( int argc, char ** argv )
 {
     cmd_set_arguments ( argc, argv );

test/textbox-test.c

@@ -24,6 +24,16 @@ Display     *display = NULL;
 Colormap    map      = None;
 XVisualInfo vinfo;
 
+void error_dialog ( const char *msg, G_GNUC_UNUSED int markup )
+{
+    fputs ( msg, stderr );
+}
+
+void show_error_message ( const char *msg, int markup )
+{
+    error_dialog ( msg, markup );
+}
+
 static unsigned int color_get ( Display *display, const char *const name )
 {
     XColor color;