master f60265e: Clean up some of PGTK code

[Eli Zaretskii]

branch: master
commit f60265e73f1d31425f35d334410441986ae3aa77
Author: Eli Zaretskii <eliz@gnu.org>
Commit: Eli Zaretskii <eliz@gnu.org>

    Clean up some of PGTK code
    
    * src/pgtkgui.h: Fix comments.
    * src/image.c (DONT_CREATE_TRANSFORMED_IMAGEMAGICK_IMAGE)
    (is_wayland_display, check_x_display_info)
    (pgtk_get_string_resource): Reformat comments.
    * src/gtkutil.c (xg_show_tooltip): Add comments to large #ifdef's.
---
 src/gtkutil.c |  4 ++--
 src/image.c   | 12 +++++-------
 src/pgtkfns.c | 48 ++++++++++++++++--------------------------------
 src/pgtkgui.h |  6 +++---
 src/pgtkim.c  |  2 +-
 5 files changed, 27 insertions(+), 45 deletions(-)

diff --git a/src/gtkutil.c b/src/gtkutil.c
index 5271ccf..c10b362 100644
--- a/src/gtkutil.c
+++ b/src/gtkutil.c
@@ -921,7 +921,7 @@ xg_hide_tooltip (struct frame *f)
   return FALSE;
 }
 
-#else
+#else  /* HAVE_PGTK */
 
 void
 xg_show_tooltip (struct frame *f,
@@ -943,7 +943,7 @@ xg_hide_tooltip (struct frame *f)
   return TRUE;
 }
 
-#endif
+#endif /* HAVE_PGTK */
 
 
 /***********************************************************************
diff --git a/src/image.c b/src/image.c
index 55f5f55..dd5ea19 100644
--- a/src/image.c
+++ b/src/image.c
@@ -102,13 +102,11 @@ static unsigned long image_alloc_image_color (struct 
frame *, struct image *,
 #endif /* USE_CAIRO */
 
 #if defined HAVE_PGTK && defined HAVE_IMAGEMAGICK
-/* On pgtk, we don't want to create scaled image.
- * If we create scaled image on scale=2.0 environment,
- * the created image is half size and Gdk scales it back,
- * and the result is blurry.
- * To avoid this, we hold original size image as far as
- * we can, and let Gdk to scale it when it is shown.
- */
+/* In pgtk, we don't want to create scaled image.  If we create scaled
+ * image on scale=2.0 environment, the created image is half size and
+ * Gdk scales it back, and the result is blurry.  To avoid this, we
+ * hold original size image as far as we can, and let Gdk to scale it
+ * when it is shown.  */
 # define DONT_CREATE_TRANSFORMED_IMAGEMAGICK_IMAGE
 #endif
 
diff --git a/src/pgtkfns.c b/src/pgtkfns.c
index 21f3184..44e3d2a 100644
--- a/src/pgtkfns.c
+++ b/src/pgtkfns.c
@@ -41,8 +41,6 @@ along with GNU Emacs.  If not, see 
<https://www.gnu.org/licenses/>.  */
 
 #ifdef HAVE_PGTK
 
-//static EmacsTooltip *pgtk_tooltip = nil;
-
 /* Static variables to handle applescript execution.  */
 static Lisp_Object as_script, *as_result;
 static int as_status;
@@ -55,7 +53,7 @@ static struct pgtk_display_info *pgtk_display_info_for_name 
(Lisp_Object);
 
 static const char *pgtk_app_name = "Emacs";
 
-/* scale factor manually set per monitor */
+/* Scale factor manually set per monitor.  */
 static Lisp_Object monitor_scale_factor_alist;
 
 /* ==========================================================================
@@ -78,13 +76,9 @@ pgtk_get_monitor_scale_factor (const char *model)
   if (NILP (cdr))
     return 0;
   if (FIXNUMP (cdr))
-    {
-      return XFIXNUM (cdr);
-    }
+    return XFIXNUM (cdr);
   else if (FLOATP (cdr))
-    {
-      return XFLOAT_DATA (cdr);
-    }
+    return XFLOAT_DATA (cdr);
   else
     error ("unknown type of scale-factor");
 }
@@ -125,15 +119,12 @@ check_pgtk_display_info (Lisp_Object object)
   return dpyinfo;
 }
 
-/* On Wayland,
- * even if without WAYLAND_DISPLAY, --display DISPLAY works, but
- * gdk_display_get_name() always return "wayland-0", which may be
- * different from DISPLAY.
- * If with WAYLAND_DISPLAY, then it always returns WAYLAND_DISPLAY.
- * So pgtk emacs is confused and enter multi display environment.
- * To workaround this situation, treat all the wayland-* as the same
- * display.
- */
+/* On Wayland, even if without WAYLAND_DISPLAY, --display DISPLAY
+   works, but gdk_display_get_name always return "wayland-0", which
+   may be different from DISPLAY.  If with WAYLAND_DISPLAY, then it
+   always returns WAYLAND_DISPLAY.  So pgtk Emacs is confused and
+   enters multi display environment.  To workaround this situation,
+   treat all the wayland-* as the same display.  */
 static Lisp_Object
 is_wayland_display (Lisp_Object dpyname)
 {
@@ -204,7 +195,6 @@ x_set_foreground_color (struct frame *f, Lisp_Object arg, 
Lisp_Object oldval)
   if (FRAME_GTK_WIDGET (f))
     {
       update_face_from_frame_parameter (f, Qforeground_color, arg);
-      /*recompute_basic_faces (f); */
       if (FRAME_VISIBLE_P (f))
        SET_FRAME_GARBAGED (f);
     }
@@ -219,7 +209,7 @@ x_set_background_color (struct frame *f, Lisp_Object arg, 
Lisp_Object oldval)
   bg = x_decode_color (f, arg, WHITE_PIX_DEFAULT (f));
   FRAME_BACKGROUND_PIXEL (f) = bg;
 
-  /* clear the frame */
+  /* Clear the frame.  */
   if (FRAME_VISIBLE_P (f))
     pgtk_clear_frame (f);
 
@@ -405,7 +395,7 @@ x_set_menu_bar_lines (struct frame *f, Lisp_Object value, 
Lisp_Object oldval)
     return;
 
   if (TYPE_RANGED_FIXNUMP (int, value))
-      nlines = XFIXNUM (value);
+    nlines = XFIXNUM (value);
   else
     nlines = 0;
 
@@ -530,8 +520,7 @@ x_change_tool_bar_height (struct frame *f, int height)
     }
 }
 
