Lexer.h revision 2c78b873f4f3823ae859c15674cb3d76c8554113
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//===--- Lexer.h - C Language Family Lexer ----------------------*- C++ -*-===// 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The LLVM Compiler Infrastructure 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This file is distributed under the University of Illinois Open Source 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// License. See LICENSE.TXT for details. 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//===----------------------------------------------------------------------===// 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This file defines the Lexer interface. 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//===----------------------------------------------------------------------===// 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef LLVM_CLANG_LEXER_H 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define LLVM_CLANG_LEXER_H 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "clang/Lex/PreprocessorLexer.h" 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "clang/Basic/LangOptions.h" 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "llvm/ADT/SmallVector.h" 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <vector> 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <cassert> 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace clang { 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Diagnostic; 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class SourceManager; 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Preprocessor; 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class DiagnosticBuilder; 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/// Lexer - This provides a simple interface that turns a text buffer into a 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/// stream of tokens. This provides no support for file reading or buffering, 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/// or buffering/seeking of tokens, only forward lexing is supported. It relies 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/// on the specified Preprocessor object to handle preprocessor directives, etc. 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Lexer : public PreprocessorLexer { 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) //===--------------------------------------------------------------------===// 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Constant configuration values for this lexer. 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char *BufferStart; // Start of the buffer. 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char *BufferEnd; // End of the buffer. 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SourceLocation FileLoc; // Location for start of file. 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LangOptions Features; // Features enabled by this language (cache). 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool Is_PragmaLexer; // True if lexer for _Pragma handling. 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) //===--------------------------------------------------------------------===// 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Context-specific lexing flags set by the preprocessor. 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// ExtendedTokenMode - The lexer can optionally keep comments and whitespace 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// and return them as tokens. This is used for -C and -CC modes, and 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// whitespace preservation can be useful for some clients that want to lex 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// the file in raw mode and get every character from the file. 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// When this is set to 2 it returns comments and whitespace. When set to 1 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// it returns comments, when it is set to 0 it returns normal tokens only. 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned char ExtendedTokenMode; 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) //===--------------------------------------------------------------------===// 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Context that changes as the file is lexed. 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // NOTE: any state that mutates when in raw mode must have save/restore code 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // in Lexer::isNextPPTokenLParen. 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // BufferPtr - Current pointer into the buffer. This is the next character 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // to be lexed. 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char *BufferPtr; 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // IsAtStartOfLine - True if the next lexed token should get the "start of 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // line" flag set on it. 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool IsAtStartOfLine; 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Lexer(const Lexer&); // DO NOT IMPLEMENT 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void operator=(const Lexer&); // DO NOT IMPLEMENT 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class Preprocessor; 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void InitLexer(const char *BufStart, const char *BufPtr, const char *BufEnd); 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)public: 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// Lexer constructor - Create a new lexer object for the specified buffer 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// with the specified preprocessor managing the lexing process. This lexer 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// assumes that the associated file buffer and Preprocessor objects will 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// outlive it, so it doesn't take ownership of either of them. 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Lexer(FileID FID, Preprocessor &PP); 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// Lexer constructor - Create a new raw lexer object. This object is only 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// suitable for calls to 'LexRawToken'. This lexer assumes that the text 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// range will outlive it, so it doesn't take ownership of it. 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Lexer(SourceLocation FileLoc, const LangOptions &Features, 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char *BufStart, const char *BufPtr, const char *BufEnd); 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// Lexer constructor - Create a new raw lexer object. This object is only 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// suitable for calls to 'LexRawToken'. This lexer assumes that the text 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// range will outlive it, so it doesn't take ownership of it. 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Lexer(FileID FID, const SourceManager &SM, const LangOptions &Features); 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// Create_PragmaLexer: Lexer constructor - Create a new lexer object for 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// _Pragma expansion. This has a variety of magic semantics that this method 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// sets up. It returns a new'd Lexer that must be delete'd when done. 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static Lexer *Create_PragmaLexer(SourceLocation SpellingLoc, 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SourceLocation InstantiationLocStart, 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SourceLocation InstantiationLocEnd, 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned TokLen, Preprocessor &PP); 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// getFeatures - Return the language features currently enabled. NOTE: this 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// lexer modifies features as a file is parsed! 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const LangOptions &getFeatures() const { return Features; } 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// getFileLoc - Return the File Location for the file we are lexing out of. 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// The physical location encodes the location where the characters come from, 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// the virtual location encodes where we should *claim* the characters came 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// from. Currently this is only used by _Pragma handling. 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SourceLocation getFileLoc() const { return FileLoc; } 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// Lex - Return the next token in the file. If this is the end of file, it 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// return the tok::eof token. Return true if an error occurred and 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// compilation should terminate, false if normal. This implicitly involves 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// the preprocessor. 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Lex(Token &Result) { 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Start a new token. 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Result.startToken(); 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // NOTE, any changes here should also change code after calls to 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Preprocessor::HandleDirective 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (IsAtStartOfLine) { 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Result.setFlag(Token::StartOfLine); 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) IsAtStartOfLine = false; 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get a token. Note that this may delete the current lexer if the end of 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // file is reached. 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LexTokenInternal(Result); 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// isPragmaLexer - Returns true if this Lexer is being used to lex a pragma. 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool isPragmaLexer() const { return Is_PragmaLexer; } 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// IndirectLex - An indirect call to 'Lex' that can be invoked via 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// the PreprocessorLexer interface. 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void IndirectLex(Token &Result) { Lex(Result); } 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// LexFromRawLexer - Lex a token from a designated raw lexer (one with no 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// associated preprocessor object. Return true if the 'next character to 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// read' pointer points at the end of the lexer buffer, false otherwise. 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool LexFromRawLexer(Token &Result) { 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) assert(LexingRawMode && "Not already in raw mode!"); 1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Lex(Result); 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Note that lexing to the end of the buffer doesn't implicitly delete the 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // lexer when in raw mode. 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return BufferPtr == BufferEnd; 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// isKeepWhitespaceMode - Return true if the lexer should return tokens for 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// every character in the file, including whitespace and comments. This 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// should only be used in raw mode, as the preprocessor is not prepared to 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// deal with the excess tokens. 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool isKeepWhitespaceMode() const { 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return ExtendedTokenMode > 1; 1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// SetKeepWhitespaceMode - This method lets clients enable or disable 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// whitespace retention mode. 1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetKeepWhitespaceMode(bool Val) { 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) assert((!Val || LexingRawMode) && 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) "Can only enable whitespace retention in raw mode"); 1635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ExtendedTokenMode = Val ? 2 : 0; 1645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// inKeepCommentMode - Return true if the lexer should return comments as 1675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// tokens. 1685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool inKeepCommentMode() const { 1695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return ExtendedTokenMode > 0; 1705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// SetCommentRetentionMode - Change the comment retention mode of the lexer 1735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// to the specified mode. This is really only useful when lexing in raw 1745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// mode, because otherwise the lexer needs to manage this. 1755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetCommentRetentionState(bool Mode) { 1765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) assert(!isKeepWhitespaceMode() && 1775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) "Can't play with comment retention state when retaining whitespace"); 1785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ExtendedTokenMode = Mode ? 1 : 0; 1795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char *getBufferStart() const { return BufferStart; } 1825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// ReadToEndOfLine - Read the rest of the current preprocessor line as an 1845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// uninterpreted string. This switches the lexer out of directive mode. 1855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string ReadToEndOfLine(); 1865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// Diag - Forwarding function for diagnostics. This translate a source 1895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// position in the current buffer into a SourceLocation object for rendering. 1905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DiagnosticBuilder Diag(const char *Loc, unsigned DiagID) const; 1915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// getSourceLocation - Return a source location identifier for the specified 1935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// offset in the current file. 1945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SourceLocation getSourceLocation(const char *Loc, unsigned TokLen = 1) const; 1955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// getSourceLocation - Return a source location for the next character in 1975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// the current file. 1985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SourceLocation getSourceLocation() { return getSourceLocation(BufferPtr); } 1995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// Stringify - Convert the specified string into a C string by escaping '\' 2015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// and " characters. This does not add surrounding ""'s to the string. 2025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// If Charify is true, this escapes the ' character instead of ". 2035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static std::string Stringify(const std::string &Str, bool Charify = false); 2045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// Stringify - Convert the specified string into a C string by escaping '\' 2065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// and " characters. This does not add surrounding ""'s to the string. 2075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void Stringify(llvm::SmallVectorImpl<char> &Str); 2085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// MeasureTokenLength - Relex the token at the specified location and return 2105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// its length in bytes in the input file. If the token needs cleaning (e.g. 2115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// includes a trigraph or an escaped newline) then this count includes bytes 2125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// that are part of that. 2135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static unsigned MeasureTokenLength(SourceLocation Loc, 2145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const SourceManager &SM, 2155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const LangOptions &LangOpts); 2165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) //===--------------------------------------------------------------------===// 2185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Internal implementation interfaces. 2195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)private: 2205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// LexTokenInternal - Internal interface to lex a preprocessing token. Called 2225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// by Lex. 2235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// 2245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void LexTokenInternal(Token &Result); 2255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// FormTokenWithChars - When we lex a token, we have identified a span 2275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// starting at BufferPtr, going to TokEnd that forms the token. This method 2285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// takes that range and assigns it to the token as its location and size. In 2295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// addition, since tokens cannot overlap, this also updates BufferPtr to be 2305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// TokEnd. 2315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void FormTokenWithChars(Token &Result, const char *TokEnd, 2325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) tok::TokenKind Kind) { 2335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned TokLen = TokEnd-BufferPtr; 2345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Result.setLength(TokLen); 2355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Result.setLocation(getSourceLocation(BufferPtr, TokLen)); 2365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Result.setKind(Kind); 2375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BufferPtr = TokEnd; 2385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// isNextPPTokenLParen - Return 1 if the next unexpanded token will return a 2415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// tok::l_paren token, 0 if it is something else and 2 if there are no more 2425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// tokens in the buffer controlled by this lexer. 2435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned isNextPPTokenLParen(); 2445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) //===--------------------------------------------------------------------===// 2465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Lexer character reading interfaces. 2475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)public: 2485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This lexer is built on two interfaces for reading characters, both of which 2505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // automatically provide phase 1/2 translation. getAndAdvanceChar is used 2515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // when we know that we will be reading a character from the input buffer and 2525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // that this character will be part of the result token. This occurs in (f.e.) 2535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // string processing, because we know we need to read until we find the 2545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // closing '"' character. 2555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 2565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The second interface is the combination of PeekCharAndSize with 2575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ConsumeChar. PeekCharAndSize reads a phase 1/2 translated character, 2585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // returning it and its size. If the lexer decides that this character is 2595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // part of the current token, it calls ConsumeChar on it. This two stage 2605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // approach allows us to emit diagnostics for characters (e.g. warnings about 2615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // trigraphs), knowing that they only are emitted if the character is 2625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // consumed. 2635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// isObviouslySimpleCharacter - Return true if the specified character is 2655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// obviously the same in translation phase 1 and translation phase 3. This 2665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// can return false for characters that end up being the same, but it will 2675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// never return true for something that needs to be mapped. 2685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static bool isObviouslySimpleCharacter(char C) { 2695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return C != '?' && C != '\\'; 2705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// getAndAdvanceChar - Read a single 'character' from the specified buffer, 2735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// advance over it, and return it. This is tricky in several cases. Here we 2745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// just handle the trivial case and fall-back to the non-inlined 2755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// getCharAndSizeSlow method to handle the hard case. 2765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) inline char getAndAdvanceChar(const char *&Ptr, Token &Tok) { 2775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If this is not a trigraph and not a UCN or escaped newline, return 2785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // quickly. 2795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (isObviouslySimpleCharacter(Ptr[0])) return *Ptr++; 2805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned Size = 0; 2825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) char C = getCharAndSizeSlow(Ptr, Size, &Tok); 2835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Ptr += Size; 2845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return C; 2855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)private: 2885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// ConsumeChar - When a character (identified by PeekCharAndSize) is consumed 2895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// and added to a given token, check to see if there are diagnostics that 2905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// need to be emitted or flags that need to be set on the token. If so, do 2915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// it. 2925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char *ConsumeChar(const char *Ptr, unsigned Size, Token &Tok) { 2935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Normal case, we consumed exactly one token. Just return it. 2945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (Size == 1) 2955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return Ptr+Size; 2965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Otherwise, re-lex the character with a current token, allowing 2985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // diagnostics to be emitted and flags to be set. 2995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Size = 0; 3005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) getCharAndSizeSlow(Ptr, Size, &Tok); 3015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return Ptr+Size; 3025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// getCharAndSize - Peek a single 'character' from the specified buffer, 3055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// get its size, and return it. This is tricky in several cases. Here we 3065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// just handle the trivial case and fall-back to the non-inlined 3075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// getCharAndSizeSlow method to handle the hard case. 3085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) inline char getCharAndSize(const char *Ptr, unsigned &Size) { 3095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If this is not a trigraph and not a UCN or escaped newline, return 3105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // quickly. 3115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (isObviouslySimpleCharacter(Ptr[0])) { 3125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Size = 1; 3135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return *Ptr; 3145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Size = 0; 3175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return getCharAndSizeSlow(Ptr, Size); 3185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// getCharAndSizeSlow - Handle the slow/uncommon case of the getCharAndSize 3215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// method. 3225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) char getCharAndSizeSlow(const char *Ptr, unsigned &Size, Token *Tok = 0); 3235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)public: 3245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// getCharAndSizeNoWarn - Like the getCharAndSize method, but does not ever 3265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// emit a warning. 3275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static inline char getCharAndSizeNoWarn(const char *Ptr, unsigned &Size, 3285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const LangOptions &Features) { 3295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If this is not a trigraph and not a UCN or escaped newline, return 3305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // quickly. 3315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (isObviouslySimpleCharacter(Ptr[0])) { 3325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Size = 1; 3335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return *Ptr; 3345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Size = 0; 3375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return getCharAndSizeSlowNoWarn(Ptr, Size, Features); 3385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)private: 3405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// getCharAndSizeSlowNoWarn - Same as getCharAndSizeSlow, but never emits a 3425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /// diagnostic. 3435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static char getCharAndSizeSlowNoWarn(const char *Ptr, unsigned &Size, 3445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const LangOptions &Features); 3455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) //===--------------------------------------------------------------------===// 3475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Other lexer functions. 3485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Helper functions to lex the remainder of a token of the specific type. 3505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void LexIdentifier (Token &Result, const char *CurPtr); 3515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void LexNumericConstant (Token &Result, const char *CurPtr); 3525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void LexStringLiteral (Token &Result, const char *CurPtr,bool Wide); 3535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void LexAngledStringLiteral(Token &Result, const char *CurPtr); 3545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void LexCharConstant (Token &Result, const char *CurPtr); 3555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool LexEndOfFile (Token &Result, const char *CurPtr); 3565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool SkipWhitespace (Token &Result, const char *CurPtr); 3585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool SkipBCPLComment (Token &Result, const char *CurPtr); 3595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool SkipBlockComment (Token &Result, const char *CurPtr); 3605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool SaveBCPLComment (Token &Result, const char *CurPtr); 3615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 3625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // end namespace clang 3655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 3675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)