annotate lisp/gtk-ffi.el @ 4921:17362f371cc2

add more byte-code assertions and better failure output -------------------- ChangeLog entries follow: -------------------- src/ChangeLog addition: 2010-02-03 Ben Wing <ben@xemacs.org> * alloc.c (Fmake_byte_code): * bytecode.h: * lisp.h: * lread.c: * lread.c (readevalloop): * lread.c (Fread): * lread.c (Fread_from_string): * lread.c (read_list_conser): * lread.c (read_list): * lread.c (vars_of_lread): * symbols.c: * symbols.c (Fdefine_function): Turn on the "compiled-function annotation hack". Implement it properly by hooking into Fdefalias(). Note in the docstring to `defalias' that we do this. Remove some old broken code and change code that implemented the old kludgy way of hooking into the Lisp reader into bracketed by `#ifdef COMPILED_FUNCTION_ANNOTATION_HACK_OLD_WAY', which is not enabled. Also enable byte-code metering when DEBUG_XEMACS -- this is a form of profiling for computing histograms of which sequences of two bytecodes are used most often. * bytecode-ops.h: * bytecode-ops.h (OPCODE): New file. Extract out all the opcodes and declare them using OPCODE(), a bit like frame slots and such. This way the file can be included multiple times if necessary to iterate multiple times over the byte opcodes. * bytecode.c: * bytecode.c (NUM_REMEMBERED_BYTE_OPS): * bytecode.c (OPCODE): * bytecode.c (assert_failed_with_remembered_ops): * bytecode.c (READ_UINT_2): * bytecode.c (READ_INT_1): * bytecode.c (READ_INT_2): * bytecode.c (PEEK_INT_1): * bytecode.c (PEEK_INT_2): * bytecode.c (JUMP_RELATIVE): * bytecode.c (JUMP_NEXT): * bytecode.c (PUSH): * bytecode.c (POP_WITH_MULTIPLE_VALUES): * bytecode.c (DISCARD): * bytecode.c (UNUSED): * bytecode.c (optimize_byte_code): * bytecode.c (optimize_compiled_function): * bytecode.c (Fbyte_code): * bytecode.c (vars_of_bytecode): * bytecode.c (init_opcode_table_multi_op): * bytecode.c (reinit_vars_of_bytecode): * emacs.c (main_1): * eval.c (funcall_compiled_function): * symsinit.h: Any time we change either the instruction pointer or the stack pointer, assert that we're going to move it to a valid location. This should catch failures right when they occur rather than sometime later. This requires that we pass in another couple of parameters into some functions (only with error-checking enabled, see below). Also keep track, using a circular queue, of the last 100 byte opcodes seen, and when we hit an assert failure during byte-code execution, output the contents of the queue in a nice readable fashion. This requires that bytecode-ops.h be included a second time so that a table mapping opcodes to the name of their operation can be constructed. This table is constructed in new function reinit_vars_of_bytecode(). Everything in the last two paras happens only when ERROR_CHECK_BYTE_CODE. Add some longish comments describing how the arrays that hold the stack and instructions, and the pointers used to access them, work. * gc.c: Import some code from my `latest-fix' workspace to mark the staticpro's in order from lowest to highest, rather than highest to lowest, so it's easier to debug when something goes wrong. * lisp.h (abort_with_message): Renamed from abort_with_msg(). * symbols.c (defsymbol_massage_name_1): * symbols.c (defsymbol_nodump): * symbols.c (defsymbol): * symbols.c (defkeyword): * symeval.h (DEFVAR_SYMVAL_FWD_OBJECT): Make the various calls to staticpro() instead call staticpro_1(), passing in the name of the C var being staticpro'ed, so that it shows up in staticpro_names. Otherwise staticpro_names just has 1000+ copies of the word `location'.
author Ben Wing <ben@xemacs.org>
date Wed, 03 Feb 2010 08:01:55 -0600
parents 0784d089fdc9
children 3889ef128488 308d34e9f07d
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
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
10 ;; XEmacs is free software; you can redistribute it and/or modify it
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
11 ;; under the terms of the GNU General Public License as published by
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
12 ;; the Free Software Foundation; either version 2, or (at your option)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
13 ;; any later version.
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
14
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
15 ;; XEmacs is distributed in the hope that it will be useful, but
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
16 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
18 ;; General Public License for more details.
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
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
21 ;; along with XEmacs; see the file COPYING. If not, write to the Free
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
22 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
23 ;; 02111-1307, USA.
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 ;;; Synched up with: Not in FSF
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 ;;; Commentary:
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 ;; This file is dumped with XEmacs.
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
30
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
31 (defvar gtk-type-aliases '((GtkType . guint)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
32 (GdkAtom . gulong)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
33 (GdkBitmap . GdkWindow)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
34 (time_t . guint)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
35 (none . void)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
36 (GdkDrawable . GdkWindow)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
37 (GdkBitmap . GdkWindow)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
38 (GdkPixmap . GdkWindow))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
39 "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
40 really part of the object system.")
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
41
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
42 (defvar gtk-ffi-debug nil
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
43 "If non-nil, all functions defined wiht `gtk-import-function' will be checked
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
44 for missing marshallers.")
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
45
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
46 (defun gtk-ffi-check-function (func)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
47 ;; 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
48 ;; hoses us (locks up xemacs handling events, but no lisp).
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
49 (if (not (memq func '(gtk-main gtk-main-quit)))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
50 (condition-case err
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
51 (funcall func)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
52 (error
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
53 (case (car err)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
54 (wrong-number-of-arguments nil)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
55 (error
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
56 (if (string= "Could not locate marshaller function" (nth 1 err))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
57 (progn
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
58 (set-buffer (get-buffer-create "needed marshallers"))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
59 (display-buffer (current-buffer))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
60 (goto-char (point-max))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
61 (insert
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
62 (format "%S\n"
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
63 (split-string
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
64 (substring (nth 2 err) (length "emacs_gtk_marshal_")) "_+")))))))))))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
65
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
66 (defmacro gtk-import-function (retval name &rest args)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
67 (if (symbolp name)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
68 (setq name (symbol-name name)))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
69 (let ((lisp-name (intern (replace-in-string name "_" "-")))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
70 (doc-string nil))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
71 (setq retval (or (cdr-safe (assoc retval gtk-type-aliases)) retval)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
72 doc-string (concat "The lisp version of " name ".\n"
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
73 (if args
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
74 (concat "Prototype: " (prin1-to-string args)))))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
75
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
76 ;; Drop off any naming of arguments, etc.
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
77 (if (and args (consp (car args)))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
78 (setq args (mapcar 'car args)))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
79
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
80 ;; Get rid of any type aliases.
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
81 (setq args (mapcar (lambda (x)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
82 (or (cdr-safe (assoc x gtk-type-aliases)) x)) args))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
83
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
84 `(progn
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
85 (defun ,lisp-name (&rest args)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
86 ,doc-string
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
87 (if (not (get (quote ,lisp-name) 'gtk-ffi nil))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
88 (put (quote ,lisp-name) 'gtk-ffi
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
89 (gtk-import-function-internal (quote ,retval) ,name
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
90 (quote ,args))))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
91 (gtk-call-function (get (quote ,lisp-name) 'gtk-ffi 'ignore) args))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
92 (and gtk-ffi-debug (gtk-ffi-check-function (quote ,lisp-name))))))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
93
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
94 (defmacro gtk-import-variable (type name)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
95 (if (symbolp name) (setq name (symbol-name name)))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
96 (let ((lisp-name (intern (replace-in-string name "_" "-")))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
97 (doc-string nil))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
98 (setq type (or (cdr-safe (assoc type gtk-type-aliases)) type)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
99 doc-string (concat "Retrieve the variable " name " (type: " (symbol-name type) ").\n"))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
100 `(defun ,lisp-name ()
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
101 ,doc-string
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
102 (gtk-import-variable-internal (quote ,type) ,name))))
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
103
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents:
diff changeset
104 (provide 'gtk-ffi)