1 /* General GUI code -- X-specific. (menubars, scrollbars, toolbars, dialogs)
2 Copyright (C) 1995 Board of Trustees, University of Illinois.
3 Copyright (C) 1995, 1996 Ben Wing.
4 Copyright (C) 1995 Sun Microsystems, Inc.
5 Copyright (C) 1998 Free Software Foundation, Inc.
7 This file is part of XEmacs.
9 XEmacs is free software; you can redistribute it and/or modify it
10 under the terms of the GNU General Public License as published by the
11 Free Software Foundation; either version 2, or (at your option) any
14 XEmacs is distributed in the hope that it will be useful, but WITHOUT
15 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
16 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19 You should have received a copy of the GNU General Public License
20 along with XEmacs; see the file COPYING. If not, write to
21 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 Boston, MA 02111-1307, USA. */
24 /* Synched up with: Not in FSF. */
29 #include "console-x.h"
30 #ifdef LWLIB_USES_MOTIF
31 #include <Xm/Xm.h> /* for XmVersion */
38 #include "redisplay.h"
41 Lisp_Object Qmenu_no_selection_hook;
43 /* we need a unique id for each popup menu, dialog box, and scrollbar */
44 static unsigned int lwlib_id_tick;
49 return ++lwlib_id_tick;
53 xmalloc_widget_value (void)
55 widget_value *tmp = malloc_widget_value ();
56 if (!tmp) memory_full ();
62 mark_widget_value_mapper (widget_value *val, void *closure)
67 VOID_TO_LISP (markee, val->call_data);
73 VOID_TO_LISP (markee, val->accel);
80 mark_popup_data (Lisp_Object obj)
82 struct popup_data *data = (struct popup_data *) XPOPUP_DATA (obj);
84 /* Now mark the callbacks and such that are hidden in the lwlib
88 lw_map_widget_values (data->id, mark_widget_value_mapper, 0);
90 return data->last_menubar_buffer;
93 DEFINE_LRECORD_IMPLEMENTATION ("popup-data", popup_data,
94 mark_popup_data, internal_object_printer,
95 0, 0, 0, 0, struct popup_data);
97 /* This is like FRAME_MENUBAR_DATA (f), but contains an alist of
98 (id . popup-data) for GCPRO'ing the callbacks of the popup menus
100 static Lisp_Object Vpopup_callbacks;
103 gcpro_popup_callbacks (LWLIB_ID id)
105 struct popup_data *pdata;
106 Lisp_Object lid = make_int (id);
109 assert (NILP (assq_no_quit (lid, Vpopup_callbacks)));
110 pdata = alloc_lcrecord_type (struct popup_data, &lrecord_popup_data);
112 pdata->last_menubar_buffer = Qnil;
113 pdata->menubar_contents_up_to_date = 0;
114 XSETPOPUP_DATA (lpdata, pdata);
115 Vpopup_callbacks = Fcons (Fcons (lid, lpdata), Vpopup_callbacks);
119 ungcpro_popup_callbacks (LWLIB_ID id)
121 Lisp_Object lid = make_int (id);
122 Lisp_Object this = assq_no_quit (lid, Vpopup_callbacks);
123 assert (!NILP (this));
124 Vpopup_callbacks = delq_no_quit (this, Vpopup_callbacks);
128 popup_handled_p (LWLIB_ID id)
130 return NILP (assq_no_quit (make_int (id), Vpopup_callbacks));
133 /* menu_item_descriptor_to_widget_value() et al. mallocs a
134 widget_value, but then may signal lisp errors. If an error does
135 not occur, the opaque ptr we have here has had its pointer set to 0
136 to tell us not to do anything. Otherwise we free the widget value.
137 (This has nothing to do with GC, it's just about not dropping
138 pointers to malloc'd data when errors happen.) */
141 widget_value_unwind (Lisp_Object closure)
143 widget_value *wv = (widget_value *) get_opaque_ptr (closure);
144 free_opaque_ptr (closure);
146 free_widget_value (wv);
152 print_widget_value (widget_value *wv, int depth)
154 /* !!#### This function has not been Mule-ized */
157 for (i = 0; i < depth; i++) d[i] = ' ';
159 /* #### - print type field */
160 printf ("%sname: %s\n", d, (wv->name ? wv->name : "(null)"));
161 if (wv->value) printf ("%svalue: %s\n", d, wv->value);
162 if (wv->key) printf ("%skey: %s\n", d, wv->key);
163 printf ("%senabled: %d\n", d, wv->enabled);
166 printf ("\n%scontents: \n", d);
167 print_widget_value (wv->contents, depth + 5);
172 print_widget_value (wv->next, depth);
177 /* This recursively calls free_widget_value() on the tree of widgets.
178 It must free all data that was malloc'ed for these widget_values.
180 It used to be that emacs only allocated new storage for the `key' slot.
181 All other slots are pointers into the data of Lisp_Strings, and must be
184 free_popup_widget_value_tree (widget_value *wv)
187 if (wv->key) xfree (wv->key);
188 if (wv->value) xfree (wv->value);
190 wv->name = wv->value = wv->key = (char *) 0xDEADBEEF;
192 if (wv->contents && (wv->contents != (widget_value*)1))
194 free_popup_widget_value_tree (wv->contents);
195 wv->contents = (widget_value *) 0xDEADBEEF;
199 free_popup_widget_value_tree (wv->next);
200 wv->next = (widget_value *) 0xDEADBEEF;
202 free_widget_value (wv);
205 /* The following is actually called from somewhere within XtDispatchEvent(),
206 called from XtAppProcessEvent() in event-Xt.c */
209 popup_selection_callback (Widget widget, LWLIB_ID ignored_id,
210 XtPointer client_data)
215 struct device *d = get_device_from_display (XtDisplay (widget));
216 struct frame *f = x_any_widget_or_parent_to_frame (d, widget);
218 /* set in lwlib to the time stamp associated with the most recent menu
220 extern Time x_focus_timestamp_really_sucks_fix_me_better;
224 if (((EMACS_INT) client_data) == 0)
226 VOID_TO_LISP (data, client_data);
227 XSETFRAME (frame, f);
230 /* #### What the hell? I can't understand why this call is here,
231 and doing it is really courting disaster in the new event
232 model, since popup_selection_callback is called from
233 within next_event_internal() and Faccept_process_output()
234 itself calls next_event_internal(). --Ben */
236 /* Flush the X and process input */
237 Faccept_process_output (Qnil, Qnil, Qnil);
240 if (((EMACS_INT) client_data) == -1)
243 arg = Qmenu_no_selection_hook;
247 MARK_SUBWINDOWS_STATE_CHANGED;
248 get_gui_callback (data, &fn, &arg);
251 /* This is the timestamp used for asserting focus so we need to get an
252 up-to-date value event if no events has been dispatched to emacs
254 #if defined(HAVE_MENUBARS)
255 DEVICE_X_MOUSE_TIMESTAMP (d) = x_focus_timestamp_really_sucks_fix_me_better;
257 DEVICE_X_MOUSE_TIMESTAMP (d) = DEVICE_X_GLOBAL_MOUSE_TIMESTAMP (d);
259 signal_special_Xt_user_event (frame, fn, arg);
263 /* Eval the activep slot of the menu item */
264 # define wv_set_evalable_slot(slot,form) do { \
265 Lisp_Object wses_form = (form); \
266 (slot) = (NILP (wses_form) ? 0 : \
267 EQ (wses_form, Qt) ? 1 : \
268 !NILP (Feval (wses_form))); \
271 /* Treat the activep slot of the menu item as a boolean */
272 # define wv_set_evalable_slot(slot,form) \
273 ((void) (slot = (!NILP (form))))
277 menu_separator_style (CONST char *s)
282 if (!s || s[0] == '\0')
285 if (first != '-' && first != '=')
287 for (p = s; *p == first; p++)
290 /* #### - cannot currently specify a separator tag "--!tag" and a
291 separator style "--:style" at the same time. */
292 /* #### - Also, the motif menubar code doesn't deal with the
293 double etched style yet, so it's not good to get into the habit of
294 using "===" in menubars to get double-etched lines */
295 if (*p == '!' || *p == '\0')
296 return ((first == '-')
297 ? NULL /* single etched is the default */
298 : xstrdup ("shadowDoubleEtchedIn"));
300 return xstrdup (p+1);
306 /* This does the dirty work. gc_currently_forbidden is 1 when this is called.
309 button_item_to_widget_value (Lisp_Object gui_item, widget_value *wv,
310 int allow_text_field_p, int no_keys_p)
312 /* !!#### This function has not been Mule-ized */
313 /* This function cannot GC because gc_currently_forbidden is set when
315 struct Lisp_Gui_Item* pgui = 0;
317 /* degenerate case */
318 if (STRINGP (gui_item))
320 wv->type = TEXT_TYPE;
321 wv->name = (char *) XSTRING_DATA (gui_item);
322 wv->name = xstrdup (wv->name);
325 else if (!GUI_ITEMP (gui_item))
326 signal_simple_error("need a string or a gui_item here", gui_item);
328 pgui = XGUI_ITEM (gui_item);
330 if (!NILP (pgui->filter))
331 signal_simple_error(":filter keyword not permitted on leaf nodes", gui_item);
334 if (!gui_item_included_p (gui_item, Vmenubar_configuration))
336 /* the include specification says to ignore this item. */
339 #endif /* HAVE_MENUBARS */
341 CHECK_STRING (pgui->name);
342 wv->name = (char *) XSTRING_DATA (pgui->name);
343 wv->name = xstrdup (wv->name);
344 wv->accel = LISP_TO_VOID (gui_item_accelerator (gui_item));
346 if (!NILP (pgui->suffix))
348 CONST char *const_bogosity;
351 /* Shortcut to avoid evaluating suffix each time */
352 if (STRINGP (pgui->suffix))
353 suffix2 = pgui->suffix;
356 suffix2 = Feval (pgui->suffix);
357 CHECK_STRING (suffix2);
360 GET_C_STRING_FILENAME_DATA_ALLOCA (suffix2, const_bogosity);
361 wv->value = (char *) const_bogosity;
362 wv->value = xstrdup (wv->value);
365 wv_set_evalable_slot (wv->enabled, pgui->active);
366 wv_set_evalable_slot (wv->selected, pgui->selected);
368 if (!NILP (pgui->callback))
369 wv->call_data = LISP_TO_VOID (pgui->callback);
373 || !menubar_show_keybindings
377 else if (!NILP (pgui->keys)) /* Use this string to generate key bindings */
379 CHECK_STRING (pgui->keys);
380 pgui->keys = Fsubstitute_command_keys (pgui->keys);
381 if (XSTRING_LENGTH (pgui->keys) > 0)
382 wv->key = xstrdup ((char *) XSTRING_DATA (pgui->keys));
386 else if (SYMBOLP (pgui->callback)) /* Show the binding of this command. */
389 /* #### Warning, dependency here on current_buffer and point */
390 where_is_to_char (pgui->callback, buf);
392 wv->key = xstrdup (buf);
397 CHECK_SYMBOL (pgui->style);
398 if (NILP (pgui->style))
400 /* If the callback is nil, treat this item like unselectable text.
401 This way, dashes will show up as a separator. */
403 wv->type = BUTTON_TYPE;
404 if (separator_string_p (wv->name))
406 wv->type = SEPARATOR_TYPE;
407 wv->value = menu_separator_style (wv->name);
412 /* #### - this is generally desirable for menubars, but it breaks
413 a package that uses dialog boxes and next_command_event magic
414 to use the callback slot in dialog buttons for data instead of
417 Code is data, right? The beauty of LISP abuse. --Stig */
419 wv->type = TEXT_TYPE;
422 wv->type = BUTTON_TYPE;
425 else if (EQ (pgui->style, Qbutton))
426 wv->type = BUTTON_TYPE;
427 else if (EQ (pgui->style, Qtoggle))
428 wv->type = TOGGLE_TYPE;
429 else if (EQ (pgui->style, Qradio))
430 wv->type = RADIO_TYPE;
431 else if (EQ (pgui->style, Qtext))
433 wv->type = TEXT_TYPE;
435 wv->value = wv->name;
440 signal_simple_error_2 ("Unknown style", pgui->style, gui_item);
442 if (!allow_text_field_p && (wv->type == TEXT_TYPE))
443 signal_simple_error ("Text field not allowed in this context", gui_item);
445 if (!NILP (pgui->selected) && EQ (pgui->style, Qtext))
446 signal_simple_error (
447 ":selected only makes sense with :style toggle, radio or button",
452 /* parse tree's of gui items into widget_value hierarchies */
453 static void gui_item_children_to_widget_values (Lisp_Object items, widget_value* parent);
455 static widget_value *
456 gui_items_to_widget_values_1 (Lisp_Object items, widget_value* parent,
459 widget_value* wv = 0;
461 assert ((parent || prev) && !(parent && prev));
462 /* now walk the tree creating widget_values as appropriate */
465 wv = xmalloc_widget_value();
467 parent->contents = wv;
470 if (!button_item_to_widget_value (items, wv, 0, 1))
472 free_widget_value (wv);
474 parent->contents = 0;
480 wv->value = xstrdup (wv->name); /* what a mess... */
485 /* first one is the parent */
486 if (CONSP (XCAR (items)))
487 signal_simple_error ("parent item must not be a list", XCAR (items));
490 wv = gui_items_to_widget_values_1 (XCAR (items), parent, 0);
492 wv = gui_items_to_widget_values_1 (XCAR (items), 0, prev);
493 /* the rest are the children */
494 gui_item_children_to_widget_values (XCDR (items), wv);
500 gui_item_children_to_widget_values (Lisp_Object items, widget_value* parent)
502 widget_value* wv = 0, *prev = 0;
506 /* first one is master */
507 prev = gui_items_to_widget_values_1 (XCAR (items), parent, 0);
508 /* the rest are the children */
509 LIST_LOOP (rest, XCDR (items))
511 Lisp_Object tab = XCAR (rest);
512 wv = gui_items_to_widget_values_1 (tab, 0, prev);
518 gui_items_to_widget_values (Lisp_Object items)
520 /* !!#### This function has not been Mule-ized */
521 /* This function can GC */
522 widget_value *control = 0, *tmp = 0;
523 int count = specpdl_depth ();
524 Lisp_Object wv_closure;
527 signal_simple_error ("must have some items", items);
529 /* Inhibit GC during this conversion. The reasons for this are
530 the same as in menu_item_descriptor_to_widget_value(); see
531 the large comment above that function. */
532 record_unwind_protect (restore_gc_inhibit,
533 make_int (gc_currently_forbidden));
534 gc_currently_forbidden = 1;
536 /* Also make sure that we free the partially-created widget_value
537 tree on Lisp error. */
538 control = xmalloc_widget_value();
539 wv_closure = make_opaque_ptr (control);
540 record_unwind_protect (widget_value_unwind, wv_closure);
542 gui_items_to_widget_values_1 (items, control, 0);
544 /* mess about getting the data we really want */
546 control = control->contents;
549 free_widget_value (tmp);
551 /* No more need to free the half-filled-in structures. */
552 set_opaque_ptr (wv_closure, 0);
553 unbind_to (count, Qnil);
558 /* This is a kludge to make sure emacs can only link against a version of
559 lwlib that was compiled in the right way. Emacs references symbols which
560 correspond to the way it thinks lwlib was compiled, and if lwlib wasn't
561 compiled in that way, then somewhat meaningful link errors will result.
562 The alternatives to this range from obscure link errors, to obscure
563 runtime errors that look a lot like bugs.
567 sanity_check_lwlib (void)
569 #define MACROLET(v) { extern int v; v = 1; }
571 #if (XlibSpecificationRelease == 4)
572 MACROLET (lwlib_uses_x11r4);
573 #elif (XlibSpecificationRelease == 5)
574 MACROLET (lwlib_uses_x11r5);
575 #elif (XlibSpecificationRelease == 6)
576 MACROLET (lwlib_uses_x11r6);
578 MACROLET (lwlib_uses_unknown_x11);
580 #ifdef LWLIB_USES_MOTIF
581 MACROLET (lwlib_uses_motif);
583 MACROLET (lwlib_does_not_use_motif);
585 #if (XmVersion >= 1002)
586 MACROLET (lwlib_uses_motif_1_2);
588 MACROLET (lwlib_does_not_use_motif_1_2);
590 #ifdef LWLIB_MENUBARS_LUCID
591 MACROLET (lwlib_menubars_lucid);
592 #elif defined (HAVE_MENUBARS)
593 MACROLET (lwlib_menubars_motif);
595 #ifdef LWLIB_SCROLLBARS_LUCID
596 MACROLET (lwlib_scrollbars_lucid);
597 #elif defined (LWLIB_SCROLLBARS_MOTIF)
598 MACROLET (lwlib_scrollbars_motif);
599 #elif defined (HAVE_SCROLLBARS)
600 MACROLET (lwlib_scrollbars_athena);
602 #ifdef LWLIB_DIALOGS_MOTIF
603 MACROLET (lwlib_dialogs_motif);
604 #elif defined (HAVE_DIALOGS)
605 MACROLET (lwlib_dialogs_athena);
607 #ifdef LWLIB_WIDGETS_MOTIF
608 MACROLET (lwlib_widgets_motif);
609 #elif defined (HAVE_WIDGETS)
610 MACROLET (lwlib_widgets_athena);
619 defsymbol (&Qmenu_no_selection_hook, "menu-no-selection-hook");
623 reinit_vars_of_gui_x (void)
625 lwlib_id_tick = (1<<16); /* start big, to not conflict with Energize */
630 /* this makes only safe calls as in emacs.c */
631 sanity_check_lwlib ();
637 reinit_vars_of_gui_x ();
639 Vpopup_callbacks = Qnil;
640 staticpro (&Vpopup_callbacks);
643 /* This DEFVAR_LISP is just for the benefit of make-docfile. */
645 DEFVAR_LISP ("menu-no-selection-hook", &Vmenu_no_selection_hook /*
646 Function or functions to call when a menu or dialog box is dismissed
647 without a selection having been made.
650 Fset (Qmenu_no_selection_hook, Qnil);