annotate man/lispref/dialog.texi @ 5142:f965e31a35f0

reduce lcrecord headers to 2 words, rename printing_unreadable_object -------------------- ChangeLog entries follow: -------------------- man/ChangeLog addition: 2010-03-13 Ben Wing <ben@xemacs.org> * internals/internals.texi (Working with Lisp Objects): * internals/internals.texi (Writing Macros): * internals/internals.texi (lrecords): More rewriting to correspond with changes from *LRECORD* to *LISP_OBJECT*. modules/ChangeLog addition: 2010-03-13 Ben Wing <ben@xemacs.org> * postgresql/postgresql.c (print_pgconn): * postgresql/postgresql.c (print_pgresult): printing_unreadable_object -> printing_unreadable_object_fmt. 2010-03-13 Ben Wing <ben@xemacs.org> * ldap/eldap.c (print_ldap): printing_unreadable_object -> printing_unreadable_object_fmt. src/ChangeLog addition: 2010-03-13 Ben Wing <ben@xemacs.org> * alloc.c (alloc_sized_lrecord_1): * alloc.c (alloc_sized_lrecord_array): * alloc.c (old_alloc_sized_lcrecord): * alloc.c (disksave_object_finalization_1): * alloc.c (mark_lcrecord_list): * alloc.c (alloc_managed_lcrecord): * alloc.c (free_managed_lcrecord): * alloc.c (tick_lcrecord_stats): * alloc.c (sweep_lcrecords_1): * buffer.c (print_buffer): * buffer.c (DEFVAR_BUFFER_LOCAL_1): * casetab.c: * casetab.c (print_case_table): * console.c (print_console): * console.c (DEFVAR_CONSOLE_LOCAL_1): * data.c (print_weak_list): * data.c (print_weak_box): * data.c (print_ephemeron): * data.c (ephemeron_equal): * database.c (print_database): * database.c (finalize_database): * device-msw.c (sync_printer_with_devmode): * device-msw.c (print_devmode): * device-msw.c (finalize_devmode): * device.c: * device.c (print_device): * elhash.c: * elhash.c (print_hash_table): * eval.c (print_subr): * eval.c (print_multiple_value): * event-stream.c (event_stream_resignal_wakeup): * events.c (clear_event_resource): * events.c (zero_event): * events.c (print_event): * extents.c: * extents.c (print_extent): * file-coding.c (print_coding_system): * font-mgr.c: * font-mgr.c (Ffc_init): * frame.c: * frame.c (print_frame): * gc.c: * gc.c (GC_CHECK_NOT_FREE): * glyphs.c: * glyphs.c (print_image_instance): * glyphs.c (print_glyph): * gui.c (print_gui_item): * gui.c (copy_gui_item): * keymap.c (print_keymap): * keymap.c (MARKED_SLOT): * lisp.h: * lisp.h (struct Lisp_String): * lisp.h (DEFUN): * lisp.h (DEFUN_NORETURN): * lrecord.h: * lrecord.h (NORMAL_LISP_OBJECT_UID): * lrecord.h (struct lrecord_header): * lrecord.h (set_lheader_implementation): * lrecord.h (struct old_lcrecord_header): * lrecord.h (struct free_lcrecord_header): * marker.c (print_marker): * mule-charset.c: * mule-charset.c (print_charset): * objects.c (print_color_instance): * objects.c (print_font_instance): * objects.c (finalize_font_instance): * print.c (print_cons): * print.c (printing_unreadable_object_fmt): * print.c (printing_unreadable_lisp_object): * print.c (external_object_printer): * print.c (internal_object_printer): * print.c (debug_p4): * print.c (ext_print_begin): * process.c (print_process): * rangetab.c (print_range_table): * rangetab.c (range_table_equal): * scrollbar.c (free_scrollbar_instance): * specifier.c (print_specifier): * specifier.c (finalize_specifier): * symbols.c (guts_of_unbound_marker): * symeval.h: * symeval.h (DEFVAR_SYMVAL_FWD): * tooltalk.c: * tooltalk.c (print_tooltalk_message): * tooltalk.c (print_tooltalk_pattern): * ui-gtk.c (ffi_object_printer): * ui-gtk.c (emacs_gtk_object_printer): * ui-gtk.c (emacs_gtk_boxed_printer): * window.c (print_window): * window.c (free_window_mirror): * window.c (debug_print_window): * xemacs.def.in.in: (1) printing_unreadable_object -> printing_unreadable_object_fmt. (2) printing_unreadable_lcrecord -> printing_unreadable_lisp_object and fix up so it no longer requires an lcrecord. These previous changes eliminate most of the remaining places where the terms `lcrecord' and `lrecord' occurred outside of specialized code. (3) Fairly major change: Reduce the number of words in an lcrecord from 3 to 2. The third word consisted of a uid that duplicated the lrecord uid, and a single free bit, which was moved into the lrecord structure. This reduces the size of the `uid' slot from 21 bits to 20 bits. Arguably this isn't enough -- we could easily have more than 1,000,000 or so objects created in a session. The answer is (a) It doesn't really matter if we overflow the uid field because it's only used for debugging, to identify an object uniquely (or pretty much so). (b) If we cared about it overflowing and wanted to reduce this, we could make it so that cons, string, float and certain other frob-block types that never print out the uid simply don't store a uid in them and don't increment the lrecord_uid_counter. (4) In conjunction with (3), create new macro NORMAL_LISP_OBJECT_UID() and use it to abstract out the differences between NEWGC and old-GC in accessing the `uid' value from a "normal Lisp Object pointer". (5) In events.c, use zero_nonsized_lisp_object() in place of custom- written equivalent. In font-mgr.c use external_object_printer() in place of custom-written equivalents.
author Ben Wing <ben@xemacs.org>
date Sat, 13 Mar 2010 05:38:08 -0600
parents 576fb035e263
children 9fae6227ede5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
1 @c -*-texinfo-*-
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
2 @c This is part of the XEmacs Lisp Reference Manual.
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 398
diff changeset
3 @c Copyright (C) 1990, 1991, 1992, 1993 Free Software Foundation, Inc.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
4 @c See the file lispref.texi for copying conditions.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
5 @setfilename ../../info/dialog.info
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
6 @node Dialog Boxes, Toolbar, Menus, Top
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
7 @chapter Dialog Boxes
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
8 @cindex dialog box
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
9
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
10 @menu
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
11 * Dialog Box Format::
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
12 * Dialog Box Functions::
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
13 @end menu
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
14
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
15 @node Dialog Box Format
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
16 @section Dialog Box Format
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
17
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
18 A dialog box description is a list.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
19
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
20 @itemize @bullet
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
21 @item
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
22 The first element of the list is a string to display in the dialog box.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
23 @item
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
24 The rest of the elements are descriptions of the dialog box's buttons.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
25 Each one is a vector of three elements:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
26 @itemize @minus
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
27 @item
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
28 The first element is the text of the button.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
29 @item
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
30 The second element is the @dfn{callback}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
31 @item
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
32 The third element is @code{t} or @code{nil}, whether this button is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
33 selectable.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
34 @end itemize
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
35 @end itemize
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
36
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
37 If the callback of a button is a symbol, then it must name a command.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
38 It will be invoked with @code{call-interactively}. If it is a list,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
39 then it is evaluated with @code{eval}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
40
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
41 One (and only one) of the buttons may be @code{nil}. This marker means
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
42 that all following buttons should be flushright instead of flushleft.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
43
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
44 The syntax, more precisely:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
45
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
46 @example
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
47 form := <something to pass to `eval'>
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
48 command := <a symbol or string, to pass to `call-interactively'>
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
49 callback := command | form
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
50 active-p := <t, nil, or a form to evaluate to decide whether this
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
51 button should be selectable>
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
52 name := <string>
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
53 partition := 'nil'
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
54 button := '[' name callback active-p ']'
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
55 dialog := '(' name [ button ]+ [ partition [ button ]+ ] ')'
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
56 @end example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
57
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
58 @node Dialog Box Functions
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
59 @section Dialog Box Functions
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
60
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
61 @defun popup-dialog-box dbox-desc
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
62 This function pops up a dialog box. @var{dbox-desc} describes how the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
63 dialog box will appear (@pxref{Dialog Box Format}).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
64 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
65
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
66 @xref{Yes-or-No Queries}, for functions to ask a yes/no question using
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
67 a dialog box.