428
|
1 /* Opaque Lisp objects.
|
|
2 Copyright (C) 1993 Sun Microsystems, Inc.
|
|
3 Copyright (C) 1995, 1996 Ben Wing.
|
|
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: Not in FSF. */
|
|
23
|
|
24 /* Written by Ben Wing, October 1993. */
|
|
25
|
440
|
26 #ifndef INCLUDED_opaque_h_
|
|
27 #define INCLUDED_opaque_h_
|
428
|
28
|
|
29 typedef struct Lisp_Opaque
|
|
30 {
|
2720
|
31 #ifdef MC_ALLOC
|
|
32 struct lrecord_header header;
|
|
33 #else /* MC_ALLOC */
|
428
|
34 struct lcrecord_header header;
|
2720
|
35 #endif /* MC_ALLOC */
|
665
|
36 Bytecount size;
|
428
|
37 max_align_t data[1];
|
|
38 } Lisp_Opaque;
|
|
39
|
|
40 DECLARE_LRECORD (opaque, Lisp_Opaque);
|
|
41 #define XOPAQUE(x) XRECORD (x, opaque, Lisp_Opaque)
|
617
|
42 #define wrap_opaque(p) wrap_record (p, opaque)
|
428
|
43 #define OPAQUEP(x) RECORDP (x, opaque)
|
|
44 /* #define CHECK_OPAQUE(x) CHECK_RECORD (x, opaque)
|
|
45 Opaque pointers should never escape to the Lisp level, so
|
|
46 functions should not be doing this. */
|
|
47
|
440
|
48 /* Alternative DATA arguments to make_opaque() */
|
442
|
49 #define OPAQUE_CLEAR ((const void *) 0)
|
|
50 #define OPAQUE_UNINIT ((const void *) -1)
|
428
|
51
|
|
52 #define OPAQUE_SIZE(op) ((op)->size)
|
|
53 #define OPAQUE_DATA(op) ((void *) ((op)->data))
|
|
54 #define XOPAQUE_SIZE(op) OPAQUE_SIZE (XOPAQUE (op))
|
|
55 #define XOPAQUE_DATA(op) OPAQUE_DATA (XOPAQUE (op))
|
|
56
|
665
|
57 Lisp_Object make_opaque (const void *data, Bytecount size);
|
428
|
58
|
|
59 typedef struct Lisp_Opaque_Ptr
|
|
60 {
|
2720
|
61 #ifdef MC_ALLOC
|
|
62 struct lrecord_header header;
|
|
63 #else /* MC_ALLOC */
|
428
|
64 struct lcrecord_header header;
|
2720
|
65 #endif /* MC_ALLOC */
|
428
|
66 void *ptr;
|
|
67 } Lisp_Opaque_Ptr;
|
|
68
|
|
69 DECLARE_LRECORD (opaque_ptr, Lisp_Opaque_Ptr);
|
|
70 #define XOPAQUE_PTR(x) XRECORD (x, opaque_ptr, Lisp_Opaque_Ptr)
|
617
|
71 #define wrap_opaque_ptr(p) wrap_record (p, opaque_ptr)
|
428
|
72 #define OPAQUE_PTRP(x) RECORDP (x, opaque_ptr)
|
|
73
|
1650
|
74 EXTERN_C MODULE_API Lisp_Object make_opaque_ptr (void *val);
|
|
75 EXTERN_C MODULE_API void free_opaque_ptr (Lisp_Object ptr);
|
428
|
76
|
|
77 #define get_opaque_ptr(op) (XOPAQUE_PTR (op)->ptr)
|
|
78 #define set_opaque_ptr(op, ptr_) (XOPAQUE_PTR (op)->ptr = (ptr_))
|
|
79
|
440
|
80 #endif /* INCLUDED_opaque_h_ */
|