comparison src/lisp.h @ 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 3d1f8f0e690f
children 56144c8593a8
comparison
equal deleted inserted replaced
5559:f3ab0c29c246 5560:58b38d5b32d0
2814 /*------------------------------ symbol --------------------------------*/ 2814 /*------------------------------ symbol --------------------------------*/
2815 2815
2816 typedef struct Lisp_Symbol Lisp_Symbol; 2816 typedef struct Lisp_Symbol Lisp_Symbol;
2817 struct Lisp_Symbol 2817 struct Lisp_Symbol
2818 { 2818 {
2819 FROB_BLOCK_LISP_OBJECT_HEADER lheader; 2819 union
2820 {
2821 FROB_BLOCK_LISP_OBJECT_HEADER lheader;
2822 struct
2823 {
2824 /* Everything before package_count must agree exactly with struct
2825 lrecord_header. */
2826 unsigned int type :8;
2827 #ifdef NEW_GC
2828 unsigned int lisp_readonly :1;
2829 unsigned int free :1;
2830 /* Number of packages this symbol is interned in, zero, one, or many.
2831 Packages aren't yet implemented, but we have a design in Common
2832 Lisp's. */
2833 unsigned int package_count :2;
2834 /* ID of the first package this symbol was interned in. Zero is
2835 uninterned, one is obarray. */
2836 unsigned int first_package_id :20;
2837 #else /* not NEW_GC */
2838 unsigned int mark :1;
2839 unsigned int c_readonly :1;
2840 unsigned int lisp_readonly :1;
2841 /* Number of packages this symbol is interned in, zero, one, or many. */
2842 unsigned int package_count :2;
2843 /* ID of the first package this symbol was interned in. Zero is
2844 uninterned, one is obarray. */
2845 unsigned int first_package_id :19;
2846 #endif /* not NEW_GC */
2847 } v;
2848 } u;
2849
2820 /* next symbol in this obarray bucket */ 2850 /* next symbol in this obarray bucket */
2821 Lisp_Symbol *next; 2851 Lisp_Symbol *next;
2822 Lisp_Object name; 2852 Lisp_Object name;
2823 Lisp_Object value; 2853 Lisp_Object value;
2824 Lisp_Object function; 2854 Lisp_Object function;
2825 Lisp_Object plist; 2855 Lisp_Object plist;
2826 }; 2856 };
2827 2857
2828 #define SYMBOL_IS_KEYWORD(sym) \ 2858 #define IN_OBARRAY(symbol) ((XSYMBOL (symbol)->u.v.first_package_id) == 1)
2829 ((string_byte (symbol_name (XSYMBOL (sym)), 0) == ':') \ 2859
2830 && EQ (sym, oblookup (Vobarray, \ 2860 #define SYMBOL_IS_KEYWORD(sym) (IN_OBARRAY (sym) && \
2831 XSTRING_DATA (symbol_name (XSYMBOL (sym))), \ 2861 (string_byte (symbol_name (XSYMBOL (sym)), \
2832 XSTRING_LENGTH (symbol_name (XSYMBOL (sym)))))) 2862 0) == ':'))
2863
2833 #define KEYWORDP(obj) (SYMBOLP (obj) && SYMBOL_IS_KEYWORD (obj)) 2864 #define KEYWORDP(obj) (SYMBOLP (obj) && SYMBOL_IS_KEYWORD (obj))
2834 2865
2835 DECLARE_MODULE_API_LISP_OBJECT (symbol, Lisp_Symbol); 2866 DECLARE_MODULE_API_LISP_OBJECT (symbol, Lisp_Symbol);
2836 #define XSYMBOL(x) XRECORD (x, symbol, Lisp_Symbol) 2867 #define XSYMBOL(x) XRECORD (x, symbol, Lisp_Symbol)
2837 #define wrap_symbol(p) wrap_record (p, symbol) 2868 #define wrap_symbol(p) wrap_record (p, symbol)
2848 #define XSYMBOL_NEXT(s) (XSYMBOL (s)->next) 2879 #define XSYMBOL_NEXT(s) (XSYMBOL (s)->next)
2849 #define XSYMBOL_NAME(s) (XSYMBOL (s)->name) 2880 #define XSYMBOL_NAME(s) (XSYMBOL (s)->name)
2850 #define XSYMBOL_VALUE(s) (XSYMBOL (s)->value) 2881 #define XSYMBOL_VALUE(s) (XSYMBOL (s)->value)
2851 #define XSYMBOL_FUNCTION(s) (XSYMBOL (s)->function) 2882 #define XSYMBOL_FUNCTION(s) (XSYMBOL (s)->function)
2852 #define XSYMBOL_PLIST(s) (XSYMBOL (s)->plist) 2883 #define XSYMBOL_PLIST(s) (XSYMBOL (s)->plist)
2884
2853 2885
2854 2886
2855 /*------------------------------- subr ---------------------------------*/ 2887 /*------------------------------- subr ---------------------------------*/
2856 2888
2857 /* A function that takes no arguments and returns a Lisp_Object. 2889 /* A function that takes no arguments and returns a Lisp_Object.
5265 EXFUN (Fstring_equal, 2); 5297 EXFUN (Fstring_equal, 2);
5266 EXFUN (Fstring_lessp, 2); 5298 EXFUN (Fstring_lessp, 2);
5267 EXFUN (Fsubseq, 3); 5299 EXFUN (Fsubseq, 3);
5268 EXFUN (Fvalid_plist_p, 1); 5300 EXFUN (Fvalid_plist_p, 1);
5269 5301
5302 extern Boolint check_eq_nokey (Lisp_Object, Lisp_Object, Lisp_Object,
5303 Lisp_Object);
5270 extern Boolint check_lss_key_car (Lisp_Object, Lisp_Object, Lisp_Object, 5304 extern Boolint check_lss_key_car (Lisp_Object, Lisp_Object, Lisp_Object,
5271 Lisp_Object); 5305 Lisp_Object);
5272 extern Boolint check_string_lessp_nokey (Lisp_Object, Lisp_Object, 5306 extern Boolint check_string_lessp_nokey (Lisp_Object, Lisp_Object,
5273 Lisp_Object, Lisp_Object); 5307 Lisp_Object, Lisp_Object);
5274 5308
5275 typedef Boolint (*check_test_func_t) (Lisp_Object test, Lisp_Object key, 5309 typedef Boolint (*check_test_func_t) (Lisp_Object test, Lisp_Object key,
5276 Lisp_Object item, Lisp_Object elt); 5310 Lisp_Object item, Lisp_Object elt);
5311
5312 typedef struct
5313 {
5314 Lisp_Object number_table;
5315 Lisp_Object new_;
5316 Lisp_Object old;
5317 Lisp_Object current_object;
5318 Boolint test_not_unboundp;
5319 } nsubst_structures_info_t;
5320
5321 Lisp_Object nsubst_structures (Lisp_Object new_, Lisp_Object old,
5322 Lisp_Object tree, check_test_func_t check_test,
5323 Boolint test_not_unboundp,
5324 Lisp_Object test, Lisp_Object key);
5277 5325
5278 Lisp_Object list_merge (Lisp_Object org_l1, Lisp_Object org_l2, 5326 Lisp_Object list_merge (Lisp_Object org_l1, Lisp_Object org_l2,
5279 check_test_func_t check_merge, 5327 check_test_func_t check_merge,
5280 Lisp_Object predicate, Lisp_Object key_func); 5328 Lisp_Object predicate, Lisp_Object key_func);
5281 Lisp_Object list_sort (Lisp_Object list, 5329 Lisp_Object list_sort (Lisp_Object list,
5614 MODULE_API DECLARE_DOESNT_RETURN (printing_unreadable_object_fmt (const CIbyte *, 5662 MODULE_API DECLARE_DOESNT_RETURN (printing_unreadable_object_fmt (const CIbyte *,
5615 ...)) 5663 ...))
5616 PRINTF_ARGS (1, 2); 5664 PRINTF_ARGS (1, 2);
5617 DECLARE_DOESNT_RETURN (printing_unreadable_lisp_object (Lisp_Object obj, 5665 DECLARE_DOESNT_RETURN (printing_unreadable_lisp_object (Lisp_Object obj,
5618 const Ibyte *name)); 5666 const Ibyte *name));
5667
5668 #define PRINT_PREPROCESS(obj, print_number_table, seen_object_count) \
5669 do if (LRECORDP (obj) \
5670 && XRECORD_LHEADER_IMPLEMENTATION (obj)->print_preprocess) \
5671 { \
5672 print_preprocess (obj, print_number_table, seen_object_count); \
5673 } while (0)
5674
5675 typedef struct { Lisp_Object table; Elemcount *count; } preprocess_info_t;
5676
5677 void print_preprocess (Lisp_Object obj, Lisp_Object print_number_table,
5678 Elemcount *seen_object_count);
5679
5680 /* These is in print.c because they use the print_preprocess
5681 infrastructure. */
5682 Lisp_Object nsubst_structures_descend (Lisp_Object new_, Lisp_Object old,
5683 Lisp_Object object,
5684 Lisp_Object number_table,
5685 Boolint test_not_unboundp);
5686
5687 Lisp_Object nsubst_structures (Lisp_Object new_, Lisp_Object old,
5688 Lisp_Object tree,
5689 check_test_func_t check_test,
5690 Boolint test_not_unboundp,
5691 Lisp_Object test, Lisp_Object key);
5619 5692
5620 extern Lisp_Object Qexternal_debugging_output; 5693 extern Lisp_Object Qexternal_debugging_output;
5621 extern Lisp_Object Qprint_length; 5694 extern Lisp_Object Qprint_length;
5622 extern Lisp_Object Qprint_string_length; 5695 extern Lisp_Object Qprint_string_length;
5623 extern Lisp_Object Qstandard_output; 5696 extern Lisp_Object Qstandard_output;