-
-/* toolbar support */
+/* Toolbar support.  */
 static void
 x_set_tool_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
 {
@@ -569,7 +558,6 @@ x_set_child_frame_border_width (struct frame *f, 
Lisp_Object arg, Lisp_Object ol
 
 }
 
-
 static void
 x_set_internal_border_width (struct frame *f, Lisp_Object arg,
                             Lisp_Object oldval)
@@ -588,7 +576,6 @@ x_set_internal_border_width (struct frame *f, Lisp_Object 
arg,
     }
 }
 
-
 static void
 x_set_icon_type (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
 {
@@ -619,7 +606,6 @@ x_set_icon_type (struct frame *f, Lisp_Object arg, 
Lisp_Object oldval)
   unblock_input ();
 }
 
-
 static void
 x_set_icon_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
 {
@@ -1239,9 +1225,7 @@ scale factor. */ )
                                            monitor_scale_factor_alist);
     }
   else
-    {
-      Fsetcdr (tem, scale_factor);
-    }
+    Fsetcdr (tem, scale_factor);
 
   return scale_factor;
 }
@@ -2382,7 +2366,7 @@ font descriptor.  If string contains `fontset' and not
 
    ========================================================================== 
*/
 
-/* called from frame.c */
+/* Called from frame.c.  */
 struct pgtk_display_info *
 check_x_display_info (Lisp_Object frame)
 {
@@ -2410,7 +2394,7 @@ pgtk_set_scroll_bar_default_height (struct frame *f)
   FRAME_CONFIG_SCROLL_BAR_LINES (f) = (min_height + height - 1) / height;
 }
 
-/* terms impl this instead of x-get-resource directly */
+/* Terminals implement this instead of x-get-resource directly.  */
 const char *
 pgtk_get_string_resource (XrmDatabase rdb, const char *name,
                          const char *class)
@@ -3888,7 +3872,7 @@ value of DIR as in previous invocations; this is standard 
MS Windows behavior.
 }
 
 DEFUN ("pgtk-backend-display-class", Fpgtk_backend_display_class, 
Spgtk_backend_display_class, 0, 1, "",
-       doc: /* Returns the name of the Gdk backend display class of the 
TERMINAL.
+       doc: /* Return the name of the Gdk backend display class of TERMINAL.
 The optional argument TERMINAL specifies which display to ask about.
 TERMINAL should be a terminal object, a frame or a display name (a string).
 If omitted or nil, that stands for the selected frame's display.  */)
diff --git a/src/pgtkgui.h b/src/pgtkgui.h
index 7342dac..035e017 100644
--- a/src/pgtkgui.h
+++ b/src/pgtkgui.h
@@ -53,15 +53,15 @@ typedef struct _GdkDisplay Display;
 typedef void *XrmDatabase;
 
 
-/* some sort of attempt to normalize rectangle handling.. seems a bit much
-   for what is accomplished */
+/* Some sort of attempt to normalize rectangle handling.. seems a bit much
+   for what is accomplished.  */
 typedef struct
 {
   int x, y;
   unsigned width, height;
 } XRectangle;
 
-/* This stuff needed by frame.c. */
+/* This stuff is needed by frame.c.  */
 #define ForgetGravity          0
 #define NorthWestGravity       1
 #define NorthGravity           2
diff --git a/src/pgtkim.c b/src/pgtkim.c
index ba69a27..c0104eb 100644
--- a/src/pgtkim.c
+++ b/src/pgtkim.c
@@ -1,4 +1,4 @@
-/* Pure Gtk+-3 communication module.      -*- coding: utf-8 -*-
+/* Pure Gtk+-3 communication module.
 
 Copyright (C) 1989, 1993-1994, 2005-2006, 2008-2020 Free Software
 Foundation, Inc.