Mercurial > hg > xemacs-beta
annotate src/lisp-disunion.h @ 5013:ae48681c47fa
changes to VOID_TO_LISP et al.
-------------------- ChangeLog entries follow: --------------------
src/ChangeLog addition:
2010-02-08 Ben Wing <ben@xemacs.org>
* casetab.c (compute_canon_mapper):
* casetab.c (initialize_identity_mapper):
* casetab.c (compute_up_or_eqv_mapper):
* casetab.c (recompute_case_table):
* casetab.c (set_case_table):
* chartab.c (copy_mapper):
* chartab.c (copy_char_table_range):
* chartab.c (get_range_char_table_1):
* console.c (find_nonminibuffer_frame_not_on_console_predicate):
* console.c (find_nonminibuffer_frame_not_on_console):
* console.c (nuke_all_console_slots):
* device.c:
* device.c (find_nonminibuffer_frame_not_on_device_predicate):
* device.c (find_nonminibuffer_frame_not_on_device):
* dialog-msw.c (dialog_proc):
* dialog-msw.c (handle_question_dialog_box):
* dialog-x.c (maybe_run_dbox_text_callback):
* eval.c:
* eval.c (safe_run_hook_trapping_problems_1):
* eval.c (safe_run_hook_trapping_problems):
* event-msw.c:
* event-msw.c (mswindows_wnd_proc):
* event-msw.c (mswindows_find_frame):
* faces.c (update_face_inheritance_mapper):
* frame-msw.c (mswindows_init_frame_1):
* frame-msw.c (mswindows_get_mouse_position):
* frame-msw.c (mswindows_get_frame_parent):
* glade.c (connector):
* glade.c (Fglade_xml_signal_connect):
* glade.c (Fglade_xml_signal_autoconnect):
* glade.c (Fglade_xml_textdomain):
* glyphs-msw.c (mswindows_subwindow_instantiate):
* glyphs-msw.c (mswindows_widget_instantiate):
* glyphs.c (check_instance_cache_mapper):
* glyphs.c (check_window_subwindow_cache):
* glyphs.c (check_image_instance_structure):
* gui-x.c (snarf_widget_value_mapper):
* gui-x.c (popup_selection_callback):
* gui-x.c (button_item_to_widget_value):
* keymap.c (map_keymap_mapper):
* keymap.c (Fmap_keymap):
* menubar-gtk.c (__torn_off_sir):
* menubar-gtk.c (__activate_menu):
* menubar-gtk.c (menu_convert):
* menubar-gtk.c (__generic_button_callback):
* menubar-gtk.c (menu_descriptor_to_widget_1):
* menubar-msw.c:
* menubar-msw.c (EMPTY_ITEM_ID):
* menubar-x.c (menu_item_descriptor_to_widget_value_1):
* menubar-x.c (pre_activate_callback):
* menubar-x.c (command_builder_operate_menu_accelerator):
* menubar-x.c (command_builder_find_menu_accelerator):
* print.c (print_internal):
* process-unix.c (close_process_descs_mapfun):
* process.c (get_process_from_usid):
* process.c (init_process_io_handles):
* profile.c (sigprof_handler):
* profile.c (get_profiling_info_timing_maphash):
* profile.c (Fget_profiling_info):
* profile.c (set_profiling_info_timing_maphash):
* profile.c (mark_profiling_info_maphash):
* scrollbar-msw.c (mswindows_create_scrollbar_instance):
* scrollbar-msw.c (mswindows_free_scrollbar_instance):
* scrollbar-msw.c (mswindows_handle_scrollbar_event):
* specifier.c (recompute_cached_specifier_everywhere_mapfun):
* specifier.c (recompute_cached_specifier_everywhere):
* syntax.c (copy_to_mirrortab):
* syntax.c (copy_if_not_already_present):
* syntax.c (update_just_this_syntax_table):
* text.c (new_dfc_convert_now_damn_it):
* text.h (LISP_STRING_TO_EXTERNAL):
* tooltalk.c:
* tooltalk.c (tooltalk_message_callback):
* tooltalk.c (tooltalk_pattern_callback):
* tooltalk.c (Fcreate_tooltalk_message):
* tooltalk.c (Fcreate_tooltalk_pattern):
* ui-byhand.c (__generic_toolbar_callback):
* ui-byhand.c (generic_toolbar_insert_item):
* ui-byhand.c (__emacs_gtk_ctree_recurse_internal):
* ui-byhand.c (Fgtk_ctree_recurse):
* ui-gtk.c (__internal_callback_destroy):
* ui-gtk.c (__internal_callback_marshal):
* ui-gtk.c (Fgtk_signal_connect):
* ui-gtk.c (gtk_type_to_lisp):
* ui-gtk.c (lisp_to_gtk_type):
* ui-gtk.c (lisp_to_gtk_ret_type):
* lisp-disunion.h:
* lisp-disunion.h (NON_LVALUE):
* lisp-union.h:
* lisp.h (LISP_HASH):
Rename:
LISP_TO_VOID -> STORE_LISP_IN_VOID
VOID_TO_LISP -> GET_LISP_FROM_VOID
These new names are meant to clearly identify that the Lisp object
is the source and void the sink, and that they can't be used the
other way around -- they aren't exact opposites despite the old
names. The names are also important given the new functions
created just below. Also, clarify comments in lisp-union.h and
lisp-disunion.h about the use of the functions.
* lisp.h:
New functions STORE_VOID_IN_LISP and GET_VOID_FROM_LISP. These
are different from the above in that the source is a void *
(previously, you had to use make_opaque_ptr()).
* eval.c (restore_lisp_object):
* eval.c (record_unwind_protect_restoring_lisp_object):
* eval.c (struct restore_int):
* eval.c (restore_int):
* eval.c (record_unwind_protect_restoring_int):
* eval.c (free_pointer):
* eval.c (record_unwind_protect_freeing):
* eval.c (free_dynarr):
* eval.c (record_unwind_protect_freeing_dynarr):
* eval.c (unbind_to_1):
Use STORE_VOID_IN_LISP and GET_VOID_FROM_LISP to eliminate the
use of make_opaque_ptr() and mostly eliminate Lisp consing
entirely in the use of these various record_unwind_protect_*
functions as well as internal_bind_* (e.g. internal_bind_int).
* tests.c:
* tests.c (Ftest_store_void_in_lisp):
* tests.c (syms_of_tests):
* tests.c (vars_of_tests):
Add an C-assert-style test to test STORE_VOID_IN_LISP and
GET_VOID_FROM_LISP to make sure the same value comes back that
was put in.
author | Ben Wing <ben@xemacs.org> |
---|---|
date | Mon, 08 Feb 2010 06:42:16 -0600 |
parents | 184461bc8de4 |
children | 308d34e9f07d |
rev | line source |
---|---|
428 | 1 /* Fundamental definitions for XEmacs Lisp interpreter -- non-union objects. |
2 Copyright (C) 1985, 1986, 1987, 1992, 1993 Free Software Foundation, Inc. | |
826 | 3 Copyright (C) 2001, 2002 Ben Wing. |
428 | 4 |
5 This file is part of XEmacs. | |
6 | |
7 XEmacs is free software; you can redistribute it and/or modify it | |
8 under the terms of the GNU General Public License as published by the | |
9 Free Software Foundation; either version 2, or (at your option) any | |
10 later version. | |
11 | |
12 XEmacs is distributed in the hope that it will be useful, but WITHOUT | |
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
15 for more details. | |
16 | |
17 You should have received a copy of the GNU General Public License | |
18 along with XEmacs; see the file COPYING. If not, write to | |
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
20 Boston, MA 02111-1307, USA. */ | |
21 | |
22 /* Synched up with: FSF 19.30. Split out from lisp.h. */ | |
23 /* This file has diverged greatly from FSF Emacs. Syncing is no | |
24 longer desirable or possible */ | |
25 | |
26 /* | |
27 Format of a non-union-type Lisp Object | |
28 | |
29 3 2 1 0 | |
30 bit 10987654321098765432109876543210 | |
31 -------------------------------- | |
32 VVVVVVVVVVVVVVVVVVVVVVVVVVVVVVTT | |
33 | |
34 Integers are treated specially, and look like this: | |
35 | |
36 3 2 1 0 | |
37 bit 10987654321098765432109876543210 | |
38 -------------------------------- | |
39 VVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVT | |
40 | |
41 For integral Lisp types, i.e. integers and characters, the value | |
458 | 42 bits are the Lisp object. Some people call such Lisp_Objects "immediate". |
428 | 43 |
458 | 44 The object is obtained by masking off the type bits. |
462 | 45 Bit 1 is used as a value bit by splitting the Lisp integer type |
458 | 46 into two subtypes, Lisp_Type_Int_Even and Lisp_Type_Int_Odd. |
47 By this trickery we get 31 bits for integers instead of 30. | |
428 | 48 |
49 For non-integral types, the value bits of a Lisp_Object contain | |
50 a pointer to a structure containing the object. The pointer is | |
51 obtained by masking off the type and mark bits. | |
52 | |
462 | 53 All pointer-based types are coalesced under a single type called |
458 | 54 Lisp_Type_Record. The type bits for this type are required by the |
55 implementation to be 00, just like the least significant bits of | |
56 word-aligned struct pointers on 32-bit hardware. This requires that | |
57 all structs implementing Lisp_Objects have an alignment of at least 4 | |
58 bytes. Because of this, Lisp_Object pointers don't have to be masked | |
59 and are full-sized. | |
428 | 60 |
458 | 61 There are no mark bits in the Lisp_Object itself (there used to be). |
62 | |
63 Integers and characters don't need to be marked. All other types are | |
64 lrecord-based, which means they get marked by setting the mark bit in | |
65 the struct lrecord_header. | |
428 | 66 |
67 Here is a brief description of the following macros: | |
68 | |
69 XTYPE The type bits of a Lisp_Object | |
70 XPNTRVAL The value bits of a Lisp_Object storing a pointer | |
867 | 71 XCHARVAL The value bits of a Lisp_Object storing a Ichar |
428 | 72 XREALINT The value bits of a Lisp_Object storing an integer, signed |
73 XUINT The value bits of a Lisp_Object storing an integer, unsigned | |
458 | 74 INTP Non-zero if this Lisp_Object is an integer |
428 | 75 Qzero Lisp Integer 0 |
458 | 76 EQ Non-zero if two Lisp_Objects are identical, not merely equal. */ |
428 | 77 |
78 | |
79 typedef EMACS_INT Lisp_Object; | |
80 | |
81 #define Lisp_Type_Int_Bit (Lisp_Type_Int_Even & Lisp_Type_Int_Odd) | |
82 #define VALMASK (((1UL << VALBITS) - 1UL) << GCTYPEBITS) | |
83 #define XTYPE(x) ((enum Lisp_Type) (((EMACS_UINT)(x)) & ~VALMASK)) | |
84 #define XPNTRVAL(x) (x) /* This depends on Lisp_Type_Record == 0 */ | |
85 #define XCHARVAL(x) ((x) >> GCBITS) | |
86 #define XREALINT(x) ((x) >> INT_GCBITS) | |
87 #define XUINT(x) ((EMACS_UINT)(x) >> INT_GCBITS) | |
826 | 88 |
89 #define wrap_pointer_1(ptr) ((Lisp_Object) (ptr)) | |
90 | |
91 DECLARE_INLINE_HEADER ( | |
92 Lisp_Object | |
93 make_int_verify (EMACS_INT val) | |
94 ) | |
95 { | |
96 Lisp_Object obj = (Lisp_Object) ((val << INT_GCBITS) | Lisp_Type_Int_Bit); | |
97 type_checking_assert (XREALINT (obj) == val); | |
98 return obj; | |
99 } | |
100 | |
101 #define make_int(x) ((Lisp_Object) (((x) << INT_GCBITS) | Lisp_Type_Int_Bit)) | |
102 | |
831 | 103 #define make_char_1(x) ((Lisp_Object) (((x) << GCBITS) | Lisp_Type_Char)) |
826 | 104 |
428 | 105 #define INTP(x) ((EMACS_UINT)(x) & Lisp_Type_Int_Bit) |
106 #define INT_PLUS(x,y) ((x)+(y)-Lisp_Type_Int_Bit) | |
107 #define INT_MINUS(x,y) ((x)-(y)+Lisp_Type_Int_Bit) | |
108 #define INT_PLUS1(x) INT_PLUS (x, make_int (1)) | |
109 #define INT_MINUS1(x) INT_MINUS (x, make_int (1)) | |
110 | |
111 #define Qzero make_int (0) | |
112 #define Qnull_pointer ((Lisp_Object) 0) | |
113 #define EQ(x,y) ((x) == (y)) | |
114 | |
853 | 115 /* WARNING!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
116 | |
5013 | 117 You can only GET_LISP_FROM_VOID something that had previously been |
118 STORE_LISP_IN_VOID'd. If you want to go the other way, use | |
119 STORE_VOID_IN_LISP and GET_VOID_FROM_LISP, or use make_opaque_ptr(). */ | |
853 | 120 |
5013 | 121 /* Convert a Lisp object to a void * pointer, as when it needs to be passed |
122 to a toolkit callback function */ | |
123 #define STORE_LISP_IN_VOID(larg) ((void *) (larg)) | |
124 | |
125 /* Convert a void * pointer back into a Lisp object, assuming that the | |
126 pointer was generated by STORE_LISP_IN_VOID. */ | |
127 #define GET_LISP_FROM_VOID(varg) ((Lisp_Object) (varg)) | |
428 | 128 |
129 /* Convert a Lisp_Object into something that can't be used as an | |
130 lvalue. Useful for type-checking. */ | |
131 #define NON_LVALUE(larg) ((larg) + 0) |