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