annotate man/lispref/range-tables.texi @ 2417:8b907450718f

[xemacs-hg @ 2004-12-05 08:48:12 by ben] The section on Troubleshooting (now 2.3) has been completely written and includes a lot of stuff that is not properly documented anywhere else. A fair amount of obsolete info has been deleted and I've incorporated the comments that people (mostly Stephen T) made. Former chapter 3 has been split up in two, one pertaining to basic I/O and the other to external I/O. What were formerly chapters 5 and 6 no longer exist as such; the info in them has been distributed across various other chapters. Old chapter 4 got split up, part going to the new chapter 4 on external I/O and part going to the new chapter 5 on the Internet. In this new chapter, stuff not pertaining to a specific package (e.g. VM or GNUS) was taken out of package-specific sections and a general mail section was constituted. Part of old chapter 5 remains in a new chapter 6 devoted to Emacs Lisp and other advanced stuff, and a section from old chapter 3 on basic init-file Lisp and some stuff from old chapter 5 on Info. The rest of chapter 5 was just misc and has gotten scattered to the winds (mostly in chapters 3 and 4). Old chapter 6 has also gotten quite scattered; there is no longer any section specifically devoted to Windows except one of the Installation sections (along with a section specfically devoted to Unix), and the rest has moved to join the appropriate non-Windows-specific section elsewhere. A lot of chapters had their sections rearranged and likewise for sections having entries rearranged, with the intention that the new arrangement should be more natural. In general I hope that stuff should be much easier to locate. I also rewrote the entries on the relation between XEmacs and GNU Emacs on the authors of XEmacs, including lots of info on who wrote specific subsections. However, this history is certainly not complete; I hope people will look over this and fix it up as necessary.
author ben
date Sun, 05 Dec 2004 08:48:12 +0000
parents 576fb035e263
children ab71ad6ff3dd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
1 @c -*-texinfo-*-
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
2 @c This is part of the XEmacs Lisp Reference Manual.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
3 @c Copyright (C) 1996 Ben Wing.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
4 @c See the file lispref.texi for copying conditions.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
5 @setfilename ../../info/range-tables.info
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
6 @node Range Tables, Databases, Hash Tables, top
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
7 @chapter Range Tables
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
8 @cindex Range Tables
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
9
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
10 A range table is a table that efficiently associated values with
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
11 ranges of integers.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
12
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
13 Note that range tables have a read syntax, like this:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
14
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
15 @example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
16 #s(range-table data ((-3 2) foo (5 20) bar))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
17 @end example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
18
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
19 This maps integers in the range (-3, 2) to @code{foo} and integers
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
20 in the range (5, 20) to @code{bar}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
21
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
22 @defun range-table-p object
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
23 Return non-@code{nil} if @var{object} is a range table.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
24 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
25
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
26 @menu
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
27 * Introduction to Range Tables:: Range tables efficiently map ranges of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
28 integers to values.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
29 * Working With Range Tables:: Range table functions.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
30 @end menu
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
31
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
32 @node Introduction to Range Tables
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
33 @section Introduction to Range Tables
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
34
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
35 @defun make-range-table
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
36 Make a new, empty range table.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
37 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
38
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 0
diff changeset
39 @defun copy-range-table range-table
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 0
diff changeset
40 This function returns a new range table which contains the same values
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 0
diff changeset
41 for the same ranges as @var{range-table}. The values will not
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 0
diff changeset
42 themselves be copied.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
43 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
44
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
45 @node Working With Range Tables
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
46 @section Working With Range Tables
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
47
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 0
diff changeset
48 @defun get-range-table pos range-table &optional default
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 0
diff changeset
49 This function finds value for position @var{pos} in @var{range-table}.
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 0
diff changeset
50 If there is no corresponding value, return @var{default} (defaults to
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
51 @code{nil}).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
52 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
53
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 0
diff changeset
54 @defun put-range-table start end value range-table
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
55 This function sets the value for range (@var{start}, @var{end}) to be
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 0
diff changeset
56 @var{value} in @var{range-table}.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
57 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
58
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 0
diff changeset
59 @defun remove-range-table start end range-table
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
60 This function removes the value for range (@var{start}, @var{end}) in
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 0
diff changeset
61 @var{range-table}.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
62 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
63
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 0
diff changeset
64 @defun clear-range-table range-table
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 0
diff changeset
65 This function flushes @var{range-table}.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
66 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
67
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 0
diff changeset
68 @defun map-range-table function range-table
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 0
diff changeset
69 This function maps @var{function} over entries in @var{range-table},
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 0
diff changeset
70 calling it with three args, the beginning and end of the range and the
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
71 corresponding value.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
72 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
73