xquery.js 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174
  1. /*
  2. Language: XQuery
  3. Author: Dirk Kirsten <dk@basex.org>
  4. Contributor: Duncan Paterson
  5. Description: Supports XQuery 3.1 including XQuery Update 3, so also XPath (as it is a superset)
  6. Refactored to process xml constructor syntax and function-bodies. Added missing data-types, xpath operands, inbuilt functions, and query prologs
  7. Website: https://www.w3.org/XML/Query/
  8. Category: functional
  9. */
  10. function xquery(hljs) {
  11. // see https://www.w3.org/TR/xquery/#id-terminal-delimitation
  12. var KEYWORDS = 'module schema namespace boundary-space preserve no-preserve strip default collation base-uri ordering context decimal-format decimal-separator copy-namespaces empty-sequence except exponent-separator external grouping-separator inherit no-inherit lax minus-sign per-mille percent schema-attribute schema-element strict unordered zero-digit ' +
  13. 'declare import option function validate variable ' +
  14. 'for at in let where order group by return if then else ' +
  15. 'tumbling sliding window start when only end previous next stable ' +
  16. 'ascending descending allowing empty greatest least some every satisfies switch case typeswitch try catch ' +
  17. 'and or to union intersect instance of treat as castable cast map array ' +
  18. 'delete insert into replace value rename copy modify update';
  19. // Node Types (sorted by inheritance)
  20. // atomic types (sorted by inheritance)
  21. var TYPE = 'item document-node node attribute document element comment namespace namespace-node processing-instruction text construction ' +
  22. 'xs:anyAtomicType xs:untypedAtomic xs:duration xs:time xs:decimal xs:float xs:double xs:gYearMonth xs:gYear xs:gMonthDay xs:gMonth xs:gDay xs:boolean xs:base64Binary xs:hexBinary xs:anyURI xs:QName xs:NOTATION xs:dateTime xs:dateTimeStamp xs:date xs:string xs:normalizedString xs:token xs:language xs:NMTOKEN xs:Name xs:NCName xs:ID xs:IDREF xs:ENTITY xs:integer xs:nonPositiveInteger xs:negativeInteger xs:long xs:int xs:short xs:byte xs:nonNegativeInteger xs:unisignedLong xs:unsignedInt xs:unsignedShort xs:unsignedByte xs:positiveInteger xs:yearMonthDuration xs:dayTimeDuration';
  23. var LITERAL = 'eq ne lt le gt ge is ' +
  24. 'self:: child:: descendant:: descendant-or-self:: attribute:: following:: following-sibling:: parent:: ancestor:: ancestor-or-self:: preceding:: preceding-sibling:: ' +
  25. 'NaN';
  26. // functions (TODO: find regex for op: without breaking build)
  27. var BUILT_IN = {
  28. className: 'built_in',
  29. variants: [{
  30. begin: /\barray\:/,
  31. end: /(?:append|filter|flatten|fold\-(?:left|right)|for-each(?:\-pair)?|get|head|insert\-before|join|put|remove|reverse|size|sort|subarray|tail)\b/
  32. }, {
  33. begin: /\bmap\:/,
  34. end: /(?:contains|entry|find|for\-each|get|keys|merge|put|remove|size)\b/
  35. }, {
  36. begin: /\bmath\:/,
  37. end: /(?:a(?:cos|sin|tan[2]?)|cos|exp(?:10)?|log(?:10)?|pi|pow|sin|sqrt|tan)\b/
  38. }, {
  39. begin: /\bop\:/,
  40. end: /\(/,
  41. excludeEnd: true
  42. }, {
  43. begin: /\bfn\:/,
  44. end: /\(/,
  45. excludeEnd: true
  46. },
  47. // do not highlight inbuilt strings as variable or xml element names
  48. {
  49. begin: /[^<\/\$\:'"-]\b(?:abs|accumulator\-(?:after|before)|adjust\-(?:date(?:Time)?|time)\-to\-timezone|analyze\-string|apply|available\-(?:environment\-variables|system\-properties)|avg|base\-uri|boolean|ceiling|codepoints?\-(?:equal|to\-string)|collation\-key|collection|compare|concat|contains(?:\-token)?|copy\-of|count|current(?:\-)?(?:date(?:Time)?|time|group(?:ing\-key)?|output\-uri|merge\-(?:group|key))?data|dateTime|days?\-from\-(?:date(?:Time)?|duration)|deep\-equal|default\-(?:collation|language)|distinct\-values|document(?:\-uri)?|doc(?:\-available)?|element\-(?:available|with\-id)|empty|encode\-for\-uri|ends\-with|environment\-variable|error|escape\-html\-uri|exactly\-one|exists|false|filter|floor|fold\-(?:left|right)|for\-each(?:\-pair)?|format\-(?:date(?:Time)?|time|integer|number)|function\-(?:arity|available|lookup|name)|generate\-id|has\-children|head|hours\-from\-(?:dateTime|duration|time)|id(?:ref)?|implicit\-timezone|in\-scope\-prefixes|index\-of|innermost|insert\-before|iri\-to\-uri|json\-(?:doc|to\-xml)|key|lang|last|load\-xquery\-module|local\-name(?:\-from\-QName)?|(?:lower|upper)\-case|matches|max|minutes\-from\-(?:dateTime|duration|time)|min|months?\-from\-(?:date(?:Time)?|duration)|name(?:space\-uri\-?(?:for\-prefix|from\-QName)?)?|nilled|node\-name|normalize\-(?:space|unicode)|not|number|one\-or\-more|outermost|parse\-(?:ietf\-date|json)|path|position|(?:prefix\-from\-)?QName|random\-number\-generator|regex\-group|remove|replace|resolve\-(?:QName|uri)|reverse|root|round(?:\-half\-to\-even)?|seconds\-from\-(?:dateTime|duration|time)|snapshot|sort|starts\-with|static\-base\-uri|stream\-available|string\-?(?:join|length|to\-codepoints)?|subsequence|substring\-?(?:after|before)?|sum|system\-property|tail|timezone\-from\-(?:date(?:Time)?|time)|tokenize|trace|trans(?:form|late)|true|type\-available|unordered|unparsed\-(?:entity|text)?\-?(?:public\-id|uri|available|lines)?|uri\-collection|xml\-to\-json|years?\-from\-(?:date(?:Time)?|duration)|zero\-or\-one)\b/,
  50. }, {
  51. begin: /\blocal\:/,
  52. end: /\(/,
  53. excludeEnd: true
  54. }, {
  55. begin: /\bzip\:/,
  56. end: /(?:zip\-file|(?:xml|html|text|binary)\-entry| (?:update\-)?entries)\b/
  57. }, {
  58. begin: /\b(?:util|db|functx|app|xdmp|xmldb)\:/,
  59. end: /\(/,
  60. excludeEnd: true
  61. }
  62. ]
  63. };
  64. var TITLE = {
  65. className: 'title',
  66. begin: /\bxquery version "[13]\.[01]"\s?(?:encoding ".+")?/,
  67. end: /;/
  68. };
  69. var VAR = {
  70. className: 'variable',
  71. begin: /[\$][\w-:]+/
  72. };
  73. var NUMBER = {
  74. className: 'number',
  75. begin: '(\\b0[0-7_]+)|(\\b0x[0-9a-fA-F_]+)|(\\b[1-9][0-9_]*(\\.[0-9_]+)?)|[0_]\\b',
  76. relevance: 0
  77. };
  78. var STRING = {
  79. className: 'string',
  80. variants: [{
  81. begin: /"/,
  82. end: /"/,
  83. contains: [{
  84. begin: /""/,
  85. relevance: 0
  86. }]
  87. },
  88. {
  89. begin: /'/,
  90. end: /'/,
  91. contains: [{
  92. begin: /''/,
  93. relevance: 0
  94. }]
  95. }
  96. ]
  97. };
  98. var ANNOTATION = {
  99. className: 'meta',
  100. begin: /%[\w-:]+/
  101. };
  102. var COMMENT = {
  103. className: 'comment',
  104. begin: '\\(:',
  105. end: ':\\)',
  106. relevance: 10,
  107. contains: [{
  108. className: 'doctag',
  109. begin: '@\\w+'
  110. }]
  111. };
  112. // see https://www.w3.org/TR/xquery/#id-computedConstructors
  113. // mocha: computed_inbuilt
  114. // see https://www.regexpal.com/?fam=99749
  115. var COMPUTED = {
  116. beginKeywords: 'element attribute comment document processing-instruction',
  117. end: '{',
  118. excludeEnd: true
  119. };
  120. // mocha: direct_method
  121. var DIRECT = {
  122. begin: /<([\w\._:\-]+)((\s*.*)=('|").*('|"))?>/,
  123. end: /(\/[\w\._:\-]+>)/,
  124. subLanguage: 'xml',
  125. contains: [{
  126. begin: '{',
  127. end: '}',
  128. subLanguage: 'xquery'
  129. }, 'self']
  130. };
  131. var CONTAINS = [
  132. VAR,
  133. BUILT_IN,
  134. STRING,
  135. NUMBER,
  136. COMMENT,
  137. ANNOTATION,
  138. TITLE,
  139. COMPUTED,
  140. DIRECT
  141. ];
  142. return {
  143. name: 'XQuery',
  144. aliases: ['xpath', 'xq'],
  145. case_insensitive: false,
  146. illegal: /(proc)|(abstract)|(extends)|(until)|(#)/,
  147. keywords: {
  148. $pattern: /[a-zA-Z\$][a-zA-Z0-9_:\-]*/,
  149. keyword: KEYWORDS,
  150. type: TYPE,
  151. literal: LITERAL
  152. },
  153. contains: CONTAINS
  154. };
  155. }
  156. module.exports = xquery;