annotate src/mule-ccl.h @ 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 023b83f4e54b
children 0c54de4c4b9d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
1 /* Header for CCL (Code Conversion Language) interpreter.
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
2 Copyright (C) 1995 Electrotechnical Laboratory, JAPAN.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
3 Licensed to the Free Software Foundation.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
4
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
5 This file is part of XEmacs.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
6
613
023b83f4e54b [xemacs-hg @ 2001-06-10 10:42:16 by ben]
ben
parents: 444
diff changeset
7 XEmacs is free software; you can redistribute it and/or modify
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
8 it under the terms of the GNU General Public License as published by
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
9 the Free Software Foundation; either version 2, or (at your option)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
10 any later version.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
11
613
023b83f4e54b [xemacs-hg @ 2001-06-10 10:42:16 by ben]
ben
parents: 444
diff changeset
12 XEmacs is distributed in the hope that it will be useful,
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
15 GNU General Public License for more details.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
16
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
613
023b83f4e54b [xemacs-hg @ 2001-06-10 10:42:16 by ben]
ben
parents: 444
diff changeset
18 along with XEmacs; see the file COPYING. If not, write to
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
20 Boston, MA 02111-1307, USA. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
21
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
22 #ifndef INCLUDED_mule_ccl_h_
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
23 #define INCLUDED_mule_ccl_h_
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
24
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
25 /* Macros for exit status of CCL program. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
26 #define CCL_STAT_SUCCESS 0 /* Terminated successfully. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
27 #define CCL_STAT_SUSPEND_BY_SRC 1 /* Terminated by empty input. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
28 #define CCL_STAT_SUSPEND_BY_DST 2 /* Terminated by output buffer full. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
29 #define CCL_STAT_INVALID_CMD 3 /* Terminated because of invalid
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
30 command. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
31 #define CCL_STAT_QUIT 4 /* Terminated because of quit. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
32
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
33 /* Structure to hold information about running CCL code. Read
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
34 comments in the file ccl.c for the detail of each field. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
35 struct ccl_program {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
36 int size; /* Size of the compiled code. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
37 Lisp_Object *prog; /* Pointer into the compiled code. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
38 int ic; /* Instruction Counter (index for PROG). */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
39 int eof_ic; /* Instruction Counter for end-of-file
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
40 processing code. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
41 int reg[8]; /* CCL registers, reg[7] is used for
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
42 condition flag of relational
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
43 operations. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
44 int private_state; /* CCL instruction may use this
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
45 for private use, mainly for saving
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
46 internal states on suspending.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
47 This variable is set to 0 when ccl is
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
48 set up. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
49 int last_block; /* Set to 1 while processing the last
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
50 block. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
51 int status; /* Exit status of the CCL program. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
52 int buf_magnification; /* Output buffer magnification. How
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
53 many times bigger the output buffer
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
54 should be than the input buffer. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
55 int stack_idx; /* How deep the call of CCL_Call is nested. */
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
56 int eol_type; /* When the CCL program is used for
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
57 encoding by a coding system, set to
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
58 the eol_type of the coding
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
59 system. */
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
60 int multibyte; /* 1 if the source text is multibyte. */
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
61 };
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
62
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
63 #define CCL_MODE_ENCODING 0
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
64 #define CCL_MODE_DECODING 1
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
65
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
66 #define CCL_CODING_EOL_LF 0 /* Line-feed only, same as Emacs'
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
67 internal format. */
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
68 #define CCL_CODING_EOL_CRLF 1 /* Sequence of carriage-return and
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
69 line-feed. */
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
70 #define CCL_CODING_EOL_CR 2 /* Carriage-return only. */
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
71
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
72 /* Alist of fontname patterns vs corresponding CCL program. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
73 extern Lisp_Object Vfont_ccl_encoder_alist;
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
74
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
75 /* Setup fields of the structure pointed by CCL appropriately for the
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
76 execution of ccl program CCL_PROG (symbol or vector). */
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
77 extern int setup_ccl_program (struct ccl_program *, Lisp_Object);
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
78
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
79 extern int ccl_driver (struct ccl_program *, const unsigned char *,
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
80 unsigned_char_dynarr *, int, int *, int);
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
81
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
82 EXFUN (Fregister_ccl_program, 2);
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
83
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
84 extern Lisp_Object Qccl_program;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
85
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
86 /* Vector of CCL program names vs corresponding program data. */
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
87 extern Lisp_Object Vccl_program_table;
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
88
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
89 /* Symbols of ccl program have this property, a value of the property
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
90 is an index for Vccl_program_table. */
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
91 extern Lisp_Object Qccl_program_idx;
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
92
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
93 #endif /* INCLUDED_mule_ccl_h_ */