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