1 /* Generic GUI code. (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. */
32 Lisp_Object Q_active, Q_suffix, Q_keys, Q_style, Q_selected;
33 Lisp_Object Q_filter, Q_config, Q_included, Q_key_sequence;
34 Lisp_Object Q_accelerator, Q_label, Q_callback;
35 Lisp_Object Qtoggle, Qradio;
39 /* count of menus/dboxes currently up */
42 DEFUN ("popup-up-p", Fpopup_up_p, 0, 0, 0, /*
43 Return t if a popup menu or dialog box is up, nil otherwise.
44 See `popup-menu' and `popup-dialog-box'.
48 return popup_up_p ? Qt : Qnil;
50 #endif /* HAVE_POPUPS */
53 separator_string_p (CONST char *s)
58 if (!s || s[0] == '\0')
61 if (first != '-' && first != '=')
63 for (p = s; *p == first; p++)
66 return (*p == '!' || *p == ':' || *p == '\0');
69 /* Massage DATA to find the correct function and argument. Used by
70 popup_selection_callback() and the msw code. */
72 get_gui_callback (Lisp_Object data, Lisp_Object *fn, Lisp_Object *arg)
75 || (COMPILED_FUNCTIONP (data)
76 && XCOMPILED_FUNCTION (data)->flags.interactivep)
77 || (EQ (XCAR (data), Qlambda)
78 && !NILP (Fassq (Qinteractive, Fcdr (Fcdr (data))))))
80 *fn = Qcall_interactively;
83 else if (CONSP (data))
91 *arg = list3 (Qsignal,
92 list2 (Qquote, Qerror),
93 list2 (Qquote, list2 (build_translated_string
100 * Add a value VAL associated with keyword KEY into PGUI_ITEM
101 * structure. If KEY is not a keyword, or is an unknown keyword, then
105 gui_item_add_keyval_pair (Lisp_Object gui_item,
106 Lisp_Object key, Lisp_Object val,
109 struct Lisp_Gui_Item* pgui_item = XGUI_ITEM (gui_item);
112 signal_simple_error_2 ("Non-keyword in gui item", key, pgui_item->name);
114 if (EQ (key, Q_suffix)) pgui_item->suffix = val;
115 else if (EQ (key, Q_active)) pgui_item->active = val;
116 else if (EQ (key, Q_included)) pgui_item->included = val;
117 else if (EQ (key, Q_config)) pgui_item->config = val;
118 else if (EQ (key, Q_filter)) pgui_item->filter = val;
119 else if (EQ (key, Q_style)) pgui_item->style = val;
120 else if (EQ (key, Q_selected)) pgui_item->selected = val;
121 else if (EQ (key, Q_keys)) pgui_item->keys = val;
122 else if (EQ (key, Q_callback)) pgui_item->callback = val;
123 else if (EQ (key, Q_key_sequence)) ; /* ignored for FSF compatability */
124 else if (EQ (key, Q_label)) ; /* ignored for 21.0 implement in 21.2 */
125 else if (EQ (key, Q_accelerator))
127 if (SYMBOLP (val) || CHARP (val))
128 pgui_item->accelerator = val;
129 else if (ERRB_EQ (errb, ERROR_ME))
130 signal_simple_error ("Bad keyboard accelerator", val);
132 else if (ERRB_EQ (errb, ERROR_ME))
133 signal_simple_error_2 ("Unknown keyword in gui item", key, pgui_item->name);
137 gui_item_init (Lisp_Object gui_item)
139 struct Lisp_Gui_Item *lp = XGUI_ITEM (gui_item);
151 lp->accelerator = Qnil;
157 struct Lisp_Gui_Item *lp =
158 alloc_lcrecord_type (struct Lisp_Gui_Item, &lrecord_gui_item);
162 XSETGUI_ITEM (val, lp);
170 * ITEM is a lisp vector, describing a menu item or a button. The
171 * function extracts the description of the item into the PGUI_ITEM
175 make_gui_item_from_keywords_internal (Lisp_Object item,
178 int length, plist_p, start;
179 Lisp_Object *contents;
180 Lisp_Object gui_item = allocate_gui_item ();
181 struct Lisp_Gui_Item* pgui_item = XGUI_ITEM (gui_item);
184 length = XVECTOR_LENGTH (item);
185 contents = XVECTOR_DATA (item);
188 signal_simple_error ("GUI item descriptors must be at least 1 elts long", item);
190 /* length 1: [ "name" ]
191 length 2: [ "name" callback ]
192 length 3: [ "name" callback active-p ]
193 or [ "name" keyword value ]
194 length 4: [ "name" callback active-p suffix ]
195 or [ "name" callback keyword value ]
196 length 5+: [ "name" callback [ keyword value ]+ ]
197 or [ "name" [ keyword value ]+ ]
199 plist_p = (length > 2 && (KEYWORDP (contents [1])
200 || KEYWORDP (contents [2])));
202 pgui_item->name = contents [0];
203 if (length > 1 && !KEYWORDP (contents [1]))
205 pgui_item->callback = contents [1];
211 if (!plist_p && length > 2)
214 pgui_item->active = contents [2];
216 pgui_item->suffix = contents [3];
222 if ((length - start) & 1)
223 signal_simple_error (
224 "GUI item descriptor has an odd number of keywords and values",
227 for (i = start; i < length;)
229 Lisp_Object key = contents [i++];
230 Lisp_Object val = contents [i++];
231 gui_item_add_keyval_pair (gui_item, key, val, errb);
238 gui_parse_item_keywords (Lisp_Object item)
240 return make_gui_item_from_keywords_internal (item, ERROR_ME);
244 gui_parse_item_keywords_no_errors (Lisp_Object item)
246 return make_gui_item_from_keywords_internal (item, ERROR_ME_NOT);
249 /* convert a gui item into plist properties */
251 gui_add_item_keywords_to_plist (Lisp_Object plist, Lisp_Object gui_item)
253 struct Lisp_Gui_Item* pgui_item = XGUI_ITEM (gui_item);
255 if (!NILP (pgui_item->callback))
256 Fplist_put (plist, Q_callback, pgui_item->callback);
257 if (!NILP (pgui_item->suffix))
258 Fplist_put (plist, Q_suffix, pgui_item->suffix);
259 if (!NILP (pgui_item->active))
260 Fplist_put (plist, Q_active, pgui_item->active);
261 if (!NILP (pgui_item->included))
262 Fplist_put (plist, Q_included, pgui_item->included);
263 if (!NILP (pgui_item->config))
264 Fplist_put (plist, Q_config, pgui_item->config);
265 if (!NILP (pgui_item->filter))
266 Fplist_put (plist, Q_filter, pgui_item->filter);
267 if (!NILP (pgui_item->style))
268 Fplist_put (plist, Q_style, pgui_item->style);
269 if (!NILP (pgui_item->selected))
270 Fplist_put (plist, Q_selected, pgui_item->selected);
271 if (!NILP (pgui_item->keys))
272 Fplist_put (plist, Q_keys, pgui_item->keys);
273 if (!NILP (pgui_item->accelerator))
274 Fplist_put (plist, Q_accelerator, pgui_item->accelerator);
278 * Decide whether a GUI item is active by evaluating its :active form
282 gui_item_active_p (Lisp_Object gui_item)
284 /* This function can call lisp */
286 /* Shortcut to avoid evaluating Qt each time */
287 return (EQ (XGUI_ITEM (gui_item)->active, Qt)
288 || !NILP (Feval (XGUI_ITEM (gui_item)->active)));
291 /* set menu accelerator key to first underlined character in menu name */
293 gui_item_accelerator (Lisp_Object gui_item)
295 struct Lisp_Gui_Item* pgui = XGUI_ITEM (gui_item);
297 if (!NILP (pgui->accelerator))
298 return pgui->accelerator;
305 gui_name_accelerator (Lisp_Object nm)
307 /* !!#### This function has not been Mule-ized */
308 char* name = (char*)XSTRING_DATA (nm);
315 if (*name=='_' && *(name+1))
317 int accelerator = (int) (unsigned char) (*(name+1));
318 return make_char (tolower (accelerator));
327 * Decide whether a GUI item is selected by evaluating its :selected form
331 gui_item_selected_p (Lisp_Object gui_item)
333 /* This function can call lisp */
335 /* Shortcut to avoid evaluating Qt each time */
336 return (EQ (XGUI_ITEM (gui_item)->selected, Qt)
337 || !NILP (Feval (XGUI_ITEM (gui_item)->selected)));
341 * Decide whether a GUI item is included by evaluating its :included
342 * form if given, and testing its :config form against supplied CONFLIST
343 * configuration variable
346 gui_item_included_p (Lisp_Object gui_item, Lisp_Object conflist)
348 /* This function can call lisp */
349 struct Lisp_Gui_Item* pgui_item = XGUI_ITEM (gui_item);
351 /* Evaluate :included first. Shortcut to avoid evaluating Qt each time */
352 if (!EQ (pgui_item->included, Qt)
353 && NILP (Feval (pgui_item->included)))
356 /* Do :config if conflist is given */
357 if (!NILP (conflist) && !NILP (pgui_item->config)
358 && NILP (Fmemq (pgui_item->config, conflist)))
365 signal_too_long_error (Lisp_Object name)
367 signal_simple_error ("GUI item produces too long displayable string", name);
370 #ifdef HAVE_WINDOW_SYSTEM
372 * Format "left flush" display portion of an item into BUF, guarded by
373 * maximum buffer size BUF_LEN. BUF_LEN does not count for terminating
374 * null character, so actual maximum size of buffer consumed is
375 * BUF_LEN + 1 bytes. If buffer is not big enough, then error is
377 * Return value is the offset to the terminating null character into the
381 gui_item_display_flush_left (Lisp_Object gui_item,
382 char* buf, Bytecount buf_len)
386 struct Lisp_Gui_Item* pgui_item = XGUI_ITEM (gui_item);
388 /* Copy item name first */
389 CHECK_STRING (pgui_item->name);
390 len = XSTRING_LENGTH (pgui_item->name);
392 signal_too_long_error (pgui_item->name);
393 memcpy (p, XSTRING_DATA (pgui_item->name), len);
396 /* Add space and suffix, if there is a suffix.
397 * If suffix is not string evaluate it */
398 if (!NILP (pgui_item->suffix))
400 Lisp_Object suffix = pgui_item->suffix;
401 /* Shortcut to avoid evaluating suffix each time */
402 if (!STRINGP (suffix))
404 suffix = Feval (suffix);
405 CHECK_STRING (suffix);
408 len = XSTRING_LENGTH (suffix);
409 if (p + len + 1 > buf + buf_len)
410 signal_too_long_error (pgui_item->name);
412 memcpy (p, XSTRING_DATA (suffix), len);
420 * Format "right flush" display portion of an item into BUF, guarded by
421 * maximum buffer size BUF_LEN. BUF_LEN does not count for terminating
422 * null character, so actual maximum size of buffer consumed is
423 * BUF_LEN + 1 bytes. If buffer is not big enough, then error is
425 * Return value is the offset to the terminating null character into the
429 gui_item_display_flush_right (Lisp_Object gui_item,
430 char* buf, Bytecount buf_len)
432 struct Lisp_Gui_Item* pgui_item = XGUI_ITEM (gui_item);
437 if (!menubar_show_keybindings)
441 /* Try :keys first */
442 if (!NILP (pgui_item->keys))
444 CHECK_STRING (pgui_item->keys);
445 if (XSTRING_LENGTH (pgui_item->keys) > buf_len)
446 signal_too_long_error (pgui_item->name);
447 strcpy (buf, (CONST char *) XSTRING_DATA (pgui_item->keys));
448 return XSTRING_LENGTH (pgui_item->keys);
451 /* See if we can derive keys out of callback symbol */
452 if (SYMBOLP (pgui_item->callback))
457 where_is_to_char (pgui_item->callback, buf2);
460 signal_too_long_error (pgui_item->name);
465 /* No keys - no right flush display */
468 #endif /* HAVE_WINDOW_SYSTEM */
471 mark_gui_item (Lisp_Object obj, void (*markobj) (Lisp_Object))
473 struct Lisp_Gui_Item *p = XGUI_ITEM (obj);
476 markobj (p->callback);
480 markobj (p->included);
484 markobj (p->selected);
486 markobj (p->accelerator);
492 gui_item_hash (Lisp_Object obj, int depth)
494 struct Lisp_Gui_Item *p = XGUI_ITEM (obj);
496 return HASH2 (HASH5 (internal_hash (p->name, depth + 1),
497 internal_hash (p->callback, depth + 1),
498 internal_hash (p->suffix, depth + 1),
499 internal_hash (p->active, depth + 1),
500 internal_hash (p->included, depth + 1)),
501 HASH5 (internal_hash (p->config, depth + 1),
502 internal_hash (p->filter, depth + 1),
503 internal_hash (p->style, depth + 1),
504 internal_hash (p->selected, depth + 1),
505 internal_hash (p->keys, depth + 1)));
509 gui_item_id_hash (Lisp_Object hashtable, Lisp_Object gitem, int slot)
511 int hashid = gui_item_hash (gitem, 0);
512 int id = GUI_ITEM_ID_BITS (hashid, slot);
513 while (!NILP (Fgethash (make_int (id),
516 id = GUI_ITEM_ID_BITS (id + 1, slot);
522 gui_item_equal (Lisp_Object obj1, Lisp_Object obj2, int depth)
524 struct Lisp_Gui_Item *p1 = XGUI_ITEM (obj1);
525 struct Lisp_Gui_Item *p2 = XGUI_ITEM (obj2);
527 if (!(internal_equal (p1->name, p2->name, depth + 1)
529 internal_equal (p1->callback, p2->callback, depth + 1)
531 EQ (p1->suffix, p2->suffix)
533 EQ (p1->active, p2->active)
535 EQ (p1->included, p2->included)
537 EQ (p1->config, p2->config)
539 EQ (p1->filter, p2->filter)
541 EQ (p1->style, p2->style)
543 EQ (p1->selected, p2->selected)
545 EQ (p1->accelerator, p2->accelerator)
547 EQ (p1->keys, p2->keys)))
553 print_gui_item (Lisp_Object obj, Lisp_Object printcharfun, int escapeflag)
555 struct Lisp_Gui_Item *g = XGUI_ITEM (obj);
559 error ("printing unreadable object #<gui-item 0x%x>", g->header.uid);
561 write_c_string ("#<gui-item ", printcharfun);
562 sprintf (buf, "0x%x>", g->header.uid);
563 write_c_string (buf, printcharfun);
566 DEFINE_LRECORD_IMPLEMENTATION ("gui-item", gui_item,
567 mark_gui_item, print_gui_item,
571 struct Lisp_Gui_Item);
576 defkeyword (&Q_active, ":active");
577 defkeyword (&Q_suffix, ":suffix");
578 defkeyword (&Q_keys, ":keys");
579 defkeyword (&Q_key_sequence,":key-sequence");
580 defkeyword (&Q_style, ":style");
581 defkeyword (&Q_selected, ":selected");
582 defkeyword (&Q_filter, ":filter");
583 defkeyword (&Q_config, ":config");
584 defkeyword (&Q_included, ":included");
585 defkeyword (&Q_accelerator, ":accelerator");
586 defkeyword (&Q_label, ":label");
587 defkeyword (&Q_callback, ":callback");
589 defsymbol (&Qtoggle, "toggle");
590 defsymbol (&Qradio, "radio");
593 DEFSUBR (Fpopup_up_p);