diff src/alloc.c @ 5560:58b38d5b32d0

Implement print-circle, allowing recursive and circular structures to be read. src/ChangeLog addition: 2011-09-04 Aidan Kehoe <kehoea@parhasard.net> * alloc.c: * alloc.c (ALLOC_FROB_BLOCK_LISP_OBJECT_1): * alloc.c (ALLOC_FROB_BLOCK_LISP_OBJECT): * alloc.c (cons_print_preprocess): * alloc.c (vector_print_preprocess): * alloc.c (vector_nsubst_structures_descend): * alloc.c (Fmake_symbol): * alloc.c (UNMARK_symbol): * alloc.c (sweep_symbols): * alloc.c (reinit_alloc_objects_early): * alloc.c (reinit_alloc_early): * bytecode.c: * bytecode.c (compiled_function_print_preprocess): * bytecode.c (compiled_function_nsubst_structures_descend): * bytecode.c (set_compiled_function_arglist): * bytecode.c (set_compiled_function_interactive): * bytecode.c (bytecode_objects_create): * chartab.c: * chartab.c (print_preprocess_mapper): * chartab.c (nsubst_structures_mapper): * chartab.c (char_table_nsubst_structures_descend): * chartab.c (chartab_objects_create): * elhash.c: * elhash.c (nsubst_structures_map_hash_table): * elhash.c (hash_table_nsubst_structures_descend): * elhash.c (print_preprocess_mapper): * elhash.c (hash_table_print_preprocess): * elhash.c (inchash_eq): * elhash.c (hash_table_objects_create): * elhash.c (syms_of_elhash): * elhash.h: * emacs.c (main_1): * fns.c: * fns.c (check_eq_nokey): * fns.c (Fnsubst): * fns.c (syms_of_fns): * lisp.h: * lisp.h (struct Lisp_Symbol): * lisp.h (IN_OBARRAY): * lisp.h (struct): * lisp.h (PRINT_PREPROCESS): * lread.c (read1): * lrecord.h: * lrecord.h (struct lrecord_implementation): * lrecord.h (DEFINE_DUMPABLE_MODULE_LISP_OBJECT): * print.c: * print.c (PRINT_CIRCLE_LIMIT): * print.c (print_continuous_numbering_changed): * print.c (print_prepare): * print.c (print_finish): * print.c (Fprin1_to_string): * print.c (print_cons): * print.c (print_preprocess_inchash_eq): * print.c (print_preprocess): * print.c (print_sort_get_numbers): * print.c (print_sort_compare_ordinals): * print.c (print_gensym_or_circle): * print.c (nsubst_structures_descend): * print.c (nsubst_structures): * print.c (print_internal): * print.c (print_symbol): * print.c (vars_of_print): * rangetab.c: * rangetab.c (range_table_print_preprocess): * rangetab.c (range_table_nsubst_structures_descend): * rangetab.c (rangetab_objects_create): * rangetab.c (syms_of_rangetab): * symbols.c: * symbols.c (symbol_print_preprocess): * symbols.c (Fintern): * symbols.c (Funintern): * symbols.c (reinit_symbol_objects_early): * symbols.c (init_symbols_once_early): * symsinit.h: Implement print-circle, printing circular structures in a readable fashion, and treating them appropriately on read. This is by means of two new object methods, print_preprocess (detecting circularities), and nsubst_structures_descend (replacing placeholders with the read objects). Expose the substitution to Lisp via #'nsubst and its new :descend-structures keyword. Store information as to whether symbols are interned in obarray or not in their header, making checking for keywords and uninterned symbols (and thus printing) cheaper. Default print_gensym to t, as Common Lisp does, and as a more-than-decade old comment suggests. lisp/ChangeLog addition: 2011-09-04 Aidan Kehoe <kehoea@parhasard.net> * bytecomp.el (byte-compile-output-file-form): * bytecomp.el (byte-compile-output-docform): Bind print-circle, print-continuous-numbering in these functions, now those variables are available. * lisp.el (forward-sexp): * lisp.el (backward-sexp): Recognise leading #N= as being part of an expression. tests/ChangeLog addition: 2011-09-04 Aidan Kehoe <kehoea@parhasard.net> * automated/lisp-reader-tests.el: * automated/lisp-tests.el (literal-with-uninterned): * automated/symbol-tests.el (foo): Test print-circle, for printing (mutually-)recursive and circular structures. Bind print-continuous-numbering where appropriate.
author Aidan Kehoe <kehoea@parhasard.net>
date Sun, 04 Sep 2011 19:51:35 +0100
parents 248176c74e6b
children 56144c8593a8
line wrap: on
line diff
--- a/src/alloc.c	Sun Aug 28 10:34:54 2011 +0100
+++ b/src/alloc.c	Sun Sep 04 19:51:35 2011 +0100
@@ -1266,24 +1266,26 @@
 #endif /* (not) NEW_GC */
 
 #ifdef NEW_GC
