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;
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 * Initialize the gui_item structure by setting all (GC-protected)
101 * fields to their default values. The defaults are t for :active and
102 * :included values, and nil for others.
105 gui_item_init (struct gui_item *pgui_item)
107 pgui_item->name = Qnil;
108 pgui_item->callback = Qnil;
109 pgui_item->suffix = Qnil;
110 pgui_item->active = Qt;
111 pgui_item->included = Qt;
112 pgui_item->config = Qnil;
113 pgui_item->filter = Qnil;
114 pgui_item->style = Qnil;
115 pgui_item->selected = Qnil;
116 pgui_item->keys = Qnil;
120 * Add a value VAL associated with keyword KEY into PGUI_ITEM
121 * structure. If KEY is not a keyword, or is an unknown keyword, then
125 gui_item_add_keyval_pair (struct gui_item *pgui_item,
126 Lisp_Object key, Lisp_Object val)
129 signal_simple_error_2 ("Non-keyword in gui item", key, pgui_item->name);
131 if (EQ (key, Q_suffix)) pgui_item->suffix = val;
132 else if (EQ (key, Q_active)) pgui_item->active = val;
133 else if (EQ (key, Q_included)) pgui_item->included = val;
134 else if (EQ (key, Q_config)) pgui_item->config = val;
135 else if (EQ (key, Q_filter)) pgui_item->filter = val;
136 else if (EQ (key, Q_style)) pgui_item->style = val;
137 else if (EQ (key, Q_selected)) pgui_item->selected = val;
138 else if (EQ (key, Q_keys)) pgui_item->keys = val;
139 else if (EQ (key, Q_key_sequence)) ; /* ignored for FSF compatability */
140 else if (EQ (key, Q_label)) ; /* ignored for 21.0 implement in 21.2 */
142 signal_simple_error_2 ("Unknown keyword in gui item", key, pgui_item->name);
146 * ITEM is a lisp vector, describing a menu item or a button. The
147 * function extracts the description of the item into the PGUI_ITEM
151 gui_parse_item_keywords (Lisp_Object item, struct gui_item *pgui_item)
153 int length, plist_p, start;
154 Lisp_Object *contents;
157 length = XVECTOR_LENGTH (item);
158 contents = XVECTOR_DATA (item);
161 signal_simple_error ("GUI item descriptors must be at least 1 elts long", item);
163 /* length 1: [ "name" ]
164 length 2: [ "name" callback ]
165 length 3: [ "name" callback active-p ]
166 or [ "name" keyword value ]
167 length 4: [ "name" callback active-p suffix ]
168 or [ "name" callback keyword value ]
169 length 5+: [ "name" callback [ keyword value ]+ ]
170 or [ "name" [ keyword value ]+ ]
172 plist_p = (length > 2 && (KEYWORDP (contents [1])
173 || KEYWORDP (contents [2])));
175 pgui_item->name = contents [0];
176 if (length > 1 && !KEYWORDP (contents [1]))
178 pgui_item->callback = contents [1];
184 if (!plist_p && length > 2)
187 pgui_item->active = contents [2];
189 pgui_item->suffix = contents [3];
195 if ((length - start) & 1)
196 signal_simple_error (
197 "GUI item descriptor has an odd number of keywords and values",
200 for (i = start; i < length;)
202 Lisp_Object key = contents [i++];
203 Lisp_Object val = contents [i++];
204 gui_item_add_keyval_pair (pgui_item, key, val);
210 * Decide whether a GUI item is active by evaluating its :active form
214 gui_item_active_p (CONST struct gui_item *pgui_item)
216 /* This function can call lisp */
218 /* Shortcut to avoid evaluating Qt each time */
219 return (EQ (pgui_item->active, Qt)
220 || !NILP (Feval (pgui_item->active)));
224 * Decide whether a GUI item is selected by evaluating its :selected form
228 gui_item_selected_p (CONST struct gui_item *pgui_item)
230 /* This function can call lisp */
232 /* Shortcut to avoid evaluating Qt each time */
233 return (EQ (pgui_item->selected, Qt)
234 || !NILP (Feval (pgui_item->selected)));
238 * Decide whether a GUI item is included by evaluating its :included
239 * form if given, and testing its :config form against supplied CONFLIST
240 * configuration variable
243 gui_item_included_p (CONST struct gui_item *pgui_item, Lisp_Object conflist)
245 /* This function can call lisp */
247 /* Evaluate :included first. Shortcut to avoid evaluating Qt each time */
248 if (!EQ (pgui_item->included, Qt)
249 && NILP (Feval (pgui_item->included)))
252 /* Do :config if conflist is given */
253 if (!NILP (conflist) && !NILP (pgui_item->config)
254 && NILP (Fmemq (pgui_item->config, conflist)))
261 signal_too_long_error (Lisp_Object name)
263 signal_simple_error ("GUI item produces too long displayable string", name);
266 #ifdef HAVE_WINDOW_SYSTEM
268 * Format "left flush" display portion of an item into BUF, guarded by
269 * maximum buffer size BUF_LEN. BUF_LEN does not count for terminating
270 * null character, so actual maximum size of buffer consumed is
271 * BUF_LEN + 1 bytes. If buffer is not big enough, then error is
273 * Return value is the offset to the terminating null character into the
277 gui_item_display_flush_left (CONST struct gui_item *pgui_item,
278 char* buf, Bytecount buf_len)
283 /* Copy item name first */
284 CHECK_STRING (pgui_item->name);
285 len = XSTRING_LENGTH (pgui_item->name);
287 signal_too_long_error (pgui_item->name);
288 memcpy (p, XSTRING_DATA (pgui_item->name), len);
291 /* Add space and suffix, if there is a suffix.
292 * If suffix is not string evaluate it */
293 if (!NILP (pgui_item->suffix))
295 Lisp_Object suffix = pgui_item->suffix;
296 /* Shortcut to avoid evaluating suffix each time */
297 if (!STRINGP (suffix))
299 suffix = Feval (suffix);
300 CHECK_STRING (suffix);
303 len = XSTRING_LENGTH (suffix);
304 if (p + len + 1 > buf + buf_len)
305 signal_too_long_error (pgui_item->name);
307 memcpy (p, XSTRING_DATA (suffix), len);
315 * Format "right flush" display portion of an item into BUF, guarded by
316 * maximum buffer size BUF_LEN. BUF_LEN does not count for terminating
317 * null character, so actual maximum size of buffer consumed is
318 * BUF_LEN + 1 bytes. If buffer is not big enough, then error is
320 * Return value is the offset to the terminating null character into the
324 gui_item_display_flush_right (CONST struct gui_item *pgui_item,
325 char* buf, Bytecount buf_len)
330 if (!menubar_show_keybindings)
333 /* Try :keys first */
334 if (!NILP (pgui_item->keys))
336 CHECK_STRING (pgui_item->keys);
337 if (XSTRING_LENGTH (pgui_item->keys) > buf_len)
338 signal_too_long_error (pgui_item->name);
339 strcpy (buf, (CONST char *) XSTRING_DATA (pgui_item->keys));
340 return XSTRING_LENGTH (pgui_item->keys);
343 /* See if we can derive keys out of callback symbol */
344 if (SYMBOLP (pgui_item->callback))
349 where_is_to_char (pgui_item->callback, buf2);
352 signal_too_long_error (pgui_item->name);
357 /* No keys - no right flush display */
360 #endif /* HAVE_WINDOW_SYSTEM */
363 mark_gui_item (struct gui_item* p, void (*markobj) (Lisp_Object))
366 markobj (p->callback);
369 markobj (p->included);
373 markobj (p->selected);
380 gui_item_hash (Lisp_Object hashtable, struct gui_item* g, int slot)
382 int hashid = HASH2 (internal_hash (g->callback, 0), internal_hash (g->name, 0));
383 int id = GUI_ITEM_ID_BITS (hashid, slot);
384 while (!NILP (Fgethash (make_int (id),
387 id = GUI_ITEM_ID_BITS (id + 1, slot);
395 defkeyword (&Q_active, ":active");
396 defkeyword (&Q_suffix, ":suffix");
397 defkeyword (&Q_keys, ":keys");
398 defkeyword (&Q_key_sequence,":key-sequence");
399 defkeyword (&Q_style, ":style");
400 defkeyword (&Q_selected, ":selected");
401 defkeyword (&Q_filter, ":filter");
402 defkeyword (&Q_config, ":config");
403 defkeyword (&Q_included, ":included");
404 defkeyword (&Q_accelerator, ":accelerator");
405 defkeyword (&Q_label, ":label");
407 defsymbol (&Qtoggle, "toggle");
408 defsymbol (&Qradio, "radio");
411 DEFSUBR (Fpopup_up_p);