update.
[chise/xemacs-chise.git] / src / opaque.h
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
26 #ifndef INCLUDED_opaque_h_
27 #define INCLUDED_opaque_h_
28
29 typedef struct Lisp_Opaque
30 {
31   struct lcrecord_header header;
32   size_t size;
33   max_align_t data[1];
34 } Lisp_Opaque;
35
36 DECLARE_LRECORD (opaque, Lisp_Opaque);
37 #define XOPAQUE(x) XRECORD (x, opaque, Lisp_Opaque)
38 #define XSETOPAQUE(x, p) XSETRECORD (x, p, opaque)
39 #define OPAQUEP(x) RECORDP (x, opaque)
40 /* #define CHECK_OPAQUE(x) CHECK_RECORD (x, opaque)
41    Opaque pointers should never escape to the Lisp level, so
42    functions should not be doing this. */
43
44 /* Alternative DATA arguments to make_opaque() */
45 #define OPAQUE_CLEAR  ((const void *)  0)
46 #define OPAQUE_UNINIT ((const void *) -1)
47
48 #define OPAQUE_SIZE(op) ((op)->size)
49 #define OPAQUE_DATA(op) ((void *) ((op)->data))
50 #define XOPAQUE_SIZE(op) OPAQUE_SIZE (XOPAQUE (op))
51 #define XOPAQUE_DATA(op) OPAQUE_DATA (XOPAQUE (op))
52
53 Lisp_Object make_opaque (const void *data, size_t size);
54
55 typedef struct Lisp_Opaque_Ptr
56 {
57   struct lcrecord_header header;
58   void *ptr;
59 } Lisp_Opaque_Ptr;
60
61 DECLARE_LRECORD (opaque_ptr, Lisp_Opaque_Ptr);
62 #define XOPAQUE_PTR(x) XRECORD (x, opaque_ptr, Lisp_Opaque_Ptr)
63 #define XSETOPAQUE_PTR(x, p) XSETRECORD (x, p, opaque_ptr)
64 #define OPAQUE_PTRP(x) RECORDP (x, opaque_ptr)
65
66 Lisp_Object make_opaque_ptr (void *val);
67 void free_opaque_ptr (Lisp_Object ptr);
68
69 #define get_opaque_ptr(op) (XOPAQUE_PTR (op)->ptr)
70 #define set_opaque_ptr(op, ptr_) (XOPAQUE_PTR (op)->ptr = (ptr_))
71
72 #endif /* INCLUDED_opaque_h_ */