Mercurial > hg > xemacs-beta
view man/xemacs/major.texi @ 4967:0d4c9d0f6a8d
rewrite dynarr code
-------------------- ChangeLog entries follow: --------------------
src/ChangeLog addition:
2010-02-03 Ben Wing <ben@xemacs.org>
* device-x.c (x_get_resource_prefix):
* device-x.c (Fx_get_resource):
* device-x.c (Fx_get_resource_prefix):
* device-x.c (Fx_put_resource):
* dialog-msw.c:
* dialog-msw.c (handle_question_dialog_box):
* dired-msw.c (mswindows_sort_files):
* dired-msw.c (mswindows_get_files):
* extents.c (extent_fragment_sort_by_priority):
* extents.c (Fset_extent_parent):
* file-coding.c (coding_reader):
* file-coding.c (coding_writer):
* file-coding.c (gzip_convert):
* frame.c (generate_title_string):
* gutter.c (calculate_gutter_size_from_display_lines):
* indent.c (vmotion_1):
* lread.c (read_bit_vector):
* mule-coding.c (iso2022_decode):
* rangetab.c:
* rangetab.c (Fcopy_range_table):
* rangetab.c (Fget_range_table):
* rangetab.c (unified_range_table_copy_data):
* redisplay-msw.c (mswindows_output_string):
* redisplay-output.c (output_display_line):
* redisplay-output.c (redisplay_move_cursor):
* redisplay-output.c (redisplay_clear_bottom_of_window):
* redisplay-tty.c (tty_output_ichar_dynarr):
* redisplay-tty.c (set_foreground_to):
* redisplay-tty.c (set_background_to):
* redisplay-xlike-inc.c (XLIKE_output_string):
* redisplay.c (redisplay_window_text_width_string):
* redisplay.c (redisplay_text_width_string):
* redisplay.c (create_text_block):
* redisplay.c (SET_CURRENT_MODE_CHARS_PIXSIZE):
* redisplay.c (generate_fstring_runes):
* redisplay.c (regenerate_modeline):
* redisplay.c (ensure_modeline_generated):
* redisplay.c (real_current_modeline_height):
* redisplay.c (create_string_text_block):
* redisplay.c (regenerate_window):
* redisplay.c (REGEN_INC_FIND_START_END):
* redisplay.c (point_visible):
* redisplay.c (redisplay_window):
* redisplay.c (mark_glyph_block_dynarr):
* redisplay.c (line_start_cache_start):
* redisplay.c (start_with_line_at_pixpos):
* redisplay.c (update_line_start_cache):
* redisplay.c (glyph_to_pixel_translation):
* redisplay.c (pixel_to_glyph_translation):
* sysdep.c (qxe_readdir):
* text.c (dfc_convert_to_external_format):
* text.c (dfc_convert_to_internal_format):
* toolbar-common.c (common_output_toolbar_button):
* window.c (window_modeline_height):
* window.c (Fwindow_last_line_visible_height):
* window.c (window_displayed_height):
* window.c (window_scroll):
* window.c (get_current_pixel_pos):
Use Dynarr_begin() in place of Dynarr_atp (foo, 0).
* dynarr.c (Dynarr_realloc):
* dynarr.c (Dynarr_lisp_realloc):
* dynarr.c (Dynarr_resize):
* dynarr.c (Dynarr_insert_many):
* dynarr.c (Dynarr_delete_many):
* dynarr.c (Dynarr_memory_usage):
* dynarr.c (stack_like_malloc):
* dynarr.c (stack_like_free):
* lisp.h:
* lisp.h (DECLARE_DYNARR_LISP_IMP):
* lisp.h (XD_DYNARR_DESC):
* lisp.h (Dynarr_pop):
* gutter.c (output_gutter):
* redisplay-output.c (sync_rune_structs):
* redisplay-output.c (redisplay_output_window):
Redo the dynarr code, add greater checks.
Rename the `len', `largest' and `max' members to `len_',
`largest_' and `max_' to try and catch existing places that might
directly modify these values. Make new accessors Dynarr_largest()
and Dynarr_max() and make them and existing Dynarr_length() be
non-lvalues by adding '+ 0' to them; fix a couple of places in the
redisplay code that tried to modify the length directly by setting
Dynarr_length(). Use the accessors whenever possible even in the
dynarr code itself. The accessors also verify that 0 <= len <=
largest <= max. Rename settor function Dynarr_set_size() to
Dynarr_set_length() and use it more consistently; also create
lower-level Dynarr_set_length_1(). This latter function should be
the only function that directly modifies the `len_' member of a
Dynarr, and in the process makes sure that the `largest' value is
kept correct.
Consistently use ERROR_CHECK_STRUCTURES instead of
ERROR_CHECK_TYPES for error-checking code. Reintroduce the
temporarily disabled verification code on the positions of
Dynarr_at(), Dynarr_atp() and Dynarr_atp_past_end().
Also create Dynarr_resize_if() in place of a repeated
code fragment. Clean up all the functions that modify Dynarrs to
use the new macros and functions and verify the correctness of the
Dynarr both before and after the change.
Note that there are two kinds of verification -- one for accessing
and one for modifying. The difference is that the modify
verification additionally checks to make sure that the Dynarr
isn't locked. (This is used in redisplay to check for problems
with reentrancy.)
* lrecord.h: Move XD_DYNARR_DESC to lisp.h, grouping with the dynarr code.
author | Ben Wing <ben@xemacs.org> |
---|---|
date | Wed, 03 Feb 2010 20:51:18 -0600 |
parents | 40dc584fce16 |
children |
line wrap: on
line source
@node Major Modes, Indentation, Mule, Top @chapter Major Modes @cindex major modes @kindex TAB @kindex DEL @kindex LFD Emacs has many different @dfn{major modes}, each of which customizes Emacs for editing text of a particular sort. The major modes are mutually exclusive; at any time, each buffer has one major mode. The mode line normally contains the name of the current major mode in parentheses. @xref{Mode Line}. The least specialized major mode is called @dfn{Fundamental mode}. This mode has no mode-specific redefinitions or variable settings. Each Emacs command behaves in its most generic manner, and each option is in its default state. For editing any specific type of text, such as Lisp code or English text, you should switch to the appropriate major mode, such as Lisp mode or Text mode. Selecting a major mode changes the meanings of a few keys to become more specifically adapted to the language being edited. @key{TAB}, @key{DEL}, and @key{LFD} are changed frequently. In addition, commands which handle comments use the mode to determine how to delimit comments. Many major modes redefine the syntactical properties of characters appearing in the buffer. @xref{Syntax}. The major modes fall into three major groups. Programming modes (@pxref{Programs}) are for specific programming languages. They tend to be line-oriented, often enforcing indentation. They emphasize facilities for creating and displaying structure. Text modes (like Nroff mode, @TeX{} mode, Outline mode, XML mode, etc.@:) are for editing human readable text. The remaining major modes are not intended for direct use in editing user files; they are used in buffers created by Emacs for specific purposes. Examples of such modes include Dired mode which is used for buffers made by Dired (@pxref{Dired}), Mail mode for buffers made by @kbd{C-x m} (@pxref{Sending Mail}), and Shell mode for buffers used for communicating with an inferior shell process (@pxref{Interactive Shell}). Most programming language major modes specify that only blank lines separate paragraphs. This is so that the paragraph commands remain useful. @xref{Paragraphs}. They also cause Auto Fill minor mode to use the definition of @key{TAB} to indent the new lines it creates. This is because most lines in a program are usually indented. @xref{Indentation}. @menu * Choosing Modes:: How major modes are specified or chosen. * Mode Hooks:: Customizing a major mode @end menu @node Choosing Modes, Mode Hooks, Major Modes, Major Modes @section Choosing Major Modes You can select a major mode explicitly for the current buffer, but most of the time Emacs determines which mode to use based on the file name or some text in the file. Use a @kbd{M-x} command to explicitly select a new major mode. Add @code{-mode} to the name of a major mode to get the name of a command to select that mode. For example, to enter Lisp mode, execute @kbd{M-x lisp-mode}. @vindex auto-mode-alist When you visit a file, Emacs usually chooses the right major mode based on the file's name. For example, files whose names end in @code{.c} are edited in C mode. The variable @code{auto-mode-alist} controls the correspondence between file names and major mode. Its value is a list in which each element has the form: @example (@var{regexp} . @var{mode-function}) @end example @noindent For example, one element normally found in the list has the form @code{(@t{"\\.c$"} . c-mode)}. It is responsible for selecting C mode for files whose names end in @file{.c}. (Note that @samp{\\} is needed in Lisp syntax to include a @samp{\} in the string, which is needed to suppress the special meaning of @samp{.} in regexps.) The only practical way to change this variable is with Lisp code. You can specify which major mode should be used for editing a certain file by a special sort of text in the first non-blank line of the file. The mode name should appear in this line both preceded and followed by @samp{-*-}. Other text may appear on the line as well. For example, @example ;-*-Lisp-*- @end example @noindent tells Emacs to use Lisp mode. Note how the semicolon is used to make Lisp treat this line as a comment. Such an explicit specification overrides any default mode based on the file name. Another format of mode specification is: @example -*-Mode: @var{modename};-*- @end example @noindent which allows other things besides the major mode name to be specified. However, Emacs does not look for anything except the mode name. The major mode can also be specified in a local variables list. @xref{File Variables}. @vindex default-major-mode When you visit a file that does not specify a major mode to use, or when you create a new buffer with @kbd{C-x b}, Emacs uses the major mode specified by the variable @code{default-major-mode}. Normally this value is the symbol @code{fundamental-mode}, which specifies Fundamental mode. If @code{default-major-mode} is @code{nil}, the major mode is taken from the previously selected buffer. @node Mode Hooks, , Choosing Modes, Major Modes @section Mode Hook Variables @cindex Hook variables @cindex mode hook @findex add-hook @findex remove-hook @vindex lisp-mode-hook @vindex emacs-lisp-mode-hook @vindex lisp-interaction-mode-hook @vindex scheme-mode-hook The last step taken by a major mode, by convention, is to invoke a list of user supplied functions that are stored in a @dfn{hook} variable. This allows a user to further customize the major mode, and is particularly convenient for associating minor modes with major modes. @xref{Minor Modes}. For example, to automatically turn on the Auto Fill minor mode when Text mode is invoked, add the following code to the initialization file (@pxref{Init File}) @example (add-hook 'text-mode-hook 'turn-on-auto-fill) @end example Derived modes often @dfn{inherit} the parent mode's hooks. For example, Texinfo Mode is derived from Text Mode, so customizing @code{text-mode-hook} as above will also enable Auto Fill minor mode in buffers containing Texinfo files. Hooks are also commonly used to set up buffer local variables (@pxref{Locals}). The name of the hook variable is created by appending the string @code{-hook} to the name of the function used to invoke the major mode. For example, as seen above, the hook variable used by Text Mode would be named @code{text-mode-hook}. By convention the mode hook function receives no arguments. If a hook variable does not exist, or it has the value @code{nil}, the major mode simply ignores it. The recommended way to add functions to a hook variable is with the @code{add-hook} function. @code{add-hook} will check that the function is not already listed in the hook variable before adding it. It will also create a hook variable with the value @code{nil} if one does not exist before adding the function. @code{add-hook} adds functions to the front of the hook variable list. This means that the last hook added is run first by the major mode. It is considered very poor style to write hook functions that depend on the order that hooks are executed. Hooks can be removed from hook variables with @code{remove-hook}.