cppcheck/lib/token.cpp

702 lines
16 KiB
C++

/*
* Cppcheck - A tool for static C/C++ code analysis
* Copyright (C) 2007-2009 Daniel Marjamäki and Cppcheck team.
*
* 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/>.
*/
#include "token.h"
#include <cassert>
#include <cstdlib>
#include <cstring>
#include <string>
#include <iostream>
#include <cctype>
#include <sstream>
#include <map>
Token::Token(Token **t) :
tokensBack(t),
_str(""),
_isName(false),
_isNumber(false),
_isBoolean(false),
_varId(0),
_next(0),
_previous(0),
_link(0),
_fileIndex(0),
_linenr(0)
{
}
Token::~Token()
{
}
void Token::str(const std::string &s)
{
_str = s;
_isName = bool(_str[0] == '_' || std::isalpha(_str[0]));
if (std::isdigit(_str[0]))
_isNumber = true;
else if (_str.length() > 1 && _str[0] == '-' && std::isdigit(_str[1]))
_isNumber = true;
else
_isNumber = false;
if (_str == "true" || _str == "false")
_isBoolean = true;
else
_isBoolean = false;
_varId = 0;
}
void Token::concatStr(std::string const& b)
{
_str.erase(_str.length() - 1);
_str.append(b.begin() + 1, b.end());
}
std::string Token::strValue() const
{
assert(_str.length() >= 2);
assert(_str[0] == '"');
assert(_str[_str.length()-1] == '"');
return _str.substr(1, _str.length() - 2);
}
void Token::deleteNext()
{
Token *n = _next;
_next = n->next();
delete n;
if (_next)
_next->previous(this);
else if (tokensBack)
*tokensBack = this;
}
void Token::deleteThis()
{
if (_next)
{
_str = _next->_str;
_isName = _next->_isName;
_isNumber = _next->_isNumber;
_isBoolean = _next->_isBoolean;
_varId = _next->_varId;
_fileIndex = _next->_fileIndex;
_linenr = _next->_linenr;
_link = _next->_link;
if (_link)
_link->link(this);
deleteNext();
}
else if (_previous)
{
// This should never be used for tokens
// at the end of the list
str(";");
}
else
{
// We are the last token in the list, we can't delete
// ourselves, so just make us ;
str(";");
}
}
void Token::replace(Token *replaceThis, Token *start, Token *end)
{
// Fix the whole in the old location of start and end
if (start->previous())
start->previous()->next(end->next());
if (end->next())
end->next()->previous(start->previous());
// Move start and end to their new location
if (replaceThis->previous())
replaceThis->previous()->next(start);
if (replaceThis->next())
replaceThis->next()->previous(end);
start->previous(replaceThis->previous());
end->next(replaceThis->next());
if (end->tokensBack && *(end->tokensBack) == end)
{
while (end->next())
end = end->next();
*(end->tokensBack) = end;
}
// Delete old token, which is replaced
delete replaceThis;
}
const Token *Token::tokAt(int index) const
{
const Token *tok = this;
int num = std::abs(index);
while (num > 0 && tok)
{
if (index > 0)
tok = tok->next();
else
tok = tok->previous();
--num;
}
return tok;
}
Token *Token::tokAt(int index)
{
Token *tok = this;
int num = std::abs(index);
while (num > 0 && tok)
{
if (index > 0)
tok = tok->next();
else
tok = tok->previous();
--num;
}
return tok;
}
const char *Token::strAt(int index) const
{
const Token *tok = this->tokAt(index);
return tok ? tok->_str.c_str() : "";
}
int Token::multiCompare(const char *haystack, const char *needle)
{
bool emptyStringFound = false;
bool noMatch = false;
const char *needlePointer = needle;
for (; *haystack && *haystack != ' '; ++haystack)
{
if (*haystack == '|')
{
if (noMatch)
{
// We didn't have a match at this round
noMatch = false;
}
else if (*needlePointer == 0)
{
// If needle and haystack are both at the end, we have a match.
return 1;
}
else if (needlePointer == needle)
{
// If needlePointer was not increased at all, we had a empty
// string in the haystack
emptyStringFound = true;
}
needlePointer = needle;
continue;
}
if (noMatch)
continue;
// If haystack and needle don't share the same character,
// find next '|' character.
if (*needlePointer != *haystack)
{
noMatch = true;
continue;
}
// All characters in haystack and needle have matched this far
++needlePointer;
}
if (!noMatch)
{
if (*needlePointer == 0)
{
// If both needle and haystack are at the end, then we have a match.
return 1;
}
else if (needlePointer == needle)
{
// Last string in haystack was empty string e.g. "one|two|"
return 0;
}
}
// If empty string was found earlier from the haystack
if (emptyStringFound)
return 0;
return -1;
}
bool Token::simpleMatch(const Token *tok, const char pattern[])
{
const char *current, *next;
current = pattern;
next = strchr(pattern, ' ');
if (!next)
next = pattern + strlen(pattern);
while (*current)
{
size_t length = static_cast<size_t>(next - current);
if (!tok || length != tok->_str.length() || strncmp(current, tok->_str.c_str(), length))
return false;
current = next;
if (*next)
{
next = strchr(++current, ' ');
if (!next)
next = current + strlen(current);
}
tok = tok->next();
}
return true;
}
int Token::firstWordEquals(const char *str, const char *word)
{
for (;;)
{
if (*str == ' ' && *word == 0)
return 0;
else if (*str != *word)
return 1;
else if (*str == 0)
break;
++str;
++word;
}
return 0;
}
const char *Token::chrInFirstWord(const char *str, char c)
{
for (;;)
{
if (*str == ' ' || *str == 0)
return 0;
if (*str == c)
return str;
++str;
}
}
int Token::firstWordLen(const char *str)
{
int len = 0;
for (;;)
{
if (*str == ' ' || *str == 0)
break;
++len;
++str;
}
return len;
}
bool Token::Match(const Token *tok, const char pattern[], unsigned int varid)
{
const char *p = pattern;
bool firstpattern = true;
bool first = true;
while (*p)
{
if (!first)
{
while (*p && *p != ' ')
++p;
}
first = false;
// Skip spaces in pattern..
while (*p == ' ')
++p;
// No token => Success!
if (*p == 0)
return true;
if (!tok)
{
// If we have no tokens, pattern "!!else" should return true
if (p[1] == '!' && p[0] == '!' && p[2] != '\0')
continue;
else
return false;
}
// If we are in the first token, we skip all initial !! patterns
if (firstpattern && !tok->previous() && tok->next() && p[1] == '!' && p[0] == '!' && p[2] != '\0')
continue;
firstpattern = false;
// Compare the first character of the string for optimization reasons
// before doing more detailed checks.
bool patternIdentified = false;
if (p[0] == '%')
{
// TODO: %var% should match only for
// variables that have varId != 0, but that needs a lot of
// work, before that change can be made.
// Any symbolname..
if (firstWordEquals(p, "%var%") == 0)
{
if (!tok->isName())
return false;
patternIdentified = true;
}
// Any symbolname..
if (firstWordEquals(p, "%name%") == 0)
{
if (!tok->isName())
return false;
patternIdentified = true;
}
// Type..
if (firstWordEquals(p, "%type%") == 0)
{
if (!tok->isName())
return false;
if (tok->varId() != 0)
return false;
if (tok->str() == "delete")
return false;
patternIdentified = true;
}
// Accept any token
else if (firstWordEquals(p, "%any%") == 0)
{
patternIdentified = true;
}
else if (firstWordEquals(p, "%varid%") == 0)
{
if (varid == 0)
{
std::cerr << "\n###### If you see this, there is a bug ######" << std::endl
<< "Token::Match(\"" << pattern << "\", 0)" << std::endl;
}
if (tok->varId() != varid)
return false;
patternIdentified = true;
}
else if (firstWordEquals(p, "%num%") == 0)
{
if (!tok->isNumber())
return false;
patternIdentified = true;
}
else if (firstWordEquals(p, "%bool%") == 0)
{
if (!tok->isBoolean())
return false;
patternIdentified = true;
}
else if (firstWordEquals(p, "%str%") == 0)
{
if (tok->_str[0] != '\"')
return false;
patternIdentified = true;
}
}
if (patternIdentified)
{
// Pattern was identified already above.
}
// [.. => search for a one-character token..
else if (p[0] == '[' && chrInFirstWord(p, ']') && tok->_str.length() == 1)
{
const char *temp = p + 1;
bool chrFound = false;
int count = 0;
while (*temp && *temp != ' ')
{
if (*temp == ']')
{
++count;
++temp;
continue;
}
if (*temp == tok->_str[0])
{
chrFound = true;
break;
}
++temp;
}
if (count > 1)
{
if (tok->_str[0] == ']')
chrFound = true;
}
if (!chrFound)
return false;
}
// Parse multi options, such as void|int|char (accept token which is one of these 3)
else if (chrInFirstWord(p, '|') && (p[0] != '|' || firstWordLen(p) > 2))
{
int res = multiCompare(p, tok->_str.c_str());
if (res == 0)
{
// Empty alternative matches, use the same token on next round
continue;
}
else if (res == -1)
{
// No match
return false;
}
}
// Parse "not" options. Token can be anything except the given one
else if (p[1] == '!' && p[0] == '!' && p[2] != '\0')
{
if (firstWordEquals(&(p[2]), tok->str().c_str()) == 0)
return false;
}
else if (firstWordEquals(p, tok->_str.c_str()) != 0)
return false;
tok = tok->next();
}
// The end of the pattern has been reached and nothing wrong has been found
return true;
}
size_t Token::getStrLength(const Token *tok)
{
assert(tok != NULL);
size_t len = 0;
const std::string strValue(tok->strValue());
const char *str = strValue.c_str();
while (*str)
{
if (*str == '\\')
{
++str;
// string ends at '\0'
if (*str == '0')
break;
}
++str;
++len;
}
return len;
}
bool Token::isStandardType() const
{
bool ret = false;
const char *type[] = {"bool", "char", "short", "int", "long", "float", "double", "size_t", 0};
for (int i = 0; type[i]; i++)
ret |= (_str == type[i]);
return ret;
}
void Token::move(Token *srcStart, Token *srcEnd, Token *newLocation)
{
/**[newLocation] -> b -> c -> [srcStart] -> [srcEnd] -> f */
// Fix the gap, which tokens to be moved will leave
srcStart->previous()->next(srcEnd->next());
srcEnd->next()->previous(srcStart->previous());
// Fix the tokens to be moved
srcEnd->next(newLocation->next());
srcStart->previous(newLocation);
// Fix the tokens at newLocation
newLocation->next()->previous(srcEnd);
newLocation->next(srcStart);
}
//---------------------------------------------------------------------------
const Token *Token::findmatch(const Token *tok, const char pattern[], unsigned int varId)
{
for (; tok; tok = tok->next())
{
if (Token::Match(tok, pattern, varId))
return tok;
}
return 0;
}
void Token::insertToken(const char str[])
{
Token *newToken = new Token(tokensBack);
newToken->str(str);
newToken->_linenr = _linenr;
newToken->_fileIndex = _fileIndex;
if (this->next())
{
newToken->next(this->next());
newToken->next()->previous(newToken);
}
else if (tokensBack)
{
*tokensBack = newToken;
}
this->next(newToken);
newToken->previous(this);
}
void Token::eraseTokens(Token *begin, const Token *end)
{
if (! begin)
return;
while (begin->next() && begin->next() != end)
{
begin->deleteNext();
}
}
void Token::createMutualLinks(Token *begin, Token *end)
{
assert(begin != NULL);
assert(end != NULL);
assert(begin != end);
begin->link(end);
end->link(begin);
}
void Token::printOut(const char *title) const
{
const std::vector<std::string> fileNames;
std::cout << stringifyList(true, title, fileNames) << std::endl;
}
void Token::printOut(const char *title, const std::vector<std::string> &fileNames) const
{
std::cout << stringifyList(true, title, fileNames) << std::endl;
}
std::string Token::stringifyList(bool varid, const char *title) const
{
const std::vector<std::string> fileNames;
return stringifyList(varid, title, fileNames);
}
std::string Token::stringifyList(bool varid, const char *title, const std::vector<std::string> &fileNames) const
{
std::ostringstream ret;
if (title)
ret << "\n### " << title << " ###\n";
unsigned int linenr = 0;
int fileIndex = -1;
std::map<unsigned int, unsigned int> lineNumbers;
for (const Token *tok = this; tok; tok = tok->next())
{
bool fileChange = false;
if (static_cast<int>(tok->_fileIndex) != fileIndex)
{
if (fileIndex != -1)
{
lineNumbers[fileIndex] = tok->_fileIndex;
}
fileIndex = static_cast<int>(tok->_fileIndex);
ret << "\n\n##file ";
if (fileNames.size() > static_cast<unsigned int>(fileIndex))
ret << fileNames.at(fileIndex);
else
ret << fileIndex;
linenr = lineNumbers[fileIndex];
fileChange = true;
}
if (linenr != tok->linenr() || fileChange)
{
while (linenr < tok->linenr())
{
++linenr;
ret << "\n" << linenr << ":";
}
linenr = tok->linenr();
}
ret << " " << tok->str();
if (varid && tok->varId() > 0)
ret << "@" << tok->varId();
}
ret << "\n";
return ret.str();
}