1 //===- AsmLexer.cpp - Lexer for Assembly Files ----------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This class implements the lexer for assembly files.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/MC/MCParser/AsmLexer.h"
15 #include "llvm/MC/MCAsmInfo.h"
16 #include "llvm/Support/MemoryBuffer.h"
17 #include "llvm/Support/SMLoc.h"
24 AsmLexer::AsmLexer(const MCAsmInfo &_MAI) : MAI(_MAI) {
27 isAtStartOfLine = true;
30 AsmLexer::~AsmLexer() {
33 void AsmLexer::setBuffer(const MemoryBuffer *buf, const char *ptr) {
39 CurPtr = CurBuf->getBufferStart();
44 /// ReturnError - Set the error to the specified string at the specified
45 /// location. This is defined to always return AsmToken::Error.
46 AsmToken AsmLexer::ReturnError(const char *Loc, const std::string &Msg) {
47 SetError(SMLoc::getFromPointer(Loc), Msg);
49 return AsmToken(AsmToken::Error, StringRef(Loc, 0));
52 int AsmLexer::getNextChar() {
53 char CurChar = *CurPtr++;
56 return (unsigned char)CurChar;
58 // A nul character in the stream is either the end of the current buffer or
59 // a random nul in the file. Disambiguate that here.
60 if (CurPtr-1 != CurBuf->getBufferEnd())
61 return 0; // Just whitespace.
63 // Otherwise, return end of file.
64 --CurPtr; // Another call to lex will return EOF again.
69 /// LexFloatLiteral: [0-9]*[.][0-9]*([eE][+-]?[0-9]*)?
71 /// The leading integral digit sequence and dot should have already been
72 /// consumed, some or all of the fractional digit sequence *can* have been
74 AsmToken AsmLexer::LexFloatLiteral() {
75 // Skip the fractional digit sequence.
76 while (isdigit(*CurPtr))
79 // Check for exponent; we intentionally accept a slighlty wider set of
80 // literals here and rely on the upstream client to reject invalid ones (e.g.,
82 if (*CurPtr == 'e' || *CurPtr == 'E') {
84 if (*CurPtr == '-' || *CurPtr == '+')
86 while (isdigit(*CurPtr))
90 return AsmToken(AsmToken::Real,
91 StringRef(TokStart, CurPtr - TokStart));
94 /// LexIdentifier: [a-zA-Z_.][a-zA-Z0-9_$.@]*
95 static bool IsIdentifierChar(char c) {
96 return isalnum(c) || c == '_' || c == '$' || c == '.' || c == '@';
98 AsmToken AsmLexer::LexIdentifier() {
99 // Check for floating point literals.
100 if (CurPtr[-1] == '.' && isdigit(*CurPtr)) {
101 // Disambiguate a .1243foo identifier from a floating literal.
102 while (isdigit(*CurPtr))
104 if (*CurPtr == 'e' || *CurPtr == 'E' || !IsIdentifierChar(*CurPtr))
105 return LexFloatLiteral();
108 while (IsIdentifierChar(*CurPtr))
111 // Handle . as a special case.
112 if (CurPtr == TokStart+1 && TokStart[0] == '.')
113 return AsmToken(AsmToken::Dot, StringRef(TokStart, 1));
115 return AsmToken(AsmToken::Identifier, StringRef(TokStart, CurPtr - TokStart));
118 /// LexSlash: Slash: /
119 /// C-Style Comment: /* ... */
120 AsmToken AsmLexer::LexSlash() {
122 case '*': break; // C style comment.
123 case '/': return ++CurPtr, LexLineComment();
124 default: return AsmToken(AsmToken::Slash, StringRef(CurPtr-1, 1));
128 ++CurPtr; // skip the star.
130 int CurChar = getNextChar();
133 return ReturnError(TokStart, "unterminated comment");
135 // End of the comment?
136 if (CurPtr[0] != '/') break;
138 ++CurPtr; // End the */.
144 /// LexLineComment: Comment: #[^\n]*
146 AsmToken AsmLexer::LexLineComment() {
147 // FIXME: This is broken if we happen to a comment at the end of a file, which
148 // was .included, and which doesn't end with a newline.
149 int CurChar = getNextChar();
150 while (CurChar != '\n' && CurChar != '\r' && CurChar != EOF)
151 CurChar = getNextChar();
154 return AsmToken(AsmToken::Eof, StringRef(CurPtr, 0));
155 return AsmToken(AsmToken::EndOfStatement, StringRef(CurPtr, 0));
158 static void SkipIgnoredIntegerSuffix(const char *&CurPtr) {
159 // Skip ULL, UL, U, L and LL suffices.
160 if (CurPtr[0] == 'U')
162 if (CurPtr[0] == 'L')
164 if (CurPtr[0] == 'L')
168 // Look ahead to search for first non-hex digit, if it's [hH], then we treat the
169 // integer as a hexadecimal, possibly with leading zeroes.
170 static unsigned doLookAhead(const char *&CurPtr, unsigned DefaultRadix) {
171 const char *FirstHex = 0;
172 const char *LookAhead = CurPtr;
174 if (isdigit(*LookAhead)) {
176 } else if (isxdigit(*LookAhead)) {
178 FirstHex = LookAhead;
184 bool isHex = *LookAhead == 'h' || *LookAhead == 'H';
185 CurPtr = isHex || !FirstHex ? LookAhead : FirstHex;
191 /// LexDigit: First character is [0-9].
192 /// Local Label: [0-9][:]
193 /// Forward/Backward Label: [0-9][fb]
194 /// Binary integer: 0b[01]+
195 /// Octal integer: 0[0-7]+
196 /// Hex integer: 0x[0-9a-fA-F]+ or [0x]?[0-9][0-9a-fA-F]*[hH]
197 /// Decimal integer: [1-9][0-9]*
198 AsmToken AsmLexer::LexDigit() {
199 // Decimal integer: [1-9][0-9]*
200 if (CurPtr[-1] != '0' || CurPtr[0] == '.') {
201 unsigned Radix = doLookAhead(CurPtr, 10);
202 bool isHex = Radix == 16;
203 // Check for floating point literals.
204 if (!isHex && (*CurPtr == '.' || *CurPtr == 'e')) {
206 return LexFloatLiteral();
209 StringRef Result(TokStart, CurPtr - TokStart);
212 if (Result.getAsInteger(Radix, Value)) {
213 // Allow positive values that are too large to fit into a signed 64-bit
214 // integer, but that do fit in an unsigned one, we just convert them over.
215 unsigned long long UValue;
216 if (Result.getAsInteger(Radix, UValue))
217 return ReturnError(TokStart, !isHex ? "invalid decimal number" :
218 "invalid hexdecimal number");
219 Value = (long long)UValue;
222 // Consume the [bB][hH].
223 if (Radix == 2 || Radix == 16)
226 // The darwin/x86 (and x86-64) assembler accepts and ignores type
227 // suffices on integer literals.
228 SkipIgnoredIntegerSuffix(CurPtr);
230 return AsmToken(AsmToken::Integer, Result, Value);
233 if (*CurPtr == 'b') {
235 // See if we actually have "0b" as part of something like "jmp 0b\n"
236 if (!isdigit(CurPtr[0])) {
238 StringRef Result(TokStart, CurPtr - TokStart);
239 return AsmToken(AsmToken::Integer, Result, 0);
241 const char *NumStart = CurPtr;
242 while (CurPtr[0] == '0' || CurPtr[0] == '1')
245 // Requires at least one binary digit.
246 if (CurPtr == NumStart)
247 return ReturnError(TokStart, "invalid binary number");
249 StringRef Result(TokStart, CurPtr - TokStart);
252 if (Result.substr(2).getAsInteger(2, Value))
253 return ReturnError(TokStart, "invalid binary number");
255 // The darwin/x86 (and x86-64) assembler accepts and ignores ULL and LL
256 // suffixes on integer literals.
257 SkipIgnoredIntegerSuffix(CurPtr);
259 return AsmToken(AsmToken::Integer, Result, Value);
262 if (*CurPtr == 'x') {
264 const char *NumStart = CurPtr;
265 while (isxdigit(CurPtr[0]))
268 // Requires at least one hex digit.
269 if (CurPtr == NumStart)
270 return ReturnError(CurPtr-2, "invalid hexadecimal number");
272 unsigned long long Result;
273 if (StringRef(TokStart, CurPtr - TokStart).getAsInteger(0, Result))
274 return ReturnError(TokStart, "invalid hexadecimal number");
276 // Consume the optional [hH].
277 if (*CurPtr == 'h' || *CurPtr == 'H')
280 // The darwin/x86 (and x86-64) assembler accepts and ignores ULL and LL
281 // suffixes on integer literals.
282 SkipIgnoredIntegerSuffix(CurPtr);
284 return AsmToken(AsmToken::Integer, StringRef(TokStart, CurPtr - TokStart),
288 // Either octal or hexadecimal.
290 unsigned Radix = doLookAhead(CurPtr, 8);
291 bool isHex = Radix == 16;
292 StringRef Result(TokStart, CurPtr - TokStart);
293 if (Result.getAsInteger(Radix, Value))
294 return ReturnError(TokStart, !isHex ? "invalid octal number" :
295 "invalid hexdecimal number");
301 // The darwin/x86 (and x86-64) assembler accepts and ignores ULL and LL
302 // suffixes on integer literals.
303 SkipIgnoredIntegerSuffix(CurPtr);
305 return AsmToken(AsmToken::Integer, Result, Value);
308 /// LexSingleQuote: Integer: 'b'
309 AsmToken AsmLexer::LexSingleQuote() {
310 int CurChar = getNextChar();
313 CurChar = getNextChar();
316 return ReturnError(TokStart, "unterminated single quote");
318 CurChar = getNextChar();
321 return ReturnError(TokStart, "single quote way too long");
323 // The idea here being that 'c' is basically just an integral
325 StringRef Res = StringRef(TokStart,CurPtr - TokStart);
328 if (Res.startswith("\'\\")) {
329 char theChar = Res[2];
331 default: Value = theChar; break;
332 case '\'': Value = '\''; break;
333 case 't': Value = '\t'; break;
334 case 'n': Value = '\n'; break;
335 case 'b': Value = '\b'; break;
340 return AsmToken(AsmToken::Integer, Res, Value);
344 /// LexQuote: String: "..."
345 AsmToken AsmLexer::LexQuote() {
346 int CurChar = getNextChar();
347 // TODO: does gas allow multiline string constants?
348 while (CurChar != '"') {
349 if (CurChar == '\\') {
351 CurChar = getNextChar();
355 return ReturnError(TokStart, "unterminated string constant");
357 CurChar = getNextChar();
360 return AsmToken(AsmToken::String, StringRef(TokStart, CurPtr - TokStart));
363 StringRef AsmLexer::LexUntilEndOfStatement() {
366 while (!isAtStartOfComment(*CurPtr) && // Start of line comment.
367 !isAtStatementSeparator(CurPtr) && // End of statement marker.
370 (*CurPtr != 0 || CurPtr != CurBuf->getBufferEnd())) {
373 return StringRef(TokStart, CurPtr-TokStart);
376 StringRef AsmLexer::LexUntilEndOfLine() {
379 while (*CurPtr != '\n' &&
381 (*CurPtr != 0 || CurPtr != CurBuf->getBufferEnd())) {
384 return StringRef(TokStart, CurPtr-TokStart);
387 bool AsmLexer::isAtStartOfComment(char Char) {
388 // FIXME: This won't work for multi-character comment indicators like "//".
389 return Char == *MAI.getCommentString();
392 bool AsmLexer::isAtStatementSeparator(const char *Ptr) {
393 return strncmp(Ptr, MAI.getSeparatorString(),
394 strlen(MAI.getSeparatorString())) == 0;
397 AsmToken AsmLexer::LexToken() {
399 // This always consumes at least one character.
400 int CurChar = getNextChar();
402 if (isAtStartOfComment(CurChar)) {
403 // If this comment starts with a '#', then return the Hash token and let
404 // the assembler parser see if it can be parsed as a cpp line filename
405 // comment. We do this only if we are at the start of a line.
406 if (CurChar == '#' && isAtStartOfLine)
407 return AsmToken(AsmToken::Hash, StringRef(TokStart, 1));
408 isAtStartOfLine = true;
409 return LexLineComment();
411 if (isAtStatementSeparator(TokStart)) {
412 CurPtr += strlen(MAI.getSeparatorString()) - 1;
413 return AsmToken(AsmToken::EndOfStatement,
414 StringRef(TokStart, strlen(MAI.getSeparatorString())));
417 // If we're missing a newline at EOF, make sure we still get an
418 // EndOfStatement token before the Eof token.
419 if (CurChar == EOF && !isAtStartOfLine) {
420 isAtStartOfLine = true;
421 return AsmToken(AsmToken::EndOfStatement, StringRef(TokStart, 1));
424 isAtStartOfLine = false;
427 // Handle identifier: [a-zA-Z_.][a-zA-Z0-9_$.@]*
428 if (isalpha(CurChar) || CurChar == '_' || CurChar == '.')
429 return LexIdentifier();
431 // Unknown character, emit an error.
432 return ReturnError(TokStart, "invalid character in input");
433 case EOF: return AsmToken(AsmToken::Eof, StringRef(TokStart, 0));
438 // Ignore whitespace.
442 while (*CurPtr==' ' || *CurPtr=='\t') {
446 return AsmToken(AsmToken::Space, StringRef(TokStart, len));
448 case '\n': // FALL THROUGH.
450 isAtStartOfLine = true;
451 return AsmToken(AsmToken::EndOfStatement, StringRef(TokStart, 1));
452 case ':': return AsmToken(AsmToken::Colon, StringRef(TokStart, 1));
453 case '+': return AsmToken(AsmToken::Plus, StringRef(TokStart, 1));
454 case '-': return AsmToken(AsmToken::Minus, StringRef(TokStart, 1));
455 case '~': return AsmToken(AsmToken::Tilde, StringRef(TokStart, 1));
456 case '(': return AsmToken(AsmToken::LParen, StringRef(TokStart, 1));
457 case ')': return AsmToken(AsmToken::RParen, StringRef(TokStart, 1));
458 case '[': return AsmToken(AsmToken::LBrac, StringRef(TokStart, 1));
459 case ']': return AsmToken(AsmToken::RBrac, StringRef(TokStart, 1));
460 case '{': return AsmToken(AsmToken::LCurly, StringRef(TokStart, 1));
461 case '}': return AsmToken(AsmToken::RCurly, StringRef(TokStart, 1));
462 case '*': return AsmToken(AsmToken::Star, StringRef(TokStart, 1));
463 case ',': return AsmToken(AsmToken::Comma, StringRef(TokStart, 1));
464 case '$': return AsmToken(AsmToken::Dollar, StringRef(TokStart, 1));
465 case '@': return AsmToken(AsmToken::At, StringRef(TokStart, 1));
466 case '\\': return AsmToken(AsmToken::BackSlash, StringRef(TokStart, 1));
469 return ++CurPtr, AsmToken(AsmToken::EqualEqual, StringRef(TokStart, 2));
470 return AsmToken(AsmToken::Equal, StringRef(TokStart, 1));
473 return ++CurPtr, AsmToken(AsmToken::PipePipe, StringRef(TokStart, 2));
474 return AsmToken(AsmToken::Pipe, StringRef(TokStart, 1));
475 case '^': return AsmToken(AsmToken::Caret, StringRef(TokStart, 1));
478 return ++CurPtr, AsmToken(AsmToken::AmpAmp, StringRef(TokStart, 2));
479 return AsmToken(AsmToken::Amp, StringRef(TokStart, 1));
482 return ++CurPtr, AsmToken(AsmToken::ExclaimEqual, StringRef(TokStart, 2));
483 return AsmToken(AsmToken::Exclaim, StringRef(TokStart, 1));
484 case '%': return AsmToken(AsmToken::Percent, StringRef(TokStart, 1));
485 case '/': return LexSlash();
486 case '#': return AsmToken(AsmToken::Hash, StringRef(TokStart, 1));
487 case '\'': return LexSingleQuote();
488 case '"': return LexQuote();
489 case '0': case '1': case '2': case '3': case '4':
490 case '5': case '6': case '7': case '8': case '9':
494 case '<': return ++CurPtr, AsmToken(AsmToken::LessLess,
495 StringRef(TokStart, 2));
496 case '=': return ++CurPtr, AsmToken(AsmToken::LessEqual,
497 StringRef(TokStart, 2));
498 case '>': return ++CurPtr, AsmToken(AsmToken::LessGreater,
499 StringRef(TokStart, 2));
500 default: return AsmToken(AsmToken::Less, StringRef(TokStart, 1));
504 case '>': return ++CurPtr, AsmToken(AsmToken::GreaterGreater,
505 StringRef(TokStart, 2));
506 case '=': return ++CurPtr, AsmToken(AsmToken::GreaterEqual,
507 StringRef(TokStart, 2));
508 default: return AsmToken(AsmToken::Greater, StringRef(TokStart, 1));
511 // TODO: Quoted identifiers (objc methods etc)
512 // local labels: [0-9][:]
513 // Forward/backward labels: [0-9][fb]
514 // Integers, fp constants, character constants.