annotate lispref/README @ 18260:a642c99198ec

(PTR_TO_OFFSET): New macro. (POS_AS_IN_BUFFER): New macro. (SYNTAX_ENTRY_VIA_PROPERTY): Set to take `syntax-table' text property into account when doing SYNTAX (c). (re_compile_fastmap): disable fastmap if any of wordbound notwordbound wordbeg wordend notsyntaxspec syntaxspec are seen. (re_search_2): SETUP_SYNTAX_TABLE_FOR_OBJECT at the start. (re_match_object): New variable. (re_match_2): SETUP_SYNTAX_TABLE_FOR_OBJECT at the start. (re_match_2_internal): For any of wordbound notwordbound wordbeg wordend notsyntaxspec syntaxspec call UPDATE_SYNTAX_TABLE before doing SYNTAX (c). [emacs]: Include charset.h and category.h [!emacs] (BASE_LEADING_CODE_P, WORD_BOUNDARY_P, CHAR_HEAD_P, SINGLE_BYTE_CHAR_P, SAME_CHARSET_P, MULTIBYTE_FORM_LENGTH, STRING_CHAR_AND_LENGTH, GET_CHAR_AFTER_2, GET_CHAR_BEFORE_2): New dummy macros. (enum re_opcode_t): New member categoryspec and notcategoryspec. (STORE_CHARACTER_AND_INCR, EXTRACT_CHARACTER, CHARSET_LOOKUP_RANGE_TABLE_WITH_COUNT, CHARSET_LOOKUP_RANGE_TABLE, CHARSET_BITMAP_SIZE, CHARSET_RANGE_TABLE_EXISTS_P, CHARSET_RANGE_TABLE CHARSET_PAST_RANGE_TABLE): New macros. (TRANSLATE): Cast return value to unsigned char, not char. (struct range_table_work_area): New structure. (EXTEND_RANGE_TABLE_WORK_AREA, SET_RANGE_TABLE_WORK_AREA, FREE_RANGE_TABLE_WORK_AREA, CLEAR_RANGE_TABLE_WORK_USED, RANGE_TABLE_WORK_USED, RANGE_TABLE_WORK_ELT): New macros. (FREE_STACK_RETURN): Call FREE_RANGE_TABLE_WORK_AREA. (regex_compile): Declare `c' and `c1' as int to store multibyte characters. Declare range_table_work and initialize it. Initialize bufp->multibyte to 0 if not emacs. For case '[' and `default', code re-written to handle multibyte characters. Add code for case 'c' and 'C' to handle category spec. (re_compile_fastmap): New local variables k, simple_char_max, and match_any_multibyte_characters. Use macro CHARSET_BITMAP_SIZE. Handle multibyte characters in cases charset, charset_not, wordchar, notwordchar, anychar, syntaxspec, notsyntaxspec, categoryspec, notcategoryspec. (STOP_ADDR_VSTRING, POS_ADDR_VSTRING): New macros. (re_search_2): Code re-written to handle multibyte characters. (AT_WORD_BOUNDARY): Macro disabled. (re_match_2_internal): New local variable multibyte. `d' is incremented while paying attention to multibyte characters if necessary. For case charset, charsetnot, wordbound, notwordbound, wordbeg, wordend, matchsyntax, and matchnotsyntax, code re-written to handle multibyte characters. Add code for case categoryspec and notcategoryspec. Declare c, c1 as unsigned int, not unsigned char.

README for Edition 2.4 of the Emacs Lisp Reference Manual.

* This directory contains the texinfo source files for the Reference
Manual, make-permuted-index, and the latest version of texinfo.tex,
which handles forms that cannot be handled by the older versions of
texinfo.tex.  Also, it contains makeinfo.c.

* Report Lisp Manual bugs to [e-mail].  We
don't read these bug reports until it's time for a new edition.  To
report other Emacs bugs, use [e-mail].
To ask questions, use the newsgroup gnu.emacs.help.

* The Emacs Lisp Reference Manual is quite large.  It totals around
700 pages in smallbook format; the info files total almost two
megabytes.

* You can format this manual either for Info or for printing hardcopy
using TeX.  

* You can buy nicely printed copies from the Free Software Foundation.
For info, send mail to [e-mail] or phone [phone].
Buying a manual from the Free Software Foundation helps support our
GNU development work.

** This distribution contains a Makefile that you can use with GNU Make.
Otherwise, here are detailed instructions:

** HARDCOPY: A copy of the version of `texinfo.tex' that formats this
manual is included in this distribution.

The master file for formatting this manual for Tex is called
`elisp.texi'.  It contains @include commands to include all the
chapters that make up the manual.  In addition, `elisp.texi' has
the title page in a new format designed by Karl Berry, using the
@titlespec command.

To create a DVI file with a sorted index, execute the following
commands in the shell:

% make index.texi
% make elisp.dvi

*** To create a DVI file with a permuted index, you may experiment
with `make-permuted-index'.  

** INFO: A copy of makeinfo.c that will format this manual for Info is
included in this distribution.  This program is written in C and can
be used separately from Emacs.  `makeinfo' produces much better error
messages than the old `texinfo-format-buffer'.  You can run `makeinfo'
it on the `elisp.texi' file.