1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
|
defmodule Makeup.Lexers.CLexer do
import NimbleParsec
import Makeup.Lexer.Combinators
import Makeup.Lexer.Groups
import Makeup.Lexers.CLexer.Helper
@behaviour Makeup.Lexer
###################################################################
# Step #1: tokenize the input (into a list of tokens)
###################################################################
# We will often compose combinators into larger combinators.
# Sometimes, the smaller combinator is usefull on its own as a token, and sometimes it isn't.
# We'll adopt the following "convention":
#
# 1. A combinator that ends with `_name` returns a string
# 2. Other combinators will *usually* return a token
#
# Why this convention? Tokens can't be composed further, while raw strings can.
# This way, we immediately know which of the combinators we can compose.
# TODO: check we're following this convention
whitespace = ascii_string([?\r, ?\s, ?\n, ?\f], min: 1) |> token(:whitespace)
any_char = utf8_char([]) |> token(:error)
# Numbers
digits = ascii_string([?0..?9], min: 1)
bin_digits = ascii_string([?0..?1], min: 1)
hex_digits = ascii_string([?0..?9, ?a..?f, ?A..?F], min: 1)
oct_digits = ascii_string([?0..?7], min: 1)
# Digits in an integer may be separated by underscores
number_bin_part = with_optional_separator(bin_digits, "_")
number_oct_part = with_optional_separator(oct_digits, "_")
number_hex_part = with_optional_separator(hex_digits, "_")
integer = with_optional_separator(digits, "_")
# Tokens for the lexer
number_bin = string("0b") |> concat(number_bin_part) |> token(:number_bin)
number_oct = string("0o") |> concat(number_oct_part) |> token(:number_oct)
number_hex = string("0x") |> concat(number_hex_part) |> token(:number_hex)
# Base 10
number_integer = token(integer, :number_integer)
# Floating point numbers
float_scientific_notation_part =
ascii_string([?e, ?E], 1)
|> optional(string("-"))
|> concat(integer)
number_float =
integer
|> string(".")
|> concat(integer)
|> optional(float_scientific_notation_part)
|> token(:number_float)
# Yes, Elixir supports much more than this.
# TODO: adapt the code from the official tokenizer, which parses the unicode database
variable_name =
ascii_string([?a..?z, ?_], 1)
|> optional(ascii_string([?a..?z, ?_, ?0..?9, ?A..?Z], min: 1))
|> optional(ascii_string([??, ?!], 1))
# Can also be a function name
variable =
variable_name
|> lexeme
|> token(:name)
define_name =
ascii_string([?A..?Z], 1)
|> optional(ascii_string([?a..?z, ?_, ?0..?9, ?A..?Z], min: 1))
define = token(define_name, :name_constant)
operator_name = word_from_list(~W(
-> + - * / % ++ -- ~ ^ & && | ||
= += -= *= /= &= |= %= ^= << >>
<<= >>= > < >= <= == != ! ? :
))
operator = token(operator_name, :operator)
normal_char =
string("?")
|> utf8_string([], 1)
|> token(:string_char)
escape_char =
string("?\\")
|> utf8_string([], 1)
|> token(:string_char)
directive =
string("#")
|> concat(variable_name)
|> token(:keyword_pseudo)
punctuation =
word_from_list(
["\\\\", ":", ";", ",", "."],
:punctuation
)
delimiters_punctuation =
word_from_list(
~W( ( \) [ ] { }),
:punctuation
)
comment = many_surrounded_by(parsec(:root_element), "/*", "*/")
delimiter_pairs = [
delimiters_punctuation,
comment
]
normal_atom_name =
utf8_string([?A..?Z, ?a..?z, ?_], 1)
|> optional(utf8_string([?A..?Z, ?a..?z, ?_, ?0..?9, ?@], min: 1))
# normal_atom =
# string(":")
# |> choice([operator_name, normal_atom_name])
# |> token(:string_symbol)
unicode_char_in_string =
string("\\u")
|> ascii_string([?0..?9, ?a..?f, ?A..?F], 4)
|> token(:string_escape)
escaped_char =
string("\\")
|> utf8_string([], 1)
|> token(:string_escape)
combinators_inside_string = [
unicode_char_in_string,
escaped_char
]
string_keyword =
choice([
string_like("\"", "\"", combinators_inside_string, :string_symbol),
string_like("'", "'", combinators_inside_string, :string_symbol)
])
|> concat(token(string(":"), :punctuation))
normal_keyword =
choice([operator_name, normal_atom_name])
|> token(:string_symbol)
|> concat(token(string(":"), :punctuation))
keyword =
choice([
normal_keyword,
string_keyword
])
|> concat(whitespace)
double_quoted_string_interpol = string_like("\"", "\"", combinators_inside_string, :string)
line = repeat(lookahead_not(ascii_char([?\n])) |> utf8_string([], 1))
inline_comment =
string("//")
|> concat(line)
|> token(:comment_single)
multiline_comment = string_like("/*", "*/", combinators_inside_string, :comment_multiline)
root_element_combinator =
choice(
[
whitespace,
# Comments
multiline_comment,
inline_comment,
# Syntax sugar for keyword lists (must come before variables and strings)
directive,
keyword,
# Strings
double_quoted_string_interpol
] ++
[
# Chars
escape_char,
normal_char
] ++
delimiter_pairs ++
[
# Operators
operator,
# Numbers
number_bin,
number_oct,
number_hex,
# Floats must come before integers
number_float,
number_integer,
# Names
variable,
define,
punctuation,
# If we can't parse any of the above, we highlight the next character as an error
# and proceed from there.
# A lexer should always consume any string given as input.
any_char
]
)
# By default, don't inline the lexers.
# Inlining them increases performance by ~20%
# at the cost of doubling the compilation times...
@inline false
@doc false
def __as_c_language__({ttype, meta, value}) do
{ttype, Map.put(meta, :language, :c), value}
end
# Semi-public API: these two functions can be used by someone who wants to
# embed an Elixir lexer into another lexer, but other than that, they are not
# meant to be used by end-users.
# @impl Makeup.Lexer
defparsec(
:root_element,
root_element_combinator |> map({__MODULE__, :__as_c_language__, []}),
inline: @inline
)
# @impl Makeup.Lexer
defparsec(
:root,
repeat(parsec(:root_element)),
inline: @inline
)
###################################################################
# Step #2: postprocess the list of tokens
###################################################################
@keyword ~W[
alignas alignoif asm atomic_cancel atomic_commit
atomic_noexcept auto break case catch class co_await
co_return co_yield compl concept const const_cast
constexpr continue decltype default delete do dynamic_cast
else enum explicit export extern for friend goto if
import inline module mutable namespace new noexcept
nullptr operator private protected public register
reinterpret_cast requires return sizeof static static_assert
static_cast struct switch synchronized template this
thread_local throw try typedef typeid typename union
using virtual volatile while
]
@keyword_type ~W[
bool byte int long unsigned double char short signed float wchar_t
char16_t char32_t int8_t uint8_t int16_t uint16_t int32_t uint32_t
int64_t uint64_t
]
@keyword_constant ~W[
NULL true false void
]
@operator_word ~W[and and_eq bitand bitor not not_eq or or_eq xor xor_eq]
@name_builtin_pseudo ~W[__FUNCTION__ __FILE__ __LINE__]
# The `postprocess/1` function will require a major redesign when we decide to support
# custom `def`-like keywords supplied by the user.
defp postprocess_helper([]), do: []
# match function names. They are followed by parens...
defp postprocess_helper([
{:name, attrs, text},
{:punctuation, %{language: :c}, "("}
| tokens
]) do
[
{:name_function, attrs, text},
{:punctuation, %{language: :c}, "("}
| postprocess_helper(tokens)
]
end
defp postprocess_helper([{:name, attrs, text} | tokens]) when text in @keyword,
do: [{:keyword, attrs, text} | postprocess_helper(tokens)]
defp postprocess_helper([{:name, attrs, text} | tokens]) when text in @keyword_type,
do: [{:keyword_type, attrs, text} | postprocess_helper(tokens)]
defp postprocess_helper([{:name, attrs, text} | tokens]) when text in @keyword_constant,
do: [{:keyword_constant, attrs, text} | postprocess_helper(tokens)]
defp postprocess_helper([{:name, attrs, text} | tokens]) when text in @operator_word,
do: [{:operator_word, attrs, text} | postprocess_helper(tokens)]
defp postprocess_helper([{:name, attrs, text} | tokens]) when text in @name_builtin_pseudo,
do: [{:name_builtin_pseudo, attrs, text} | postprocess_helper(tokens)]
# Unused variables
defp postprocess_helper([{:name, attrs, "_" <> _name = text} | tokens]),
do: [{:comment, attrs, text} | postprocess_helper(tokens)]
# Otherwise, don't do anything with the current token and go to the next token.
defp postprocess_helper([token | tokens]), do: [token | postprocess_helper(tokens)]
# Public API
@impl Makeup.Lexer
def postprocess(tokens, _opts \\ []), do: postprocess_helper(tokens)
###################################################################
# Step #3: highlight matching delimiters
###################################################################
@impl Makeup.Lexer
defgroupmatcher(:match_groups,
parentheses: [
open: [[{:punctuation, %{language: :c}, "("}]],
close: [[{:punctuation, %{language: :c}, ")"}]]
],
array: [
open: [[{:punctuation, %{language: :c}, "["}]],
close: [[{:punctuation, %{language: :c}, "]"}]]
],
brackets: [
open: [[{:punctuation, %{language: :c}, "{"}]],
close: [[{:punctuation, %{language: :c}, "}"}]]
]
)
defp remove_initial_newline([{ttype, meta, text} | tokens]) do
case to_string(text) do
"\n" -> tokens
"\n" <> rest -> [{ttype, meta, rest} | tokens]
end
end
# Finally, the public API for the lexer
@impl Makeup.Lexer
def lex(text, opts \\ []) do
group_prefix = Keyword.get(opts, :group_prefix, random_prefix(10))
{:ok, tokens, "", _, _, _} = root("\n" <> text)
tokens
|> remove_initial_newline()
|> postprocess([])
|> match_groups(group_prefix)
end
end
|