Fix some typos and style in client.c, and add a comment.
authorMikael Magnusson <mikachu@comhem.se>
Wed, 27 Feb 2008 02:59:25 +0000 (03:59 +0100)
committerMikael Magnusson <mikachu@comhem.se>
Wed, 27 Feb 2008 03:34:35 +0000 (04:34 +0100)
Also moves a comment from many places into one place.

openbox/client.c
openbox/event.h
openbox/focus.c
openbox/frame.h

index 115ea09..3a46f82 100644 (file)
@@ -68,7 +68,7 @@ typedef struct
     gpointer data;
 } ClientCallback;
 
-GList            *client_list           = NULL;
+GList          *client_list             = NULL;
 
 static GSList  *client_destroy_notifies = NULL;
 static RrImage *client_default_icon     = NULL;
@@ -541,7 +541,7 @@ void client_manage(Window window, ObPrompt *prompt)
                               "Not focusing the window because the user is "
                               "working in another window\n");
             }
-            /* If its a transient (and its parents aren't focused) */
+            /* If it's a transient (and its parents aren't focused) */
             else if (client_has_parent(self)) {
                 activate = FALSE;
                 ob_debug_type(OB_DEBUG_FOCUS,
@@ -582,7 +582,7 @@ void client_manage(Window window, ObPrompt *prompt)
         if (!activate) {
             ob_debug_type(OB_DEBUG_FOCUS,
                           "Focus stealing prevention activated for %s at "
-                          "time %u (last user interactioon time %u)\n",
+                          "time %u (last user interaction time %u)\n",
                           self->title, map_time, event_last_user_time);
             /* if the client isn't focused, then hilite it so the user
                knows it is there */
@@ -681,7 +681,7 @@ ObClient *client_fake_manage(Window window)
 
 void client_unmanage_all(void)
 {
-    while (client_list != NULL)
+    while (client_list)
         client_unmanage(client_list->data);
 }
 
@@ -1086,7 +1086,7 @@ gboolean client_find_onscreen(ObClient *self, gint *x, gint *y, gint w, gint h,
 
         /* This makes sure windows aren't entirely outside of the screen so you
            can't see them at all.
-           It makes sure 10% of the window is on the screen at least. At don't
+           It makes sure 10% of the window is on the screen at least. And don't
            let it move itself off the top of the screen, which would hide the
            titlebar on you. (The user can still do this if they want too, it's
            only limiting the application.
@@ -1296,7 +1296,7 @@ static void client_get_state(ObClient *self)
 static void client_get_shaped(ObClient *self)
 {
     self->shaped = FALSE;
-#ifdef   SHAPE
+#ifdef SHAPE
     if (extensions_shape) {
         gint foo;
         guint ufoo;
@@ -1307,7 +1307,7 @@ static void client_get_shaped(ObClient *self)
         XShapeQueryExtents(ob_display, self->window, &s, &foo,
                            &foo, &ufoo, &ufoo, &foo, &foo, &foo, &ufoo,
                            &ufoo);
-        self->shaped = (s != 0);
+        self->shaped = !!s;
     }
 #endif
 }
@@ -1319,13 +1319,13 @@ void client_update_transient_for(ObClient *self)
     gboolean trangroup = FALSE;
 
     if (XGetTransientForHint(ob_display, self->window, &t)) {
-        if (t != self->window) { /* cant be transient to itself! */
+        if (t != self->window) { /* can't be transient to itself! */
             target = g_hash_table_lookup(window_map, &t);
-            /* if this happens then we need to check for it*/
+            /* if this happens then we need to check for it */
             g_assert(target != self);
             if (target && !WINDOW_IS_CLIENT(target)) {
-                /* this can happen when a dialog is a child of
-                   a dockapp, for example */
+                /* watch out for windows with a parent that is something
+                   different, like a dockapp for example */
                 target = NULL;
             }
         }
@@ -1409,7 +1409,7 @@ static void client_update_transient_tree(ObClient *self,
     /* If we are now transient for a single window we need to add ourselves to
        its children
 
-       WARNING: Cyclical transient ness is possible if two windows are
+       WARNING: Cyclical transient-ness is possible if two windows are
        transient for eachother.
     */
     else if (newparent &&
@@ -1448,7 +1448,7 @@ static void client_update_transient_tree(ObClient *self,
     }
 
     /** If we change our group transient-ness, our children change their
-        effect group transient-ness, which affects how they relate to other
+        effective group transient-ness, which affects how they relate to other
         group windows **/
 
     for (it = self->transients; it; it = g_slist_next(it)) {
@@ -1890,7 +1890,7 @@ void client_update_wmhints(ObClient *self)
 {
     XWMHints *hints;
 
-    /* assume a window takes input if it doesnt specify */
+    /* assume a window takes input if it doesn't specify */
     self->can_focus = TRUE;
 
     if ((hints = XGetWMHints(ob_display, self->window)) != NULL) {
@@ -1922,7 +1922,7 @@ void client_update_wmhints(ObClient *self)
             ObGroup *oldgroup = self->group;
 
             /* remove from the old group if there was one */
-            if (self->group != NULL) {
+            if (self->group) {
                 group_remove(self->group, self);
                 self->group = NULL;
             }
@@ -2607,13 +2607,6 @@ gboolean client_hide(ObClient *self)
 
     if (!client_should_show(self)) {
         if (self == focus_client) {
-            /* if there is a grab going on, then we need to cancel it. if we
-               move focus during the grab, applications will get
-               NotifyWhileGrabbed events and ignore them !
-
-               actions should not rely on being able to move focus during an
-               interactive grab.
-            */
             event_cancel_all_key_grabs();
         }
 
@@ -2826,7 +2819,7 @@ void client_try_configure(ObClient *self, gint *x, gint *y, gint *w, gint *h,
     Rect desired = {*x, *y, *w, *h};
     frame_rect_to_frame(self->frame, &desired);
 
-    /* make the frame recalculate its dimentions n shit without changing
+    /* make the frame recalculate its dimensions n shit without changing
        anything visible for real, this way the constraints below can work with
        the updated frame dimensions. */
     frame_adjust_area(self->frame, FALSE, TRUE, TRUE);
@@ -2881,7 +2874,7 @@ void client_try_configure(ObClient *self, gint *x, gint *y, gint *w, gint *h,
     /* gets the client's position */
     frame_frame_gravity(self->frame, x, y);
 
-    /* work within the prefered sizes given by the window */
+    /* work within the preferred sizes given by the window */
     if (!(*w == self->area.width && *h == self->area.height)) {
         gint basew, baseh, minw, minh;
         gint incw, inch;
@@ -2911,6 +2904,7 @@ void client_try_configure(ObClient *self, gint *x, gint *y, gint *w, gint *h,
             minh = self->base_size.height;
         }
 
+        /* This comment is no longer true */
         /* if this is a user-requested resize, then check against min/max
            sizes */
 
@@ -3146,7 +3140,7 @@ void client_fullscreen(ObClient *self, gboolean fs)
     if (fs) {
         self->pre_fullscreen_area = self->area;
         /* if the window is maximized, its area isn't all that meaningful.
-           save it's premax area instead. */
+           save its premax area instead. */
         if (self->max_horz) {
             self->pre_fullscreen_area.x = self->pre_max_area.x;
             self->pre_fullscreen_area.width = self->pre_max_area.width;
@@ -3197,7 +3191,6 @@ static void client_iconify_recursive(ObClient *self,
     GSList *it;
     gboolean changed = FALSE;
 
-
     if (self->iconic != iconic) {
         ob_debug("%sconifying window: 0x%lx\n", (iconic ? "I" : "Uni"),
                  self->window);
@@ -3812,13 +3805,6 @@ gboolean client_focus(ObClient *self)
        go moving on us */
     event_halt_focus_delay();
 
-    /* if there is a grab going on, then we need to cancel it. if we move
-       focus during the grab, applications will get NotifyWhileGrabbed events
-       and ignore them !
-
-       actions should not rely on being able to move focus during an
-       interactive grab.
-    */
     event_cancel_all_key_grabs();
 
     xerror_set_ignore(TRUE);
@@ -3878,6 +3864,8 @@ static void client_present(ObClient *self, gboolean here, gboolean raise,
     client_focus(self);
 }
 
+/* this function exists to map to the client_activate message in the ewmh,
+   the user arg is unused because nobody uses it correctly anyway. */
 void client_activate(ObClient *self, gboolean here, gboolean raise,
                      gboolean unshade, gboolean user)
 {
@@ -3923,8 +3911,6 @@ gboolean client_focused(ObClient *self)
     return self == focus_client;
 }
 
-
-
 RrImage* client_icon(ObClient *self)
 {
     RrImage *ret = NULL;
index a8d1aea..93af6b4 100644 (file)
@@ -25,7 +25,7 @@
 struct _ObClient;
 
 /*! The amount of time before a window appears that is checked for user input
-  to determine if the user is working in another window */
+    to determine if the user is working in another window */
 #define OB_EVENT_USER_TIME_DELAY (500) /* 0.5 seconds */
 
 /*! Time at which the last event with a timestamp occured. */
@@ -42,15 +42,21 @@ void event_startup(gboolean reconfig);
 void event_shutdown(gboolean reconfig);
 
 /*! Make as if the mouse just entered the client, use only when using focus
-  follows mouse */
+    follows mouse */
 void event_enter_client(struct _ObClient *client);
 
 /*! Make mouse focus not move at all from the stuff that happens between these
- two function calls. */
   two function calls. */
 gulong event_start_ignore_all_enters();
 void event_end_ignore_all_enters(gulong start);
 
-/*! End *all* active and passive grabs on the keyboard */
+/*! End *all* active and passive grabs on the keyboard
+    This is called in situations where if there is a grab going on, then
+    we need to cancel it. If we move focus during the grab, applications
+    will get NotifyWhileGrabbed events and ignore them!
+
+    Actions should not rely on being able to move focus during an
+    interactive grab. */
 void event_cancel_all_key_grabs();
 
 /* Halts any focus delay in progress, use this when the user is selecting a
@@ -58,7 +64,7 @@ void event_cancel_all_key_grabs();
 void event_halt_focus_delay();
 
 /*! Compare t1 and t2, taking into account wraparound. True if t1
-  comes at the same time or later than t2. */
+    comes at the same time or later than t2. */
 gboolean event_time_after(Time t1, Time t2);
 
 Time event_get_server_time();
index c2d7e11..12625fd 100644 (file)
@@ -197,13 +197,6 @@ void focus_nothing(void)
     /* nothing is focused, update the colormap and _the root property_ */
     focus_set_client(NULL);
 
-    /* if there is a grab going on, then we need to cancel it. if we move
-       focus during the grab, applications will get NotifyWhileGrabbed events
-       and ignore them !
-
-       actions should not rely on being able to move focus during an
-       interactive grab.
-    */
     event_cancel_all_key_grabs();
 
     /* when nothing will be focused, send focus to the backup target */
index e1b787f..fd5adf7 100644 (file)
@@ -74,7 +74,7 @@ typedef enum {
     /*! Display a button to toggle the window's placement on
       all desktops */
     OB_FRAME_DECOR_ALLDESKTOPS = 1 << 7,
-    OB_FRAME_DECOR_SHADE       = 1 << 8, /*!< Displays a shade button */
+    OB_FRAME_DECOR_SHADE       = 1 << 8, /*!< Display a shade button */
     OB_FRAME_DECOR_CLOSE       = 1 << 9  /*!< Display a close button */
 } ObFrameDecorations;