xref: /vim-8.2.3635/src/gui.h (revision d4fc577e)
1 /* vi:set ts=8 sts=4 sw=4 noet:
2  *
3  * VIM - Vi IMproved		by Bram Moolenaar
4  *				Motif support by Robert Webb
5  *
6  * Do ":help uganda"  in Vim to read copying and usage conditions.
7  * Do ":help credits" in Vim to see a list of people who contributed.
8  */
9 
10 #ifdef FEAT_GUI_MOTIF
11 # include <Xm/Xm.h>
12 #endif
13 
14 #ifdef FEAT_GUI_ATHENA
15 # include <X11/Intrinsic.h>
16 # include <X11/StringDefs.h>
17 #endif
18 
19 #ifdef FEAT_GUI_GTK
20 # ifdef VMS /* undef MIN and MAX because Intrinsic.h redefines them anyway */
21 #  ifdef MAX
22 #   undef MAX
23 #  endif
24 #  ifdef MIN
25 #   undef MIN
26 #  endif
27 # endif
28 # include <X11/Intrinsic.h>
29 # include <gtk/gtk.h>
30 #endif
31 
32 #ifdef FEAT_GUI_MAC
33 # include <Types.h>
34 /*# include <Memory.h>*/
35 # include <Quickdraw.h>
36 # include <Fonts.h>
37 # include <Events.h>
38 # include <Menus.h>
39 # if !(defined (TARGET_API_MAC_CARBON) && (TARGET_API_MAC_CARBON))
40 #  include <Windows.h>
41 # endif
42 # include <Controls.h>
43 /*# include <TextEdit.h>*/
44 # include <Dialogs.h>
45 # include <OSUtils.h>
46 /*
47 # include <ToolUtils.h>
48 # include <SegLoad.h>*/
49 #endif
50 
51 #ifdef FEAT_GUI_PHOTON
52 # include <Ph.h>
53 # include <Pt.h>
54 # include "photon/PxProto.h"
55 #endif
56 
57 /*
58  * On some systems scrolling needs to be done right away instead of in the
59  * main loop.
60  */
61 #if defined(FEAT_GUI_MSWIN) || defined(FEAT_GUI_MAC) || defined(FEAT_GUI_GTK)
62 # define USE_ON_FLY_SCROLL
63 #endif
64 
65 /*
66  * GUIs that support dropping files on a running Vim.
67  */
68 #if defined(FEAT_GUI_MSWIN) || defined(FEAT_GUI_MAC) \
69 	|| defined(FEAT_GUI_GTK)
70 # define HAVE_DROP_FILE
71 #endif
72 
73 /*
74  * This define makes menus always use a fontset.
75  * We're not sure if this code always works, thus it can be disabled.
76  */
77 #ifdef FEAT_XFONTSET
78 # define FONTSET_ALWAYS
79 #endif
80 
81 /*
82  * These macros convert between character row/column and pixel coordinates.
83  * TEXT_X   - Convert character column into X pixel coord for drawing strings.
84  * TEXT_Y   - Convert character row into Y pixel coord for drawing strings.
85  * FILL_X   - Convert character column into X pixel coord for filling the area
86  *		under the character.
87  * FILL_Y   - Convert character row into Y pixel coord for filling the area
88  *		under the character.
89  * X_2_COL  - Convert X pixel coord into character column.
90  * Y_2_ROW  - Convert Y pixel coord into character row.
91  */
92 #ifdef FEAT_GUI_W32
93 # define TEXT_X(col)	((col) * gui.char_width)
94 # define TEXT_Y(row)	((row) * gui.char_height + gui.char_ascent)
95 # define FILL_X(col)	((col) * gui.char_width)
96 # define FILL_Y(row)	((row) * gui.char_height)
97 # define X_2_COL(x)	((x) / gui.char_width)
98 # define Y_2_ROW(y)	((y) / gui.char_height)
99 #else
100 # define TEXT_X(col)	((col) * gui.char_width  + gui.border_offset)
101 # define FILL_X(col)	((col) * gui.char_width  + gui.border_offset)
102 # define X_2_COL(x)	(((x) - gui.border_offset) / gui.char_width)
103 # define TEXT_Y(row)	((row) * gui.char_height + gui.char_ascent \
104 							+ gui.border_offset)
105 # define FILL_Y(row)	((row) * gui.char_height + gui.border_offset)
106 # define Y_2_ROW(y)	(((y) - gui.border_offset) / gui.char_height)
107 #endif
108 
109 /* Indices for arrays of scrollbars */
110 #define SBAR_NONE	    -1
111 #define SBAR_LEFT	    0
112 #define SBAR_RIGHT	    1
113 #define SBAR_BOTTOM	    2
114 
115 /* Orientations for scrollbars */
116 #define SBAR_VERT	    0
117 #define SBAR_HORIZ	    1
118 
119 /* Default size of scrollbar */
120 #define SB_DEFAULT_WIDTH    16
121 
122 /* Default height of the menu bar */
123 #define MENU_DEFAULT_HEIGHT 1		/* figure it out at runtime */
124 
125 /* Flags for gui_mch_outstr_nowrap() */
126 #define GUI_MON_WRAP_CURSOR	0x01	/* wrap cursor at end of line */
127 #define GUI_MON_INVERT		0x02	/* invert the characters */
128 #define GUI_MON_IS_CURSOR	0x04	/* drawing cursor */
129 #define GUI_MON_TRS_CURSOR	0x08	/* drawing transparent cursor */
130 #define GUI_MON_NOCLEAR		0x10	/* don't clear selection */
131 
132 /* Flags for gui_mch_draw_string() */
133 #define DRAW_TRANSP		0x01	/* draw with transparent bg */
134 #define DRAW_BOLD		0x02	/* draw bold text */
135 #define DRAW_UNDERL		0x04	/* draw underline text */
136 #define DRAW_UNDERC		0x08	/* draw undercurl text */
137 #if defined(FEAT_GUI_GTK)
138 # define DRAW_ITALIC		0x10	/* draw italic text */
139 #endif
140 #define DRAW_CURSOR		0x20	/* drawing block cursor (win32) */
141 #define DRAW_STRIKE		0x40	/* strikethrough */
142 
143 /* For our own tearoff menu item */
144 #define TEAR_STRING		"-->Detach"
145 #define TEAR_LEN		(9)	/* length of above string */
146 
147 /* for the toolbar */
148 #define TOOLBAR_BUTTON_HEIGHT	18
149 #define TOOLBAR_BUTTON_WIDTH	18
150 #define TOOLBAR_BORDER_HEIGHT	12  /* room above+below buttons for MSWindows */
151 
152 #ifdef FEAT_GUI_MSWIN
153 # define TABLINE_HEIGHT 22
154 #endif
155 #ifdef FEAT_GUI_MOTIF
156 # define TABLINE_HEIGHT 30
157 #endif
158 
159 #if defined(NO_CONSOLE) || defined(FEAT_GUI_GTK) || defined(FEAT_GUI_X11)
160 # define NO_CONSOLE_INPUT	/* use no_console_input() to check if there
161 				   is no console input possible */
162 #endif
163 
164 typedef struct GuiScrollbar
165 {
166     long	ident;		/* Unique identifier for each scrollbar */
167     win_T	*wp;		/* Scrollbar's window, NULL for bottom */
168     int		type;		/* one of SBAR_{LEFT,RIGHT,BOTTOM} */
169     long	value;		/* Represents top line number visible */
170 #ifdef FEAT_GUI_ATHENA
171     int		pixval;		/* pixel count of value */
172 #endif
173     long	size;		/* Size of scrollbar thumb */
174     long	max;		/* Number of lines in buffer */
175 
176     /* Values measured in characters: */
177     int		top;		/* Top of scroll bar (chars from row 0) */
178     int		height;		/* Current height of scroll bar in rows */
179     int		width;		/* Current width of scroll bar in cols */
180     int		status_height;	/* Height of status line */
181 #ifdef FEAT_GUI_X11
182     Widget	id;		/* Id of real scroll bar */
183 #endif
184 #ifdef FEAT_GUI_GTK
185     GtkWidget *id;		/* Id of real scroll bar */
186     unsigned long handler_id;   /* Id of "value_changed" signal handler */
187 #endif
188 
189 #ifdef FEAT_GUI_MSWIN
190     HWND	id;		/* Id of real scroll bar */
191     int		scroll_shift;	/* The scrollbar stuff can handle only up to
192 				   32767 lines.  When the file is longer,
193 				   scroll_shift is set to the number of shifts
194 				   to reduce the count.  */
195 #endif
196 #ifdef FEAT_GUI_MAC
197     ControlHandle id;		/* A handle to the scrollbar */
198 #endif
199 #ifdef FEAT_GUI_PHOTON
200     PtWidget_t	*id;
201 #endif
202 } scrollbar_T;
203 
204 typedef long	    guicolor_T;	/* handle for a GUI color; for X11 this should
205 				   be "Pixel", but that's an unsigned and we
206 				   need a signed value */
207 #define INVALCOLOR (guicolor_T)-11111	/* number for invalid color; on 32 bit
208 				   displays there is a tiny chance this is an
209 				   actual color */
210 #define CTERMCOLOR (guicolor_T)-11110	/* only used for cterm.bg_rgb and
211 					   cterm.fg_rgb: use cterm color */
212 
213 #ifdef FEAT_GUI_GTK
214   typedef PangoFontDescription	*GuiFont;       /* handle for a GUI font */
215   typedef PangoFontDescription  *GuiFontset;    /* handle for a GUI fontset */
216 # define NOFONT		(GuiFont)NULL
217 # define NOFONTSET	(GuiFontset)NULL
218 #else
219 # ifdef FEAT_GUI_PHOTON
220   typedef char		*GuiFont;
221   typedef char		*GuiFontset;
222 #  define NOFONT	(GuiFont)NULL
223 #  define NOFONTSET	(GuiFontset)NULL
224 # else
225 #  ifdef FEAT_GUI_X11
226   typedef XFontStruct	*GuiFont;	/* handle for a GUI font */
227   typedef XFontSet	GuiFontset;	/* handle for a GUI fontset */
228 #   define NOFONT	(GuiFont)0
229 #   define NOFONTSET	(GuiFontset)0
230 #  else
231   typedef long_u	GuiFont;	/* handle for a GUI font */
232   typedef long_u	GuiFontset;	/* handle for a GUI fontset */
233 #   define NOFONT	(GuiFont)0
234 #   define NOFONTSET	(GuiFontset)0
235 #  endif
236 # endif
237 #endif
238 
239 typedef struct Gui
240 {
241     int		in_focus;	    /* Vim has input focus */
242     int		in_use;		    /* Is the GUI being used? */
243     int		starting;	    /* GUI will start in a little while */
244     int		shell_created;	    /* Has the shell been created yet? */
245     int		dying;		    /* Is vim dying? Then output to terminal */
246     int		dofork;		    /* Use fork() when GUI is starting */
247     int		dragged_sb;	    /* Which scrollbar being dragged, if any? */
248     win_T	*dragged_wp;	    /* Which WIN's sb being dragged, if any? */
249     int		pointer_hidden;	    /* Is the mouse pointer hidden? */
250     int		col;		    /* Current cursor column in GUI display */
251     int		row;		    /* Current cursor row in GUI display */
252     int		cursor_col;	    /* Physical cursor column in GUI display */
253     int		cursor_row;	    /* Physical cursor row in GUI display */
254     char	cursor_is_valid;    /* There is a cursor at cursor_row/col */
255     int		num_cols;	    /* Number of columns */
256     int		num_rows;	    /* Number of rows */
257     int		scroll_region_top;  /* Top (first) line of scroll region */
258     int		scroll_region_bot;  /* Bottom (last) line of scroll region */
259     int		scroll_region_left;  /* Left (first) column of scroll region */
260     int		scroll_region_right;  /* Right (last) col. of scroll region */
261     int		highlight_mask;	    /* Highlight attribute mask */
262     int		scrollbar_width;    /* Width of vertical scrollbars */
263     int		scrollbar_height;   /* Height of horizontal scrollbar */
264     int		left_sbar_x;	    /* Calculated x coord for left scrollbar */
265     int		right_sbar_x;	    /* Calculated x coord for right scrollbar */
266 
267 #ifdef FEAT_MENU
268 # ifndef FEAT_GUI_GTK
269     int		menu_height;	    /* Height of the menu bar */
270     int		menu_width;	    /* Width of the menu bar */
271 # endif
272     char	menu_is_active;	    /* TRUE if menu is present */
273 # ifdef FEAT_GUI_ATHENA
274     char	menu_height_fixed;  /* TRUE if menu height fixed */
275 # endif
276 #endif
277 
278     scrollbar_T bottom_sbar;	    /* Bottom scrollbar */
279     int		which_scrollbars[3];/* Which scrollbar boxes are active? */
280     int		prev_wrap;	    /* For updating the horizontal scrollbar */
281     int		char_width;	    /* Width of char cell in pixels */
282     int		char_height;	    /* Height of char cell in pixels, includes
283 				       'linespace' */
284     int		char_ascent;	    /* Ascent of char in pixels */
285     int		border_width;	    /* Width of our border around text area */
286     int		border_offset;	    /* Total pixel offset for all borders */
287 
288     GuiFont	norm_font;	    /* Normal font */
289 #ifndef FEAT_GUI_GTK
290     GuiFont	bold_font;	    /* Bold font */
291     GuiFont	ital_font;	    /* Italic font */
292     GuiFont	boldital_font;	    /* Bold-Italic font */
293 #else
294     int		font_can_bold;	    /* Whether norm_font supports bold weight.
295 				     * The styled font variants are not used. */
296 #endif
297 
298 #if defined(FEAT_MENU) && !defined(FEAT_GUI_GTK)
299 # ifdef FONTSET_ALWAYS
300     GuiFontset	menu_fontset;	    /* set of fonts for multi-byte chars */
301 # else
302     GuiFont	menu_font;	    /* menu item font */
303 # endif
304 #endif
305 #ifdef FEAT_MBYTE
306     GuiFont	wide_font;	    /* Normal 'guifontwide' font */
307 # ifndef FEAT_GUI_GTK
308     GuiFont	wide_bold_font;	    /* Bold 'guifontwide' font */
309     GuiFont	wide_ital_font;	    /* Italic 'guifontwide' font */
310     GuiFont	wide_boldital_font; /* Bold-Italic 'guifontwide' font */
311 # endif
312 #endif
313 #ifdef FEAT_XFONTSET
314     GuiFontset	fontset;	    /* set of fonts for multi-byte chars */
315 #endif
316     guicolor_T	back_pixel;	    /* Color of background */
317     guicolor_T	norm_pixel;	    /* Color of normal text */
318     guicolor_T	def_back_pixel;	    /* default Color of background */
319     guicolor_T	def_norm_pixel;	    /* default Color of normal text */
320 
321 #ifdef FEAT_GUI_X11
322     char	*rsrc_menu_fg_name;	/* Color of menu & dialog foreground */
323     guicolor_T	menu_fg_pixel;		/* Same in Pixel format */
324     char	*rsrc_menu_bg_name;	/* Color of menu & dialog background */
325     guicolor_T	menu_bg_pixel;		/* Same in Pixel format */
326     char	*rsrc_scroll_fg_name;	/* Color of scrollbar foreground */
327     guicolor_T	scroll_fg_pixel;	/* Same in Pixel format */
328     char	*rsrc_scroll_bg_name;	/* Color of scrollbar background */
329     guicolor_T	scroll_bg_pixel;	/* Same in Pixel format */
330 
331 # ifdef FEAT_GUI_MOTIF
332     guicolor_T	menu_def_fg_pixel;  /* Default menu foreground */
333     guicolor_T	menu_def_bg_pixel;  /* Default menu background */
334     guicolor_T	scroll_def_fg_pixel;  /* Default scrollbar foreground */
335     guicolor_T	scroll_def_bg_pixel;  /* Default scrollbar background */
336 # endif
337     Display	*dpy;		    /* X display */
338     Window	wid;		    /* Window id of text area */
339     int		visibility;	    /* Is shell partially/fully obscured? */
340     GC		text_gc;
341     GC		back_gc;
342     GC		invert_gc;
343     Cursor	blank_pointer;	    /* Blank pointer */
344 
345     /* X Resources */
346     char_u	*rsrc_font_name;    /* Resource font name, used if 'guifont'
347 				       not set */
348     char_u	*rsrc_bold_font_name; /* Resource bold font name */
349     char_u	*rsrc_ital_font_name; /* Resource italic font name */
350     char_u	*rsrc_boldital_font_name;  /* Resource bold-italic font name */
351     char_u	*rsrc_menu_font_name;    /* Resource menu Font name */
352     Bool	rsrc_rev_video;	    /* Use reverse video? */
353 
354     char_u	*geom;		    /* Geometry, eg "80x24" */
355     Bool	color_approx;	    /* Some color was approximated */
356 #endif
357 
358 #ifdef FEAT_GUI_GTK
359 # ifndef USE_GTK3
360     int		visibility;	    /* Is shell partially/fully obscured? */
361 # endif
362     GdkCursor	*blank_pointer;	    /* Blank pointer */
363 
364     /* X Resources */
365     char_u	*geom;		    /* Geometry, eg "80x24" */
366 
367     GtkWidget	*mainwin;	    /* top level GTK window */
368     GtkWidget	*formwin;	    /* manages all the windows below */
369     GtkWidget	*drawarea;	    /* the "text" area */
370 # ifdef FEAT_MENU
371     GtkWidget	*menubar;	    /* menubar */
372 # endif
373 # ifdef FEAT_TOOLBAR
374     GtkWidget	*toolbar;	    /* toolbar */
375 # endif
376 # ifdef FEAT_GUI_GNOME
377     GtkWidget	*menubar_h;	    /* menubar handle */
378     GtkWidget	*toolbar_h;	    /* toolbar handle */
379 # endif
380 # ifdef USE_GTK3
381     GdkRGBA	*fgcolor;	    /* GDK-styled foreground color */
382     GdkRGBA	*bgcolor;	    /* GDK-styled background color */
383     GdkRGBA	*spcolor;	    /* GDK-styled special color */
384 # else
385     GdkColor	*fgcolor;	    /* GDK-styled foreground color */
386     GdkColor	*bgcolor;	    /* GDK-styled background color */
387     GdkColor	*spcolor;	    /* GDK-styled special color */
388 # endif
389 # ifdef USE_GTK3
390     cairo_surface_t *surface;       /* drawarea surface */
391     gboolean	     by_signal;     /* cause of draw operation */
392 # else
393     GdkGC	*text_gc;	    /* cached GC for normal text */
394 # endif
395     PangoContext     *text_context; /* the context used for all text */
396     PangoFont	     *ascii_font;   /* cached font for ASCII strings */
397     PangoGlyphString *ascii_glyphs; /* cached code point -> glyph map */
398 # ifdef FEAT_GUI_TABLINE
399     GtkWidget	*tabline;	    /* tab pages line handle */
400 # endif
401 
402     GtkAccelGroup *accel_group;
403     GtkWidget	*filedlg;	    /* file selection dialog */
404     char_u	*browse_fname;	    /* file name from filedlg */
405 
406     guint32	event_time;
407 #endif	/* FEAT_GUI_GTK */
408 
409 #if defined(FEAT_GUI_TABLINE) \
410 	&& (defined(FEAT_GUI_W32) || defined(FEAT_GUI_MOTIF) \
411 		|| defined(FEAT_GUI_MAC))
412     int		tabline_height;
413 #endif
414 
415 #ifdef FEAT_FOOTER
416     int		footer_height;	    /* height of the message footer */
417 #endif
418 
419 #if defined(FEAT_TOOLBAR) \
420 	&& (defined(FEAT_GUI_ATHENA) || defined(FEAT_GUI_MOTIF))
421     int		toolbar_height;	    /* height of the toolbar */
422 #endif
423 
424 #ifdef FEAT_BEVAL_TIP
425     /* Tooltip properties; also used for balloon evaluation */
426     char_u	*rsrc_tooltip_font_name; /* tooltip font name */
427     char	*rsrc_tooltip_fg_name;	/* tooltip foreground color name */
428     char	*rsrc_tooltip_bg_name;	/* tooltip background color name */
429     guicolor_T	tooltip_fg_pixel;	/* tooltip foreground color */
430     guicolor_T	tooltip_bg_pixel;	/* tooltip background color */
431     XFontSet	tooltip_fontset;	/* tooltip fontset */
432 #endif
433 
434 #ifdef FEAT_GUI_MSWIN
435     GuiFont	currFont;	    /* Current font */
436     guicolor_T	currFgColor;	    /* Current foreground text color */
437     guicolor_T	currBgColor;	    /* Current background text color */
438     guicolor_T	currSpColor;	    /* Current special text color */
439 #endif
440 
441 #ifdef FEAT_GUI_MAC
442     WindowPtr	VimWindow;
443     MenuHandle	MacOSHelpMenu;	    /* Help menu provided by the MacOS */
444     int		MacOSHelpItems;	    /* Nr of help-items supplied by MacOS */
445     WindowPtr	wid;		    /* Window id of text area */
446     int		visibility;	    /* Is window partially/fully obscured? */
447 #endif
448 
449 #ifdef FEAT_GUI_PHOTON
450     PtWidget_t	*vimWindow;		/* PtWindow */
451     PtWidget_t	*vimTextArea;		/* PtRaw */
452     PtWidget_t	*vimContainer;		/* PtPanel */
453 # if defined(FEAT_MENU) || defined(FEAT_TOOLBAR)
454     PtWidget_t	*vimToolBarGroup;
455 # endif
456 # ifdef FEAT_MENU
457     PtWidget_t	*vimMenuBar;
458 # endif
459 # ifdef FEAT_TOOLBAR
460     PtWidget_t	*vimToolBar;
461     int		toolbar_height;
462 # endif
463     PhEvent_t	*event_buffer;
464 #endif
465 
466 #ifdef FEAT_XIM
467     char	*rsrc_input_method;
468     char	*rsrc_preedit_type_name;
469 #endif
470 } gui_T;
471 
472 extern gui_T gui;			/* this is defined in gui.c */
473 
474 /* definitions of available window positionings for gui_*_position_in_parent()
475  */
476 typedef enum
477 {
478     VW_POS_MOUSE,
479     VW_POS_CENTER,
480     VW_POS_TOP_CENTER
481 } gui_win_pos_T;
482 
483 #ifdef FIND_REPLACE_DIALOG
484 /*
485  * Flags used to distinguish the different contexts in which the
486  * find/replace callback may be called.
487  */
488 # define FRD_FINDNEXT	1	/* Find next in find dialog */
489 # define FRD_R_FINDNEXT	2	/* Find next in repl dialog */
490 # define FRD_REPLACE	3	/* Replace once */
491 # define FRD_REPLACEALL	4	/* Replace remaining matches */
492 # define FRD_UNDO	5	/* Undo replaced text */
493 # define FRD_TYPE_MASK   7	/* Mask for the callback type */
494 /* Flags which change the way searching is done. */
495 # define FRD_WHOLE_WORD	0x08	/* match whole word only */
496 # define FRD_MATCH_CASE	0x10	/* match case */
497 #endif
498 
499 #ifdef FEAT_GUI_GTK
500 /*
501  * Convenience macros to convert from 'encoding' to 'termencoding' and
502  * vice versa.	If no conversion is necessary the passed-in pointer is
503  * returned as is, without allocating any memory.  Thus additional _FREE()
504  * macros are provided.  The _FREE() macros also set the pointer to NULL,
505  * in order to avoid bugs due to illegal memory access only happening if
506  * 'encoding' != utf-8...
507  *
508  * Defining these macros as pure expressions looks a bit tricky but
509  * avoids depending on the context of the macro expansion.  One of the
510  * rare occasions where the comma operator comes in handy :)
511  *
512  * Note: Do NOT keep the result around when handling control back to
513  * the main Vim!  The user could change 'encoding' at any time.
514  */
515 # define CONVERT_TO_UTF8(String)				\
516     ((output_conv.vc_type == CONV_NONE || (String) == NULL)	\
517 	    ? (String)						\
518 	    : string_convert(&output_conv, (String), NULL))
519 
520 # define CONVERT_TO_UTF8_FREE(String)				\
521     ((String) = ((output_conv.vc_type == CONV_NONE)		\
522 			? (char_u *)NULL			\
523 			: (vim_free(String), (char_u *)NULL)))
524 
525 # define CONVERT_FROM_UTF8(String)				\
526     ((input_conv.vc_type == CONV_NONE || (String) == NULL)	\
527 	    ? (String)						\
528 	    : string_convert(&input_conv, (String), NULL))
529 
530 # define CONVERT_FROM_UTF8_FREE(String)				\
531     ((String) = ((input_conv.vc_type == CONV_NONE)		\
532 			? (char_u *)NULL			\
533 			: (vim_free(String), (char_u *)NULL)))
534 
535 #else
536 # define CONVERT_TO_UTF8(String) (String)
537 # define CONVERT_TO_UTF8_FREE(String) ((String) = (char_u *)NULL)
538 # define CONVERT_FROM_UTF8(String) (String)
539 # define CONVERT_FROM_UTF8_FREE(String) ((String) = (char_u *)NULL)
540 #endif /* FEAT_GUI_GTK */
541 
542 #ifdef FEAT_GUI_GTK
543 /*
544  * The second parameter of g_signal_handlers_disconnect_by_func() is supposed
545  * to be a function pointer which was passed to g_signal_connect_*() somewhere
546  * previously, and hence it must be of type GCallback, i.e., void (*)(void).
547  *
548  * Meanwhile, g_signal_handlers_disconnect_by_func() is a macro calling
549  * g_signal_handlers_disconnect_matched(), and the second parameter of the
550  * former is to be passed to the sixth parameter of the latter the type of
551  * which, however, is declared as void * in the function signature.
552  *
553  * While the ISO C Standard does not require that function pointers be
554  * interconvertible to void *, widely-used compilers such as gcc and clang
555  * do such conversion implicitly and automatically on some platforms without
556  * issuing any warning.
557  *
558  * For Solaris Studio, that is not the case.  An explicit type cast is needed
559  * to suppress warnings on that particular conversion.
560  */
561 # if defined(__SUNPRO_C) && defined(USE_GTK3)
562 #  define FUNC2GENERIC(func) (void *)(func)
563 # else
564 #  define FUNC2GENERIC(func) G_CALLBACK(func)
565 # endif
566 #endif /* FEAT_GUI_GTK */
567