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 */
40 #include "redisplay.h"
43 Lisp_Object Qmenu_no_selection_hook;
45 /* we need a unique id for each popup menu, dialog box, and scrollbar */
46 static unsigned int lwlib_id_tick;
51 return ++lwlib_id_tick;
55 xmalloc_widget_value (void)
57 widget_value *tmp = malloc_widget_value ();
58 if (!tmp) memory_full ();
64 mark_widget_value_mapper (widget_value *val, void *closure)
69 VOID_TO_LISP (markee, val->call_data);
75 VOID_TO_LISP (markee, val->accel);
82 mark_popup_data (Lisp_Object obj)
84 struct popup_data *data = (struct popup_data *) XPOPUP_DATA (obj);
86 /* Now mark the callbacks and such that are hidden in the lwlib
90 lw_map_widget_values (data->id, mark_widget_value_mapper, 0);
92 return data->last_menubar_buffer;
95 DEFINE_LRECORD_IMPLEMENTATION ("popup-data", popup_data,
96 mark_popup_data, internal_object_printer,
97 0, 0, 0, 0, struct popup_data);
99 /* This is like FRAME_MENUBAR_DATA (f), but contains an alist of
100 (id . popup-data) for GCPRO'ing the callbacks of the popup menus
102 static Lisp_Object Vpopup_callbacks;
105 gcpro_popup_callbacks (LWLIB_ID id)
107 struct popup_data *pdata;
108 Lisp_Object lid = make_int (id);
111 assert (NILP (assq_no_quit (lid, Vpopup_callbacks)));
112 pdata = alloc_lcrecord_type (struct popup_data, &lrecord_popup_data);
114 pdata->last_menubar_buffer = Qnil;
115 pdata->menubar_contents_up_to_date = 0;
116 XSETPOPUP_DATA (lpdata, pdata);
117 Vpopup_callbacks = Fcons (Fcons (lid, lpdata), Vpopup_callbacks);
121 ungcpro_popup_callbacks (LWLIB_ID id)
123 Lisp_Object lid = make_int (id);
124 Lisp_Object this = assq_no_quit (lid, Vpopup_callbacks);
125 assert (!NILP (this));
126 Vpopup_callbacks = delq_no_quit (this, Vpopup_callbacks);
130 popup_handled_p (LWLIB_ID id)
132 return NILP (assq_no_quit (make_int (id), Vpopup_callbacks));
135 /* menu_item_descriptor_to_widget_value() et al. mallocs a
136 widget_value, but then may signal lisp errors. If an error does
137 not occur, the opaque ptr we have here has had its pointer set to 0
138 to tell us not to do anything. Otherwise we free the widget value.
139 (This has nothing to do with GC, it's just about not dropping
140 pointers to malloc'd data when errors happen.) */
143 widget_value_unwind (Lisp_Object closure)
145 widget_value *wv = (widget_value *) get_opaque_ptr (closure);
146 free_opaque_ptr (closure);
148 free_widget_value_tree (wv);
154 print_widget_value (widget_value *wv, int depth)
156 /* !!#### This function has not been Mule-ized */
159 for (i = 0; i < depth; i++) d[i] = ' ';
161 /* #### - print type field */
162 printf ("%sname: %s\n", d, (wv->name ? wv->name : "(null)"));
163 if (wv->value) printf ("%svalue: %s\n", d, wv->value);
164 if (wv->key) printf ("%skey: %s\n", d, wv->key);
165 printf ("%senabled: %d\n", d, wv->enabled);
168 printf ("\n%scontents: \n", d);
169 print_widget_value (wv->contents, depth + 5);
174 print_widget_value (wv->next, depth);
179 /* This recursively calls free_widget_value() on the tree of widgets.
180 It must free all data that was malloc'ed for these widget_values.
182 It used to be that emacs only allocated new storage for the `key' slot.
183 All other slots are pointers into the data of Lisp_Strings, and must be
186 free_popup_widget_value_tree (widget_value *wv)
189 if (wv->key) xfree (wv->key);
190 if (wv->value) xfree (wv->value);
191 if (wv->name) xfree (wv->name);
193 wv->name = wv->value = wv->key = (char *) 0xDEADBEEF;
195 if (wv->contents && (wv->contents != (widget_value*)1))
197 free_popup_widget_value_tree (wv->contents);
198 wv->contents = (widget_value *) 0xDEADBEEF;
202 free_popup_widget_value_tree (wv->next);
203 wv->next = (widget_value *) 0xDEADBEEF;
205 free_widget_value (wv);
208 /* The following is actually called from somewhere within XtDispatchEvent(),
209 called from XtAppProcessEvent() in event-Xt.c */
212 popup_selection_callback (Widget widget, LWLIB_ID ignored_id,
213 XtPointer client_data)
215 Lisp_Object data, image_instance, callback, callback_ex;
216 Lisp_Object frame, event;
217 int update_subwindows_p = 0;
218 struct device *d = get_device_from_display (XtDisplay (widget));
219 struct frame *f = x_any_widget_or_parent_to_frame (d, widget);
221 /* set in lwlib to the time stamp associated with the most recent menu
223 extern Time x_focus_timestamp_really_sucks_fix_me_better;
227 if (((EMACS_INT) client_data) == 0)
229 VOID_TO_LISP (data, client_data);
230 XSETFRAME (frame, f);
233 /* #### What the hell? I can't understand why this call is here,
234 and doing it is really courting disaster in the new event
235 model, since popup_selection_callback is called from
236 within next_event_internal() and Faccept_process_output()
237 itself calls next_event_internal(). --Ben */
239 /* Flush the X and process input */
240 Faccept_process_output (Qnil, Qnil, Qnil);
243 if (((EMACS_INT) client_data) == -1)
245 event = Fmake_event (Qnil, Qnil);
247 XEVENT (event)->event_type = misc_user_event;
248 XEVENT (event)->channel = frame;
249 XEVENT (event)->event.eval.function = Qrun_hooks;
250 XEVENT (event)->event.eval.object = Qmenu_no_selection_hook;
254 image_instance = XCAR (data);
255 callback = XCAR (XCDR (data));
256 callback_ex = XCDR (XCDR (data));
257 update_subwindows_p = 1;
259 if (!NILP (callback_ex) && !UNBOUNDP (callback_ex))
261 event = Fmake_event (Qnil, Qnil);
263 XEVENT (event)->event_type = misc_user_event;
264 XEVENT (event)->channel = frame;
265 XEVENT (event)->event.eval.function = Qeval;
266 XEVENT (event)->event.eval.object =
267 list4 (Qfuncall, callback_ex, image_instance, event);
269 else if (NILP (callback) || UNBOUNDP (callback))
275 event = Fmake_event (Qnil, Qnil);
277 get_gui_callback (callback, &fn, &arg);
278 XEVENT (event)->event_type = misc_user_event;
279 XEVENT (event)->channel = frame;
280 XEVENT (event)->event.eval.function = fn;
281 XEVENT (event)->event.eval.object = arg;
285 /* This is the timestamp used for asserting focus so we need to get an
286 up-to-date value event if no events has been dispatched to emacs
288 #if defined(HAVE_MENUBARS)
289 DEVICE_X_MOUSE_TIMESTAMP (d) = x_focus_timestamp_really_sucks_fix_me_better;
291 DEVICE_X_MOUSE_TIMESTAMP (d) = DEVICE_X_GLOBAL_MOUSE_TIMESTAMP (d);
294 enqueue_Xt_dispatch_event (event);
295 /* The result of this evaluation could cause other instances to change so
296 enqueue an update callback to check this. */
297 if (update_subwindows_p && !NILP (event))
298 enqueue_magic_eval_event (update_widget_instances, frame);
302 /* Eval the activep slot of the menu item */
303 # define wv_set_evalable_slot(slot,form) do { \
304 Lisp_Object wses_form = (form); \
305 (slot) = (NILP (wses_form) ? 0 : \
306 EQ (wses_form, Qt) ? 1 : \
307 !NILP (Feval (wses_form))); \
310 /* Treat the activep slot of the menu item as a boolean */
311 # define wv_set_evalable_slot(slot,form) \
312 ((void) (slot = (!NILP (form))))
316 menu_separator_style (const char *s)
321 if (!s || s[0] == '\0')
324 if (first != '-' && first != '=')
326 for (p = s; *p == first; p++)
329 /* #### - cannot currently specify a separator tag "--!tag" and a
330 separator style "--:style" at the same time. */
331 /* #### - Also, the motif menubar code doesn't deal with the
332 double etched style yet, so it's not good to get into the habit of
333 using "===" in menubars to get double-etched lines */
334 if (*p == '!' || *p == '\0')
335 return ((first == '-')
336 ? NULL /* single etched is the default */
337 : xstrdup ("shadowDoubleEtchedIn"));
339 return xstrdup (p+1);
345 strdup_and_add_accel (char *name)
350 for (i=0; name[i]; ++i)
351 if (name[i] == '%' && name[i+1] == '_')
358 return xstrdup (name);
361 char *chars = (char *) alloca (strlen (name) + 3);
364 memcpy (chars+2, name, strlen (name) + 1);
365 return xstrdup (chars);
369 /* This does the dirty work. gc_currently_forbidden is 1 when this is called.
372 button_item_to_widget_value (Lisp_Object gui_object_instance,
373 Lisp_Object gui_item, widget_value *wv,
374 int allow_text_field_p, int no_keys_p,
377 /* !!#### This function has not been Mule-ized */
378 /* This function cannot GC because gc_currently_forbidden is set when
380 Lisp_Gui_Item* pgui = 0;
382 /* degenerate case */
383 if (STRINGP (gui_item))
385 wv->type = TEXT_TYPE;
386 wv->name = (char *) XSTRING_DATA (gui_item);
387 wv->name = strdup_and_add_accel (wv->name);
390 else if (!GUI_ITEMP (gui_item))
391 signal_simple_error("need a string or a gui_item here", gui_item);
393 pgui = XGUI_ITEM (gui_item);
395 if (!NILP (pgui->filter))
396 signal_simple_error(":filter keyword not permitted on leaf nodes", gui_item);
399 if (menu_entry_p && !gui_item_included_p (gui_item, Vmenubar_configuration))
401 /* the include specification says to ignore this item. */
404 #endif /* HAVE_MENUBARS */
406 if (!STRINGP (pgui->name))
407 pgui->name = Feval (pgui->name);
409 CHECK_STRING (pgui->name);
410 wv->name = (char *) XSTRING_DATA (pgui->name);
411 wv->name = xstrdup (wv->name);
412 wv->accel = LISP_TO_VOID (gui_item_accelerator (gui_item));
414 if (!NILP (pgui->suffix))
416 const char *const_bogosity;
419 /* Shortcut to avoid evaluating suffix each time */
420 if (STRINGP (pgui->suffix))
421 suffix2 = pgui->suffix;
424 suffix2 = Feval (pgui->suffix);
425 CHECK_STRING (suffix2);
428 TO_EXTERNAL_FORMAT (LISP_STRING, suffix2,
429 C_STRING_ALLOCA, const_bogosity,
431 wv->value = (char *) const_bogosity;
432 wv->value = xstrdup (wv->value);
435 wv_set_evalable_slot (wv->enabled, pgui->active);
436 wv_set_evalable_slot (wv->selected, pgui->selected);
438 if (!NILP (pgui->callback) || !NILP (pgui->callback_ex))
439 wv->call_data = LISP_TO_VOID (cons3 (gui_object_instance,
445 || (menu_entry_p && !menubar_show_keybindings)
449 else if (!NILP (pgui->keys)) /* Use this string to generate key bindings */
451 CHECK_STRING (pgui->keys);
452 pgui->keys = Fsubstitute_command_keys (pgui->keys);
453 if (XSTRING_LENGTH (pgui->keys) > 0)
454 wv->key = xstrdup ((char *) XSTRING_DATA (pgui->keys));
458 else if (SYMBOLP (pgui->callback)) /* Show the binding of this command. */
460 char buf[1024]; /* #### */
461 /* #### Warning, dependency here on current_buffer and point */
462 where_is_to_char (pgui->callback, buf);
464 wv->key = xstrdup (buf);
469 CHECK_SYMBOL (pgui->style);
470 if (NILP (pgui->style))
472 /* If the callback is nil, treat this item like unselectable text.
473 This way, dashes will show up as a separator. */
475 wv->type = BUTTON_TYPE;
476 if (separator_string_p (wv->name))
478 wv->type = SEPARATOR_TYPE;
479 wv->value = menu_separator_style (wv->name);
484 /* #### - this is generally desirable for menubars, but it breaks
485 a package that uses dialog boxes and next_command_event magic
486 to use the callback slot in dialog buttons for data instead of
489 Code is data, right? The beauty of LISP abuse. --Stig */
491 wv->type = TEXT_TYPE;
494 wv->type = BUTTON_TYPE;
497 else if (EQ (pgui->style, Qbutton))
498 wv->type = BUTTON_TYPE;
499 else if (EQ (pgui->style, Qtoggle))
500 wv->type = TOGGLE_TYPE;
501 else if (EQ (pgui->style, Qradio))
502 wv->type = RADIO_TYPE;
503 else if (EQ (pgui->style, Qtext))
505 wv->type = TEXT_TYPE;
507 wv->value = wv->name;
512 signal_simple_error_2 ("Unknown style", pgui->style, gui_item);
514 if (!allow_text_field_p && (wv->type == TEXT_TYPE))
515 signal_simple_error ("Text field not allowed in this context", gui_item);
517 if (!NILP (pgui->selected) && EQ (pgui->style, Qtext))
518 signal_simple_error (
519 ":selected only makes sense with :style toggle, radio or button",
524 /* parse tree's of gui items into widget_value hierarchies */
525 static void gui_item_children_to_widget_values (Lisp_Object gui_object_instance,
527 widget_value* parent);
529 static widget_value *
530 gui_items_to_widget_values_1 (Lisp_Object gui_object_instance,
531 Lisp_Object items, widget_value* parent,
534 widget_value* wv = 0;
536 assert ((parent || prev) && !(parent && prev));
537 /* now walk the tree creating widget_values as appropriate */
540 wv = xmalloc_widget_value();
542 parent->contents = wv;
545 if (!button_item_to_widget_value (gui_object_instance,
548 free_widget_value_tree (wv);
550 parent->contents = 0;
556 wv->value = xstrdup (wv->name); /* what a mess... */
561 /* first one is the parent */
562 if (CONSP (XCAR (items)))
563 signal_simple_error ("parent item must not be a list", XCAR (items));
566 wv = gui_items_to_widget_values_1 (gui_object_instance,
567 XCAR (items), parent, 0);
569 wv = gui_items_to_widget_values_1 (gui_object_instance,
570 XCAR (items), 0, prev);
571 /* the rest are the children */
572 gui_item_children_to_widget_values (gui_object_instance,
579 gui_item_children_to_widget_values (Lisp_Object gui_object_instance,
580 Lisp_Object items, widget_value* parent)
582 widget_value* wv = 0, *prev = 0;
586 /* first one is master */
587 prev = gui_items_to_widget_values_1 (gui_object_instance, XCAR (items),
589 /* the rest are the children */
590 LIST_LOOP (rest, XCDR (items))
592 Lisp_Object tab = XCAR (rest);
593 wv = gui_items_to_widget_values_1 (gui_object_instance, tab, 0, prev);
599 gui_items_to_widget_values (Lisp_Object gui_object_instance, Lisp_Object items)
601 /* !!#### This function has not been Mule-ized */
602 /* This function can GC */
603 widget_value *control = 0, *tmp = 0;
604 int count = specpdl_depth ();
605 Lisp_Object wv_closure;
608 signal_simple_error ("must have some items", items);
610 /* Inhibit GC during this conversion. The reasons for this are
611 the same as in menu_item_descriptor_to_widget_value(); see
612 the large comment above that function. */
613 record_unwind_protect (restore_gc_inhibit,
614 make_int (gc_currently_forbidden));
615 gc_currently_forbidden = 1;
617 /* Also make sure that we free the partially-created widget_value
618 tree on Lisp error. */
619 control = xmalloc_widget_value();
620 wv_closure = make_opaque_ptr (control);
621 record_unwind_protect (widget_value_unwind, wv_closure);
623 gui_items_to_widget_values_1 (gui_object_instance, items, control, 0);
625 /* mess about getting the data we really want */
627 control = control->contents;
630 free_widget_value_tree (tmp);
632 /* No more need to free the half-filled-in structures. */
633 set_opaque_ptr (wv_closure, 0);
634 unbind_to (count, Qnil);
639 /* This is a kludge to make sure emacs can only link against a version of
640 lwlib that was compiled in the right way. Emacs references symbols which
641 correspond to the way it thinks lwlib was compiled, and if lwlib wasn't
642 compiled in that way, then somewhat meaningful link errors will result.
643 The alternatives to this range from obscure link errors, to obscure
644 runtime errors that look a lot like bugs.
648 sanity_check_lwlib (void)
650 #define MACROLET(v) { extern int v; v = 1; }
652 #if (XlibSpecificationRelease == 4)
653 MACROLET (lwlib_uses_x11r4);
654 #elif (XlibSpecificationRelease == 5)
655 MACROLET (lwlib_uses_x11r5);
656 #elif (XlibSpecificationRelease == 6)
657 MACROLET (lwlib_uses_x11r6);
659 MACROLET (lwlib_uses_unknown_x11);
661 #ifdef LWLIB_USES_MOTIF
662 MACROLET (lwlib_uses_motif);
664 MACROLET (lwlib_does_not_use_motif);
666 #if (XmVersion >= 1002)
667 MACROLET (lwlib_uses_motif_1_2);
669 MACROLET (lwlib_does_not_use_motif_1_2);
671 #ifdef LWLIB_MENUBARS_LUCID
672 MACROLET (lwlib_menubars_lucid);
673 #elif defined (HAVE_MENUBARS)
674 MACROLET (lwlib_menubars_motif);
676 #ifdef LWLIB_SCROLLBARS_LUCID
677 MACROLET (lwlib_scrollbars_lucid);
678 #elif defined (LWLIB_SCROLLBARS_MOTIF)
679 MACROLET (lwlib_scrollbars_motif);
680 #elif defined (HAVE_SCROLLBARS)
681 MACROLET (lwlib_scrollbars_athena);
683 #ifdef LWLIB_DIALOGS_MOTIF
684 MACROLET (lwlib_dialogs_motif);
685 #elif defined (HAVE_DIALOGS)
686 MACROLET (lwlib_dialogs_athena);
688 #ifdef LWLIB_WIDGETS_MOTIF
689 MACROLET (lwlib_widgets_motif);
690 #elif defined (HAVE_WIDGETS)
691 MACROLET (lwlib_widgets_athena);
700 INIT_LRECORD_IMPLEMENTATION (popup_data);
702 defsymbol (&Qmenu_no_selection_hook, "menu-no-selection-hook");
706 reinit_vars_of_gui_x (void)
708 lwlib_id_tick = (1<<16); /* start big, to not conflict with Energize */
713 /* this makes only safe calls as in emacs.c */
714 sanity_check_lwlib ();
720 reinit_vars_of_gui_x ();
722 Vpopup_callbacks = Qnil;
723 staticpro (&Vpopup_callbacks);
726 /* This DEFVAR_LISP is just for the benefit of make-docfile. */
728 DEFVAR_LISP ("menu-no-selection-hook", &Vmenu_no_selection_hook /*
729 Function or functions to call when a menu or dialog box is dismissed
730 without a selection having been made.
733 Fset (Qmenu_no_selection_hook, Qnil);