source: project/wiki/eggref/5/packrat @ 36418

Last change on this file since 36418 was 36418, checked in by Mario Domenech Goulart, 2 years ago

eggref/5/packrat: add documentation of packrat for CHICKEN 5

File size: 2.1 KB
Line 
1[[tags:egg]]
2== packrat
3
4
5
6A packrat parsing library
7
8[[toc:]]
9
10== Documentation
11
12
13Packrat parsing is a memoizing, backtracking recursive-descent parsing technique that runs in time and space linear in the size of the input text. The technique was originally discovered by Alexander Birman in 1970 , and Bryan Ford took up the idea for his master's thesis in 2002.
14
15For detailed information on the technique, please see Bryan Ford's web page at [[http://pdos.csail.mit.edu/~baford/packrat/|http://pdos.csail.mit.edu/~baford/packrat/]].
16
17A reference manual can be found here: [[http://bugs.call-cc.org/export/20226/release/4/packrat/doc/packrat.pdf|packrat.pdf]].
18
19To use the packrat API, import the {{packrat}} module.
20
21== License
22
23
24 Copyright (c) 2004, 2005 Tony Garnock-Jones <tonyg@kcbbs.gen.nz>
25 Copyright (c) 2005 LShift Ltd. <query@lshift.net>
26 
27 Permission is hereby granted, free of charge, to any person
28 obtaining a copy of this software and associated documentation
29 files (the "Software"), to deal in the Software without
30 restriction, including without limitation the rights to use, copy,
31 modify, merge, publish, distribute, sublicense, and/or sell copies
32 of the Software, and to permit persons to whom the Software is
33 furnished to do so, subject to the following conditions:
34 
35 The above copyright notice and this permission notice shall be
36 included in all copies or substantial portions of the Software.
37 
38 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
39 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
40 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
41 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
42 BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
43 ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
44 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
45 SOFTWARE.
46
47== About this egg
48
49
50=== Author
51
52Tony Garnock-Jones
53=== Version history
54
55
56; 1.5 : CHICKEN 5 support (Mario Goulart)
57; 1.4 : .setup script fixes (felix)
58; 1.2 : Ported to CHICKEN 4
59; 1.1 : Added use of srfi-1
60; 1.0 : Initial release
61
Note: See TracBrowser for help on using the repository browser.