Mercurial > hg > xemacs-beta

comparison man/lispref/range-tables.texi @ 2421:ab71ad6ff3dd

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[xemacs-hg @ 2004-12-06 03:50:53 by ben] (none) README.packages: Document use of --package-prefix. Fix error in specifying standard package location. make-docfile.c: Use QXE_PATH_MAX. info.el: Correct doc string giving example package path. menubar-items.el: Move Prefix Rectangle command up one level. xemacs/packages.texi: Add long form of Lisp Reference Manual to links. Add links pointing to Lisp Reference Manual for more detailed package discussion. lispref/range-tables.texi: Document range-table changes. internals/internals.texi: Update history section. elhash.c, elhash.h, profile.c: Create inchash_eq() to allow direct incrementing of hash-table entry. Use in profile.c to try to reduce profiling overhead. Increase initial size of profile hash tables to reduce profiling overhead. buffer.c, device-msw.c, dialog-msw.c, dired-msw.c, editfns.c, event-msw.c, events.c, glyphs-msw.c, keymap.c, objects-msw.c, process-nt.c, syswindows.h, text.c, text.h, unexnt.c: Rename xetcs* -> qxetcs* for consistency with qxestr*. Rename ei*_c(_*) -> ei*_ascii(_*) since they work with ASCII-only strings not "C strings", whatever those are. This is the last place where "c" was incorrectly being used for "ascii". dialog-msw.c, dumper.c, event-msw.c, fileio.c, glyphs-gtk.c, glyphs-x.c, nt.c, process-nt.c, realpath.c, sysdep.c, sysfile.h, unexcw.c, unexnext.c, unexnt.c: Try to avoid differences in systems that do or do not include final null byte in PATH_MAX. Create PATH_MAX_INTERNAL and PATH_MAX_EXTERNAL and use them everywhere. Rewrite code in dumper.c to avoid use of PATH_MAX. When necessary in nt.c, use _MAX_PATH instead of MAX_PATH to be consistent with other places. text.c: Code to short-circuit when binary or Unicode was not working due to EOL wrapping. Fix this code to work when either no EOL autodetection or no CR's or LF's in the text. lisp.h, rangetab.c, rangetab.h, regex.c, search.c: Implement different types of ranges (open/closed start and end). Change default to be start-closed, end-open.
author ben
date Mon, 06 Dec 2004 03:52:23 +0000
parents 576fb035e263
children 6772ce4d982b
comparison
equal deleted inserted replaced
2420:ad56e5a6d09f 2421:ab71ad6ff3dd
11 ranges of integers. 11 ranges of integers.
12 12
13 Note that range tables have a read syntax, like this: 13 Note that range tables have a read syntax, like this:
14 14
15 @example 15 @example
16 #s(range-table data ((-3 2) foo (5 20) bar)) 16 #s(range-table type start-closed-end-open data ((-3 2) foo (5 20) bar))
17 @end example 17 @end example
18 18
19 This maps integers in the range (-3, 2) to @code{foo} and integers 19 This maps integers in the range [-3, 2) to @code{foo} and integers
20 in the range (5, 20) to @code{bar}. 20 in the range [5, 20) to @code{bar}.
21
22 By default, range tables have a @var{type} of
23 @code{start-closed-end-open}. (@strong{NOTE}: This is a change from
24 21.4 and earlier, where there was no @var{type} and range tables were always
25 closed on both ends.) This makes them work like text properties.
21 26
22 @defun range-table-p object 27 @defun range-table-p object
23 Return non-@code{nil} if @var{object} is a range table. 28 Return non-@code{nil} if @var{object} is a range table.
24 @end defun 29 @end defun
25 30
30 @end menu 35 @end menu
31 36
32 @node Introduction to Range Tables 37 @node Introduction to Range Tables
33 @section Introduction to Range Tables 38 @section Introduction to Range Tables
34 39
35 @defun make-range-table 40 @defun make-range-table &optional type
36 Make a new, empty range table. 41 Make a new, empty range table.
42
43 @var{type} is a symbol indicating how ranges are assumed to function
44 at their ends. It can be one of
45
46 @example
47 SYMBOL RANGE-START RANGE-END
48 ------ ----------- ---------
49 `start-closed-end-open' (the default) closed open
50 `start-closed-end-closed' closed closed
51 `start-open-end-open' open open
52 `start-open-end-closed' open closed
53 @end example
54
55 A @dfn{closed} endpoint of a range means that the number at that end
56 is included in the range. For an @dfn{open} endpoint, the number
57 would not be included.
58
59 For example, a closed-open range from 5 to 20 would be indicated as
60 @samp{[5, 20)} where a bracket indicates a closed end and a
61 parenthesis an open end, and would mean `all the numbers between 5 and
62 20', including 5 but not 20. This seems a little strange at first but
63 is in fact extremely common in the outside world as well as in
64 computers and makes things work sensibly. For example, if I say
65 "there are seven days between today and next week today", I'm
66 including today but not next week today; if I included both, there
67 would be eight days. Similarly, there are 15 (= 20 - 5) elements in
68 the range @samp{[5, 20)}, but 16 in the range @samp{[5, 20]}.
37 @end defun 69 @end defun
38 70
39 @defun copy-range-table range-table 71 @defun copy-range-table range-table
40 This function returns a new range table which contains the same values 72 This function returns a new range table which contains the same values
41 for the same ranges as @var{range-table}. The values will not 73 for the same ranges as @var{range-table}. The values will not
47 79
48 @defun get-range-table pos range-table &optional default 80 @defun get-range-table pos range-table &optional default
49 This function finds value for position @var{pos} in @var{range-table}. 81 This function finds value for position @var{pos} in @var{range-table}.
50 If there is no corresponding value, return @var{default} (defaults to 82 If there is no corresponding value, return @var{default} (defaults to
51 @code{nil}). 83 @code{nil}).
84
85 @strong{NOTE}: If you are working with ranges that are closed at the
86 start and open at the end (the default), and you put a value for a
87 range with @var{start} equal to @var{end}, @code{get-range-table} will
88 @strong{not} return that value! You would need to set @var{end} one
89 greater than @var{start}.
52 @end defun 90 @end defun
53 91
54 @defun put-range-table start end value range-table 92 @defun put-range-table start end value range-table
55 This function sets the value for range (@var{start}, @var{end}) to be 93 This function sets the value for range (@var{start}, @var{end}) to be
56 @var{value} in @var{range-table}. 94 @var{value} in @var{range-table}.
95
96 @strong{NOTE}: Unless you are working with ranges that are closed at
97 both ends, nothing will happen if @var{start} equals @var{end}.
57 @end defun 98 @end defun
58 99
59 @defun remove-range-table start end range-table 100 @defun remove-range-table start end range-table
60 This function removes the value for range (@var{start}, @var{end}) in 101 This function removes the value for range (@var{start}, @var{end}) in
61 @var{range-table}. 102 @var{range-table}.