1 /* Opaque Lisp objects.
2 Copyright (C) 1993 Sun Microsystems, Inc.
3 Copyright (C) 1995, 1996 Ben Wing.
5 This file is part of XEmacs.
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
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
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. */
22 /* Synched up with: Not in FSF. */
24 /* Written by Ben Wing, October 1993. */
26 #ifndef _XEMACS_OPAQUE_H_
27 #define _XEMACS_OPAQUE_H_
30 struct { Lisp_Object obj; } obj;
31 struct { void *p; } p;
32 struct { double d; } d;
35 typedef struct Lisp_Opaque
37 struct lcrecord_header header;
38 Lisp_Object (*markfun) (Lisp_Object obj, void (*markobj) (Lisp_Object));
39 /* An integral size for non-freed objects, an opaque or nil for
41 Lisp_Object size_or_chain;
45 typedef struct Lisp_Opaque_List
47 struct lcrecord_header header;
48 /* `markfun' allows you to put lisp objects inside of opaque objects
49 without having to create a new object type. */
50 Lisp_Object (*markfun) (Lisp_Object obj, void (*markobj) (Lisp_Object));
55 DECLARE_LRECORD (opaque, Lisp_Opaque);
56 #define XOPAQUE(x) XRECORD (x, opaque, Lisp_Opaque)
57 #define XSETOPAQUE(x, p) XSETRECORD (x, p, opaque)
58 #define OPAQUEP(x) RECORDP (x, opaque)
59 #define GC_OPAQUEP(x) GC_RECORDP (x, opaque)
60 /* #define CHECK_OPAQUE(x) CHECK_RECORD (x, opaque)
61 Opaque pointers should never escape to the Lisp level, so
62 functions should not be doing this. */
64 DECLARE_LRECORD (opaque_list, Lisp_Opaque_List);
65 #define XOPAQUE_LIST(x) XRECORD (x, opaque_list, Lisp_Opaque_List)
66 #define XSETOPAQUE_LIST(x, p) XSETRECORD (x, p, opaque_list)
67 #define OPAQUE_LISTP(x) RECORDP (x, opaque_list)
68 #define GC_OPAQUE_LISTP(x) GC_RECORDP (x, opaque_list)
69 /* #define CHECK_OPAQUE_LIST(x) CHECK_RECORD (x, opaque_list)
70 Opaque lists should never escape to the Lisp level, so
71 functions should not be doing this. */
73 /* Alternative DATA arguments to make_opaque */
74 #define OPAQUE_CLEAR ((CONST void *) 0)
75 #define OPAQUE_UNINIT ((CONST void *) -1)
77 Lisp_Object make_opaque (size_t size, CONST void *data);
78 Lisp_Object make_opaque_ptr (CONST void *val);
79 Lisp_Object make_opaque_long (long val);
80 void free_opaque_ptr (Lisp_Object ptr);
82 #define OPAQUE_SIZE(op) XINT ((op)->size_or_chain)
83 #define OPAQUE_DATA(op) ((void *) ((op)->data))
84 #define OPAQUE_MARKFUN(op) ((op)->markfun)
85 #define XOPAQUE_SIZE(op) OPAQUE_SIZE (XOPAQUE (op))
86 #define XOPAQUE_DATA(op) OPAQUE_DATA (XOPAQUE (op))
87 #define XOPAQUE_MARKFUN(op) OPAQUE_MARKFUN (XOPAQUE (op))
89 #define get_opaque_ptr(op) (* (void **) XOPAQUE_DATA (op))
90 #define set_opaque_ptr(op, ptr) (get_opaque_ptr (op) = (void *) ptr)
91 #define get_opaque_long(op) (* (long *) XOPAQUE_DATA (op))
92 #define set_opaque_long(op, ptr) (get_opaque_long (op) = ptr)
93 #define set_opaque_markfun(op, fun) (XOPAQUE_MARKFUN (op) = fun)
95 Lisp_Object make_opaque_list (size_t size,
96 Lisp_Object (*markfun)
98 void (*markobj) (Lisp_Object)));
99 Lisp_Object allocate_managed_opaque (Lisp_Object opaque_list,
101 void free_managed_opaque (Lisp_Object opaque_list, Lisp_Object opaque);
103 #endif /* _XEMACS_OPAQUE_H_ */