c-like.js 8.2 KB

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