annotate man/new-users-guide/modes.texi @ 5157:1fae11d56ad2

redo memory-usage mechanism, add way of dynamically initializing Lisp objects -------------------- ChangeLog entries follow: -------------------- lisp/ChangeLog addition: 2010-03-18 Ben Wing <ben@xemacs.org> * diagnose.el (show-memory-usage): Rewrite to take into account API changes in memory-usage functions. src/ChangeLog addition: 2010-03-18 Ben Wing <ben@xemacs.org> * alloc.c: * alloc.c (disksave_object_finalization_1): * alloc.c (lisp_object_storage_size): * alloc.c (listu): * alloc.c (listn): * alloc.c (Fobject_memory_usage_stats): * alloc.c (compute_memusage_stats_length): * alloc.c (Fobject_memory_usage): * alloc.c (Ftotal_object_memory_usage): * alloc.c (malloced_storage_size): * alloc.c (common_init_alloc_early): * alloc.c (reinit_alloc_objects_early): * alloc.c (reinit_alloc_early): * alloc.c (init_alloc_once_early): * alloc.c (syms_of_alloc): * alloc.c (reinit_vars_of_alloc): * buffer.c: * buffer.c (struct buffer_stats): * buffer.c (compute_buffer_text_usage): * buffer.c (compute_buffer_usage): * buffer.c (buffer_memory_usage): * buffer.c (buffer_objects_create): * buffer.c (syms_of_buffer): * buffer.c (vars_of_buffer): * console-impl.h (struct console_methods): * dynarr.c (Dynarr_memory_usage): * emacs.c (main_1): * events.c (clear_event_resource): * extents.c: * extents.c (compute_buffer_extent_usage): * extents.c (extent_objects_create): * extents.h: * faces.c: * faces.c (compute_face_cachel_usage): * faces.c (face_objects_create): * faces.h: * general-slots.h: * glyphs.c: * glyphs.c (compute_glyph_cachel_usage): * glyphs.c (glyph_objects_create): * glyphs.h: * lisp.h: * lisp.h (struct usage_stats): * lrecord.h: * lrecord.h (enum lrecord_type): * lrecord.h (struct lrecord_implementation): * lrecord.h (MC_ALLOC_CALL_FINALIZER_FOR_DISKSAVE): * lrecord.h (DEFINE_DUMPABLE_LISP_OBJECT): * lrecord.h (DEFINE_DUMPABLE_SIZABLE_LISP_OBJECT): * lrecord.h (DEFINE_DUMPABLE_FROB_BLOCK_LISP_OBJECT): * lrecord.h (DEFINE_DUMPABLE_FROB_BLOCK_SIZABLE_LISP_OBJECT): * lrecord.h (DEFINE_DUMPABLE_INTERNAL_LISP_OBJECT): * lrecord.h (DEFINE_DUMPABLE_SIZABLE_INTERNAL_LISP_OBJECT): * lrecord.h (DEFINE_NODUMP_LISP_OBJECT): * lrecord.h (DEFINE_NODUMP_SIZABLE_LISP_OBJECT): * lrecord.h (DEFINE_NODUMP_FROB_BLOCK_LISP_OBJECT): * lrecord.h (DEFINE_NODUMP_FROB_BLOCK_SIZABLE_LISP_OBJECT): * lrecord.h (DEFINE_NODUMP_INTERNAL_LISP_OBJECT): * lrecord.h (DEFINE_NODUMP_SIZABLE_INTERNAL_LISP_OBJECT): * lrecord.h (MAKE_LISP_OBJECT): * lrecord.h (DEFINE_DUMPABLE_MODULE_LISP_OBJECT): * lrecord.h (DEFINE_DUMPABLE_MODULE_SIZABLE_LISP_OBJECT): * lrecord.h (DEFINE_NODUMP_MODULE_LISP_OBJECT): * lrecord.h (DEFINE_NODUMP_MODULE_SIZABLE_LISP_OBJECT): * lrecord.h (MAKE_MODULE_LISP_OBJECT): * lrecord.h (INIT_LISP_OBJECT): * lrecord.h (INIT_MODULE_LISP_OBJECT): * lrecord.h (UNDEF_LISP_OBJECT): * lrecord.h (UNDEF_MODULE_LISP_OBJECT): * lrecord.h (DECLARE_LISP_OBJECT): * lrecord.h (DECLARE_MODULE_API_LISP_OBJECT): * lrecord.h (DECLARE_MODULE_LISP_OBJECT): * lstream.c: * lstream.c (syms_of_lstream): * lstream.c (vars_of_lstream): * marker.c: * marker.c (compute_buffer_marker_usage): * mc-alloc.c (mc_alloced_storage_size): * mc-alloc.h: * mule-charset.c: * mule-charset.c (struct charset_stats): * mule-charset.c (compute_charset_usage): * mule-charset.c (charset_memory_usage): * mule-charset.c (mule_charset_objects_create): * mule-charset.c (syms_of_mule_charset): * mule-charset.c (vars_of_mule_charset): * redisplay.c: * redisplay.c (compute_rune_dynarr_usage): * redisplay.c (compute_display_block_dynarr_usage): * redisplay.c (compute_glyph_block_dynarr_usage): * redisplay.c (compute_display_line_dynarr_usage): * redisplay.c (compute_line_start_cache_dynarr_usage): * redisplay.h: * scrollbar-gtk.c (gtk_compute_scrollbar_instance_usage): * scrollbar-msw.c (mswindows_compute_scrollbar_instance_usage): * scrollbar-x.c (x_compute_scrollbar_instance_usage): * scrollbar.c (compute_scrollbar_instance_usage): * scrollbar.h: * symbols.c: * symbols.c (reinit_symbol_objects_early): * symbols.c (init_symbols_once_early): * symbols.c (reinit_symbols_early): * symbols.c (defsymbol_massage_name_1): * symsinit.h: * ui-gtk.c: * ui-gtk.c (emacs_gtk_object_getprop): * ui-gtk.c (emacs_gtk_object_putprop): * ui-gtk.c (ui_gtk_objects_create): * unicode.c (compute_from_unicode_table_size_1): * unicode.c (compute_to_unicode_table_size_1): * unicode.c (compute_from_unicode_table_size): * unicode.c (compute_to_unicode_table_size): * window.c: * window.c (struct window_stats): * window.c (compute_window_mirror_usage): * window.c (compute_window_usage): * window.c (window_memory_usage): * window.c (window_objects_create): * window.c (syms_of_window): * window.c (vars_of_window): * window.h: Redo memory-usage mechanism, make it general; add way of dynamically initializing Lisp object types -- OBJECT_HAS_METHOD(), similar to CONSOLE_HAS_METHOD(). (1) Create OBJECT_HAS_METHOD(), OBJECT_HAS_PROPERTY() etc. for specifying that a Lisp object type has a particular method or property. Call such methods with OBJECT_METH, MAYBE_OBJECT_METH, OBJECT_METH_OR_GIVEN; retrieve properties with OBJECT_PROPERTY. Methods that formerly required a DEFINE_*GENERAL_LISP_OBJECT() to specify them (getprop, putprop, remprop, plist, disksave) now instead use the dynamic-method mechanism. The main benefit of this is that new methods or properties can be added without requiring that the declaration statements of all existing methods be modified. We have to make the `struct lrecord_implementation' non-const, but I don't think this should have any effect on speed -- the only possible method that's really speed-critical is the mark method, and we already extract those out into a separate (non-const) array for increased cache locality. Object methods need to be reinitialized after pdump, so we put them in separate functions such as face_objects_create(), extent_objects_create() and call them appropriately from emacs.c The only current object property (`memusage_stats_list') that objects can specify is a Lisp object and gets staticpro()ed so it only needs to be set during dump time, but because it references symbols that might not exist in a syms_of_() function, we initialize it in vars_of_(). There is also an object property (`num_extra_memusage_stats') that is automatically initialized based on `memusage_stats_list'; we do that in reinit_vars_of_alloc(), which is called after all vars_of_() functions are called. `disksaver' method was renamed `disksave' to correspond with the name normally given to the function (e.g. disksave_lstream()). (2) Generalize the memory-usage mechanism in `buffer-memory-usage', `window-memory-usage', `charset-memory-usage' into an object-type- specific mechanism called by a single function `object-memory-usage'. (Former function `object-memory-usage' renamed to `total-object-memory-usage'). Generalize the mechanism of different "slices" so that we can have different "classes" of memory described and different "slices" onto each class; `t' separates classes, `nil' separates slices. Currently we have three classes defined: the memory of an object itself, non-Lisp-object memory associated with the object (e.g. arrays or dynarrs stored as fields in the object), and Lisp-object memory associated with the object (other internal Lisp objects stored in the object). This isn't completely finished yet and we might need to further separate the "other internal Lisp objects" class into two classes. The memory-usage mechanism uses a `struct usage_stats' (renamed from `struct overhead_stats') to describe a malloc-view onto a set of allocated memory (listing how much was requested and various types of overhead) and a more general `struct generic_usage_stats' (with a `struct usage_stats' in it) to hold all statistics about object memory. `struct generic_usage_stats' contains an array of 32 Bytecounts, which are statistics of unspecified semantics. The intention is that individual types declare a corresponding struct (e.g. `struct window_stats') with the same structure but with specific fields in place of the array, corresponding to specific statistics. The number of such statistics is an object property computed from the list of tags (Lisp symbols describing the statistics) stored in `memusage_stats_list'. The idea here is to allow particular object types to customize the number and semantics of the statistics where completely avoiding consing. This doesn't matter so much yet, but the intention is to have the memory usage of all objects computed at the end of GC, at the same time as other statistics are currently computed. The values for all statistics for a single type would be added up to compute aggregate values for all objects of a specific type. To make this efficient, we can't allow any memory allocation at all. (3) Create some additional functions for creating lists that specify the elements directly as args rather than indirectly through an array: listn() (number of args given), listu() (list terminated by Qunbound). (4) Delete a bit of remaining unused C window_config stuff, also unused lrecord_type_popup_data.
author Ben Wing <ben@xemacs.org>
date Thu, 18 Mar 2010 10:50:06 -0500
parents 0784d089fdc9
children
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 @comment node-name, next, previous, up
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
2 @node Modes, Files, Help, Top
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
3 @chapter Major and Minor Modes
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
4 @cindex modes
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
5
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
6 XEmacs is @dfn{language sensitive}. It has several @dfn{major} and
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
7 @dfn{minor} modes. The major modes customize Emacs to edit text of a
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
8 particular sort. There are major modes for C, Lisp, Emacs Lisp, LaTeX,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
9 English etc. Within each major mode, certain functions and keys are
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
10 redefined to "suit" that particular sort of text. The minor modes
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
11 provide certain features which can be turned off or on at any
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
12 time. Emacs can only be in one major mode at any time, but it can turn
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
13 on several minor modes at the same time. After you have selected any
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
14 major or minor mode, you can select @b{Describe Mode} from the @b{Help}
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
15 menu and you will get documentation about those modes.
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 @comment node-name, next, previous, up
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
18 @menu
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
19 * Major Modes:: Choosing Major Modes
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
20 * Minor Modes:: Auto-Fill, Abbrev and other minor modes
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
21 @end menu
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
22
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
23 @node Major Modes, Minor Modes, Modes, Modes
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
24 @section Major Modes
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
25 @cindex major modes
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
26
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
27 Emacs has several major modes which customize Emacs to edit text of
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
28 various sorts. You can have only one major mode at any time. Within each
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
29 major mode, Emacs redefines certain functions (like cursor movement,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
30 indentation and text killing) to suit the needs of the text being
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
31 edited. When you are editing a specific type of text you should switch
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
32 to the appropriate mode. If you are working with C code, you should
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
33 switch to C mode; if you are working with Lisp code, then switch to lisp
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
34 mode and if you are working with English text switch to Text mode.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
35
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
36 When you open a file to work on, Emacs usually selects the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
37 appropriate mode. For example, if you open a file called @file{guide.c}
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
38 then Emacs will select the C mode because of the ".c" extension of the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
39 file. To explicitly select a mode type the following command:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
40
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
41 @example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
42 ;;; selects lisp mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
43 M-x lisp-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
44
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
45 ;;; selects C mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
46 M-x c-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
47 @end example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
48
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
49 @noindent
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
50 To select any other mode, just add the major mode name before the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
51 '-mode'. The current mode in which you are in will be displayed in
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
52 parenthesis in the mode-line at the bottom of the frame. All major
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
53 modes have some special keybindings and you can get a listing of those
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
54 keybindings by selecting @b{List Keybindings} from the @b{Help} menu on
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
55 the menu bar.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
56
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
57 Some of the available modes in XEmacs are :
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
58
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
59 @table @b
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
60 @item fundamental-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
61 @cindex fundamental-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
62 When you start XEmacs, usually you start with the default "Fundamental"
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
63 mode. This mode has no special definitions or settings.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
64
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
65 @item nroff-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
66 @cindex nroff-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
67 Use this mode when you have to format a text with nroff before it can be
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
68 available in readable form. It redefines some indentation
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
69 commands. @xref{Nroff Mode,,,xemacs,XEmacs User's Manual}, for information
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
70 on this mode.
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 @item tex-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
73 @cindex tex-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
74 Use this mode if you are using the LaTeX text-formatter. It provides
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
75 commands for insertion of quotes, braces and other characters. It also
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
76 allows you to format the buffer for printing. @xref{TeX
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
77 Mode,,,xemacs,XEmacs User's Manual}, for information on this mode.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
78
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
79 @item texinfo-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
80 @cindex texinfo-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
81 Texinfo is a documentation system that uses a single source file to
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
82 produce both printed output and on-line documentation. When you use this
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
83 mode, there will be some special keybindings for inserting some
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
84 characters and executing some commands.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
85
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
86 @ifinfo
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
87 This info file which you are reading right now is produced by 'Texinfo'
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
88 @end ifinfo
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
89 @iftex
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
90 This manual itself is produced by 'Texinfo'
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
91 @end iftex
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
92
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
93 @item outline-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
94 @cindex outline-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
95 Use this mode for editing outlines. When you enable this mode, you can
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
96 make part of the text temporarily invisible so that you can see the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
97 overall structure of the outline. @xref{Outline Mode,,,xemacs,XEmacs User's
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
98 Manual}, for information on this mode.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
99
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
100 @item c-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
101 @cindex c-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
102 Use this mode for C programs. It will redefine some indentation
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
103 commands. @xref{C Indent,,,xemacs,XEmacs User's Manual}.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
104
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
105 @item lisp-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
106 @cindex lisp-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
107 Use this mode for Lisp programs. Look at the XEmacs User's Manual for
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
108 more information.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
109
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
110 @item fortran-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
111 @cindex fortran-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
112 Use this mode for Fortran programs. This mode provides special commands
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
113 to move around and some other indentation commands. For more
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
114 information on this mode, @xref{Fortran,,,xemacs,XEmacs User's Manual}.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
115
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
116 @item edit-picture
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
117 @cindex edit-picture
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
118 This is the picture mode which you can use to create a picture out of
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
119 text characters. @xref{Picture,,,xemacs,XEmacs User's Manual}, for more
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
120 information.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
121
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
122 @item asm-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
123 @cindex asm-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
124 Use asm-mode for editing files of assembler code. Look at the file
462
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents: 442
diff changeset
125 @file{ /usr/local/lib/xemacs-VERSION/lisp/modes/asm.el} for more
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
126 information.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
127
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
128 @end table
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
129
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
130 There are some other modes and commands for working with other kinds of
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
131 text or programs. Emacs also provides commands for reading and sending
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
132 Mail. For more information on these features look at the XEmacs
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
133 Manual. Emacs also provides the functions of a desk calendar, with a
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
134 diary of past or planned events. For more information on the calendar
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
135 mode look at the manual for Calendar Mode and Diary.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
136
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
137 @comment node-name, next, previous, up
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
138 @node Minor Modes, , Major Modes, Modes
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
139 @section Minor Modes
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
140 @cindex minor modes
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
141
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
142 The minor modes in Emacs provide some optional features which you can
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
143 turn on or off. Any number of minor modes can be active at the same time
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
144 with any major mode. You can enable a minor mode in one buffer and
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
145 disable it in other mode. To enable a minor mode, for example the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
146 font-lock mode type the following command:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
147
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
148 @example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
149 M-x font-lock-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
150 @end example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
151 @noindent
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
152 To enable the other minor modes, replace the "font-lock" with the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
153 name of the minor mode. To disable the mode type the command again. A
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
154 positive argument will always turn the mode on. Whenever you type this
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
155 command, it will turn the mode on if it was off, OR it will turn it off
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
156 if it was on i.e. it toggles. Look at the mode-line at the bottom of the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
157 frame. If it says FLock in parentheses, then it means that this
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
158 mode is on, otherwise it is off.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
159
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
160 The following are some of the minor modes available in XEmacs. To enable
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
161 any one of them type "M-x" in front of them.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
162
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
163 @table @b
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
164 @item font-lock-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
165 @cindex font-lock-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
166
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
167 You can also choose this mode by selecting the @b{Syntax Highlighting}
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
168 menu item from the @b{Options} menu on the menu-bar at the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
169 top. If you wish to have this mode enabled permanently, choose
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
170 @b{Save Options} from the @b{Options} menu. @xref{Options Menu}, for
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
171 more information on the Options menu. You can also add statements in
462
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents: 442
diff changeset
172 your @file{init.el} file. For each major mode in which you wish to
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents: 442
diff changeset
173 enable this minor mode, you need a statement in your @file{init.el}
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
174 file. The following example shows how to enable the font-lock mode when
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
175 the major mode is c-mode.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
176
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
177 @example
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
178 (add-hook 'c-mode-hook 'turn-on-font-lock)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
179 @end example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
180
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
181 @noindent
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
182 @xref{Other Customizations}.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
183
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
184 When you enable this mode, the text will be displayed in
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
185 different colors and fonts depending on the type of the text. This makes
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
186 the text very easy to read and understand. For example, comments might
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
187 be displayed in red, variables in black, functions in blue and other
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
188 keywords in different colors and fonts. When you select @b{More} from
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
189 the @b{Syntax Highlighting} option, you get very detailed display of
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
190 colors and fonts; function names within comments themselves might appear
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
191 in a different font and color.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
192
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
193 @item auto-fill-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
194 @findex auto-fill-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
195 Enabling this mode will provide automatic word-wrapping. The @key{SPC}
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
196 key will break lines i.e. insert newlines as you type to prevent lines
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
197 from becoming too long.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
198
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
199 @item overwrite-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
200 @cindex overwrite-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
201 When you enable this mode, the text that you type will replace the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
202 existing text rather than moving it to the right (the default case). You
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
203 can enable this mode by selecting @b{Overstrike} menu-item from the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
204 @b{Options} menu from the menu-bar.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
205
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
206 @item abbrev-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
207 @cindex abbrev-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
208 After you enable this mode, you can define words which will expand into
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
209 some different text i.e. you can define abbreviations. For example, you
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
210 might define "expand" to "expand will eventually expand to this
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
211 text". After this definition you will be able to get "expand will
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
212 eventually expand to this text" simply by typing
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
213
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
214 @example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
215 expand @key{SPC}
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
216 @end example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
217
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
218 @noindent
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
219 @xref{Abbrevs,,,xemacs,XEmacs User's Manual}, for more information on this
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
220 mode and on defining abbreviations.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
221
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
222 @item auto-save-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
223 @cindex auto-save-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
224 After you enable this mode in a buffer, the contents of that buffer will
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
225 be saved periodically. This will reduce the amount you might lose in
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
226 case of a system crash.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
227
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
228 @item line-number-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
229 @cindex line-number-mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
230 After you enable this mode, the line number at which your cursor is
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
231 present will be displayed continuously in the mode line.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
232
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
233 @item blink-paren
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
234 @cindex blink-paren
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
235 To enable this command, just type
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
236 @example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
237 M-x blink-paren
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
238 @end example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
239
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
240 @noindent
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
241 Do not add the "-mode" to it. You can also select the @b{Paren
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
242 Highlighting} option from the @b{Options} menu. After you enable this
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
243 command, put your cursor on one of the left parenthesis. The other
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
244 matching parenthesis will start blinking. @xref{Options Menu}, for more
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
245 information on the @b{Paren Highlighting} option.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
246 @end table
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
247
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
248 For information on some other modes, look at the XEmacs User's Manual
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
249 and the associated files.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
250