cppcheck/src/token.h

217 lines
6.9 KiB
C
Raw Normal View History

2008-12-18 22:28:57 +01:00
/*
* Cppcheck - A tool for static C/C++ code analysis
* Copyright (C) 2007-2009 Daniel Marjamäki and Cppcheck team.
2008-12-18 22:28:57 +01:00
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/
*/
#ifndef TokenH
#define TokenH
2008-12-18 22:28:57 +01:00
#include <string>
class Token
2008-12-18 22:28:57 +01:00
{
public:
Token();
~Token();
void str(const char s[]);
2008-12-18 22:28:57 +01:00
void concatStr(std::string const& b);
2008-12-18 22:28:57 +01:00
const std::string &str() const
{
return _str;
}
2008-12-18 22:28:57 +01:00
/**
* Unlink and delete next token.
*/
void deleteNext();
/**
* Returns token in given index, related to this token.
* For example index 1 would return next token, and 2
* would return next from that one.
*/
const Token *tokAt(int index) const;
2009-01-20 07:20:55 +01:00
Token *tokAt(int index);
2008-12-18 22:28:57 +01:00
const char *strAt(int index) const;
2008-12-23 22:51:54 +01:00
/**
* Match given token (or list of tokens) to a pattern list.
*
* Possible patterns
* "someRandomText" If token contains "someRandomText".
* @note Use Match() if you want to use flags in patterns
*
* The patterns can be also combined to compare to multiple tokens at once
* by separating tokens with a space, e.g.
* ") void {" will return true if first token is ')' next token
* is "void" and token after that is '{'. If even one of the tokens does
* not match its pattern, false is returned.
*
* @param tok List of tokens to be compared to the pattern
* @param pattern The pattern against which the tokens are compared,
* e.g. "const" or ") void {".
* @return true if given token matches with given pattern
* false if given token does not match with given pattern
*/
static bool simpleMatch(const Token *tok, const char pattern[]);
2008-12-18 22:28:57 +01:00
/**
* Match given token (or list of tokens) to a pattern list.
*
* Possible patterns
* "%any%" any token
* "%var%" any token which is a name or type e.g. "hello" or "int"
* "%num%" Any numeric token, e.g. "23"
* "%bool%" true or false
2008-12-18 22:28:57 +01:00
* "%str%" Any token starting with "-character (C-string).
* "%varid%" Match with parameter varid
* "[abc]" Any of the characters 'a' or 'b' or 'c'
* "int|void|char" Any of the strings, int, void or char
* "int|void|char|" Any of the strings, int, void or char or empty string
* "!!else" No tokens or any token that is not "else".
* "someRandomText" If token contains "someRandomText".
*
* The patterns can be also combined to compare to multiple tokens at once
* by separating tokens with a space, e.g.
* ") const|void {" will return true if first token is ')' next token is either
* "const" or "void" and token after that is '{'. If even one of the tokens does not
* match its pattern, false is returned.
*
* @param tok List of tokens to be compared to the pattern
2008-12-23 22:51:54 +01:00
* @param pattern The pattern against which the tokens are compared,
* e.g. "const" or ") const|volatile| {".
2008-12-18 22:28:57 +01:00
* @return true if given token matches with given pattern
* false if given token does not match with given pattern
*/
static bool Match(const Token *tok, const char pattern[], unsigned int varid = 0);
2008-12-18 22:28:57 +01:00
bool isName() const;
bool isNumber() const;
bool isBoolean() const;
2008-12-18 22:28:57 +01:00
bool isStandardType() const;
static const Token *findmatch(const Token *tok, const char pattern[], unsigned int varId = 0);
2008-12-18 22:28:57 +01:00
/**
* Needle is build from multiple alternatives. If one of
* them is equal to haystack, return value is 1. If there
* are no matches, but one alternative to needle is empty
* string, return value is 0. If needle was not found, return
* value is -1.
*
* @param haystack e.g. "one|two" or "|one|two"
* @param needle e.g. "one", "two" or "invalid"
2008-12-18 22:28:57 +01:00
* @return 1 if needle is found from the haystack
* 0 if needle was empty string
* -1 if needle was not found
*/
static int multiCompare(const char *haystack, const char *needle);
2008-12-18 22:28:57 +01:00
unsigned int linenr() const;
void linenr(unsigned int linenr);
2008-12-18 22:28:57 +01:00
unsigned int fileIndex() const;
void fileIndex(unsigned int fileIndex);
2008-12-18 22:28:57 +01:00
Token *next() const;
2008-12-18 22:28:57 +01:00
/**
* Delete tokens between begin and end. E.g. if begin = 1
* and end = 5, tokens 2,3 and 4 would be erased.
*
* @param begin Tokens after this will be erased.
* @param end Tokens before this will be erased.
*/
static void eraseTokens(Token *begin, const Token *end);
2008-12-18 22:28:57 +01:00
/**
* Insert new token after this token. This function will handle
* relations between next and previous token also.
* @param str String for the new token.
*/
void insertToken(const char str[]);
2008-12-18 22:28:57 +01:00
Token *previous() const;
2008-12-18 22:28:57 +01:00
unsigned int varId() const;
void varId(unsigned int id);
2008-12-18 22:28:57 +01:00
/**
* For debugging purposes, prints token and all tokens
* followed by it.
* @param title Title for the printout or use default parameter or 0
* for no title.
*/
void printOut(const char *title = 0) const;
2008-12-18 22:28:57 +01:00
/**
* Replace token replaceThis with tokens between start and end,
* including start and end. The replaceThis token is deleted.
* @param replaceThis, this token will be deleted.
* @param start This will be in the place of replaceThis
* @param end This is also in the place of replaceThis
*/
static void replace(Token *replaceThis, Token *start, Token *end);
/** Stringify a token list (with or without varId) */
std::string stringifyList(const bool varid = true, const char *title = 0) const;
/**
* This is intended to be used for the first token in the list
* Do not use this for the tokens at the end of the list unless the
* token is the last token in the list.
*/
void deleteThis();
/**
* Create link to given token
* @param link The token where this token should link
* to.
*/
void link(Token *link);
/**
* Return token where this token links to.
* Supported links are:
* "{" <-> "}"
*
* @return The token where this token links to.
*/
Token *link() const;
2008-12-18 22:28:57 +01:00
private:
void next(Token *next);
void previous(Token *previous);
2008-12-18 22:28:57 +01:00
std::string _str;
bool _isName;
bool _isNumber;
bool _isBoolean;
2008-12-18 22:28:57 +01:00
unsigned int _varId;
Token *_next;
Token *_previous;
Token *_link;
2008-12-18 22:28:57 +01:00
unsigned int _fileIndex;
unsigned int _linenr;
};
#endif // TokenH