typoscript.py 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216
  1. """
  2. pygments.lexers.typoscript
  3. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  4. Lexers for TypoScript
  5. `TypoScriptLexer`
  6. A TypoScript lexer.
  7. `TypoScriptCssDataLexer`
  8. Lexer that highlights markers, constants and registers within css.
  9. `TypoScriptHtmlDataLexer`
  10. Lexer that highlights markers, constants and registers within html tags.
  11. :copyright: Copyright 2006-2024 by the Pygments team, see AUTHORS.
  12. :license: BSD, see LICENSE for details.
  13. """
  14. import re
  15. from pygments.lexer import RegexLexer, include, bygroups, using
  16. from pygments.token import Text, Comment, Name, String, Number, \
  17. Operator, Punctuation
  18. __all__ = ['TypoScriptLexer', 'TypoScriptCssDataLexer', 'TypoScriptHtmlDataLexer']
  19. class TypoScriptCssDataLexer(RegexLexer):
  20. """
  21. Lexer that highlights markers, constants and registers within css blocks.
  22. """
  23. name = 'TypoScriptCssData'
  24. aliases = ['typoscriptcssdata']
  25. url = 'http://docs.typo3.org/typo3cms/TyposcriptReference/'
  26. version_added = '2.2'
  27. tokens = {
  28. 'root': [
  29. # marker: ###MARK###
  30. (r'(.*)(###\w+###)(.*)', bygroups(String, Name.Constant, String)),
  31. # constant: {$some.constant}
  32. (r'(\{)(\$)((?:[\w\-]+\.)*)([\w\-]+)(\})',
  33. bygroups(String.Symbol, Operator, Name.Constant,
  34. Name.Constant, String.Symbol)), # constant
  35. # constant: {register:somevalue}
  36. (r'(.*)(\{)([\w\-]+)(\s*:\s*)([\w\-]+)(\})(.*)',
  37. bygroups(String, String.Symbol, Name.Constant, Operator,
  38. Name.Constant, String.Symbol, String)), # constant
  39. # whitespace
  40. (r'\s+', Text),
  41. # comments
  42. (r'/\*(?:(?!\*/).)*\*/', Comment),
  43. (r'(?<!(#|\'|"))(?:#(?!(?:[a-fA-F0-9]{6}|[a-fA-F0-9]{3}))[^\n#]+|//[^\n]*)',
  44. Comment),
  45. # other
  46. (r'[<>,:=.*%+|]', String),
  47. (r'[\w"\-!/&;(){}]+', String),
  48. ]
  49. }
  50. class TypoScriptHtmlDataLexer(RegexLexer):
  51. """
  52. Lexer that highlights markers, constants and registers within html tags.
  53. """
  54. name = 'TypoScriptHtmlData'
  55. aliases = ['typoscripthtmldata']
  56. url = 'http://docs.typo3.org/typo3cms/TyposcriptReference/'
  57. version_added = '2.2'
  58. tokens = {
  59. 'root': [
  60. # INCLUDE_TYPOSCRIPT
  61. (r'(INCLUDE_TYPOSCRIPT)', Name.Class),
  62. # Language label or extension resource FILE:... or LLL:... or EXT:...
  63. (r'(EXT|FILE|LLL):[^}\n"]*', String),
  64. # marker: ###MARK###
  65. (r'(.*)(###\w+###)(.*)', bygroups(String, Name.Constant, String)),
  66. # constant: {$some.constant}
  67. (r'(\{)(\$)((?:[\w\-]+\.)*)([\w\-]+)(\})',
  68. bygroups(String.Symbol, Operator, Name.Constant,
  69. Name.Constant, String.Symbol)), # constant
  70. # constant: {register:somevalue}
  71. (r'(.*)(\{)([\w\-]+)(\s*:\s*)([\w\-]+)(\})(.*)',
  72. bygroups(String, String.Symbol, Name.Constant, Operator,
  73. Name.Constant, String.Symbol, String)), # constant
  74. # whitespace
  75. (r'\s+', Text),
  76. # other
  77. (r'[<>,:=.*%+|]', String),
  78. (r'[\w"\-!/&;(){}#]+', String),
  79. ]
  80. }
  81. class TypoScriptLexer(RegexLexer):
  82. """
  83. Lexer for TypoScript code.
  84. """
  85. name = 'TypoScript'
  86. url = 'http://docs.typo3.org/typo3cms/TyposcriptReference/'
  87. aliases = ['typoscript']
  88. filenames = ['*.typoscript']
  89. mimetypes = ['text/x-typoscript']
  90. version_added = '2.2'
  91. flags = re.DOTALL | re.MULTILINE
  92. tokens = {
  93. 'root': [
  94. include('comment'),
  95. include('constant'),
  96. include('html'),
  97. include('label'),
  98. include('whitespace'),
  99. include('keywords'),
  100. include('punctuation'),
  101. include('operator'),
  102. include('structure'),
  103. include('literal'),
  104. include('other'),
  105. ],
  106. 'keywords': [
  107. # Conditions
  108. (r'(?i)(\[)(browser|compatVersion|dayofmonth|dayofweek|dayofyear|'
  109. r'device|ELSE|END|GLOBAL|globalString|globalVar|hostname|hour|IP|'
  110. r'language|loginUser|loginuser|minute|month|page|PIDinRootline|'
  111. r'PIDupinRootline|system|treeLevel|useragent|userFunc|usergroup|'
  112. r'version)([^\]]*)(\])',
  113. bygroups(String.Symbol, Name.Constant, Text, String.Symbol)),
  114. # Functions
  115. (r'(?=[\w\-])(HTMLparser|HTMLparser_tags|addParams|cache|encapsLines|'
  116. r'filelink|if|imageLinkWrap|imgResource|makelinks|numRows|numberFormat|'
  117. r'parseFunc|replacement|round|select|split|stdWrap|strPad|tableStyle|'
  118. r'tags|textStyle|typolink)(?![\w\-])', Name.Function),
  119. # Toplevel objects and _*
  120. (r'(?:(=?\s*<?\s+|^\s*))(cObj|field|config|content|constants|FEData|'
  121. r'file|frameset|includeLibs|lib|page|plugin|register|resources|sitemap|'
  122. r'sitetitle|styles|temp|tt_[^:.\s]*|types|xmlnews|INCLUDE_TYPOSCRIPT|'
  123. r'_CSS_DEFAULT_STYLE|_DEFAULT_PI_VARS|_LOCAL_LANG)(?![\w\-])',
  124. bygroups(Operator, Name.Builtin)),
  125. # Content objects
  126. (r'(?=[\w\-])(CASE|CLEARGIF|COA|COA_INT|COBJ_ARRAY|COLUMNS|CONTENT|'
  127. r'CTABLE|EDITPANEL|FILE|FILES|FLUIDTEMPLATE|FORM|HMENU|HRULER|HTML|'
  128. r'IMAGE|IMGTEXT|IMG_RESOURCE|LOAD_REGISTER|MEDIA|MULTIMEDIA|OTABLE|'
  129. r'PAGE|QTOBJECT|RECORDS|RESTORE_REGISTER|SEARCHRESULT|SVG|SWFOBJECT|'
  130. r'TEMPLATE|TEXT|USER|USER_INT)(?![\w\-])', Name.Class),
  131. # Menu states
  132. (r'(?=[\w\-])(ACTIFSUBRO|ACTIFSUB|ACTRO|ACT|CURIFSUBRO|CURIFSUB|CURRO|'
  133. r'CUR|IFSUBRO|IFSUB|NO|SPC|USERDEF1RO|USERDEF1|USERDEF2RO|USERDEF2|'
  134. r'USRRO|USR)', Name.Class),
  135. # Menu objects
  136. (r'(?=[\w\-])(GMENU_FOLDOUT|GMENU_LAYERS|GMENU|IMGMENUITEM|IMGMENU|'
  137. r'JSMENUITEM|JSMENU|TMENUITEM|TMENU_LAYERS|TMENU)', Name.Class),
  138. # PHP objects
  139. (r'(?=[\w\-])(PHP_SCRIPT(_EXT|_INT)?)', Name.Class),
  140. (r'(?=[\w\-])(userFunc)(?![\w\-])', Name.Function),
  141. ],
  142. 'whitespace': [
  143. (r'\s+', Text),
  144. ],
  145. 'html': [
  146. (r'<\S[^\n>]*>', using(TypoScriptHtmlDataLexer)),
  147. (r'&[^;\n]*;', String),
  148. (r'(?s)(_CSS_DEFAULT_STYLE)(\s*)(\()(.*(?=\n\)))',
  149. bygroups(Name.Class, Text, String.Symbol, using(TypoScriptCssDataLexer))),
  150. ],
  151. 'literal': [
  152. (r'0x[0-9A-Fa-f]+t?', Number.Hex),
  153. # (r'[0-9]*\.[0-9]+([eE][0-9]+)?[fd]?\s*(?:[^=])', Number.Float),
  154. (r'[0-9]+', Number.Integer),
  155. (r'(###\w+###)', Name.Constant),
  156. ],
  157. 'label': [
  158. # Language label or extension resource FILE:... or LLL:... or EXT:...
  159. (r'(EXT|FILE|LLL):[^}\n"]*', String),
  160. # Path to a resource
  161. (r'(?![^\w\-])([\w\-]+(?:/[\w\-]+)+/?)(\S*\n)',
  162. bygroups(String, String)),
  163. ],
  164. 'punctuation': [
  165. (r'[,.]', Punctuation),
  166. ],
  167. 'operator': [
  168. (r'[<>,:=.*%+|]', Operator),
  169. ],
  170. 'structure': [
  171. # Brackets and braces
  172. (r'[{}()\[\]\\]', String.Symbol),
  173. ],
  174. 'constant': [
  175. # Constant: {$some.constant}
  176. (r'(\{)(\$)((?:[\w\-]+\.)*)([\w\-]+)(\})',
  177. bygroups(String.Symbol, Operator, Name.Constant,
  178. Name.Constant, String.Symbol)), # constant
  179. # Constant: {register:somevalue}
  180. (r'(\{)([\w\-]+)(\s*:\s*)([\w\-]+)(\})',
  181. bygroups(String.Symbol, Name.Constant, Operator,
  182. Name.Constant, String.Symbol)), # constant
  183. # Hex color: #ff0077
  184. (r'(#[a-fA-F0-9]{6}\b|#[a-fA-F0-9]{3}\b)', String.Char)
  185. ],
  186. 'comment': [
  187. (r'(?<!(#|\'|"))(?:#(?!(?:[a-fA-F0-9]{6}|[a-fA-F0-9]{3}))[^\n#]+|//[^\n]*)',
  188. Comment),
  189. (r'/\*(?:(?!\*/).)*\*/', Comment),
  190. (r'(\s*#\s*\n)', Comment),
  191. ],
  192. 'other': [
  193. (r'[\w"\-!/&;]+', Text),
  194. ],
  195. }