annotate modules/README @ 5045:c3cc3fa503a2

more frame-sizing cleanups -------------------- ChangeLog entries follow: -------------------- man/ChangeLog addition: 2010-02-16 Ben Wing <ben@xemacs.org> * internals/internals.texi (Top): * internals/internals.texi (Modules for the Basic Displayable Lisp Objects): * internals/internals.texi (Creating a Window-System Type): * internals/internals.texi (Window and Frame Geometry): * internals/internals.texi (Intro to Window and Frame Geometry): * internals/internals.texi (The Frame): * internals/internals.texi (The Non-Client Area): * internals/internals.texi (The Client Area): * internals/internals.texi (The Paned Area): * internals/internals.texi (Text Areas): * internals/internals.texi (The Displayable Area): * internals/internals.texi (Which Functions Use Which?): * internals/internals.texi (The Redisplay Mechanism): Integrate the long comment in frame.c into the internals manual. src/ChangeLog addition: 2010-02-16 Ben Wing <ben@xemacs.org> * frame-impl.h: * frame-impl.h (FRAME_INTERNAL_BORDER_WIDTH): * frame-impl.h (FRAME_REAL_TOOLBAR_BOUNDS): * frame-impl.h (FRAME_REAL_TOP_TOOLBAR_BOUNDS): * frame-impl.h (FRAME_BOTTOM_BORDER_START): * frame-impl.h (FRAME_LEFT_BORDER_START): * frame-impl.h (FRAME_RIGHT_BORDER_START): * frame.c (frame_conversion_internal_1): * frame.c (change_frame_size_1): * redisplay-output.c (clear_left_border): * redisplay-output.c (clear_right_border): * redisplay-output.c (redisplay_clear_top_of_window): * redisplay-output.c (redisplay_clear_to_window_end): * redisplay-output.c (redisplay_clear_bottom_of_window): Rename FRAME_BORDER_* to FRAME_INTERNAL_BORDER_*. Add general FRAME_INTERNAL_BORDER_SIZE(). Add FRAME_REAL_TOOLBAR_BOUNDS() to encompass the entire size of the toolbar including its border. Add specific top/left/bottom/right versions of this macro. Rewrite FRAME_*_BORDER_START and FRAME_*_BORDER_END to take into use FRAME_REAL_*_TOOLBAR_BOUNDS(). Add some comments about existing problems in frame sizing and how they might be fixed. Simplify change_frame_size_1() using the macros just created.
author Ben Wing <ben@xemacs.org>
date Tue, 16 Feb 2010 01:21:32 -0600
parents 25e260cb7994
children da1365dd3f07
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
996
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
1 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
2 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
3 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
4 "(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
5 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
6 succeed.
388
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
7
996
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
8 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
9 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
10 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
11 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
12 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
13 'require' will then load the module, as described above.
388
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
14
996
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
15 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
16 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
17 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
18 can be found in the ../info directory.
388
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
19
996
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
20 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
21 'sample' directory. It contains two subdirectories: internal and
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
22 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
23 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
24 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
25 'external' subdirectory contains the somewhat simpler framework needed
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
26 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
27 starting places for module writing.