* Updated my email address from "kasper@typo3.com" (which is closed and will stay...
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_tsparser.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2004 Kasper Skaarhoj (kasperYYYY@typo3.com)
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27 /**
28 * Contains the TypoScript parser class
29 *
30 * $Id$
31 * Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
32 *
33 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
34 */
35 /**
36 * [CLASS/FUNCTION INDEX of SCRIPT]
37 *
38 *
39 *
40 * 80: class t3lib_TSparser
41 * 133: function parse($string,$matchObj='')
42 * 169: function nextDivider()
43 * 185: function parseSub(&$setup)
44 * 337: function rollParseSub($string,&$setup)
45 * 361: function getVal($string,$setup)
46 * 387: function setVal($string,&$setup,$value,$wipeOut=0)
47 * 433: function error($err,$num=2)
48 * 445: function checkIncludeLines($string)
49 * 489: function checkIncludeLines_array($array)
50 *
51 * SECTION: Syntax highlighting
52 * 532: function doSyntaxHighlight($string,$lineNum='',$highlightBlockMode=0)
53 * 553: function regHighLight($code,$pointer,$strlen=-1)
54 * 571: function syntaxHighlight_print($lineNumDat,$highlightBlockMode)
55 *
56 * TOTAL FUNCTIONS: 12
57 * (This index is automatically created/updated by the extension "extdeveval")
58 *
59 */
60
61
62
63
64
65
66
67
68
69
70
71
72 /**
73 * The TypoScript parser
74 *
75 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
76 * @package TYPO3
77 * @subpackage t3lib
78 * @see t3lib_tstemplate, t3lib_matchcondition, t3lib_BEfunc::getPagesTSconfig(), t3lib_userAuthGroup::fetchGroupData(), t3lib_TStemplate::generateConfig()
79 */
80 class t3lib_TSparser {
81 var $strict = 1; // If set, then key names cannot contain characters other than [:alnum:]_\.-
82
83 // Internal
84 var $setup = Array(); // TypoScript hierarchy being build during parsing.
85 var $raw; // raw data, the input string exploded by chr(10)
86 var $rawP; // pointer to entry in raw data array
87 var $lastComment=''; // Holding the value of the last comment
88 var $commentSet=0; // Internally set, used as internal flag to create a multi-line comment (one of those like /*... */)
89 var $multiLineEnabled=0; // Internally set, when multiline value is accumulated
90 var $multiLineObject=''; // Internally set, when multiline value is accumulated
91 var $multiLineValue=array(); // Internally set, when multiline value is accumulated
92 var $inBrace = 0; // Internally set, when in brace. Counter.
93 var $lastConditionTrue = 1; // For each condition this flag is set, if the condition is true, else it's cleared. Then it's used by the [ELSE] condition to determine if the next part should be parsed.
94 var $sections=array(); // Tracking all conditions found
95 var $sectionsMatch=array(); // Tracking all matching conditions found
96 var $syntaxHighLight = 0; // If set, then syntax highlight mode is on; Call the function syntaxHighlight() to use this function
97 var $highLightData=array(); // Syntax highlight data is accumulated in this array. Used by syntaxHighlight_print() to construct the output.
98 var $highLightData_bracelevel = array(); // Syntax highlight data keeping track of the curly brace level for each line
99
100 // Debugging, analysis:
101 var $regComments = 0; // DO NOT register the comments. This is default for the ordinary sitetemplate!
102 var $regLinenumbers = 0; // DO NOT register the linenumbers. This is default for the ordinary sitetemplate!
103 var $errors=array(); // Error accumulation array.
104 var $lineNumberOffset=0; // Used for the error messages line number reporting. Set externally.
105 var $breakPointLN=0; // Line for break point.
106 var $highLightStyles=array(
107 'prespace' => array('<span class="ts-prespace">','</span>'), // Space before any content on a line
108 'objstr_postspace' => array('<span class="ts-objstr_postspace">','</span>'), // Space after the object string on a line
109 'operator_postspace' => array('<span class="ts-operator_postspace">','</span>'), // Space after the operator on a line
110 'operator' => array('<span class="ts-operator">','</span>'), // The operator char
111 'value' => array('<span class="ts-value">','</span>'), // The value of a line
112 'objstr' => array('<span class="ts-objstr">','</span>'), // The object string of a line
113 'value_copy' => array('<span class="ts-value_copy">','</span>'), // The value when the copy syntax (<) is used; that means the object reference
114 'value_unset' => array('<span class="ts-value_unset">','</span>'), // The value when an object is unset. Should not exist.
115 'ignored' => array('<span class="ts-ignored">','</span>'), // The "rest" of a line which will be ignored.
116 'default' => array('<span class="ts-default">','</span>'), // The default style if none other is applied.
117 'comment' => array('<span class="ts-comment">','</span>'), // Comment lines
118 'condition' => array('<span class="ts-condition">','</span>'), // Conditions
119 'error' => array('<span class="ts-error">','</span>'), // Error messages
120 'linenum' => array('<span class="ts-linenum">','</span>'), // Line numbers
121 );
122 var $highLightBlockStyles = ''; // Additional attributes for the <span> tags for a blockmode line
123 var $highLightBlockStyles_basecolor = '#cccccc'; // The hex-HTML color for the blockmode
124
125
126 /**
127 * Start parsing the input TypoScript text piece. The result is stored in $this->setup
128 *
129 * @param string The TypoScript text
130 * @param object If is object (instance of t3lib_matchcondition), then this is used to match conditions found in the TypoScript code. If matchObj not specified, then no conditions will work! (Except [GLOBAL])
131 * @return void
132 */
133 function parse($string,$matchObj='') {
134 $this->raw = explode(chr(10),$string);
135 $this->rawP = 0;
136 $pre = '[GLOBAL]';
137 while($pre) {
138 if ($this->breakPointLN && $pre=='[_BREAK]') {
139 $this->error('Breakpoint at '.($this->lineNumberOffset+$this->rawP-2).': Line content was "'.$this->raw[$this->rawP-2].'"',1);
140 break;
141 }
142
143 if (strtoupper($pre)=='[GLOBAL]' || strtoupper($pre)=='[END]' || (!$this->lastConditionTrue && strtoupper($pre)=='[ELSE]')) {
144 $pre = trim($this->parseSub($this->setup));
145 $this->lastConditionTrue=1;
146 } else {
147 if (strtoupper($pre)!='[ELSE]') {$this->sections[md5($pre)]=$pre;} // we're in a specific section. Therefore we log this section
148 if ((is_object($matchObj) && $matchObj->match($pre)) || $this->syntaxHighLight) {
149 if (strtoupper($pre)!='[ELSE]') {$this->sectionsMatch[md5($pre)]=$pre;}
150 $pre = trim($this->parseSub($this->setup));
151 $this->lastConditionTrue=1;
152 } else {
153 $pre = trim($this->nextDivider());
154 $this->lastConditionTrue=0;
155 }
156 }
157 }
158 if ($this->inBrace) {$this->error('Line '.($this->lineNumberOffset+$this->rawP-1).': The script is short of '.$this->inBrace.' end brace(s)',1); }
159 if ($this->multiLineEnabled) {$this->error('Line '.($this->lineNumberOffset+$this->rawP-1).': A multiline value section is not ended with a parenthesis!',1); }
160 $this->lineNumberOffset+=count($this->raw)+1;
161 }
162
163 /**
164 * Will search for the next condition. When found it will return the line content (the condition value) and have advanced the internal $this->rawP pointer to point to the next line after the condition.
165 *
166 * @return string The condition value
167 * @see parse()
168 */
169 function nextDivider() {
170 while (isset($this->raw[$this->rawP])) {
171 $line = ltrim($this->raw[$this->rawP]);
172 $this->rawP++;
173 if ($line && substr($line,0,1)=='[') {
174 return $line;
175 }
176 }
177 }
178
179 /**
180 * Parsing the $this->raw TypoScript lines from pointer, $this->rawP
181 *
182 * @param array Reference to the setup array in which to accumulate the values.
183 * @return string Returns the string of the condition found, the exit signal or possible nothing (if it completed parsing with no interruptions)
184 */
185 function parseSub(&$setup) {
186 while (isset($this->raw[$this->rawP])) {
187 $line = ltrim($this->raw[$this->rawP]);
188 $lineP = $this->rawP;
189 $this->rawP++;
190 if ($this->syntaxHighLight) $this->regHighLight("prespace",$lineP,strlen($line));
191
192 // Breakpoint?
193 if ($this->breakPointLN && ($this->lineNumberOffset+$this->rawP-1)==($this->breakPointLN+1)) { // by adding 1 we get that line processed
194 return '[_BREAK]';
195 }
196
197 // Set comment flag?
198 if (!$this->multiLineEnabled && substr($line,0,2)=='/*') {
199 $this->commentSet=1;
200 }
201
202 if (!$this->commentSet && ($line || $this->multiLineEnabled)) { // If $this->multiLineEnabled we will go and get the line values here because we know, the first if() will be true.
203 if ($this->multiLineEnabled) { // If multiline is enabled. Escape by ')'
204 if (substr($line,0,1)==')') { // Multiline ends...
205 if ($this->syntaxHighLight) $this->regHighLight("operator",$lineP,strlen($line)-1);
206 $this->multiLineEnabled=0; // Disable multiline
207 $theValue = implode($this->multiLineValue,chr(10));
208 if (strstr($this->multiLineObject,'.')) {
209 $this->setVal($this->multiLineObject,$setup,array($theValue)); // Set the value deeper.
210 } else {
211 $setup[$this->multiLineObject] = $theValue; // Set value regularly
212 if ($this->lastComment && $this->regComments) {
213 $setup[$this->multiLineObject.'..'].=$this->lastComment;
214 }
215 if ($this->regLinenumbers) {
216 $setup[$this->multiLineObject.'.ln..'][]=($this->lineNumberOffset+$this->rawP-1);
217 }
218 }
219 } else{
220 if ($this->syntaxHighLight) $this->regHighLight("value",$lineP);
221 $this->multiLineValue[]=$this->raw[($this->rawP-1)];
222 }
223 } elseif ($this->inBrace==0 && substr($line,0,1)=='[') { // Beginning of condition (only on level zero compared to brace-levels
224 if ($this->syntaxHighLight) $this->regHighLight("condition",$lineP);
225 return $line;
226 } else {
227 if (substr($line,0,1)=='[' && strtoupper(trim($line))=='[GLOBAL]') { // Return if GLOBAL condition is set - no matter what.
228 if ($this->syntaxHighLight) $this->regHighLight("condition",$lineP);
229 $this->error('Line '.($this->lineNumberOffset+$this->rawP-1).': On return to [GLOBAL] scope, the script was short of '.$this->inBrace.' end brace(s)',1);
230 $this->inBrace=0;
231 return $line;
232 } elseif (strcspn($line,'}#/')!=0) { // If not brace-end or comment
233 $varL = strcspn($line,' {=<>('); // Find object name string until we meet an operator VER2: Added '>'!!
234 $objStrName=trim(substr($line,0,$varL));
235 if ($this->syntaxHighLight) $this->regHighLight("objstr",$lineP,strlen(substr($line,$varL)));
236 if ($objStrName) {
237 if ($this->strict && eregi('[^[:alnum:]_\.-]',$objStrName,$r)) {
238 $this->error('Line '.($this->lineNumberOffset+$this->rawP-1).': Object Name String, "'.htmlspecialchars($objStrName).'" contains invalid character "'.$r[0].'". Must be alphanumeric or one of: "_-."');
239 } else {
240 $line = ltrim(substr($line,$varL));
241 if ($this->syntaxHighLight) {
242 $this->regHighLight("objstr_postspace", $lineP, strlen($line));
243 if (strlen($line)>0) {
244 $this->regHighLight("operator", $lineP, strlen($line)-1);
245 $this->regHighLight("operator_postspace", $lineP, strlen(ltrim(substr($line,1))));
246 }
247 }
248 switch(substr($line,0,1)) {
249 case '=':
250 if ($this->syntaxHighLight) $this->regHighLight("value", $lineP, strlen(ltrim(substr($line,1)))-strlen(trim(substr($line,1))));
251 if (strstr($objStrName,'.')) {
252 $value = Array();
253 $value[0] = trim(substr($line,1));
254 $this->setVal($objStrName,$setup,$value);
255 } else {
256 $setup[$objStrName] = trim(substr($line,1));
257 if ($this->lastComment && $this->regComments) { // Setting comment..
258 $setup[$objStrName.'..'].=$this->lastComment;
259 }
260 if ($this->regLinenumbers) {
261 $setup[$objStrName.'.ln..'][]=($this->lineNumberOffset+$this->rawP-1);
262 }
263 }
264 break;
265 case '{':
266 $this->inBrace++;
267 if (strstr($objStrName,'.')) {
268 $exitSig=$this->rollParseSub($objStrName,$setup);
269 if ($exitSig) return $exitSig;
270 } else {
271 if (!isset($setup[$objStrName.'.'])) {$setup[$objStrName.'.'] = Array();}
272 $exitSig=$this->parseSub($setup[$objStrName.'.']);
273 if ($exitSig) return $exitSig;
274 }
275 break;
276 case '(':
277 $this->multiLineObject = $objStrName;
278 $this->multiLineEnabled=1;
279 $this->multiLineValue=array();
280 break;
281 case '<':
282 if ($this->syntaxHighLight) $this->regHighLight("value_copy", $lineP, strlen(ltrim(substr($line,1)))-strlen(trim(substr($line,1))));
283 $theVal = trim(substr($line,1));
284 if (substr($theVal,0,1)=='.') {
285 $res = $this->getVal(substr($theVal,1),$setup);
286 } else {
287 $res = $this->getVal($theVal,$this->setup);
288 }
289 $this->setVal($objStrName,$setup,unserialize(serialize($res)),1);
290 break;
291 case '>':
292 if ($this->syntaxHighLight) $this->regHighLight("value_unset", $lineP, strlen(ltrim(substr($line,1)))-strlen(trim(substr($line,1))));
293 $this->setVal($objStrName,$setup,'UNSET');
294 break;
295 default:
296 $this->error('Line '.($this->lineNumberOffset+$this->rawP-1).': Object Name String, "'.htmlspecialchars($objStrName).'" was not preceeded by any operator, =<>({');
297 break;
298 }
299 }
300 $this->lastComment='';
301 }
302 } elseif (substr($line,0,1)=='}') {
303 $this->inBrace--;
304 $this->lastComment='';
305 if ($this->syntaxHighLight) $this->regHighLight("operator", $lineP, strlen($line)-1);
306 if ($this->inBrace<0) {
307 $this->error('Line '.($this->lineNumberOffset+$this->rawP-1).': An end brace is in excess.',1);
308 $this->inBrace=0;
309 } else {
310 break;
311 }
312 } else {
313 if ($this->syntaxHighLight) $this->regHighLight("comment", $lineP);
314
315 // Comment. The comments are concatenated in this temporary string:
316 if ($this->regComments) $this->lastComment.= trim($line).chr(10);
317 }
318 }
319 }
320
321 // Unset comment
322 if ($this->commentSet) {
323 if ($this->syntaxHighLight) $this->regHighLight("comment", $lineP);
324 if (substr($line,0,2)=='*/') $this->commentSet=0;
325 }
326 }
327 }
328
329 /**
330 * Parsing of TypoScript keys inside a curly brace where the key is composite of at least two keys, thus having to recursively call itself to get the value
331 *
332 * @param string The object sub-path, eg "thisprop.another_prot"
333 * @param array The local setup array from the function calling this function
334 * @return string Returns the exitSignal
335 * @see parseSub()
336 */
337 function rollParseSub($string,&$setup) {
338 if ((string)$string!='') {
339 $keyLen = strcspn($string,'.');
340 if ($keyLen==strlen($string)) {
341 $key = $string.'.';
342 if (!isset($setup[$key])){$setup[$key]=Array();}
343 $exitSig=$this->parseSub($setup[$key]);
344 if ($exitSig) return $exitSig;
345 } else {
346 $key = substr($string,0,$keyLen).'.';
347 if (!isset($setup[$key])){$setup[$key]=Array();}
348 $exitSig=$this->rollParseSub(substr($string,$keyLen+1),$setup[$key]);
349 if ($exitSig) return $exitSig;
350 }
351 }
352 }
353
354 /**
355 * Get a value/property pair for an object path in TypoScript, eg. "myobject.myvalue.mysubproperty". Here: Used by the "copy" operator, <
356 *
357 * @param string Object path for which to get the value
358 * @param array Global setup code if $string points to a global object path. But if string is prefixed with "." then its the local setup array.
359 * @return array An array with keys 0/1 being value/property respectively
360 */
361 function getVal($string,$setup) {
362 if ((string)$string!='') {
363 $keyLen = strcspn($string,'.');
364 if ($keyLen==strlen($string)) {
365 $retArr=array(); // Added 6/6/03. Shouldn't hurt
366 if (isset($setup[$string])) {$retArr[0]=$setup[$string]; }
367 if (isset($setup[$string.'.'])) {$retArr[1]=$setup[$string.'.']; }
368 return $retArr;
369 } else {
370 $key = substr($string,0,$keyLen).'.';
371 if ($setup[$key]) {
372 return $this->getVal(substr($string,$keyLen+1),$setup[$key]);
373 }
374 }
375 }
376 }
377
378 /**
379 * Setting a value/property of an object string in the setup array.
380 *
381 * @param string The object sub-path, eg "thisprop.another_prot"
382 * @param array The local setup array from the function calling this function.
383 * @param array The value/property pair array to set. If only one of them is set, then the other is not touched (unless $wipeOut is set, which it is when copies are made which must include both value and property)
384 * @param boolean If set, then both value and property is wiped out when a copy is made of another value.
385 * @return void
386 */
387 function setVal($string,&$setup,$value,$wipeOut=0) {
388 if ((string)$string!='') {
389 $keyLen = strcspn($string,'.');
390 if ($keyLen==strlen($string)) {
391 if ($value=='UNSET') {
392 unset($setup[$string]);
393 unset($setup[$string.'.']);
394 if ($this->regLinenumbers) {
395 $setup[$string.'.ln..'][]=($this->lineNumberOffset+$this->rawP-1).'>';
396 }
397 } else {
398 $lnRegisDone=0;
399 if ($wipeOut && $this->strict) {
400 if ((isset($setup[$string]) && !isset($value[0])) || (isset($setup[$string.'.']) && !isset($value[1]))) {$this->error('Line '.($this->lineNumberOffset+$this->rawP-1).': Object copied in this line "'.trim($this->raw[($this->rawP-1)]).'" would leave either the value or properties untouched in TypoScript Version 1. Please check that this is not a problem for you.',1);}
401 unset($setup[$string]);
402 unset($setup[$string.'.']);
403 if ($this->regLinenumbers) {
404 $setup[$string.'.ln..'][]=($this->lineNumberOffset+$this->rawP-1).'<';
405 $lnRegisDone=1;
406 }
407 }
408 if (isset($value[0])) {$setup[$string] = $value[0];}
409 if (isset($value[1])) {$setup[$string.'.'] = $value[1];}
410 if ($this->lastComment && $this->regComments) {
411 $setup[$string.'..'].=$this->lastComment;
412 }
413 if ($this->regLinenumbers && !$lnRegisDone) {
414 $setup[$string.'.ln..'][]=($this->lineNumberOffset+$this->rawP-1);
415 }
416 }
417 } else {
418 $key = substr($string,0,$keyLen).'.';
419 if (!isset($setup[$key])){$setup[$key]=Array();}
420 $this->setVal(substr($string,$keyLen+1),$setup[$key],$value);
421 }
422 }
423 }
424
425 /**
426 * Stacks errors/messages from the TypoScript parser into an internal array, $this->error
427 * If "TT" is a global object (as it is in the frontend when backend users are logged in) the message will be registered here as well.
428 *
429 * @param string The error message string
430 * @param integer The error severity (in the scale of $GLOBALS['TT']->setTSlogMessage: Approx: 2=warning, 1=info, 0=nothing, 3=fatal.)
431 * @return void
432 */
433 function error($err,$num=2) {
434 if (is_object($GLOBALS['TT'])) $GLOBALS['TT']->setTSlogMessage($err,$num);
435 $this->errors[]=array($err,$num,$this->rawP-1,$this->lineNumberOffset);
436 }
437
438 /**
439 * Checks the input string (un-parsed TypoScript) for include-commands ("<INCLUDE_TYPOSCRIPT: ....")
440 * Use: t3lib_TSparser::checkIncludeLines()
441 *
442 * @param string Unparsed TypoScript
443 * @return string Complete TypoScript with includes added.
444 */
445 function checkIncludeLines($string) {
446 $splitStr='<INCLUDE_TYPOSCRIPT:';
447 if (strstr($string,$splitStr)) {
448 $newString='';
449 $allParts = explode($splitStr,chr(10).$string.chr(10)); // adds line break char before/after
450 reset($allParts);
451 while(list($c,$v)=each($allParts)) {
452 if (!$c) { // first goes through
453 $newString.=$v;
454 } elseif (ereg("\r?\n[ ]*$",$allParts[$c-1])) { // There must be a line-break char before.
455 $subparts=explode('>',$v,2);
456 if (ereg("^[ ]*\r?\n",$subparts[1])) { // There must be a line-break char after
457 // SO, the include was positively recognized:
458 $newString.='### '.$splitStr.$subparts[0].'> BEGIN:'.chr(10);
459 $params = t3lib_div::get_tag_attributes($subparts[0]);
460 if ($params['source']) {
461 $sourceParts = explode(':',$params['source'],2);
462 switch(strtolower(trim($sourceParts[0]))) {
463 case 'file':
464 $filename = t3lib_div::getFileAbsFileName(trim($sourceParts[1]));
465 if (strcmp($filename,'')) { // Must exist and must not contain '..' and must be relative
466 if (@is_file($filename) && filesize($filename)<100000) { // Max. 100 KB include files!
467 $newString.=t3lib_div::getUrl($filename).chr(10);
468 }
469 }
470 break;
471 }
472 }
473 $newString.='### '.$splitStr.$subparts[0].'> END:'.chr(10);
474 $newString.=$subparts[1];
475 } else $newString.=$splitStr.$v;
476 } else $newString.=$splitStr.$v;
477 }
478 $string=substr($newString,1,-1); // not the first/last linebreak char.
479 }
480 return $string;
481 }
482
483 /**
484 * Parses the string in each value of the input array for include-commands
485 *
486 * @param array Array with TypoScript in each value
487 * @return array Same array but where the values has been parsed for include-commands
488 */
489 function checkIncludeLines_array($array) {
490 reset($array);
491 while(list($k)=each($array)) {
492 $array[$k]=t3lib_TSparser::checkIncludeLines($array[$k]);
493 }
494 return $array;
495 }
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517 /**********************************
518 *
519 * Syntax highlighting
520 *
521 *********************************/
522
523 /**
524 * Syntax highlight a TypoScript text
525 * Will parse the content. Remember, the internal setup array may contain INvalid parsed content since conditions are ignored!
526 *
527 * @param string The TypoScript text
528 * @param mixed If blank, linenumbers are NOT printed. If array then the first key is the linenumber offset to add to the internal counter.
529 * @param boolean If set, then the highlighted output will be formatted in blocks based on the brace levels. prespace will be ignored and empty lines represented with a single no-break-space.
530 * @return string HTML code for the syntax highlighted string
531 */
532 function doSyntaxHighlight($string,$lineNum='',$highlightBlockMode=0) {
533 $this->syntaxHighLight=1;
534 $this->highLightData=array();
535 $this->error=array();
536 $string = str_replace(chr(13),'',$string); // This is done in order to prevent empty <span>..</span> sections around chr(13) content. Should not do anything but help lessen the amount of HTML code.
537
538 $this->parse($string);
539
540 return $this->syntaxHighlight_print($lineNum,$highlightBlockMode);
541 }
542
543 /**
544 * Registers a part of a TypoScript line for syntax highlighting.
545 *
546 * @param string Key from the internal array $this->highLightStyles
547 * @param integer Pointer to the line in $this->raw which this is about
548 * @param integer The number of chars LEFT on this line before the end is reached.
549 * @return void
550 * @access private
551 * @see parse()
552 */
553 function regHighLight($code,$pointer,$strlen=-1) {
554 if ($strlen==-1) {
555 $this->highLightData[$pointer] = array(array($code,0));
556 } else {
557 $this->highLightData[$pointer][] = array($code,$strlen);
558 }
559 $this->highLightData_bracelevel[$pointer] = $this->inBrace;
560 }
561
562 /**
563 * Formatting the TypoScript code in $this->raw based on the data collected by $this->regHighLight in $this->highLightData
564 *
565 * @param mixed If blank, linenumbers are NOT printed. If array then the first key is the linenumber offset to add to the internal counter.
566 * @param boolean If set, then the highlighted output will be formatted in blocks based on the brace levels. prespace will be ignored and empty lines represented with a single no-break-space.
567 * @return string HTML content
568 * @access private
569 * @see doSyntaxHighlight()
570 */
571 function syntaxHighlight_print($lineNumDat,$highlightBlockMode) {
572 // Registers all error messages in relation to their linenumber
573 $errA=array();
574 foreach($this->errors as $err) {
575 $errA[$err[2]][]=$err[0];
576 }
577 // Generates the syntax highlighted output:
578 $lines=array();
579 foreach($this->raw as $rawP => $value) {
580 $start=0;
581 $strlen=strlen($value);
582 $lineC='';
583
584 if (is_array($this->highLightData[$rawP])) {
585 foreach($this->highLightData[$rawP] as $set) {
586 $len = $strlen-$start-$set[1];
587 if ($len > 0) {
588 $part = substr($value,$start,$len);
589 $start+=$len;
590 $st = $this->highLightStyles[(isset($this->highLightStyles[$set[0]])?$set[0]:'default')];
591 if (!$highlightBlockMode || $set[0]!='prespace') $lineC.=$st[0].htmlspecialchars($part).$st[1];
592 }elseif ($len < 0) debug(array($len,$value,$rawP));
593 }
594 } else debug(array($value));
595
596 if (strlen(substr($value,$start))) $lineC.=$this->highLightStyles['ignored'][0].htmlspecialchars(substr($value,$start)).$this->highLightStyles['ignored'][1];
597
598 if ($errA[$rawP]) {
599 $lineC.=$this->highLightStyles['error'][0].'<strong> - ERROR:</strong> '.htmlspecialchars(implode(';',$errA[$rawP])).$this->highLightStyles['error'][1];
600 }
601
602 if ($highlightBlockMode && $this->highLightData_bracelevel[$rawP]) {
603 $lineC = str_pad('',$this->highLightData_bracelevel[$rawP]*2,' ',STR_PAD_LEFT).'<span style="'.$this->highLightBlockStyles.($this->highLightBlockStyles_basecolor?'background-color: '.t3lib_div::modifyHTMLColorAll($this->highLightBlockStyles_basecolor,-$this->highLightData_bracelevel[$rawP]*16):'').'">'.(strcmp($lineC,'')?$lineC:'&nbsp;').'</span>';
604 }
605
606 if (is_array($lineNumDat)) {
607 $lineNum = $rawP+$lineNumDat[0];
608 $lineC = $this->highLightStyles['linenum'][0].str_pad($lineNum,4,' ',STR_PAD_LEFT).':'.$this->highLightStyles['linenum'][1].' '.$lineC;
609 }
610
611
612 $lines[] = $lineC;
613 }
614
615 return '<pre class="ts-hl">'.implode(chr(10),$lines).'</pre>';
616 }
617 }
618
619
620 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_tsparser.php']) {
621 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_tsparser.php']);
622 }
623 ?>