annotate modules/README @ 5617:b0d712bbc2a6

The "flush" face property. -------------------- ChangeLog entries follow: -------------------- src/ChangeLog addition: 2011-12-23 Didier Verna <didier@xemacs.org> * faces.h (struct Lisp_Face): New 'flush slot. * faces.h (struct face_cachel): New 'flush and 'flush_specified flags. * faces.h (WINDOW_FACE_CACHEL_FLUSH_P): * faces.h (FACE_FLUSH_P): New macros. * faces.c: Declare Qflush. * lisp.h: Externalize it. * faces.c (syms_of_faces): Define it. * faces.c (vars_of_faces): Update built-in face specifiers. * faces.c (complex_vars_of_faces): Update specifier fallbacks. * faces.c (mark_face): * faces.c (face_equal): * faces.c (face_getprop): * faces.c (face_putprop): * faces.c (face_remprop): * faces.c (face_plist): * faces.c (reset_face): * faces.c (update_face_inheritance_mapper): * faces.c (Fmake_face): * faces.c (update_face_cachel_data): * faces.c (merge_face_cachel_data): * faces.c (Fcopy_face): * fontcolor.c (face_boolean_validate): Handle the flush property. * redisplay.h (struct display_line): Rename 'default_findex slot to clearer name 'clear_findex. * redisplay.h (DISPLAY_LINE_INIT): Update accordingly. * redisplay-output.c (compare_display_blocks): * redisplay-output.c (output_display_line): * redisplay-output.c (redisplay_output_window): * redisplay.c (regenerate_window_extents_only_changed): * redisplay.c (regenerate_window_incrementally): Update the comparison tests between the current and desired display lines to cope for different 'clear_findex values. * redisplay.c (create_text_block): Initialize the display line's 'clear_findex slot to DEFAULT_INDEX. Record a new 'clear_findex value when we encounter a newline character displayed in a flushed face. * redisplay.c (create_string_text_block): Record a new 'clear_findex value when we encounter a newline character displayed in a flushed face. lisp/ChangeLog addition: 2011-12-23 Didier Verna <didier@xemacs.org> * cl-macs.el (face-flush-p): New defsetf. * faces.el (set-face-property): Document the flush property. * faces.el (face-flush-p): New function. * faces.el (set-face-flush-p): New function. * faces.el (face-equal): * cus-face.el (custom-face-attributes): * x-faces.el (x-init-face-from-resources): * x-faces.el (make-face-x-resource-internal): Handle the flush property.
author Didier Verna <didier@xemacs.org>
date Fri, 23 Dec 2011 10:56:16 +0100
parents da1365dd3f07
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5436
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
1 This file is part of XEmacs.
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
2
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
3 XEmacs is free software: you can redistribute it and/or modify it
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
4 under the terms of the GNU General Public License as published by the
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
5 Free Software Foundation, either version 3 of the License, or (at your
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
6 option) any later version.
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
7
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
8 XEmacs is distributed in the hope that it will be useful, but WITHOUT
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
9 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
10 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
11 for more details.
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
12
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
13 You should have received a copy of the GNU General Public License
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
14 along with XEmacs. If not, see <http://www.gnu.org/licenses/>.
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
15
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
16
996
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
17 This directory contains a number of XEmacs dynamic modules. These
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
18 modules can be loaded directly with the command 'M-x load-module'.
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
19 However, the preferred method of loading a module is to issue a
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
20 "(require 'module-name)" command to the Lisp interpreter. This will
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
21 store information so that a later "(unload-feature 'module-name)" can
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
22 succeed.
388
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
23
996
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
24 To compile one of these modules, simply enter the desired directory,
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
25 type 'configure', and then 'make'. If you are building the module for
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
26 an installed XEmacs, then 'make install' will place the module in the
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
27 appropriate directory for XEmacs to find it later (assuming you have
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
28 permission to write to that directory). A subsequent 'load-module' or
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
29 'require' will then load the module, as described above.
388
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
30
996
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
31 Each of these demonstrates different features and limitations of the
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
32 XEmacs module loading technology. For a complete discussion on XEmacs
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
33 dynamic modules, please consult the XEmacs Module Writers Guide, which
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
34 can be found in the ../info directory.
388
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
35
996
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
36 For those wanting to get started with module writing, please see the
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
37 'sample' directory. It contains two subdirectories: internal and
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
38 external. The 'internal' subdirectory contains the framework needed to
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
39 migrate some core piece of XEmacs functionality into code that can
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
40 either be compiled into the core or built as a separate module. The
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
41 'external' subdirectory contains the somewhat simpler framework needed
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
42 to build a module separately from XEmacs. These should be considered
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
43 starting places for module writing.