annotate lisp/gtk-ffi.el @ 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 4dee0387b9de
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
462
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
1 ;;; gtk-ffi.el --- Foreign function interface for the GTK object system
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
2
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
3 ;; Copyright (C) 2000 Free Software Foundation
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
4
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
5 ;; Maintainer: William Perry <wmperry@gnu.org>
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
6 ;; Keywords: extensions, dumped
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
7
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
8 ;; This file is part of XEmacs.
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
9
5402
308d34e9f07d Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents: 462
diff changeset
10 ;; XEmacs is free software: you can redistribute it and/or modify it
308d34e9f07d Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents: 462
diff changeset
11 ;; under the terms of the GNU General Public License as published by the
308d34e9f07d Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents: 462
diff changeset
12 ;; Free Software Foundation, either version 3 of the License, or (at your
308d34e9f07d Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents: 462
diff changeset
13 ;; option) any later version.
462
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
14
5402
308d34e9f07d Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents: 462
diff changeset
15 ;; XEmacs is distributed in the hope that it will be useful, but WITHOUT
308d34e9f07d Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents: 462
diff changeset
16 ;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
308d34e9f07d Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents: 462
diff changeset
17 ;; FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
308d34e9f07d Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents: 462
diff changeset
18 ;; for more details.
462
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
19
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
20 ;; You should have received a copy of the GNU General Public License
5402
308d34e9f07d Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents: 462
diff changeset
21 ;; along with XEmacs. If not, see <http://www.gnu.org/licenses/>.
462
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
22
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
23 ;;; Synched up with: Not in FSF
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
24
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
25 ;;; Commentary:
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
26
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
27 ;; This file is dumped with XEmacs.
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
28
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
29 (defvar gtk-type-aliases '((GtkType . guint)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
30 (GdkAtom . gulong)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
31 (GdkBitmap . GdkWindow)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
32 (time_t . guint)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
33 (none . void)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
34 (GdkDrawable . GdkWindow)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
35 (GdkBitmap . GdkWindow)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
36 (GdkPixmap . GdkWindow))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
37 "An assoc list of aliases for commonly used GTK types that are not
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
38 really part of the object system.")
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
39
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
40 (defvar gtk-ffi-debug nil
5384
3889ef128488 Fix misspelled words, and some grammar, across the entire source tree.
Jerry James <james@xemacs.org>
parents: 462
diff changeset
41 "If non-nil, all functions defined with `gtk-import-function' will be checked
462
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
42 for missing marshallers.")
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
43
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
44 (defun gtk-ffi-check-function (func)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
45 ;; We don't call gtk-main or gtk-main-quit because it thoroughly
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
46 ;; hoses us (locks up xemacs handling events, but no lisp).
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
47 (if (not (memq func '(gtk-main gtk-main-quit)))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
48 (condition-case err
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
49 (funcall func)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
50 (error
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
51 (case (car err)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
52 (wrong-number-of-arguments nil)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
53 (error
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
54 (if (string= "Could not locate marshaller function" (nth 1 err))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
55 (progn
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
56 (set-buffer (get-buffer-create "needed marshallers"))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
57 (display-buffer (current-buffer))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
58 (goto-char (point-max))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
59 (insert
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
60 (format "%S\n"
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
61 (split-string
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
62 (substring (nth 2 err) (length "emacs_gtk_marshal_")) "_+")))))))))))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
63
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
64 (defmacro gtk-import-function (retval name &rest args)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
65 (if (symbolp name)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
66 (setq name (symbol-name name)))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
67 (let ((lisp-name (intern (replace-in-string name "_" "-")))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
68 (doc-string nil))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
69 (setq retval (or (cdr-safe (assoc retval gtk-type-aliases)) retval)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
70 doc-string (concat "The lisp version of " name ".\n"
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
71 (if args
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
72 (concat "Prototype: " (prin1-to-string args)))))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
73
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
74 ;; Drop off any naming of arguments, etc.
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
75 (if (and args (consp (car args)))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
76 (setq args (mapcar 'car args)))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
77
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
78 ;; Get rid of any type aliases.
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
79 (setq args (mapcar (lambda (x)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
80 (or (cdr-safe (assoc x gtk-type-aliases)) x)) args))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
81
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
82 `(progn
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
83 (defun ,lisp-name (&rest args)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
84 ,doc-string
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
85 (if (not (get (quote ,lisp-name) 'gtk-ffi nil))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
86 (put (quote ,lisp-name) 'gtk-ffi
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
87 (gtk-import-function-internal (quote ,retval) ,name
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
88 (quote ,args))))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
89 (gtk-call-function (get (quote ,lisp-name) 'gtk-ffi 'ignore) args))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
90 (and gtk-ffi-debug (gtk-ffi-check-function (quote ,lisp-name))))))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
91
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
92 (defmacro gtk-import-variable (type name)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
93 (if (symbolp name) (setq name (symbol-name name)))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
94 (let ((lisp-name (intern (replace-in-string name "_" "-")))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
95 (doc-string nil))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
96 (setq type (or (cdr-safe (assoc type gtk-type-aliases)) type)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
97 doc-string (concat "Retrieve the variable " name " (type: " (symbol-name type) ").\n"))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
98 `(defun ,lisp-name ()
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
99 ,doc-string
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
100 (gtk-import-variable-internal (quote ,type) ,name))))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
101
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
102 (provide 'gtk-ffi)