diff src/bytecode.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 ac37a5f7e5be
children 56144c8593a8
line wrap: on
line diff
--- a/src/bytecode.c	Sun Aug 28 10:34:54 2011 +0100
+++ b/src/bytecode.c	Sun Sep 04 19:51:35 2011 +0100
@@ -95,6 +95,13 @@
 					      Lisp_Compiled_Function_Args);
 #endif /* NEW_GC */
 
+static void set_compiled_function_arglist (Lisp_Compiled_Function *,
+                                           Lisp_Object);
+static void set_compiled_function_constants (Lisp_Compiled_Function *,
+                                             Lisp_Object);
+static void set_compiled_function_interactive (Lisp_Compiled_Function *,
+                                               Lisp_Object);
+
 EXFUN (Ffetch_bytecode, 1);
 
 Lisp_Object Qbyte_code, Qcompiled_functionp, Qinvalid_byte_code;
@@ -2360,6 +2367,76 @@
 		     f2->doc_and_interactive, depth + 1));
 }
 
+static void
+compiled_function_print_preprocess (Lisp_Object object,
+                                    Lisp_Object print_number_table,
+                                    Elemcount *seen_object_count)
+{
+  Lisp_Compiled_Function *cf = XCOMPILED_FUNCTION (object);
+
+  PRINT_PREPROCESS (compiled_function_arglist (cf), print_number_table,
+                    seen_object_count);
+
+  PRINT_PREPROCESS (compiled_function_constants (cf), print_number_table,
+                    seen_object_count);
+
+  if (cf->flags.interactivep)
+    {
+      PRINT_PREPROCESS (compiled_function_interactive (cf),
+                        print_number_table, seen_object_count);
+    }
+}
+
+static void
+compiled_function_nsubst_structures_descend (Lisp_Object new_, Lisp_Object old,
+                                             Lisp_Object object,
+                                             Lisp_Object number_table,
+                                             Boolint test_not_unboundp)
+{
+  Lisp_Compiled_Function *cf = XCOMPILED_FUNCTION (object);
+  Lisp_Object arglist = compiled_function_arglist (cf);
+  Lisp_Object constants = compiled_function_constants (cf);
+
+  if (EQ (arglist, old) == test_not_unboundp)
+    {
+      set_compiled_function_arglist (cf, new_);
+    }
+  else if (CONSP (arglist))
+    {
+      nsubst_structures_descend (new_, old, arglist, number_table,
+				 test_not_unboundp);
+    }
+
+  if (EQ (constants, old) == test_not_unboundp)
+    {
+      set_compiled_function_constants (cf, new_);
+    }
+  else
+    {
+      nsubst_structures_descend (new_, old, constants, number_table,
+				 test_not_unboundp);
+    }
+
+  /* We're not descending into the instructions here, because this function
+     is initially for use in the Lisp reader, where it only makes sense to
+     use the #%d= syntax for lrecords. */
+
+  if (cf->flags.interactivep)
+    {
+      Lisp_Object interactive = compiled_function_interactive (cf);
+      if (EQ (interactive, old) == test_not_unboundp)
+	{
+	  set_compiled_function_interactive (cf, new_);
+	}
+      else if (LRECORDP (interactive) &&
+               HAS_OBJECT_METH_P (interactive, nsubst_structures_descend))
+	{
+	  nsubst_structures_descend (new_, old, interactive, number_table,
+				     test_not_unboundp);
+	}
+    }
+}
+
 static Hashcode
 compiled_function_hash (Lisp_Object obj, int depth, Boolint UNUSED (equalp))
 {
@@ -2607,6 +2684,47 @@
     }
 }
 
+static void
+set_compiled_function_arglist (Lisp_Compiled_Function *f, Lisp_Object new_)
+{
+  CHECK_LIST (new_);
+  f->arglist = new_;
+
+  /* Recalculate the optimized version of the function, since this depends
+     on the arglist. */
+  f->instructions = compiled_function_instructions (f);
+  optimize_compiled_function (wrap_compiled_function (f));
+}
+
+static void
+set_compiled_function_constants (Lisp_Compiled_Function *f, Lisp_Object new_)
+{
+  CHECK_VECTOR (new_);
+  f->constants = new_;
+}
+
+static void
+set_compiled_function_interactive (Lisp_Compiled_Function *f, Lisp_Object new_)
+{
+  assert (f->flags.interactivep);
+
+  if (f->flags.documentationp && f->flags.domainp)
+    {
+      XSETCAR (XCDR (f->doc_and_interactive), new_);
+    }
+  else if (f->flags.documentationp)
+    {
+      XSETCDR (f->doc_and_interactive, new_);
+    }
+  else if (f->flags.domainp)
+    {
+      XSETCAR (f->doc_and_interactive, new_);
+    }
+  else
+    {
+      f->doc_and_interactive = new_;
+    }
+}
 
 DEFUN ("compiled-function-arglist", Fcompiled_function_arglist, 1, 1, 0, /*
 Return the argument list of the compiled-function object FUNCTION.
@@ -2782,6 +2900,13 @@
 
 
 void
+bytecode_objects_create (void)
+{
+  OBJECT_HAS_METHOD (compiled_function, print_preprocess);
+  OBJECT_HAS_METHOD (compiled_function, nsubst_structures_descend);
+}
+
+void
 syms_of_bytecode (void)
 {
   INIT_LISP_OBJECT (compiled_function);