checkpoint
[sbp.git] / tests / tibdoc.g
1 // interactions between !=> and &~ mean that I need to rethink the chartage
2 // indentation styling...
3 // literal blocks [[need to ignore bracing]] double-colon style?
4 // definition -- by prior line indentation, like headings in the original structured text
5 // tables
6 // dropcap
7 // output formats: latex, contex, ps, pdf, html, man, txt, rfc
8
9 // escapification
10 // comment
11 // math
12 // image
13 // figures
14
15 // "reference-style" links
16 //
17 //   this[1] is fun
18 //
19 //   [1] http://...
20 //
21
22 // nonbreaking text?
23 // degree: 15^o
24 // Arrows: <- -> => <= <->
25
26 // textblocks:
27 //  - attention, caution, danger, error, hint, important, note, tip, warning
28 // definition
29 // sidebar
30 // figure-with-caption
31 // epigraph (end-of-chapter note)
32 // compound paragraph (??)
33 // csv-table?
34 // table of contents
35 // header, footer
36 // #include
37
38 // simple macros (#define) (\define)
39
40 // table representation
41 //  
42 //  \table
43 //     a bbb c
44 //     ddd   e
45 //
46 //     [a] ...
47 //     [b] ...
48 //     [c] ...
49
50 // FIXME: these have to go at the top so they have their dropAll bit set before PreSequence.build...
51 ws         = w**
52 w          =  [\r\n\ ]
53 nw         = ~[\r\n\ ]
54
55 //////////////////////////////////////////////////////////////////////////////
56
57 s                   = Doc
58
59 Doc                 = head:Header body:Body  /ws
60 Header              = H:: { "header" { KeyVal */ ws } /ws }
61 Body                = B:: {Section}*/ws
62 Section             = SectionHeader Paragraph* /ws
63 SectionHeader       = "==" SectionHeaderBody "=="
64 SectionHeaderBody   =  "=" SectionHeaderBody "="
65                     >      ws! alphanum++ ws!
66
67 sp       = " "**
68 blank    = sp! "\n" sp! "\n" ws!
69
70 KeyVal       = key:word "=" val:text /ws
71 wp           = w++
72 num          = [0-9]++
73
74 Paragraph   = Blockquote:: { "\"\" "    text }
75             > HR::         { "---" "-"*      }
76             > P::          { text            }
77
78 onums        = nums (". "|") ")!
79 any          = ~[]*
80
81 uli          =  "* "         (ws! text &~ any (oli|uli)!)
82 oli          = ("# "|onums)! (ws! text &~ any (oli|uli)!)
83
84 text         = Item
85 Itemx        = ws! Item
86              | ()
87 Item*/ws
88      =
89 // "[]":: blockquote                 ((ws! Item) | ())
90 //             >
91                { UL:: uli+/ws }           
92              | { OL:: oli+/ws }           
93              > pre                        
94              > link                       
95              > structured                 
96              > styled                     
97              > (Chars:: alphanum++)       
98              > "\"" text "\""             
99              > (Symbol:: sym++)           
100              > { Block:: text }           
101
102
103 //blockquote   = Blockquote:: "\"\"" (block | text "\"\"")
104              
105 pre          = Verbatim:: "[verbatim]" { ~[]+ } /ws   // FIXME doesn't work
106
107 styled       = Underline::     "__" text "__"      
108              | Footnote::      "((" text "))"      
109              | TT::            "[[" text "]]"
110              | Citation::       "[" word "]"
111              | Strikethrough:: "!!" text "!!"      
112              | Superscript::   "^^" (word|block)   
113              | Subscript::     ",," (word|block)   
114              | Smallcap::      "\\sc" block        
115              | Bold::           "++" text "++"
116              | Keyword::         "!" (word|block)    
117              | Italic::         "**" text "**"
118
119 block         = { text }
120
121 link          = LinkText:: text:({ text })      "->" href:(url|email)
122               > LinkChars:: text:alphanum++  ws! "->" href:(url|email)
123
124 structured    = command & "\\" ([a-zA-Z0-9]++)! block?
125               > glyph
126               > email
127               > url
128
129 glyph        = Euro:: "(e)" | "(r)" | "(c)" | "(tm)" | emdash:: "--" | "..."
130
131 command      = Today::     "\\today"
132              | LineBreak:: "\\br"
133
134 // URLs //////////////////////////////////////////////////////////////////////////////
135
136 // interesting opportunity to show off boolean grammars here: define other
137 // subtypes of url (ftp, etc) as conjunctions, but the "master pattern"
138 // only gets parsed once
139
140 urlpath      = urlchar*
141 username     = [a-zA-Z0-9;/?:&=$\-_.+]++
142 password     = [a-zA-Z0-9;/?:&=$\-_.+]++
143 urlc         = [a-zA-Z0-9;/?:&=$\-_.+@]
144 urlv         = urlc | [%]
145 urlchar      = urlc
146              | urlescape:: "%" [0-9] [0-9]
147 url          = Mailto:: "mailto" ":"   email -> ~urlv
148              > URL::
149                   method:method 
150                   "://"
151                   login:url_login?
152                   host:host
153                   port:(":" nums)?
154                   path:("/" urlpath)?
155                      -> ~urlv
156 url_login    = Login:: username:username password:(":" password) "@"
157 method       = [+\-.a-z0-9]+
158 domain       = (part +/ ".") -> ~"."
159 part         = [a-zA-Z0-9\-]++
160 // interesting use of boolean grammars
161 //            &~ ([\-0-9] ~[]* | ~[]* [\-0-9])
162
163 email        = user:username "@" host:host -> ~[.]
164 nums         = [0-9]++
165 host         = IP::  nums "." nums "." nums "." nums
166              | DNS:: domain
167
168
169
170 // Tokens ///////////////////////////////////////////////////////////////////
171
172 word       = alphanum++
173            | quoted
174
175 quoted     = "\"" ((~[\"\\] | escaped)+) "\""
176            | "\"\"":: "\"\""
177 escaped    = lf:: "\\n"
178            | cr:: "\\r"
179            | "\\" ~[nr]
180
181
182 // Chars ///////////////////////////////////////////////////////////////
183
184 alpha      = [a-zA-Z]
185 alphanum   = [a-zA-Z0-9]
186 sym        = ~[a-zA-Z0-9\ \r\n=\">]
187
188