diff src/opaque.h @ 0:376386a54a3c r19-14

Import from CVS: tag r19-14
author cvs
date Mon, 13 Aug 2007 08:45:50 +0200
parents
children 8626e4521993
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/opaque.h	Mon Aug 13 08:45:50 2007 +0200
@@ -0,0 +1,94 @@
+/* Opaque Lisp objects.
+   Copyright (C) 1993 Sun Microsystems, Inc.
+   Copyright (C) 1995, 1996 Ben Wing.
+
+This file is part of XEmacs.
+
+XEmacs is free software; you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the
+Free Software Foundation; either version 2, or (at your option) any
+later version.
+
+XEmacs is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+for more details.
+
+You should have received a copy of the GNU General Public License
+along with XEmacs; see the file COPYING.  If not, write to
+the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+Boston, MA 02111-1307, USA.  */
+
+/* Synched up with: Not in FSF. */
+
+/* Written by Ben Wing, October 1993. */
+
+#ifndef _XEMACS_OPAQUE_H_
+#define _XEMACS_OPAQUE_H_
+
+struct Lisp_Opaque
+{
+  struct lcrecord_header header;
+  Lisp_Object (*markfun) (Lisp_Object obj, void (*markobj) (Lisp_Object));
+  /* An integral size for non-freed objects, an opaque or nil for
+     freed objects. */
+  Lisp_Object size_or_chain;
+  /* It's actually more space-efficient to declare this as an int
+     rather than a char, because the structure will get rounded up
+     in size by the compiler anyway. */
+  int data[1];
+};
+
+struct Lisp_Opaque_List
+{
+  struct lcrecord_header header;
+  Lisp_Object (*markfun) (Lisp_Object obj, void (*markobj) (Lisp_Object));
+  Lisp_Object free;
+  int size;
+};
+
+DECLARE_LRECORD (opaque, struct Lisp_Opaque);
+#define XOPAQUE(x) XRECORD (x, opaque, struct Lisp_Opaque)
+#define XSETOPAQUE(x, p) XSETRECORD (x, p, opaque)
+#define OPAQUEP(x) RECORDP (x, opaque)
+#define GC_OPAQUEP(x) GC_RECORDP (x, opaque)
+/* #define CHECK_OPAQUE(x) CHECK_RECORD (x, opaque)
+   Opaque pointers should never escape to the Lisp level, so
+   functions should not be doing this. */
+
+DECLARE_LRECORD (opaque_list, struct Lisp_Opaque_List);
+#define XOPAQUE_LIST(x) XRECORD (x, opaque_list, struct Lisp_Opaque_List)
+#define XSETOPAQUE_LIST(x, p) XSETRECORD (x, p, opaque_list)
+#define OPAQUE_LISTP(x) RECORDP (x, opaque_list)
+#define GC_OPAQUE_LISTP(x) GC_RECORDP (x, opaque_list)
+/* #define CHECK_OPAQUE_LIST(x) CHECK_RECORD (x, opaque_list)
+   Opaque lists should never escape to the Lisp level, so
+   functions should not be doing this. */
+
+Lisp_Object make_opaque (int size, CONST void *data);
+Lisp_Object make_opaque_ptr (CONST void *val);
+Lisp_Object make_opaque_long (long val);
+void free_opaque_ptr (Lisp_Object ptr);
+
+#define OPAQUE_SIZE(op) XINT ((op)->size_or_chain)
+#define OPAQUE_DATA(op) ((op)->data)
+#define OPAQUE_MARKFUN(op) ((op)->markfun) /* What's the point if this? */
+#define XOPAQUE_SIZE(op) OPAQUE_SIZE (XOPAQUE (op))
+#define XOPAQUE_DATA(op) OPAQUE_DATA (XOPAQUE (op))
+#define XOPAQUE_MARKFUN(op) OPAQUE_MARKFUN (XOPAQUE (op))
+
+#define get_opaque_ptr(op) (* (void **) XOPAQUE_DATA (op))
+#define set_opaque_ptr(op, ptr) (get_opaque_ptr (op) = (void *) ptr)
+#define get_opaque_long(op) (* (long *) XOPAQUE_DATA (op))
+#define set_opaque_long(op, ptr) (get_opaque_long (op) = ptr)
+#define set_opaque_markfun(op, fun) (XOPAQUE_MARKFUN (op) = fun)
+
+Lisp_Object make_opaque_list (int size,
+			      Lisp_Object (*markfun)
+			      (Lisp_Object obj,
+			       void (*markobj) (Lisp_Object)));
+Lisp_Object allocate_managed_opaque (Lisp_Object opaque_list,
+				     CONST void *data);
+void free_managed_opaque (Lisp_Object opaque_list, Lisp_Object opaque);
+
+#endif /* _XEMACS_OPAQUE_H_ */