annotate lisp/gtk-ffi.el @ 617:af57a77cbc92

[xemacs-hg @ 2001-06-18 07:09:50 by ben] --------------------------------------------------------------- DOCUMENTATION FIXES: --------------------------------------------------------------- eval.c: Correct documentation. elhash.c: Doc correction. --------------------------------------------------------------- LISP OBJECT CLEANUP: --------------------------------------------------------------- bytecode.h, buffer.h, casetab.h, chartab.h, console-msw.h, console.h, database.c, device.h, eldap.h, elhash.h, events.h, extents.h, faces.h, file-coding.h, frame.h, glyphs.h, gui-x.h, gui.h, keymap.h, lisp-disunion.h, lisp-union.h, lisp.h, lrecord.h, lstream.h, mule-charset.h, objects.h, opaque.h, postgresql.h, process.h, rangetab.h, specifier.h, toolbar.h, tooltalk.h, ui-gtk.h: Add wrap_* to all objects (it was already there for a few of them) -- an expression to encapsulate a pointer into a Lisp object, rather than the inconvenient XSET*. "wrap" was chosen because "make" as in make_int(), make_char() is not appropriate. (It implies allocation. The issue does not exist for ints and chars because they are not allocated.) Full error checking has been added to these expressions. When used without error checking, non-union build, use of these expressions will incur no loss of efficiency. (In fact, XSET* is now defined in terms of wrap_* in a non-union build.) In a union build, you will also get no loss of efficiency provided that you have a decent optimizing compiler, and a compiler that either understands inlines or automatically inlines those particular functions. (And since people don't normally do their production builds on union, it doesn't matter.) Update the sample Lisp object definition in lrecord.h accordingly. dumper.c: Fix places in dumper that referenced wrap_object to reference its new name, wrap_pointer_1. buffer.c, bufslots.h, conslots.h, console.c, console.h, devslots.h, device.c, device.h, frame.c, frame.h, frameslots.h, window.c, window.h, winslots.h: -- Extract out the Lisp objects of `struct device' into devslots.h, just like for the other structures. -- Extract out the remaining (not copied into the window config) Lisp objects in `struct window' into winslots.h; use different macros (WINDOW_SLOT vs. WINDOW_SAVED_SLOT) to differentiate them. -- Eliminate the `dead' flag of `struct frame', since it duplicates information already available in `framemeths', and fix FRAME_LIVE_P accordingly. (Devices and consoles already work this way.) -- In *slots.h, switch to system where MARKED_SLOT is automatically undef'd at the end of the file. (Follows what winslots.h already does.) -- Update the comments at the beginning of *slots.h to be accurate. -- When making any of the above objects dead, zero it out entirely and reset all Lisp object slots to Qnil. (We were already doing this somewhat, but not consistently.) This (1) Eliminates the possibility of extra objects hanging around that ought to be GC'd, (2) Causes an immediate crash if anyone tries to access a structure in one of these objects, (3) Ensures consistent behavior wrt dead objects. dialog-msw.c: Use internal_object_printer, since this object should not escape. --------------------------------------------------------------- FIXING A CRASH THAT I HIT ONCE (AND A RELATED BAD BEHAVIOR): --------------------------------------------------------------- eval.c: Fix up some comments about the FSF implementation. Fix two nasty bugs: (1) condition_case_unwind frees the conses sitting in the catch->tag slot too quickly, resulting in a crash that I hit. (2) catches need to be unwound one at a time when calling unwind-protect code, rather than all at once at the end; otherwise, incorrect behavior can result. (A comment shows exactly how.) backtrace.h: Improve comment about FSF differences in the handler stack. --------------------------------------------------------------- FIXING A CRASH THAT I REPEATEDLY HIT WHEN USING THE MOUSE WHEEL UNDER MSWINDOWS: --------------------------------------------------------------- Basic idea: My crash is due either to a dead, non-marked, GC-collected frame inside of a window mirror, or a prematurely freed window mirror. We need to mark the Lisp objects inside of window mirrors. Tracking the lifespan of window mirrors and scrollbar instances is extremely hard, and there may well be lurking bugs where such objects are freed too soon. The only safe way to fix these problems (and it fixes both problems at once) is to make both of these structures Lisp objects. lrecord.h, emacs.c, inline.c, scrollbar-gtk.c, scrollbar-msw.c, scrollbar-x.c, scrollbar.c, scrollbar.h, symsinit.h: Make scrollbar instances actual Lisp objects. Mark the window mirrors in them. inline.c needs to know about scrollbar.h now. Record the new type in lrecord.h. Fix up scrollbar-*.c appropriately. Create a hash table in scrollbar-msw.c so that the scrollbar instances stored in scrollbar HWND's are properly GC-protected. Create complex_vars_of_scrollbar_mswindows() to create the hash table at startup, and call it from emacs.c. Don't store the scrollbar instance as a property of the GTK scrollbar, as it's not used and if we did this, we'd have to separately GC-protect it in a hash table, like in MS Windows. lrecord.h, frame.h, frame.c, frameslots.h, redisplay.c, window.c, window.h: Move mark_window_mirror from redisplay.c to window.c. Make window mirrors actual Lisp objects. Tell lrecord.h about them. Change the window mirror member of struct frame from a pointer to a Lisp object, and add XWINDOW_MIRROR in appropriate places. Mark the scrollbar instances in the window mirror. redisplay.c, redisplay.h, alloc.c: Delete mark_redisplay. Don't call mark_redisplay. We now mark frame-specific structures in mark_frame. NOTE: I also deleted an extremely questionable call to update_frame_window_mirrors(). It was extremely questionable before, and now totally impossible, since it will create Lisp objects during redisplay. frame.c: Mark the scrollbar instances, which are now Lisp objects. Call mark_gutter() here, not in mark_redisplay(). gutter.c: Update comments about correct marking. --------------------------------------------------------------- ISSUES BROUGHT UP BY MARTIN: --------------------------------------------------------------- buffer.h: Put back these macros the way Steve T and I think they ought to be. I already explained in a previous changelog entry why I think these macros should be the way I'd defined them. Once again: We fix these macros so they don't care about the type of their lvalues. The non-C-string equivalents of these already function in the same way, and it's correct because it should be OK to pass in a CBufbyte *, a BufByte *, a Char_Binary *, an UChar_Binary *, etc. The whole reason for these different types is to work around errors caused by signed-vs-unsigned non-matching types. Any possible error that might be caught in a DFC macro would also be caught wherever the argument is used elsewhere. So creating multiple macro versions would add no useful error-checking and just further complicate an already complicated area. As for Martin's "ANSI aliasing" bug, XEmacs is not ANSI-aliasing clean and probably never will be. Unless the board agrees to change XEmacs in this way (and we really don't want to go down that road), this is not a bug. sound.h: Undo Martin's type change. signal.c: Fix problem identified by Martin with Linux and g++ due to non-standard declaration of setitimer(). systime.h: Update the docs for "qxe_" to point out why making the encapsulation explicit is always the right way to go. (setitimer() itself serves as an example.) For 21.4: update-elc-2.el: Correct misplaced parentheses, making lisp/mule not get recompiled.
author ben
date Mon, 18 Jun 2001 07:10:32 +0000
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)