cerc-io/solidity
10
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

modifying solidity scanner class to conform with the coding standards

Browse Source
This commit is contained in:
Lefteris Karapetsas 2014-11-21 17:08:35 +01:00
parent c7b933b4db
commit 4cbfb5a903
2 changed files with 88 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

112
Scanner.cpp
View File

@ -63,34 +63,34 @@ namespace solidity
namespace namespace
{ {
bool IsDecimalDigit(char c) bool isDecimalDigit(char c)
{ {
return '0' <= c && c <= '9'; return '0' <= c && c <= '9';
} }
bool IsHexDigit(char c) bool isHexDigit(char c)
{ {
return IsDecimalDigit(c) return isDecimalDigit(c)
|| ('a' <= c && c <= 'f') || ('a' <= c && c <= 'f')
|| ('A' <= c && c <= 'F'); || ('A' <= c && c <= 'F');
} }
bool IsLineTerminator(char c) bool isLineTerminator(char c)
{ {
return c == '\n'; return c == '\n';
} }
bool IsWhiteSpace(char c) bool isWhiteSpace(char c)
{ {
return c == ' ' || c == '\n' || c == '\t'; return c == ' ' || c == '\n' || c == '\t';
} }
bool IsIdentifierStart(char c) bool isIdentifierStart(char c)
{ {
return c == '_' || c == '$' || ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z'); return c == '_' || c == '$' || ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
} }
bool IsIdentifierPart(char c) bool isIdentifierPart(char c)
{ {
return IsIdentifierStart(c) || IsDecimalDigit(c); return isIdentifierStart(c) || isDecimalDigit(c);
} }
int HexValue(char c) int hexValue(char c)
{ {
if (c >= '0' && c <= '9') if (c >= '0' && c <= '9')
return c - '0'; return c - '0';
@ -111,9 +111,9 @@ void Scanner::reset(CharStream const& _source)
foundDocComment = scanToken(); foundDocComment = scanToken();
// special version of Scanner:next() taking the previous scanToken() result into account // special version of Scanner:next() taking the previous scanToken() result into account
m_current_token = m_next_token; m_currentToken = m_nextToken;
if (scanToken() || foundDocComment) if (scanToken() || foundDocComment)
m_skipped_comment = m_next_skipped_comment; m_skippedComment = m_nextSkippedComment;
} }
@ -122,7 +122,7 @@ bool Scanner::scanHexByte(char& o_scannedByte)
char x = 0; char x = 0;
for (int i = 0; i < 2; i++) for (int i = 0; i < 2; i++)
{ {
int d = HexValue(m_char); int d = hexValue(m_char);
if (d < 0) if (d < 0)
{ {
rollback(i); rollback(i);
@ -141,10 +141,10 @@ BOOST_STATIC_ASSERT(Token::NUM_TOKENS <= 0x100);
Token::Value Scanner::next() Token::Value Scanner::next()
{ {
m_current_token = m_next_token; m_currentToken = m_nextToken;
if (scanToken()) if (scanToken())
m_skipped_comment = m_next_skipped_comment; m_skippedComment = m_nextSkippedComment;
return m_current_token.token; return m_currentToken.token;
} }
Token::Value Scanner::selectToken(char _next, Token::Value _then, Token::Value _else) Token::Value Scanner::selectToken(char _next, Token::Value _then, Token::Value _else)
@ -159,11 +159,11 @@ Token::Value Scanner::selectToken(char _next, Token::Value _then, Token::Value _
bool Scanner::skipWhitespace() bool Scanner::skipWhitespace()
{ {
int const start_position = getSourcePos(); int const startPosition = getSourcePos();
while (IsWhiteSpace(m_char)) while (isWhiteSpace(m_char))
advance(); advance();
// Return whether or not we skipped any characters. // Return whether or not we skipped any characters.
return getSourcePos() != start_position; return getSourcePos() != startPosition;
} }
@ -173,7 +173,7 @@ Token::Value Scanner::skipSingleLineComment()
// to be part of the single-line comment; it is recognized // to be part of the single-line comment; it is recognized
// separately by the lexical grammar and becomes part of the // separately by the lexical grammar and becomes part of the
// stream of input elements for the syntactic grammar // stream of input elements for the syntactic grammar
while (advance() && !IsLineTerminator(m_char)) { }; while (advance() && !isLineTerminator(m_char)) { };
return Token::WHITESPACE; return Token::WHITESPACE;
} }
@ -182,12 +182,12 @@ Token::Value Scanner::scanDocumentationComment()
{ {
LiteralScope literal(this); LiteralScope literal(this);
advance(); //consume the last '/' advance(); //consume the last '/'
while (!isSourcePastEndOfInput() && !IsLineTerminator(m_char)) while (!isSourcePastEndOfInput() && !isLineTerminator(m_char))
{ {
addCommentLiteralChar(m_char); addCommentLiteralChar(m_char);
advance(); advance();
} }
literal.Complete(); literal.complete();
return Token::COMMENT_LITERAL; return Token::COMMENT_LITERAL;
} }
@ -217,12 +217,12 @@ Token::Value Scanner::skipMultiLineComment()
bool Scanner::scanToken() bool Scanner::scanToken()
{ {
bool foundDocComment = false; bool foundDocComment = false;
m_next_token.literal.clear(); m_nextToken.literal.clear();
Token::Value token; Token::Value token;
do do
{ {
// Remember the position of the next token // Remember the position of the next token
m_next_token.location.start = getSourcePos(); m_nextToken.location.start = getSourcePos();
switch (m_char) switch (m_char)
{ {
case '\n': // fall-through case '\n': // fall-through
@ -301,7 +301,7 @@ bool Scanner::scanToken()
} }
else if (m_char == '=') else if (m_char == '=')
token = selectToken(Token::ASSIGN_SUB); token = selectToken(Token::ASSIGN_SUB);
else if (m_char == '.' || IsDecimalDigit(m_char)) else if (m_char == '.' || isDecimalDigit(m_char))
token = scanNumber('-'); token = scanNumber('-');
else else
token = Token::SUB; token = Token::SUB;
@ -324,10 +324,10 @@ bool Scanner::scanToken()
else if (m_char == '/') else if (m_char == '/')
{ {
Token::Value comment; Token::Value comment;
m_next_skipped_comment.location.start = getSourcePos(); m_nextSkippedComment.location.start = getSourcePos();
comment = scanDocumentationComment(); comment = scanDocumentationComment();
m_next_skipped_comment.location.end = getSourcePos(); m_nextSkippedComment.location.end = getSourcePos();
m_next_skipped_comment.token = comment; m_nextSkippedComment.token = comment;
token = Token::WHITESPACE; token = Token::WHITESPACE;
foundDocComment = true; foundDocComment = true;
} }
@ -368,7 +368,7 @@ bool Scanner::scanToken()
case '.': case '.':
// . Number // . Number
advance(); advance();
if (IsDecimalDigit(m_char)) if (isDecimalDigit(m_char))
token = scanNumber('.'); token = scanNumber('.');
else else
token = Token::PERIOD; token = Token::PERIOD;
@ -407,9 +407,9 @@ bool Scanner::scanToken()
token = selectToken(Token::BIT_NOT); token = selectToken(Token::BIT_NOT);
break; break;
default: default:
if (IsIdentifierStart(m_char)) if (isIdentifierStart(m_char))
token = scanIdentifierOrKeyword(); token = scanIdentifierOrKeyword();
else if (IsDecimalDigit(m_char)) else if (isDecimalDigit(m_char))
token = scanNumber(); token = scanNumber();
else if (skipWhitespace()) else if (skipWhitespace())
token = Token::WHITESPACE; token = Token::WHITESPACE;
@ -423,8 +423,8 @@ bool Scanner::scanToken()
// whitespace. // whitespace.
} }
while (token == Token::WHITESPACE); while (token == Token::WHITESPACE);
m_next_token.location.end = getSourcePos(); m_nextToken.location.end = getSourcePos();
m_next_token.token = token; m_nextToken.token = token;
return foundDocComment; return foundDocComment;
} }
@ -434,7 +434,7 @@ bool Scanner::scanEscape()
char c = m_char; char c = m_char;
advance(); advance();
// Skip escaped newlines. // Skip escaped newlines.
if (IsLineTerminator(c)) if (isLineTerminator(c))
return true; return true;
switch (c) switch (c)
{ {
@ -475,7 +475,7 @@ Token::Value Scanner::scanString()
char const quote = m_char; char const quote = m_char;
advance(); // consume quote advance(); // consume quote
LiteralScope literal(this); LiteralScope literal(this);
while (m_char != quote && !isSourcePastEndOfInput() && !IsLineTerminator(m_char)) while (m_char != quote && !isSourcePastEndOfInput() && !isLineTerminator(m_char))
{ {
char c = m_char; char c = m_char;
advance(); advance();
@ -487,8 +487,9 @@ Token::Value Scanner::scanString()
else else
addLiteralChar(c); addLiteralChar(c);
} }
if (m_char != quote) return Token::ILLEGAL; if (m_char != quote)
literal.Complete(); return Token::ILLEGAL;
literal.complete();
advance(); // consume quote advance(); // consume quote
return Token::STRING_LITERAL; return Token::STRING_LITERAL;
} }
@ -496,7 +497,7 @@ Token::Value Scanner::scanString()
void Scanner::scanDecimalDigits() void Scanner::scanDecimalDigits()
{ {
while (IsDecimalDigit(m_char)) while (isDecimalDigit(m_char))
addLiteralCharAndAdvance(); addLiteralCharAndAdvance();
} }
@ -525,9 +526,9 @@ Token::Value Scanner::scanNumber(char _charSeen)
// hex number // hex number
kind = HEX; kind = HEX;
addLiteralCharAndAdvance(); addLiteralCharAndAdvance();
if (!IsHexDigit(m_char)) if (!isHexDigit(m_char))
return Token::ILLEGAL; // we must have at least one hex digit after 'x'/'X' return Token::ILLEGAL; // we must have at least one hex digit after 'x'/'X'
while (IsHexDigit(m_char)) while (isHexDigit(m_char))
addLiteralCharAndAdvance(); addLiteralCharAndAdvance();
} }
} }
@ -547,12 +548,13 @@ Token::Value Scanner::scanNumber(char _charSeen)
{ {
if (asserts(kind != HEX)) // 'e'/'E' must be scanned as part of the hex number if (asserts(kind != HEX)) // 'e'/'E' must be scanned as part of the hex number
BOOST_THROW_EXCEPTION(InternalCompilerError()); BOOST_THROW_EXCEPTION(InternalCompilerError());
if (kind != DECIMAL) return Token::ILLEGAL; if (kind != DECIMAL)
return Token::ILLEGAL;
// scan exponent // scan exponent
addLiteralCharAndAdvance(); addLiteralCharAndAdvance();
if (m_char == '+' || m_char == '-') if (m_char == '+' || m_char == '-')
addLiteralCharAndAdvance(); addLiteralCharAndAdvance();
if (!IsDecimalDigit(m_char)) if (!isDecimalDigit(m_char))
return Token::ILLEGAL; // we must have at least one decimal digit after 'e'/'E' return Token::ILLEGAL; // we must have at least one decimal digit after 'e'/'E'
scanDecimalDigits(); scanDecimalDigits();
} }
@ -560,9 +562,9 @@ Token::Value Scanner::scanNumber(char _charSeen)
// not be an identifier start or a decimal digit; see ECMA-262 // not be an identifier start or a decimal digit; see ECMA-262
// section 7.8.3, page 17 (note that we read only one decimal digit // section 7.8.3, page 17 (note that we read only one decimal digit
// if the value is 0). // if the value is 0).
if (IsDecimalDigit(m_char) || IsIdentifierStart(m_char)) if (isDecimalDigit(m_char) || isIdentifierStart(m_char))
return Token::ILLEGAL; return Token::ILLEGAL;
literal.Complete(); literal.complete();
return Token::NUMBER; return Token::NUMBER;
} }
@ -724,15 +726,15 @@ Token::Value Scanner::scanNumber(char _charSeen)
KEYWORD("while", Token::WHILE) \ KEYWORD("while", Token::WHILE) \
static Token::Value KeywordOrIdentifierToken(string const& input) static Token::Value KeywordOrIdentifierToken(string const& c_input)
{ {
if (asserts(!input.empty())) if (asserts(!c_input.empty()))
BOOST_THROW_EXCEPTION(InternalCompilerError()); BOOST_THROW_EXCEPTION(InternalCompilerError());
int const kMinLength = 2; int const kMinLength = 2;
int const kMaxLength = 10; int const kMaxLength = 10;
if (input.size() < kMinLength || input.size() > kMaxLength) if (c_input.size() < kMinLength || c_input.size() > kMaxLength)
return Token::IDENTIFIER; return Token::IDENTIFIER;
switch (input[0]) switch (c_input[0])
{ {
default: default:
#define KEYWORD_GROUP_CASE(ch) \ #define KEYWORD_GROUP_CASE(ch) \
@ -742,10 +744,10 @@ case ch:
{ \ { \
/* 'keyword' is a char array, so sizeof(keyword) is */ \ /* 'keyword' is a char array, so sizeof(keyword) is */ \
/* strlen(keyword) plus 1 for the NUL char. */ \ /* strlen(keyword) plus 1 for the NUL char. */ \
int const keyword_length = sizeof(keyword) - 1; \ int const keywordLength = sizeof(keyword) - 1; \
BOOST_STATIC_ASSERT(keyword_length >= kMinLength); \ BOOST_STATIC_ASSERT(keywordLength >= kMinLength); \
BOOST_STATIC_ASSERT(keyword_length <= kMaxLength); \ BOOST_STATIC_ASSERT(keywordLength <= kMaxLength); \
if (input == keyword) \ if (c_input == keyword) \
return token; \ return token; \
} }
KEYWORDS(KEYWORD_GROUP_CASE, KEYWORD) KEYWORDS(KEYWORD_GROUP_CASE, KEYWORD)
@ -755,15 +757,15 @@ case ch:
Token::Value Scanner::scanIdentifierOrKeyword() Token::Value Scanner::scanIdentifierOrKeyword()
{ {
if (asserts(IsIdentifierStart(m_char))) if (asserts(isIdentifierStart(m_char)))
BOOST_THROW_EXCEPTION(InternalCompilerError()); BOOST_THROW_EXCEPTION(InternalCompilerError());
LiteralScope literal(this); LiteralScope literal(this);
addLiteralCharAndAdvance(); addLiteralCharAndAdvance();
// Scan the rest of the identifier characters. // Scan the rest of the identifier characters.
while (IsIdentifierPart(m_char)) while (isIdentifierPart(m_char))
addLiteralCharAndAdvance(); addLiteralCharAndAdvance();
literal.Complete(); literal.complete();
return KeywordOrIdentifierToken(m_next_token.literal); return KeywordOrIdentifierToken(m_nextToken.literal);
} }
char CharStream::advanceAndGet() char CharStream::advanceAndGet()

46
Scanner.h
View File

@ -96,18 +96,18 @@ private:
class Scanner class Scanner
{ {
public: public:
// Scoped helper for literal recording. Automatically drops the literal /// Scoped helper for literal recording. Automatically drops the literal
// if aborting the scanning before it's complete. /// if aborting the scanning before it's complete.
class LiteralScope class LiteralScope
{ {
public: public:
explicit LiteralScope(Scanner* self): scanner_(self), complete_(false) { scanner_->startNewLiteral(); } explicit LiteralScope(Scanner* self): m_scanner(self), m_complete(false) { m_scanner->startNewLiteral(); }
~LiteralScope() { if (!complete_) scanner_->dropLiteral(); } ~LiteralScope() { if (!m_complete) m_scanner->dropLiteral(); }
void Complete() { complete_ = true; } void complete() { m_complete = true; }
private: private:
Scanner* scanner_; Scanner* m_scanner;
bool complete_; bool m_complete;
}; };
Scanner() { reset(CharStream()); } Scanner() { reset(CharStream()); }
@ -125,25 +125,25 @@ public:
/// Returns the current token /// Returns the current token
Token::Value getCurrentToken() Token::Value getCurrentToken()
{ {
return m_current_token.token; return m_currentToken.token;
} }
Location getCurrentLocation() const { return m_current_token.location; } Location getCurrentLocation() const { return m_currentToken.location; }
std::string const& getCurrentLiteral() const { return m_current_token.literal; } std::string const& getCurrentLiteral() const { return m_currentToken.literal; }
///@} ///@}
///@{ ///@{
///@name Information about the current comment token ///@name Information about the current comment token
Location getCurrentCommentLocation() const { return m_skipped_comment.location; } Location getCurrentCommentLocation() const { return m_skippedComment.location; }
std::string const& getCurrentCommentLiteral() const { return m_skipped_comment.literal; } std::string const& getCurrentCommentLiteral() const { return m_skippedComment.literal; }
///@} ///@}
///@{ ///@{
///@name Information about the next token ///@name Information about the next token
/// Returns the next token without advancing input. /// Returns the next token without advancing input.
Token::Value peekNextToken() const { return m_next_token.token; } Token::Value peekNextToken() const { return m_nextToken.token; }
Location peekLocation() const { return m_next_token.location; } Location peekLocation() const { return m_nextToken.location; }
std::string const& peekLiteral() const { return m_next_token.literal; } std::string const& peekLiteral() const { return m_nextToken.literal; }
///@} ///@}
///@{ ///@{
@ -165,10 +165,10 @@ private:
///@{ ///@{
///@name Literal buffer support ///@name Literal buffer support
inline void startNewLiteral() { m_next_token.literal.clear(); } inline void startNewLiteral() { m_nextToken.literal.clear(); }
inline void addLiteralChar(char c) { m_next_token.literal.push_back(c); } inline void addLiteralChar(char c) { m_nextToken.literal.push_back(c); }
inline void addCommentLiteralChar(char c) { m_next_skipped_comment.literal.push_back(c); } inline void addCommentLiteralChar(char c) { m_nextSkippedComment.literal.push_back(c); }
inline void dropLiteral() { m_next_token.literal.clear(); } inline void dropLiteral() { m_nextToken.literal.clear(); }
inline void addLiteralCharAndAdvance() { addLiteralChar(m_char); advance(); } inline void addLiteralCharAndAdvance() { addLiteralChar(m_char); advance(); }
///@} ///@}
@ -206,11 +206,11 @@ private:
int getSourcePos() { return m_source.getPos(); } int getSourcePos() { return m_source.getPos(); }
bool isSourcePastEndOfInput() { return m_source.isPastEndOfInput(); } bool isSourcePastEndOfInput() { return m_source.isPastEndOfInput(); }
TokenDesc m_skipped_comment; // desc for current skipped comment TokenDesc m_skippedComment; // desc for current skipped comment
TokenDesc m_next_skipped_comment; // desc for next skiped comment TokenDesc m_nextSkippedComment; // desc for next skiped comment
TokenDesc m_current_token; // desc for current token (as returned by Next()) TokenDesc m_currentToken; // desc for current token (as returned by Next())
TokenDesc m_next_token; // desc for next token (one token look-ahead) TokenDesc m_nextToken; // desc for next token (one token look-ahead)
CharStream m_source; CharStream m_source;