c-like.js 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237
  1. /*
  2. Language: C-like foundation grammar for C/C++ grammars
  3. Author: Ivan Sagalaev <maniac@softwaremaniacs.org>
  4. Contributors: Evgeny Stepanischev <imbolk@gmail.com>, Zaven Muradyan <megalivoithos@gmail.com>, Roel Deckers <admin@codingcat.nl>, Sam Wu <samsam2310@gmail.com>, Jordi Petit <jordi.petit@gmail.com>, Pieter Vantorre <pietervantorre@gmail.com>, Google Inc. (David Benjamin) <davidben@google.com>
  5. Category: common, system
  6. */
  7. /* In the future the intention is to split out the C/C++ grammars distinctly
  8. since they are separate languages. They will likely share a common foundation
  9. though, and this file sets the groundwork for that - so that we get the breaking
  10. change in v10 and don't have to change the requirements again later.
  11. See: https://github.com/highlightjs/highlight.js/issues/2146
  12. */
  13. export default function (hljs) {
  14. function optional(s) {
  15. return '(?:' + s + ')?';
  16. }
  17. var DECLTYPE_AUTO_RE = 'decltype\\(auto\\)';
  18. var NAMESPACE_RE = '[a-zA-Z_]\\w*::';
  19. var TEMPLATE_ARGUMENT_RE = '<.*?>';
  20. var FUNCTION_TYPE_RE = '(' + DECLTYPE_AUTO_RE + '|' + optional(NAMESPACE_RE) + '[a-zA-Z_]\\w*' + optional(TEMPLATE_ARGUMENT_RE) + ')';
  21. var CPP_PRIMITIVE_TYPES = {
  22. className: 'keyword',
  23. begin: '\\b[a-z\\d_]*_t\\b'
  24. };
  25. // https://en.cppreference.com/w/cpp/language/escape
  26. // \\ \x \xFF \u2837 \u00323747 \374
  27. var CHARACTER_ESCAPES = '\\\\(x[0-9A-Fa-f]{2}|u[0-9A-Fa-f]{4,8}|[0-7]{3}|\\S)';
  28. var STRINGS = {
  29. className: 'string',
  30. variants: [
  31. {
  32. begin: '(u8?|U|L)?"',
  33. end: '"',
  34. illegal: '\\n',
  35. contains: [hljs.BACKSLASH_ESCAPE]
  36. },
  37. {
  38. begin: "(u8?|U|L)?'(" + CHARACTER_ESCAPES + '|.)',
  39. end: "'",
  40. illegal: '.'
  41. },
  42. {
  43. begin: /(?:u8?|U|L)?R"([^()\\ ]{0,16})\((?:.|\n)*?\)\1"/
  44. }
  45. ]
  46. };
  47. var NUMBERS = {
  48. className: 'number',
  49. variants: [
  50. {
  51. begin: "\\b(0b[01']+)"
  52. },
  53. {
  54. begin: "(-?)\\b([\\d']+(\\.[\\d']*)?|\\.[\\d']+)(u|U|l|L|ul|UL|f|F|b|B)"
  55. },
  56. {
  57. begin: "(-?)(\\b0[xX][a-fA-F0-9']+|(\\b[\\d']+(\\.[\\d']*)?|\\.[\\d']+)([eE][-+]?[\\d']+)?)"
  58. }
  59. ],
  60. relevance: 0
  61. };
  62. var PREPROCESSOR = {
  63. className: 'meta',
  64. begin: /#\s*[a-z]+\b/,
  65. end: /$/,
  66. keywords: {
  67. 'meta-keyword': 'if else elif endif define undef warning error line pragma _Pragma ifdef ifndef include'
  68. },
  69. contains: [
  70. {
  71. begin: /\\\n/,
  72. relevance: 0
  73. },
  74. hljs.inherit(STRINGS, {
  75. className: 'meta-string'
  76. }),
  77. {
  78. className: 'meta-string',
  79. begin: /<.*?>/,
  80. end: /$/,
  81. illegal: '\\n'
  82. },
  83. hljs.C_LINE_COMMENT_MODE,
  84. hljs.C_BLOCK_COMMENT_MODE
  85. ]
  86. };
  87. var TITLE_MODE = {
  88. className: 'title',
  89. begin: optional(NAMESPACE_RE) + hljs.IDENT_RE,
  90. relevance: 0
  91. };
  92. var FUNCTION_TITLE = optional(NAMESPACE_RE) + hljs.IDENT_RE + '\\s*\\(';
  93. var CPP_KEYWORDS = {
  94. keyword:
  95. 'int float while private char char8_t char16_t char32_t catch import module export virtual operator sizeof dynamic_cast|10 typedef const_cast|10 const for static_cast|10 union namespace unsigned long volatile static protected bool template mutable if public friend ' +
  96. 'do goto auto void enum else break extern using asm case typeid wchar_t ' +
  97. 'short reinterpret_cast|10 default double register explicit signed typename try this ' +
  98. 'switch continue inline delete alignas alignof constexpr consteval constinit decltype ' +
  99. 'concept co_await co_return co_yield requires ' +
  100. 'noexcept static_assert thread_local restrict final override ' +
  101. 'atomic_bool atomic_char atomic_schar ' +
  102. 'atomic_uchar atomic_short atomic_ushort atomic_int atomic_uint atomic_long atomic_ulong atomic_llong ' +
  103. 'atomic_ullong new throw return ' +
  104. 'and and_eq bitand bitor compl not not_eq or or_eq xor xor_eq',
  105. built_in:
  106. 'std string wstring cin cout cerr clog stdin stdout stderr stringstream istringstream ostringstream auto_ptr deque list queue stack vector map set bitset multiset multimap unordered_set unordered_map unordered_multiset unordered_multimap array shared_ptr abort terminate abs acos ' +
  107. 'asin atan2 atan calloc ceil cosh cos exit exp fabs floor fmod fprintf fputs free frexp ' +
  108. 'fscanf future isalnum isalpha iscntrl isdigit isgraph islower isprint ispunct isspace isupper ' +
  109. 'isxdigit tolower toupper labs ldexp log10 log malloc realloc memchr memcmp memcpy memset modf pow ' +
  110. 'printf putchar puts scanf sinh sin snprintf sprintf sqrt sscanf strcat strchr strcmp ' +
  111. 'strcpy strcspn strlen strncat strncmp strncpy strpbrk strrchr strspn strstr tanh tan ' +
  112. 'vfprintf vprintf vsprintf endl initializer_list unique_ptr _Bool complex _Complex imaginary _Imaginary',
  113. literal: 'true false nullptr NULL'
  114. };
  115. var EXPRESSION_CONTAINS = [CPP_PRIMITIVE_TYPES, hljs.C_LINE_COMMENT_MODE, hljs.C_BLOCK_COMMENT_MODE, NUMBERS, STRINGS];
  116. var EXPRESSION_CONTEXT = {
  117. // This mode covers expression context where we can't expect a function
  118. // definition and shouldn't highlight anything that looks like one:
  119. // `return some()`, `else if()`, `(x*sum(1, 2))`
  120. variants: [
  121. {
  122. begin: /=/,
  123. end: /;/
  124. },
  125. {
  126. begin: /\(/,
  127. end: /\)/
  128. },
  129. {
  130. beginKeywords: 'new throw return else',
  131. end: /;/
  132. }
  133. ],
  134. keywords: CPP_KEYWORDS,
  135. contains: EXPRESSION_CONTAINS.concat([
  136. {
  137. begin: /\(/,
  138. end: /\)/,
  139. keywords: CPP_KEYWORDS,
  140. contains: EXPRESSION_CONTAINS.concat(['self']),
  141. relevance: 0
  142. }
  143. ]),
  144. relevance: 0
  145. };
  146. var FUNCTION_DECLARATION = {
  147. className: 'function',
  148. begin: '(' + FUNCTION_TYPE_RE + '[\\*&\\s]+)+' + FUNCTION_TITLE,
  149. returnBegin: true,
  150. end: /[{;=]/,
  151. excludeEnd: true,
  152. keywords: CPP_KEYWORDS,
  153. illegal: /[^\w\s\*&:<>]/,
  154. contains: [
  155. {
  156. // to prevent it from being confused as the function title
  157. begin: DECLTYPE_AUTO_RE,
  158. keywords: CPP_KEYWORDS,
  159. relevance: 0
  160. },
  161. {
  162. begin: FUNCTION_TITLE,
  163. returnBegin: true,
  164. contains: [TITLE_MODE],
  165. relevance: 0
  166. },
  167. {
  168. className: 'params',
  169. begin: /\(/,
  170. end: /\)/,
  171. keywords: CPP_KEYWORDS,
  172. relevance: 0,
  173. contains: [
  174. hljs.C_LINE_COMMENT_MODE,
  175. hljs.C_BLOCK_COMMENT_MODE,
  176. STRINGS,
  177. NUMBERS,
  178. CPP_PRIMITIVE_TYPES,
  179. // Count matching parentheses.
  180. {
  181. begin: /\(/,
  182. end: /\)/,
  183. keywords: CPP_KEYWORDS,
  184. relevance: 0,
  185. contains: ['self', hljs.C_LINE_COMMENT_MODE, hljs.C_BLOCK_COMMENT_MODE, STRINGS, NUMBERS, CPP_PRIMITIVE_TYPES]
  186. }
  187. ]
  188. },
  189. CPP_PRIMITIVE_TYPES,
  190. hljs.C_LINE_COMMENT_MODE,
  191. hljs.C_BLOCK_COMMENT_MODE,
  192. PREPROCESSOR
  193. ]
  194. };
  195. return {
  196. aliases: ['c', 'cc', 'h', 'c++', 'h++', 'hpp', 'hh', 'hxx', 'cxx'],
  197. keywords: CPP_KEYWORDS,
  198. // the base c-like language will NEVER be auto-detected, rather the
  199. // derivitives: c, c++, arduino turn auto-detect back on for themselves
  200. disableAutodetect: true,
  201. illegal: '</',
  202. contains: [].concat(EXPRESSION_CONTEXT, FUNCTION_DECLARATION, EXPRESSION_CONTAINS, [
  203. PREPROCESSOR,
  204. {
  205. begin: '\\b(deque|list|queue|stack|vector|map|set|bitset|multiset|multimap|unordered_map|unordered_set|unordered_multiset|unordered_multimap|array)\\s*<',
  206. end: '>',
  207. keywords: CPP_KEYWORDS,
  208. contains: ['self', CPP_PRIMITIVE_TYPES]
  209. },
  210. {
  211. begin: hljs.IDENT_RE + '::',
  212. keywords: CPP_KEYWORDS
  213. },
  214. {
  215. className: 'class',
  216. beginKeywords: 'class struct',
  217. end: /[{;:]/,
  218. contains: [
  219. {
  220. begin: /</,
  221. end: />/,
  222. contains: ['self']
  223. },
  224. // skip generic stuff
  225. hljs.TITLE_MODE
  226. ]
  227. }
  228. ]),
  229. exports: {
  230. preprocessor: PREPROCESSOR,
  231. strings: STRINGS,
  232. keywords: CPP_KEYWORDS
  233. }
  234. };
  235. }