-#define ALLOC_FROB_BLOCK_LISP_OBJECT(type, lisp_type, var, lrec_ptr)\
+#define ALLOC_FROB_BLOCK_LISP_OBJECT_1(type, lisp_type, var, lrec_ptr,  \
+                                       lheader)                         \
 do {									\
-  (var) = (lisp_type *) XPNTR (ALLOC_NORMAL_LISP_OBJECT (type));               \
+  (var) = (lisp_type *) XPNTR (ALLOC_NORMAL_LISP_OBJECT (type));        \
 } while (0)
-#define NOSEEUM_ALLOC_FROB_BLOCK_LISP_OBJECT(type, lisp_type, var,	\
-                                                 lrec_ptr)		\
+#define NOSEEUM_ALLOC_FROB_BLOCK_LISP_OBJECT_1(type, lisp_type, var,	\
+                                               lrec_ptr, lheader)       \
 do {									\
   (var) = (lisp_type *) XPNTR (noseeum_alloc_lrecord (lrec_ptr));	\
 } while (0)
 #else /* not NEW_GC */
-#define ALLOC_FROB_BLOCK_LISP_OBJECT(type, lisp_type, var, lrec_ptr) \
+#define ALLOC_FROB_BLOCK_LISP_OBJECT_1(type, lisp_type, var, lrec_ptr,  \
+                                       lheader)                         \
 do									\
 {									\
   ALLOCATE_FIXED_TYPE (type, lisp_type, var);				\
   set_lheader_implementation (&(var)->lheader, lrec_ptr);		\
 } while (0)
-#define NOSEEUM_ALLOC_FROB_BLOCK_LISP_OBJECT(type, lisp_type, var,	\
-                                                 lrec_ptr)		\
+#define NOSEEUM_ALLOC_FROB_BLOCK_LISP_OBJECT_1(type, lisp_type, var,	\
+                                               lrec_ptr, lheader)       \
 do									\
 {									\
   NOSEEUM_ALLOCATE_FIXED_TYPE (type, lisp_type, var);			\
@@ -1291,7 +1293,12 @@
 } while (0)
 #endif /* not NEW_GC */
 
-
+#define ALLOC_FROB_BLOCK_LISP_OBJECT(type, lisp_type, var, lrec_ptr) \
+  ALLOC_FROB_BLOCK_LISP_OBJECT_1(type, lisp_type, var, lrec_ptr, lheader) 
+
+#define NOSEEUM_ALLOC_FROB_BLOCK_LISP_OBJECT(type, lisp_type, var, lrec_ptr) \
+  NOSEEUM_ALLOC_FROB_BLOCK_LISP_OBJECT_1(type, lisp_type, var, lrec_ptr, \
+                                         lheader) 
 
 /************************************************************************/
 /*			   Cons allocation				*/
@@ -1326,6 +1333,66 @@
   return 0;
 }
 
