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
|
from __future__ import print_function
from __future__ import unicode_literals
import re
import sys
from cmakelang import common
# NOTE(josh): inspiration and some bits taken from cmakeast_ and
# cmakelistparsing_
#
# .. _cmake_ast: https://github.com/polysquare/cmake-ast
# .. _cmakelist_parsing: https://github.com/ijt/cmakelists_parsing
class TokenType(common.EnumObject):
_id_map = {}
TokenType.QUOTED_LITERAL = TokenType(0)
TokenType.LEFT_PAREN = TokenType(1)
TokenType.RIGHT_PAREN = TokenType(2)
TokenType.WORD = TokenType(3)
TokenType.NUMBER = TokenType(4)
TokenType.DEREF = TokenType(5)
TokenType.WHITESPACE = TokenType(6)
TokenType.NEWLINE = TokenType(7)
TokenType.COMMENT = TokenType(8)
TokenType.UNQUOTED_LITERAL = TokenType(9)
TokenType.FORMAT_OFF = TokenType(10)
TokenType.FORMAT_ON = TokenType(11)
TokenType.BRACKET_ARGUMENT = TokenType(12)
TokenType.BRACKET_COMMENT = TokenType(13)
TokenType.BYTEORDER_MARK = TokenType(14)
TokenType.ATWORD = TokenType(15)
class SourceLocation(tuple):
"""
Named tuple of (line, col, offset)
"""
# def __init__(self, line, col, offset):
# super(SourceLocation, self).__init__((line, col, offset))
@property
def line(self):
return self[0]
@property
def col(self):
return self[1]
@property
def offset(self):
return self[2]
def __repr__(self):
return '{}:{}'.format(self.line, self.col)
class Token(object):
"""
Lexical unit of a listfile.
"""
def __init__(self, tok_type, spelling, index, begin, end):
self.type = tok_type
self.spelling = spelling
self.index = index
self.begin = begin
self.end = end
@property
def content(self):
return self.spelling
# TODO(josh): get rid of this? Is it used or did I accidentally add it when
# I meant to add get_location()? Or should this be a property?
def location(self):
return self.begin
def get_location(self):
return self.begin
def count_newlines(self):
return self.spelling.count('\n')
def __repr__(self):
"""A string representation of this token."""
return ("Token(type={0}, "
"content={1}, "
"line={2}, "
"col={3})").format(self.type.name, repr(self.spelling), *self.begin)
def tokenize(contents):
"""
Scan a string and return a list of Token objects representing the contents
of the cmake listfile.
"""
# https://cmake.org/cmake/help/v3.0/manual/
# cmake-language.7.html#grammar-token-unquoted_legacy
legacy_pattern = "({})+".format(
"|".join([
# Make-style variable like $(MAKE)
r'(\$\([^\$\(\)]+\))',
# Quoted-substring
r'("[^"\\]*(?:\\.[^"\\]*)*")',
# Any element except whitespace or one of '()#"\'
r'([^\s\(\)#"\\])',
# Escape sequences
# https://cmake.org/cmake/help/v3.0/manual/
# cmake-language.7.html#grammar-token-escape_sequence
r'(\\[\(\)#" \\\$@^trn;])'
])
)
# https://cmake.org/cmake/help/v3.0/manual/
# cmake-language.7.html#unquoted-argument
unquoted_pattern = "({})+".format(
"|".join([
# Any element except whitespace or one of '()#"\'
r'([^\s\(\)#"\\])',
# Escape sequences
# https://cmake.org/cmake/help/v3.0/manual/
# cmake-language.7.html#grammar-token-escape_sequence
r'(\\[\(\)#" \\\$@^trn;])'
])
)
# Regexes are in priority order. Changing the order may alter the
# behavior of the lexer
scanner = re.Scanner([
# double quoted string
# NOTE(josh): regex borrowed from
# https://stackoverflow.com/a/37379449/141023
(r'(?<![^\s\(])"[^"\\]*(?:\\.[^"\\]*)*"(?![^\s\)])',
lambda s, t: (TokenType.QUOTED_LITERAL, t)),
# single quoted string
(r"(?<![^\s\(])'[^'\\]*(?:\\.[^'\\]*)*'(?![^\s\)])",
lambda s, t: (TokenType.QUOTED_LITERAL, t)),
# bracket argument
(r"(?<![^\s\(])\[(=*)\[.*?\]\1\](?![^\s\)])",
lambda s, t: (TokenType.BRACKET_ARGUMENT, t)),
(r"(?<![^\s\(])-?[0-9]+(?![^\s\)\(])",
lambda s, t: (TokenType.NUMBER, t)),
# Either a valid function name or variable name.
(r"(?<![^\s\(])[a-zA-z_][a-zA-Z0-9_]*(?![^\s\)\(])",
lambda s, t: (TokenType.WORD, t)),
# A configure_file replacement @<word>@
# Either a valid function name or variable name.
(r"(?<![^\s\(])@[a-zA-z_][a-zA-Z0-9_]*@(?![^\s\)\(])",
lambda s, t: (TokenType.ATWORD, t)),
# A variable dereference ${<word>}
(r"(?<![^\s\(])\${[a-zA-z_][a-zA-Z0-9_]*}(?![^\s\)])",
lambda s, t: (TokenType.DEREF, t)),
# unquoted_legacy
(legacy_pattern,
lambda s, t: (TokenType.UNQUOTED_LITERAL, t)),
# unquoted_element+
(unquoted_pattern,
lambda s, t: (TokenType.UNQUOTED_LITERAL, t)),
(r"\(", lambda s, t: (TokenType.LEFT_PAREN, t)),
(r"\)", lambda s, t: (TokenType.RIGHT_PAREN, t)),
# NOTE(josh): bare carriage returns are very unlikely to be used but
# just for the case of explicitnes, if we ever encounter any we treat
# it as a newline
(r"\r?\n", lambda s, t: (TokenType.NEWLINE, t)),
(r"\r\n?", lambda s, t: (TokenType.NEWLINE, t)),
# NOTE(josh): don't match '\s' here or we'll miss some newline tokens
# TODO(josh): should we match unicode whitespace too?
(r"[ \t\f\v]+", lambda s, t: (TokenType.WHITESPACE, t)),
(r"#\s*(cmake-format|cmf): off[^\n]*",
lambda s, t: (TokenType.FORMAT_OFF, t)),
(r"#\s*(cmake-format|cmf): on[^\n]*",
lambda s, t: (TokenType.FORMAT_ON, t)),
# bracket comment
(r"#\[(=*)\[.*?\]\1\]", lambda s, t: (TokenType.BRACKET_COMMENT, t)),
# line comment
(r"#[^\n]*", lambda s, t: (TokenType.COMMENT, t)),
# Catch-all for literals which are compound statements.
(r"([^\s\(\)]+|[^\s\(]*[^\)]|[^\(][^\s\)]*)",
lambda s, t: (TokenType.UNQUOTED_LITERAL, t)),
], re.DOTALL)
tokens_return = []
if contents.startswith("\ufeff"):
tokens_return = [
Token(tok_type=TokenType.BYTEORDER_MARK,
spelling=contents[0],
index=-1,
begin=SourceLocation((0, 0, 0)),
end=SourceLocation((0, 0, 0)))]
contents = contents[1:]
tokens, remainder = scanner.scan(contents)
# Now add line, column, and serial number to token objects. We get lineno
# by maintaining a running count of newline characters encountered among
# tokens so far, and column count by splitting the most recent token on
# it's right most newline. Note that line and numbers are 1-indexed to match
# up with editors but column numbers are zero indexed because its fun to be
# inconsistent.
lineno = 1
col = 0
offset = 0
for tok_index, (tok_type, spelling) in enumerate(tokens):
if sys.version_info[0] < 3:
assert isinstance(spelling, unicode)
begin = SourceLocation((lineno, col, offset))
newlines = spelling.count('\n')
lineno += newlines
if newlines:
col = len(spelling.rsplit('\n', 1)[1])
else:
col += len(spelling)
offset += len(bytearray(spelling, 'utf-8'))
tokens_return.append(Token(tok_type=tok_type,
spelling=spelling,
index=tok_index,
begin=begin,
end=SourceLocation((lineno, col, offset))))
if remainder:
raise common.UserError(
"Lexer Error: failed to tokenize input starting at: {}:{} with:\n {}"
.format(lineno, col, remainder[:-20]))
return tokens_return
def parse_bracket_argument(text):
regex = re.compile(r'^\[(=*)\[(.*)\]\1\]$', re.DOTALL)
match = regex.match(text)
assert match, "Failed to match bracket argument pattern in {}".format(text)
return ('[' + match.group(1) + '[',
match.group(2),
']' + match.group(1) + ']')
def parse_bracket_comment(text):
prefix, content, suffix = parse_bracket_argument(text[1:])
return ('#' + prefix, content, suffix)
def get_first_non_whitespace_token(tokens):
"""
Return the first token in the list that is not whitespace, or None
"""
for token in tokens:
if token.type not in (TokenType.WHITESPACE, TokenType.NEWLINE):
return token
return None
|