Add built local::lib
[catagits/Gitalist.git] / local-lib5 / man / man3 / Syntax::Highlight::Engine::Kate::Template.3pm
1 .\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el       .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 .    de IX
53 .    tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 .    nr % 0
56 .    rr F
57 .\}
58 .el \{\
59 .    de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
65 .    \" fudge factors for nroff and troff
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 .    \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 .    \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 .    \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 .    ds : e
114 .    ds 8 ss
115 .    ds o a
116 .    ds d- d\h'-1'\(ga
117 .    ds D- D\h'-1'\(hy
118 .    ds th \o'bp'
119 .    ds Th \o'LP'
120 .    ds ae ae
121 .    ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "Syntax::Highlight::Engine::Kate::Template 3"
127 .TH Syntax::Highlight::Engine::Kate::Template 3 "2009-07-23" "perl v5.8.7" "User Contributed Perl Documentation"
128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 Syntax::Highlight::Engine::Kate::Template \- a template for syntax highlighting plugins
134 .SH "DESCRIPTION"
135 .IX Header "DESCRIPTION"
136 Syntax::Highlight::Engine::Kate::Template is a framework to assist authors of plugin modules.
137 All methods to provide highlighting to the Syntax::Highlight::Engine::Kate module are there, Just
138 no syntax definitions and callbacks. An instance of Syntax::Highlight::Engine::Kate::Template 
139 should never be created, it's meant to be sub classed only.
140 .SH "METHODS"
141 .IX Header "METHODS"
142 .IP "\fBattributes\fR(\fI?$attributesref?\fR);" 4
143 .IX Item "attributes(?$attributesref?);"
144 Sets and returns a reference to the attributes hash.
145 .IP "\fBbasecontext\fR(\fI?$context?\fR);" 4
146 .IX Item "basecontext(?$context?);"
147 Sets and returns the basecontext instance variable. This is the context that is used when highlighting starts.
148 .ie n .IP "\fBcaptured\fR(\fI\fI$cap\fI\fR);" 4
149 .el .IP "\fBcaptured\fR(\fI\f(CI$cap\fI\fR);" 4
150 .IX Item "captured($cap);"
151 Puts \f(CW$cap\fR in the first element of the stack, the current context. Used when the context is dynamic.
152 .ie n .IP "\fBcapturedGet\fR(\fI\fI$num\fI\fR);" 4
153 .el .IP "\fBcapturedGet\fR(\fI\f(CI$num\fI\fR);" 4
154 .IX Item "capturedGet($num);"
155 Returns the \f(CW$num\fR'th element that was captured in the current context.
156 .ie n .IP "\fBcapturedParse\fR(\fI\fI$string\fI\fR, \fI\fI$mode\fI\fR);" 4
157 .el .IP "\fBcapturedParse\fR(\fI\f(CI$string\fI\fR, \fI\f(CI$mode\fI\fR);" 4
158 .IX Item "capturedParse($string, $mode);"
159 If \fB\f(CB$mode\fB\fR is specified, \fB\f(CB$string\fB\fR should only be one character long and numeric.
160 \&\fBcapturedParse\fR will return the Nth captured element of the current context.
161 .Sp
162 If \fB\f(CB$mode\fB\fR is not specified, all occurences of %[1\-9] will be replaced by the captured
163 element of the current context.
164 .IP "\fBcolumn\fR" 4
165 .IX Item "column"
166 returns the column position in the line that is currently highlighted.
167 .IP "\fBcontextdata\fR(\fI\e%data\fR);" 4
168 .IX Item "contextdata(%data);"
169 Sets and returns a reference to the contextdata hash.
170 .ie n .IP "\fBcontextInfo\fR(\fI\fI$context\fI\fR, \fI\fI$item\fI\fR);" 4
171 .el .IP "\fBcontextInfo\fR(\fI\f(CI$context\fI\fR, \fI\f(CI$item\fI\fR);" 4
172 .IX Item "contextInfo($context, $item);"
173 returns the value of several context options. \fB\f(CB$item\fB\fR can be \fBcallback\fR, \fBattribute\fR, \fBlineending\fR,
174 \&\fBlinebeginning\fR, \fBfallthrough\fR.
175 .ie n .IP "\fBcontextParse\fR(\fI\fI$plugin\fI\fR, \fI\fI$context\fI\fR);" 4
176 .el .IP "\fBcontextParse\fR(\fI\f(CI$plugin\fI\fR, \fI\f(CI$context\fI\fR);" 4
177 .IX Item "contextParse($plugin, $context);"
178 Called by the plugins after a test succeeds. if \fB\f(CB$context\fB\fR has following values:
179 .Sp
180 .Vb 5
181 \& #pop       returns to the previous context, removes to top item in the stack. Can
182 \&            also be specified as #pop#pop etc.
183 \& #stay      does nothing.
184 \& ##....     Switches to the plugin specified in .... and assumes it\*(Aqs basecontext.
185 \& ....       Swtiches to the context specified in ....
186 .Ve
187 .IP "\fBdeliminators\fR(\fI?$delim?\fR);" 4
188 .IX Item "deliminators(?$delim?);"
189 Sets and returns a string that is a regular expression for detecting deliminators.
190 .IP "\fBengine\fR" 4
191 .IX Item "engine"
192 Returns a reference to the Syntax::Highlight::Engine::Kate module that created this plugin.
193 .ie n .IP "\fBfirstnonspace\fR(\fI\fI$string\fI\fR);" 4
194 .el .IP "\fBfirstnonspace\fR(\fI\f(CI$string\fI\fR);" 4
195 .IX Item "firstnonspace($string);"
196 returns true if the current line did not contain a non-spatial character so far and the first 
197 character in \fB\f(CB$string\fB\fR is also a spatial character.
198 .IP "\fBformatTable\fR" 4
199 .IX Item "formatTable"
200 sets and returns the instance variable \fBformat_table\fR. See also the option \fBformat_table\fR
201 .ie n .IP "\fBhighlight\fR(\fI\fI$text\fI\fR);" 4
202 .el .IP "\fBhighlight\fR(\fI\f(CI$text\fI\fR);" 4
203 .IX Item "highlight($text);"
204 highlights \fI\f(CI$text\fI\fR. It does so by selecting the proper callback
205 from the \fBcommands\fR hash and invoke it. It will do so untill
206 \&\f(CW$text\fR has been reduced to an empty string. returns a paired list
207 of snippets of text and the attribute with which they should be 
208 highlighted.
209 .ie n .IP "\fBhighlightText\fR(\fI\fI$text\fI\fR);" 4
210 .el .IP "\fBhighlightText\fR(\fI\f(CI$text\fI\fR);" 4
211 .IX Item "highlightText($text);"
212 highlights \fI\f(CI$text\fI\fR and reformats it using the \fBformat_table\fR and \fBsubstitutions\fR
213 .ie n .IP "\fBincludePlugin\fR(\fI\fI$language\fI\fR, \fI\e$text\fR);" 4
214 .el .IP "\fBincludePlugin\fR(\fI\f(CI$language\fI\fR, \fI\e$text\fR);" 4
215 .IX Item "includePlugin($language, $text);"
216 Includes the plugin for \fB\f(CB$language\fB\fR in the highlighting.
217 .ie n .IP "\fBincludeRules\fR(\fI\fI$language\fI\fR, \fI\e$text\fR);" 4
218 .el .IP "\fBincludeRules\fR(\fI\f(CI$language\fI\fR, \fI\e$text\fR);" 4
219 .IX Item "includeRules($language, $text);"
220 Includes the plugin for \fB\f(CB$language\fB\fR in the highlighting.
221 .IP "\fBkeywordscase\fR" 4
222 .IX Item "keywordscase"
223 Sets and returns the keywordscase instance variable.
224 .IP "\fBlastchar\fR" 4
225 .IX Item "lastchar"
226 return the last character that was processed.
227 .IP "\fBlastcharDeliminator\fR" 4
228 .IX Item "lastcharDeliminator"
229 returns true if the last character processed was a deliminator.
230 .IP "\fBlinesegment\fR" 4
231 .IX Item "linesegment"
232 returns the string of text in the current line that has been processed so far,
233 .IP "\fBlinestart\fR" 4
234 .IX Item "linestart"
235 returns true if processing is currently at the beginning of a line.
236 .ie n .IP "\fBlistAdd\fR(\fI'listname'\fR, \fI\fI$item1\fI\fR, \fI\fI$item2\fI\fR ...);" 4
237 .el .IP "\fBlistAdd\fR(\fI'listname'\fR, \fI\f(CI$item1\fI\fR, \fI\f(CI$item2\fI\fR ...);" 4
238 .IX Item "listAdd('listname', $item1, $item2 ...);"
239 Adds a list to the 'lists' hash.
240 .IP "\fBlists\fR(\fI?\e%lists?\fR);" 4
241 .IX Item "lists(?%lists?);"
242 sets and returns the instance variable 'lists'.
243 .IP "\fBout\fR(\fI?\e@highlightedlist?\fR);" 4
244 .IX Item "out(?@highlightedlist?);"
245 sets and returns the instance variable 'out'.
246 .ie n .IP "\fBparseResult\fR(\fI\e$text\fR, \fI\fI$match\fI\fR, \fI\fI$lookahaed\fI\fR, \fI\fI$column\fI\fR, \fI\fI$firstnonspace\fI\fR, \fI\fI$context\fI\fR, \fI\fI$attribute\fI\fR);" 4
247 .el .IP "\fBparseResult\fR(\fI\e$text\fR, \fI\f(CI$match\fI\fR, \fI\f(CI$lookahaed\fI\fR, \fI\f(CI$column\fI\fR, \fI\f(CI$firstnonspace\fI\fR, \fI\f(CI$context\fI\fR, \fI\f(CI$attribute\fI\fR);" 4
248 .IX Item "parseResult($text, $match, $lookahaed, $column, $firstnonspace, $context, $attribute);"
249 Called by every one of the test methods below. If the test matches, it will do a couple of subtests.
250 If \fB\f(CB$column\fB\fR is a defined numerical value it will test if the process is at the requested column.
251 If \fB\f(CB$firnonspace\fB\fR is true, it will test this also.
252 Ig it is not a look ahead and all tests are passed, \fB\f(CB$match\fB\fR is then parsed and removed from \fB$$text\fR.
253 .ie n .IP "\fBpluginGet\fR(\fI\fI$language\fI\fR);" 4
254 .el .IP "\fBpluginGet\fR(\fI\f(CI$language\fI\fR);" 4
255 .IX Item "pluginGet($language);"
256 Returns a reference to a plugin object for the specified language. Creating an 
257 instance if needed.
258 .IP "\fBreset\fR" 4
259 .IX Item "reset"
260 Resets the highlight engine to a fresh state, does not change the syntx.
261 .IP "\fBsnippet\fR" 4
262 .IX Item "snippet"
263 Contains the current snippet of text that will have one attribute. The moment the attribute 
264 changes it will be parsed.
265 .ie n .IP "\fBsnippetAppend\fR(\fI\fI$string\fI\fR)" 4
266 .el .IP "\fBsnippetAppend\fR(\fI\f(CI$string\fI\fR)" 4
267 .IX Item "snippetAppend($string)"
268 appends \fI\f(CI$string\fI\fR to the current snippet.
269 .ie n .IP "\fBsnippetAttribute\fR(\fI\fI$attribute\fI\fR)" 4
270 .el .IP "\fBsnippetAttribute\fR(\fI\f(CI$attribute\fI\fR)" 4
271 .IX Item "snippetAttribute($attribute)"
272 Sets and returns the used attribute.
273 .IP "\fBsnippetForce\fR" 4
274 .IX Item "snippetForce"
275 Forces the current snippet to be parsed.
276 .ie n .IP "\fBsnippetParse\fR(\fI\fI$text\fI\fR, \fI?$attribute?\fR)" 4
277 .el .IP "\fBsnippetParse\fR(\fI\f(CI$text\fI\fR, \fI?$attribute?\fR)" 4
278 .IX Item "snippetParse($text, ?$attribute?)"
279 If attribute is defined and differs from the current attribute it does a snippetForce and
280 sets the current attribute to \fB\f(CB$attribute\fB\fR. Then it does a snippetAppend of \fB\f(CB$text\fB\fR
281 .IP "\fBstack\fR" 4
282 .IX Item "stack"
283 sets and returns the instance variable 'stack', a reference to an array
284 .IP "\fBstackPull\fR" 4
285 .IX Item "stackPull"
286 retrieves the element that is on top of the stack, decrements stacksize by 1.
287 .ie n .IP "\fBstackPush\fR(\fI\fI$tagname\fI\fR);" 4
288 .el .IP "\fBstackPush\fR(\fI\f(CI$tagname\fI\fR);" 4
289 .IX Item "stackPush($tagname);"
290 puts \fI\f(CI$tagname\fI\fR on top of the stack, increments stacksize by 1
291 .IP "\fBstackTop\fR" 4
292 .IX Item "stackTop"
293 Retrieves the element that is on top of the stack.
294 .IP "\fBstateCompare\fR(\fI\e@state\fR)" 4
295 .IX Item "stateCompare(@state)"
296 Compares two lists, \e@state and the stack. returns true if they
297 match.
298 .IP "\fBstateGet\fR" 4
299 .IX Item "stateGet"
300 Returns a list containing the entire stack.
301 .ie n .IP "\fBstateSet\fR(\fI\fI@list\fI\fR)" 4
302 .el .IP "\fBstateSet\fR(\fI\f(CI@list\fI\fR)" 4
303 .IX Item "stateSet(@list)"
304 Accepts \fI\f(CI@list\fI\fR as the current stack.
305 .IP "\fBsubstitutions\fR" 4
306 .IX Item "substitutions"
307 sets and returns a reference to the substitutions hash.
308 .PP
309 The methods below all return a boolean value.
310 .ie n .IP "\fBtestAnyChar\fR(\fI\e$text\fR, \fI\fI$string\fI\fR, \fI\fI$insensitive\fI\fR, \fI\fI$lookahaed\fI\fR, \fI\fI$column\fI\fR, \fI\fI$firstnonspace\fI\fR, \fI\fI$context\fI\fR, \fI\fI$attribute\fI\fR);" 4
311 .el .IP "\fBtestAnyChar\fR(\fI\e$text\fR, \fI\f(CI$string\fI\fR, \fI\f(CI$insensitive\fI\fR, \fI\f(CI$lookahaed\fI\fR, \fI\f(CI$column\fI\fR, \fI\f(CI$firstnonspace\fI\fR, \fI\f(CI$context\fI\fR, \fI\f(CI$attribute\fI\fR);" 4
312 .IX Item "testAnyChar($text, $string, $insensitive, $lookahaed, $column, $firstnonspace, $context, $attribute);"
313 .PD 0
314 .ie n .IP "\fBtestDetectChar\fR(\fI\e$text\fR, \fI\fI$char\fI\fR, \fI\fI$insensitive\fI\fR, \fI\fI$dynamic\fI\fR, \fI\fI$lookahaed\fI\fR, \fI\fI$column\fI\fR, \fI\fI$firstnonspace\fI\fR, \fI\fI$context\fI\fR, \fI\fI$attribute\fI\fR);" 4
315 .el .IP "\fBtestDetectChar\fR(\fI\e$text\fR, \fI\f(CI$char\fI\fR, \fI\f(CI$insensitive\fI\fR, \fI\f(CI$dynamic\fI\fR, \fI\f(CI$lookahaed\fI\fR, \fI\f(CI$column\fI\fR, \fI\f(CI$firstnonspace\fI\fR, \fI\f(CI$context\fI\fR, \fI\f(CI$attribute\fI\fR);" 4
316 .IX Item "testDetectChar($text, $char, $insensitive, $dynamic, $lookahaed, $column, $firstnonspace, $context, $attribute);"
317 .ie n .IP "\fBtestDetect2Chars\fR(\fI\e$text\fR, \fI\fI$char1\fI\fR, \fI\fI$char2\fI\fR, \fI\fI$insensitive\fI\fR, \fI\fI$dynamic\fI\fR, \fI\fI$lookahaed\fI\fR, \fI\fI$column\fI\fR, \fI\fI$firstnonspace\fI\fR, \fI\fI$context\fI\fR, \fI\fI$attribute\fI\fR);" 4
318 .el .IP "\fBtestDetect2Chars\fR(\fI\e$text\fR, \fI\f(CI$char1\fI\fR, \fI\f(CI$char2\fI\fR, \fI\f(CI$insensitive\fI\fR, \fI\f(CI$dynamic\fI\fR, \fI\f(CI$lookahaed\fI\fR, \fI\f(CI$column\fI\fR, \fI\f(CI$firstnonspace\fI\fR, \fI\f(CI$context\fI\fR, \fI\f(CI$attribute\fI\fR);" 4
319 .IX Item "testDetect2Chars($text, $char1, $char2, $insensitive, $dynamic, $lookahaed, $column, $firstnonspace, $context, $attribute);"
320 .ie n .IP "\fBtestDetectIdentifier\fR(\fI\e$text\fR, \fI\fI$lookahaed\fI\fR, \fI\fI$column\fI\fR, \fI\fI$firstnonspace\fI\fR, \fI\fI$context\fI\fR, \fI\fI$attribute\fI\fR);" 4
321 .el .IP "\fBtestDetectIdentifier\fR(\fI\e$text\fR, \fI\f(CI$lookahaed\fI\fR, \fI\f(CI$column\fI\fR, \fI\f(CI$firstnonspace\fI\fR, \fI\f(CI$context\fI\fR, \fI\f(CI$attribute\fI\fR);" 4
322 .IX Item "testDetectIdentifier($text, $lookahaed, $column, $firstnonspace, $context, $attribute);"
323 .ie n .IP "\fBtestDetectSpaces\fR(\fI\e$text\fR, \fI\fI$lookahaed\fI\fR, \fI\fI$column\fI\fR, \fI\fI$firstnonspace\fI\fR, \fI\fI$context\fI\fR, \fI\fI$attribute\fI\fR);" 4
324 .el .IP "\fBtestDetectSpaces\fR(\fI\e$text\fR, \fI\f(CI$lookahaed\fI\fR, \fI\f(CI$column\fI\fR, \fI\f(CI$firstnonspace\fI\fR, \fI\f(CI$context\fI\fR, \fI\f(CI$attribute\fI\fR);" 4
325 .IX Item "testDetectSpaces($text, $lookahaed, $column, $firstnonspace, $context, $attribute);"
326 .ie n .IP "\fBtestFloat\fR(\fI\e$text\fR, \fI\fI$lookahaed\fI\fR, \fI\fI$column\fI\fR, \fI\fI$firstnonspace\fI\fR, \fI\fI$context\fI\fR, \fI\fI$attribute\fI\fR);" 4
327 .el .IP "\fBtestFloat\fR(\fI\e$text\fR, \fI\f(CI$lookahaed\fI\fR, \fI\f(CI$column\fI\fR, \fI\f(CI$firstnonspace\fI\fR, \fI\f(CI$context\fI\fR, \fI\f(CI$attribute\fI\fR);" 4
328 .IX Item "testFloat($text, $lookahaed, $column, $firstnonspace, $context, $attribute);"
329 .ie n .IP "\fBtestHlCChar\fR(\fI\e$text\fR, \fI\fI$lookahaed\fI\fR, \fI\fI$column\fI\fR, \fI\fI$firstnonspace\fI\fR, \fI\fI$context\fI\fR, \fI\fI$attribute\fI\fR);" 4
330 .el .IP "\fBtestHlCChar\fR(\fI\e$text\fR, \fI\f(CI$lookahaed\fI\fR, \fI\f(CI$column\fI\fR, \fI\f(CI$firstnonspace\fI\fR, \fI\f(CI$context\fI\fR, \fI\f(CI$attribute\fI\fR);" 4
331 .IX Item "testHlCChar($text, $lookahaed, $column, $firstnonspace, $context, $attribute);"
332 .ie n .IP "\fBtestHlCHex\fR(\fI\e$text\fR, \fI\fI$lookahaed\fI\fR, \fI\fI$column\fI\fR, \fI\fI$firstnonspace\fI\fR, \fI\fI$context\fI\fR, \fI\fI$attribute\fI\fR);" 4
333 .el .IP "\fBtestHlCHex\fR(\fI\e$text\fR, \fI\f(CI$lookahaed\fI\fR, \fI\f(CI$column\fI\fR, \fI\f(CI$firstnonspace\fI\fR, \fI\f(CI$context\fI\fR, \fI\f(CI$attribute\fI\fR);" 4
334 .IX Item "testHlCHex($text, $lookahaed, $column, $firstnonspace, $context, $attribute);"
335 .ie n .IP "\fBtestHlCOct\fR(\fI\e$text\fR, \fI\fI$lookahaed\fI\fR, \fI\fI$column\fI\fR, \fI\fI$firstnonspace\fI\fR, \fI\fI$context\fI\fR, \fI\fI$attribute\fI\fR);" 4
336 .el .IP "\fBtestHlCOct\fR(\fI\e$text\fR, \fI\f(CI$lookahaed\fI\fR, \fI\f(CI$column\fI\fR, \fI\f(CI$firstnonspace\fI\fR, \fI\f(CI$context\fI\fR, \fI\f(CI$attribute\fI\fR);" 4
337 .IX Item "testHlCOct($text, $lookahaed, $column, $firstnonspace, $context, $attribute);"
338 .ie n .IP "\fBtestHlCStringChar\fR(\fI\e$text\fR, \fI\fI$lookahaed\fI\fR, \fI\fI$column\fI\fR, \fI\fI$firstnonspace\fI\fR, \fI\fI$context\fI\fR, \fI\fI$attribute\fI\fR);" 4
339 .el .IP "\fBtestHlCStringChar\fR(\fI\e$text\fR, \fI\f(CI$lookahaed\fI\fR, \fI\f(CI$column\fI\fR, \fI\f(CI$firstnonspace\fI\fR, \fI\f(CI$context\fI\fR, \fI\f(CI$attribute\fI\fR);" 4
340 .IX Item "testHlCStringChar($text, $lookahaed, $column, $firstnonspace, $context, $attribute);"
341 .ie n .IP "\fBtestInt\fR(\fI\e$text\fR, \fI\fI$lookahaed\fI\fR, \fI\fI$column\fI\fR, \fI\fI$firstnonspace\fI\fR, \fI\fI$context\fI\fR, \fI\fI$attribute\fI\fR);" 4
342 .el .IP "\fBtestInt\fR(\fI\e$text\fR, \fI\f(CI$lookahaed\fI\fR, \fI\f(CI$column\fI\fR, \fI\f(CI$firstnonspace\fI\fR, \fI\f(CI$context\fI\fR, \fI\f(CI$attribute\fI\fR);" 4
343 .IX Item "testInt($text, $lookahaed, $column, $firstnonspace, $context, $attribute);"
344 .ie n .IP "\fBtestKeyword\fR(\fI\e$text\fR, \fI\fI$list\fI\fR, \fI\fI$insensitive\fI\fR, \fI\fI$lookahaed\fI\fR, \fI\fI$column\fI\fR, \fI\fI$firstnonspace\fI\fR, \fI\fI$context\fI\fR, \fI\fI$attribute\fI\fR);" 4
345 .el .IP "\fBtestKeyword\fR(\fI\e$text\fR, \fI\f(CI$list\fI\fR, \fI\f(CI$insensitive\fI\fR, \fI\f(CI$lookahaed\fI\fR, \fI\f(CI$column\fI\fR, \fI\f(CI$firstnonspace\fI\fR, \fI\f(CI$context\fI\fR, \fI\f(CI$attribute\fI\fR);" 4
346 .IX Item "testKeyword($text, $list, $insensitive, $lookahaed, $column, $firstnonspace, $context, $attribute);"
347 .ie n .IP "\fBtestLineContinue\fR(\fI\e$text\fR, \fI\fI$lookahaed\fI\fR, \fI\fI$column\fI\fR, \fI\fI$firstnonspace\fI\fR, \fI\fI$context\fI\fR, \fI\fI$attribute\fI\fR);" 4
348 .el .IP "\fBtestLineContinue\fR(\fI\e$text\fR, \fI\f(CI$lookahaed\fI\fR, \fI\f(CI$column\fI\fR, \fI\f(CI$firstnonspace\fI\fR, \fI\f(CI$context\fI\fR, \fI\f(CI$attribute\fI\fR);" 4
349 .IX Item "testLineContinue($text, $lookahaed, $column, $firstnonspace, $context, $attribute);"
350 .ie n .IP "\fBtestRangeDetect\fR(\fI\e$text\fR,  \fI\fI$char1\fI\fR, \fI\fI$char2\fI\fR, \fI\fI$insensitive\fI\fR, \fI\fI$lookahaed\fI\fR, \fI\fI$column\fI\fR, \fI\fI$firstnonspace\fI\fR, \fI\fI$context\fI\fR, \fI\fI$attribute\fI\fR);" 4
351 .el .IP "\fBtestRangeDetect\fR(\fI\e$text\fR,  \fI\f(CI$char1\fI\fR, \fI\f(CI$char2\fI\fR, \fI\f(CI$insensitive\fI\fR, \fI\f(CI$lookahaed\fI\fR, \fI\f(CI$column\fI\fR, \fI\f(CI$firstnonspace\fI\fR, \fI\f(CI$context\fI\fR, \fI\f(CI$attribute\fI\fR);" 4
352 .IX Item "testRangeDetect($text,  $char1, $char2, $insensitive, $lookahaed, $column, $firstnonspace, $context, $attribute);"
353 .ie n .IP "\fBtestRegExpr\fR(\fI\e$text\fR, \fI\fI$reg\fI\fR, \fI\fI$insensitive\fI\fR, \fI\fI$dynamic\fI\fR, \fI\fI$lookahaed\fI\fR, \fI\fI$column\fI\fR, \fI\fI$firstnonspace\fI\fR, \fI\fI$context\fI\fR, \fI\fI$attribute\fI\fR);" 4
354 .el .IP "\fBtestRegExpr\fR(\fI\e$text\fR, \fI\f(CI$reg\fI\fR, \fI\f(CI$insensitive\fI\fR, \fI\f(CI$dynamic\fI\fR, \fI\f(CI$lookahaed\fI\fR, \fI\f(CI$column\fI\fR, \fI\f(CI$firstnonspace\fI\fR, \fI\f(CI$context\fI\fR, \fI\f(CI$attribute\fI\fR);" 4
355 .IX Item "testRegExpr($text, $reg, $insensitive, $dynamic, $lookahaed, $column, $firstnonspace, $context, $attribute);"
356 .ie n .IP "\fBtestStringDetect\fR(\fI\e$text\fR, \fI\fI$string\fI\fR, \fI\fI$insensitive\fI\fR, \fI\fI$dynamic\fI\fR, I\fI\fI$lookahaed\fI\fR, \fI\fI$column\fI\fR, \fI\fI$firstnonspace\fI\fR, \fI\fI$context\fI\fR, \fI\fI$attribute\fI\fR);" 4
357 .el .IP "\fBtestStringDetect\fR(\fI\e$text\fR, \fI\f(CI$string\fI\fR, \fI\f(CI$insensitive\fI\fR, \fI\f(CI$dynamic\fI\fR, I\fI\f(CI$lookahaed\fI\fR, \fI\f(CI$column\fI\fR, \fI\f(CI$firstnonspace\fI\fR, \fI\f(CI$context\fI\fR, \fI\f(CI$attribute\fI\fR);" 4
358 .IX Item "testStringDetect($text, $string, $insensitive, $dynamic, I$lookahaed, $column, $firstnonspace, $context, $attribute);"
359 .PD
360 .SH "ACKNOWLEDGEMENTS"
361 .IX Header "ACKNOWLEDGEMENTS"
362 All the people who wrote Kate and the syntax highlight xml files.
363 .SH "AUTHOR AND COPYRIGHT"
364 .IX Header "AUTHOR AND COPYRIGHT"
365 This module is written and maintained by:
366 .PP
367 Hans Jeuken < haje at toneel dot demon dot nl >
368 .PP
369 Copyright (c) 2006 by Hans Jeuken, all rights reserved.
370 .PP
371 You may freely distribute and/or modify this module under same terms as
372 Perl itself
373 .SH "SEE ALSO"
374 .IX Header "SEE ALSO"
375 Synax::Highlight::Engine::Kate http:://www.kate\-editor.org
376 .SH "POD ERRORS"
377 .IX Header "POD ERRORS"
378 Hey! \fBThe above document had some coding errors, which are explained below:\fR
379 .IP "Around line 919:" 4
380 .IX Item "Around line 919:"
381 =cut found outside a pod block.  Skipping to next block.