+extern Elemcount
+print_preprocess_inchash_eq (Lisp_Object obj, Lisp_Object table,
+                             Elemcount *seen_object_count);
+
+static void
+cons_print_preprocess (Lisp_Object object, Lisp_Object print_number_table,
+                       Elemcount *seen_object_count)
+{
+  /* Special-case conses, don't recurse down the cdr if the cdr is a cons. */
+  for (;;)
+    {
+      PRINT_PREPROCESS (XCAR (object), print_number_table, seen_object_count);
+      object = XCDR (object);
+
+      if (!CONSP (object))
+        {
+          break;
+        }
+
+      if (print_preprocess_inchash_eq (object, print_number_table,
+                                       seen_object_count) > 1)
+        {
+          return;
+        }
+    }
+
+  PRINT_PREPROCESS (object, print_number_table, seen_object_count);
+}
+
+static void
+cons_nsubst_structures_descend (Lisp_Object new_, Lisp_Object old,
+                                Lisp_Object object,
+                                Lisp_Object number_table,
+                                Boolint test_not_unboundp)
+{
+  /* No need for a special case, nsubst_structures_descend is called much
+     less frequently than is print_preprocess. */
+  if (EQ (old, XCAR (object)) == test_not_unboundp)
+    {
+      XSETCAR (object, new_);
+    }
+  else if (LRECORDP (XCAR (object)) &&
+           HAS_OBJECT_METH_P (XCAR (object), nsubst_structures_descend))
+    {
+      nsubst_structures_descend (new_, old, XCAR (object), number_table,
+                                 test_not_unboundp);
+    }
+        
+  if (EQ (old, XCDR (object)) == test_not_unboundp)
+    {
+      XSETCDR (object, new_);
+    }
+  else if (LRECORDP (XCDR (object)) &&
+           HAS_OBJECT_METH_P (XCDR (object), nsubst_structures_descend))
+    {
+      nsubst_structures_descend (new_, old, XCDR (object), number_table,
+				 test_not_unboundp);
+    }
+}
+
 static const struct memory_description cons_description[] = {
   { XD_LISP_OBJECT, offsetof (Lisp_Cons, car_) },
   { XD_LISP_OBJECT, offsetof (Lisp_Cons, cdr_) },
@@ -1713,6 +1780,44 @@
 				     depth + 1, equalp));
 }
 
+static void
+vector_print_preprocess (Lisp_Object object, Lisp_Object print_number_table,
+                         Elemcount *seen_object_count)
+{
+  Elemcount ii, len;
+
+  for (ii = 0, len = XVECTOR_LENGTH (object); ii < len; ii++)
+    {
+      PRINT_PREPROCESS (XVECTOR_DATA (object)[ii], print_number_table,
+                        seen_object_count);
+    }
+}
+
+static void
+vector_nsubst_structures_descend (Lisp_Object new_, Lisp_Object old,
+                                  Lisp_Object object, Lisp_Object number_table,
+                                  Boolint test_not_unboundp)
+{
+  Elemcount ii = XVECTOR_LENGTH (object);
+  Lisp_Object *vdata = XVECTOR_DATA (object);
+
+  while (ii > 0)
+    {
+      --ii;
+
+      if (EQ (vdata[ii], old) == test_not_unboundp)
+	{
+	  vdata[ii] = new_;
+	}
+      else if (LRECORDP (vdata[ii]) &&
+               HAS_OBJECT_METH_P (vdata[ii], nsubst_structures_descend))
+	{
+	  nsubst_structures_descend (new_, old, vdata[ii], number_table,
+				     test_not_unboundp);
+	}
+    }
+}
+
 static const struct memory_description vector_description[] = {
   { XD_LONG,              offsetof (Lisp_Vector, size) },
   { XD_LISP_OBJECT_ARRAY, offsetof (Lisp_Vector, contents), XD_INDIRECT(0, 0) },
@@ -2115,7 +2220,11 @@
 
   CHECK_STRING (name);
 
-  ALLOC_FROB_BLOCK_LISP_OBJECT (symbol, Lisp_Symbol, p, &lrecord_symbol);
+  ALLOC_FROB_BLOCK_LISP_OBJECT_1 (symbol, Lisp_Symbol, p, &lrecord_symbol,
+                                  u.lheader);
+  p->u.v.package_count = 0;
+  p->u.v.first_package_id = 0;
+
   p->name     = name;
   p->plist    = Qnil;
   p->value    = Qunbound;
@@ -4789,10 +4898,10 @@
 static void
 sweep_symbols (void)
 {
-#define UNMARK_symbol(ptr) UNMARK_RECORD_HEADER (&((ptr)->lheader))
+#define UNMARK_symbol(ptr) UNMARK_RECORD_HEADER (&(((ptr)->u.lheader)))
 #define ADDITIONAL_FREE_symbol(ptr)
 
-  SWEEP_FIXED_TYPE_BLOCK (symbol, Lisp_Symbol);
+  SWEEP_FIXED_TYPE_BLOCK_1 (symbol, Lisp_Symbol, u.lheader);
 }
 
 static void
@@ -5631,6 +5740,11 @@
   OBJECT_HAS_METHOD (string, putprop);
   OBJECT_HAS_METHOD (string, remprop);
   OBJECT_HAS_METHOD (string, plist);
+
+  OBJECT_HAS_METHOD (cons, print_preprocess);
+  OBJECT_HAS_METHOD (cons, nsubst_structures_descend);
+  OBJECT_HAS_METHOD (vector, print_preprocess);
+  OBJECT_HAS_METHOD (vector, nsubst_structures_descend);
 }
 
 void