1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
-- Copyright 2014-2024 stef@ailleurs.land. See LICENSE.
-- Plain Texinfo version 5.2 LPeg lexer
-- Freely inspired from Mitchell work and valuable help from him too !
-- Directives are processed (more or less) in the Reference Card Texinfo order Reference Card
-- page for each directive group is in comment for reference
--[[
Note: Improving Fold Points use with Texinfo
At the very beginning of your Texinfo file, it could be wised to insert theses alias :
@alias startchapter = comment
@alias endchapter = comment
Then use this to begin each chapter :
@endchapter --------------------------------------------------------------------
@chapter CHAPTER TITLE
@startchapter ------------------------------------------------------------------
With the use of Scintilla's `SCI_FOLDALL(SC_FOLDACTION_TOGGLE)` or Textadept's
`buffer:fold_all(buffer.FOLDACTION_TOGGLE)`, you have then a nice chapter folding, useful with
large documents.
]]
local lexer = lexer
local token, word_match = lexer.token, lexer.word_match
local P, S = lpeg.P, lpeg.S
local lex = lexer.new(...)
-- Directives.
lex:add_rule('directive',
lex:tag('command', ('@end' * lexer.space^1 + '@') * lex:word_match('directive', true)))
-- Chapters.
lex:add_rule('chapter', lex:tag('command.section',
('@end' * lexer.space^1 + '@') * lex:word_match('chapter', true)))
-- Common keywords.
lex:add_rule('keyword', lex:tag(lexer.KEYWORD, ('@end' * lexer.space^1 + '@') *
lex:word_match(lexer.KEYWORD, true)))
-- Italics
local nested_braces = lexer.range('{', '}', false, false, true)
lex:add_rule('emph', lex:tag(lexer.ITALIC, '@emph' * nested_braces))
-- Bold
lex:add_rule('strong', lex:tag(lexer.BOLD, '@strong' * nested_braces))
-- Identifiers
lex:add_rule('identifier', lex:tag(lexer.IDENTIFIER, lexer.word))
-- Strings.
lex:add_rule('string', lex:tag(lexer.STRING, nested_braces))
-- Numbers.
lex:add_rule('number', lex:tag(lexer.NUMBER, lexer.number))
-- Comments.
local line_comment = lexer.to_eol('@c', true)
-- local line_comment_long = lexer.to_eol('@comment', true)
local block_comment = lexer.range('@ignore', '@end ignore')
lex:add_rule('comment', lex:tag(lexer.COMMENT, line_comment + block_comment))
-- Fold points.
lex:add_fold_point('command', '@titlepage', '@end titlepage')
lex:add_fold_point('command', '@copying', '@end copying')
lex:add_fold_point('command', '@ifset', '@end ifset')
lex:add_fold_point('command', '@tex', '@end tex')
lex:add_fold_point('command', '@itemize', '@end itemize')
lex:add_fold_point('command', '@enumerate', '@end enumerate')
lex:add_fold_point('command', '@multitable', '@end multitable')
lex:add_fold_point('command', '@example', '@end example')
lex:add_fold_point('command', '@smallexample', '@end smallexample')
lex:add_fold_point('command', '@cartouche', '@end cartouche')
lex:add_fold_point('command', '@startchapter', '@end startchapter')
-- Word lists.
lex:set_word_list('directive', {
'end',
-- Custom keywords for chapter folding
'startchapter', 'endchapter',
-- List and tables (page 2, column 2)
'itemize', 'enumerate',
-- Beginning a Texinfo document (page 1, column 1)
'titlepage', 'copying',
-- Block environments (page 2, column 1)
'cartouche',
-- Block environments > Displays using fixed-width fonts (page 2, column 2)
'example', 'smallexample',
-- List and tables (page 2, column 2)
'multitable',
-- Floating Displays (page 2, column 3)
'float', 'listoffloats', 'caption', 'shortcaption', 'image',
-- Floating Displays > Footnotes (page 2, column 3)
'footnote', 'footnotestyle',
-- Conditionally (in)visible text > Output formats (page 3, column 3)
'ifdocbook', 'ifhtml', 'ifinfo', 'ifplaintext', 'iftex', 'ifxml', 'ifnotdocbook', 'ifnothtml',
'ifnotplaintext', 'ifnottex', 'ifnotxml', 'ifnotinfo', 'inlinefmt', 'inlinefmtifelse',
-- Conditionally (in)visible text > Raw formatter text (page 4, column 1)
'docbook', 'html', 'tex', 'xml', 'inlineraw',
-- Conditionally (in)visible text > Documents variables (page 4, column 1)
'set', 'clear', 'value', 'ifset', 'ifclear', 'inlineifset', 'inlineifclear',
-- Conditionally (in)visible text > Testing for commands (page 4, column 1)
'ifcommanddefined', 'ifcommandnotdefined', 'end',
-- Defining new Texinfo commands (page 4, column 1)
'alias', 'macro', 'unmacro', 'definfounclose',
-- File inclusion (page 4, column 1)
'include', 'verbatiminclude',
-- Formatting and headers footers for TeX (page 4, column 1)
'allowcodebreaks', 'finalout', 'fonttextsize',
-- Formatting and headers footers for TeX > paper size (page 4, column 2)
'smallbook', 'afourpaper', 'afivepaper', 'afourlatex', 'afourwide', 'pagesizes',
-- Formatting and headers footers for TeX > Page headers and footers (page 4, column 2)
-- not implemented
-- Document preferences (page 4, column 2)
-- not implemented
-- Ending a Texinfo document (page 4, column 2)
'bye'
})
lex:set_word_list('chapter', {
-- Chapter structuring (page 1, column 2)
'lowersections', 'raisesections', 'part',
-- Chapter structuring > Numbered, included in contents (page 1, column 2)
'chapter', 'centerchap',
-- Chapter structuring > Context-dependent, included in contents (page 1, column 2)
'section', 'subsection', 'subsubsection',
-- Chapter structuring > Unumbered, included in contents (page 1, column 2)
'unnumbered', 'unnumberedsec', 'unnumberedsubsec', 'unnumberedsubsection', 'unnumberedsubsubsec',
'unnumberedsubsubsection',
-- Chapter structuring > Letter and numbered, included in contents (page 1, column 2)
'appendix', 'appendixsec', 'appendixsection', 'appendixsubsec', 'appendixsubsection',
'appendixsubsubsec', 'appendixsubsubsection',
-- Chapter structuring > Unumbered, not included in contents, no new page (page 1, column 3)
'chapheading', 'majorheading', 'heading', 'subheading', 'subsubheading'
})
lex:set_word_list(lexer.KEYWORD, {
'end',
-- Beginning a Texinfo document (page 1, column 1)
'setfilename', 'settitle', 'insertcopying',
-- Beginning a Texinfo document > Internationlization (page 1, column 1)
'documentencoding', 'documentlanguage', 'frenchspacing',
-- Beginning a Texinfo document > Info directory specification and HTML document description
-- (page 1, column 1)
'dircategory', 'direntry', 'documentdescription',
-- Beginning a Texinfo document > Titre pages (page 1, column 1)
'shorttitlepage', 'center', 'titlefont', 'title', 'subtitle', 'author',
-- Beginning a Texinfo document > Tables of contents (page 1, column 2)
'shortcontents', 'summarycontents', 'contents', 'setcontentsaftertitlepage',
'setshortcontentsaftertitlepage',
-- Nodes (page 1, column 2)
'node', 'top', 'anchor', 'novalidate',
-- Menus (page 1, column 2)
'menu', 'detailmenu',
-- Cross references > Within the Info system (page 1, column 3)
'xref', 'pxref', 'ref', 'inforef', 'xrefautomaticsectiontitle',
-- Cross references > Outside of info (page 1, column 3)
'url', 'cite',
-- Marking text > Markup for regular text (page 1, column 3)
'var', 'dfn', 'acronym', 'abbr',
-- Marking text > Markup for litteral text (page 1, column 3)
'code', 'file', 'command', 'env', 'option', 'kbd', 'key', 'email', 'indicateurl', 'samp', 'verb',
-- Marking text > GUI sequences (page 2, column 1)
'clicksequence', 'click', 'clickstyle', 'arrow',
-- Marking text > Math (page 2, column 1)
'math', 'minus', 'geq', 'leq',
-- Marking text > Explicit font selection (page 2, column 1)
'sc', 'r', 'i', 'slanted', 'b', 'sansserif', 't',
-- Block environments (page 2, column 1)
'noindent', 'indent', 'exdent',
-- Block environments > Normally filled displays using regular text fonts (page 2, column 1)
'quotation', 'smallquotation', 'indentedblock', 'smallindentedblock', 'raggedright',
-- Block environments > Line-for-line displays using regular test fonts (page 2, column 2)
'format', 'smallformat', 'display', 'smalldisplay', 'flushleft', 'flushright',
-- Block environments > Displays using fixed-width fonts (page 2, column 2)
'lisp', 'smalllisp', 'verbatim',
-- List and tables (page 2, column 2)
'table', 'ftable', 'vtable', 'tab', 'item', 'itemx', 'headitem', 'headitemfont', 'asis',
-- Indices (page 2, column 3)
'cindex', 'findex', 'vindex', 'kindex', 'pindex', 'tindex', 'defcodeindex', 'syncodeindex',
'synindex', 'printindex',
-- Insertions within a paragraph > Characters special to Texinfo (page 2, column 3)
'@', '{', '}', 'backslashcar', 'comma', 'hashcar', ':', '.', '?', '!', 'dmn',
-- Insertions within a paragraph > Accents (page 3, column 1)
-- not implemented
-- Insertions within a paragraph > Non-English characters (page 3, column 1)
-- not implemented
-- Insertions within a paragraph > Other text characters an logos (page 3, column 1)
'bullet', 'dots', 'enddots', 'euro', 'pounds', 'textdegree', 'copyright', 'registeredsymbol',
'TeX', 'LaTeX', 'today', 'guillemetleft', 'guillementright', 'guillemotleft', 'guillemotright',
-- Insertions within a paragraph > Glyphs for code examples (page 3, column 2)
'equiv', 'error', 'expansion', 'point', 'print', 'result',
-- Making and preventing breaks (page 3, column 2)
'*', '/', '-', 'hyphenation', 'tie', 'w', 'refill',
-- Vertical space (page 3, column 2)
'sp', 'page', 'need', 'group', 'vskip'
-- Definition commands (page 3, column 2)
-- not implemented
})
lexer.property['scintillua.comment'] = '@c'
return lex
|
