annotate modules/sample/sample.c @ 826:6728e641994e

[xemacs-hg @ 2002-05-05 11:30:15 by ben] syntax cache, 8-bit-format, lots of code cleanup README.packages: Update info about --package-path. i.c: Create an inheritable event and pass it on to XEmacs, so that ^C can be handled properly. Intercept ^C and signal the event. "Stop Build" in VC++ now works. bytecomp-runtime.el: Doc string changes. compat.el: Some attempts to redo this to make it truly useful and fix the "multiple versions interacting with each other" problem. Not yet done. Currently doesn't work. files.el: Use with-obsolete-variable to avoid warnings in new revert-buffer code. xemacs.mak: Split up CFLAGS into a version without flags specifying the C library. The problem seems to be that minitar depends on zlib, which depends specifically on libc.lib, not on any of the other C libraries. Unless you compile with libc.lib, you get errors -- specifically, no _errno in the other libraries, which must make it something other than an int. (#### But this doesn't seem to obtain in XEmacs, which also uses zlib, and can be linked with any of the C libraries. Maybe zlib is used differently and doesn't need errno, or maybe XEmacs provides an int errno; ... I don't understand. Makefile.in.in: Fix so that packages are around when testing. abbrev.c, alloc.c, buffer.c, buffer.h, bytecode.c, callint.c, casefiddle.c, casetab.c, casetab.h, charset.h, chartab.c, chartab.h, cmds.c, console-msw.h, console-stream.c, console-x.c, console.c, console.h, data.c, device-msw.c, device.c, device.h, dialog-msw.c, dialog-x.c, dired-msw.c, dired.c, doc.c, doprnt.c, dumper.c, editfns.c, elhash.c, emacs.c, eval.c, event-Xt.c, event-gtk.c, event-msw.c, event-stream.c, events.c, events.h, extents.c, extents.h, faces.c, file-coding.c, file-coding.h, fileio.c, fns.c, font-lock.c, frame-gtk.c, frame-msw.c, frame-x.c, frame.c, frame.h, glade.c, glyphs-gtk.c, glyphs-msw.c, glyphs-msw.h, glyphs-x.c, glyphs.c, glyphs.h, gui-msw.c, gui-x.c, gui.h, gutter.h, hash.h, indent.c, insdel.c, intl-win32.c, intl.c, keymap.c, lisp-disunion.h, lisp-union.h, lisp.h, lread.c, lrecord.h, lstream.c, lstream.h, marker.c, menubar-gtk.c, menubar-msw.c, menubar-x.c, menubar.c, minibuf.c, mule-ccl.c, mule-charset.c, mule-coding.c, mule-wnnfns.c, nas.c, objects-msw.c, objects-x.c, opaque.c, postgresql.c, print.c, process-nt.c, process-unix.c, process.c, process.h, profile.c, rangetab.c, redisplay-gtk.c, redisplay-msw.c, redisplay-output.c, redisplay-x.c, redisplay.c, redisplay.h, regex.c, regex.h, scrollbar-msw.c, search.c, select-x.c, specifier.c, specifier.h, symbols.c, symsinit.h, syntax.c, syntax.h, syswindows.h, tests.c, text.c, text.h, tooltalk.c, ui-byhand.c, ui-gtk.c, unicode.c, win32.c, window.c: Another big Ben patch. -- FUNCTIONALITY CHANGES: add partial support for 8-bit-fixed, 16-bit-fixed, and 32-bit-fixed formats. not quite done yet. (in particular, needs functions to actually convert the buffer.) NOTE: lots of changes to regex.c here. also, many new *_fmt() inline funs that take an Internal_Format argument. redo syntax cache code. make the cache per-buffer; keep the cache valid across calls to functions that use it. also keep it valid across insertions/deletions and extent changes, as much as is possible. eliminate the junky regex-reentrancy code by passing in the relevant lisp info to the regex routines as local vars. add general mechanism in extents code for signalling extent changes. fix numerous problems with the case-table implementation; yoshiki never properly transferred many algorithms from old-style to new-style case tables. redo char tables to support a default argument, so that mapping only occurs over changed args. change many chartab functions to accept Lisp_Object instead of Lisp_Char_Table *. comment out the code in font-lock.c by default, because font-lock.el no longer uses it. we should consider eliminating it entirely. Don't output bell as ^G in console-stream when not a TTY. add -mswindows-termination-handle to interface with i.c, so we can properly kill a build. add more error-checking to buffer/string macros. add some additional buffer_or_string_() funs. -- INTERFACE CHANGES AFFECTING MORE CODE: switch the arguments of write_c_string and friends to be consistent with write_fmt_string, which must have printcharfun first. change BI_* macros to BYTE_* for increased clarity; similarly for bi_* local vars. change VOID_TO_LISP to be a one-argument function. eliminate no-longer-needed CVOID_TO_LISP. -- char/string macro changes: rename MAKE_CHAR() to make_emchar() for slightly less confusion with make_char(). (The former generates an Emchar, the latter a Lisp object. Conceivably we should rename make_char() -> wrap_char() and similarly for make_int(), make_float().) Similar changes for other *CHAR* macros -- we now consistently use names with `emchar' whenever we are working with Emchars. Any remaining name with just `char' always refers to a Lisp object. rename macros with XSTRING_* to string_* except for those that reference actual fields in the Lisp_String object, following conventions used elsewhere. rename set_string_{data,length} macros (the only ones to work with a Lisp_String_* instead of a Lisp_Object) to set_lispstringp_* to make the difference clear. try to be consistent about caps vs. lowercase in macro/inline-fun names for chars and such, which wasn't the case before. we now reserve caps either for XFOO_ macros that reference object fields (e.g. XSTRING_DATA) or for things that have non-function semantics, e.g. directly modifying an arg (BREAKUP_EMCHAR) or evaluating an arg (any arg) more than once. otherwise, use lowercase. here is a summary of most of the macros/inline funs changed by all of the above changes: BYTE_*_P -> byte_*_p XSTRING_BYTE -> string_byte set_string_data/length -> set_lispstringp_data/length XSTRING_CHAR_LENGTH -> string_char_length XSTRING_CHAR -> string_emchar INTBYTE_FIRST_BYTE_P -> intbyte_first_byte_p INTBYTE_LEADING_BYTE_P -> intbyte_leading_byte_p charptr_copy_char -> charptr_copy_emchar LEADING_BYTE_* -> leading_byte_* CHAR_* -> EMCHAR_* *_CHAR_* -> *_EMCHAR_* *_CHAR -> *_EMCHAR CHARSET_BY_ -> charset_by_* BYTE_SHIFT_JIS* -> byte_shift_jis* BYTE_BIG5* -> byte_big5* REP_BYTES_BY_FIRST_BYTE -> rep_bytes_by_first_byte char_to_unicode -> emchar_to_unicode valid_char_p -> valid_emchar_p Change intbyte_strcmp -> qxestrcmp_c (duplicated functionality). -- INTERFACE CHANGES AFFECTING LESS CODE: use DECLARE_INLINE_HEADER in various places. remove '#ifdef emacs' from XEmacs-only files. eliminate CHAR_TABLE_VALUE(), which duplicated the functionality of get_char_table(). add BUFFER_TEXT_LOOP to simplify iterations over buffer text. define typedefs for signed and unsigned types of fixed sizes (INT_32_BIT, UINT_32_BIT, etc.). create ALIGN_FOR_TYPE as a higher-level interface onto ALIGN_SIZE; fix code to use it. add charptr_emchar_len to return the text length of the character pointed to by a ptr; use it in place of charcount_to_bytecount(..., 1). add emchar_len to return the text length of a given character. add types Bytexpos and Charxpos to generalize Bytebpos/Bytecount and Charbpos/Charcount, in code (particularly, the extents code and redisplay code) that works with either kind of index. rename redisplay struct params with names such as `charbpos' to e.g. `charpos' when they are e.g. a Charxpos, not a Charbpos. eliminate xxDEFUN in place of DEFUN; no longer necessary with changes awhile back to doc.c. split up big ugly combined list of EXFUNs in lisp.h on a file-by-file basis, since other prototypes are similarly split. rewrite some "*_UNSAFE" macros as inline funs and eliminate the _UNSAFE suffix. move most string code from lisp.h to text.h; the string code and text.h code is now intertwined in such a fashion that they need to be in the same place and partially interleaved. (you can't create forward references for inline funs) automated/lisp-tests.el, automated/symbol-tests.el, automated/test-harness.el: Fix test harness to output FAIL messages to stderr when in batch mode. Fix up some problems in lisp-tests/symbol-tests that were causing spurious failures.
author ben
date Sun, 05 May 2002 11:33:57 +0000
parents abe6d1db359e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
388
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
1 /*
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
2 * Very simple sample module. Illustrates most of the salient features
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
3 * of Emacs dynamic modules.
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
4 * (C) Copyright 1998, 1999 J. Kean Johnston. All rights reserved.
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
5 */
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
6
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
7 #include <emodules.h>
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
8
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
9 /*
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
10 * This sample introduces three new Lisp objects to the Lisp reader.
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
11 * The first, a simple boolean value, and the second a string. The
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
12 * Third is a sample function that simply prints a message.
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
13 */
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
14 int sample_bool;
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
15 Lisp_Object Vsample_string;
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
16
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
17 DEFUN ("sample-function", Fsample_function, 0, 0, "", /*
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
18 This is a sample function loaded dynamically.
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
19
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
20 You will notice in the source code for this module that the
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
21 declaration is identical to internal Emacs functions. This
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
22 makes it possible to use the exact same code in a dumped
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
23 version of Emacs.
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
24 */
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
25 ())
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
26 {
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
27 message ("Eureka! It worked");
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
28 return Qt;
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
29 }
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
30
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
31 /*
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
32 * Each dynamically loaded Emacs module is given a name at compile
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
33 * time. This is a short name, and must be a valid part of a C
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 388
diff changeset
34 * identifier. This name is used to construct the name of several
388
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
35 * functions which must appear in the module source code.
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 388
diff changeset
36 * The first such function, modules_of_XXXX, should load in any dependent
388
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
37 * modules. This function is optional, and the module will still load if
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
38 * it is not present in the module.
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
39 *
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
40 * The second function, which is NOT optional, is syms_of_XXXX, in which
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
41 * all functions that the module will be provided are declared. This
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
42 * function will contain calls to DEFSUBR().
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
43 *
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
44 * The third function, which is also NOT optional, is vars_of_XXXX, in
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
45 * which you declare all variables that the module provides. This
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
46 * function will contain calls to DEFVAR_LISP(), DEFVAR_BOOL() etc.
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
47 *
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
48 * When declaring functions and variables in the syms_of_XXXX and
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
49 * vars_of_XXXX functions, you use the exact same syntax that you
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
50 * would as if this module were being compiled into the pure Emacs.
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
51 *
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
52 * All three of these functions are declared as void functions,
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
53 * taking no parameters. Since this sample module is called 'sample',
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
54 * the functions will be named 'modules_of_sample', 'syms_of_sample'
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
55 * and 'vars_of_sample'.
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
56 */
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
57
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
58 void
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
59 modules_of_sample()
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
60 {
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
61 /*
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
62 * This function isn't actually required as we will not be loading
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 388
diff changeset
63 * in any dependent modules, but if we were, we would do something like:
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 388
diff changeset
64 * emodules_load ("dependent.ell", "sample2", "1.0.0");
388
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
65 */
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
66 }
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
67
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
68 void
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
69 syms_of_sample()
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
70 {
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
71 DEFSUBR(Fsample_function);
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
72 }
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
73
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
74 void
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
75 vars_of_sample()
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
76 {
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
77 DEFVAR_LISP ("sample-string", &Vsample_string /*
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
78 This is a sample string, declared in a dynamic module.
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
79
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
80 The syntax and conventions used for all normal Emacs variables
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
81 apply equally to modules, using an identical syntax.
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
82 */ );
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
83
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
84 DEFVAR_BOOL ("sample-boolean", &sample_bool /*
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
85 *Sample boolean value, in a dynamic module.
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
86
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
87 This is a user-settable variable, as indicated by the *
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
88 as the first character of the description. Declared in
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
89 a module exactly as it would be internally in Emacs.
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
90 */ );
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
91 }
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
92