/*
* Cppcheck - A tool for static C/C++ code analysis
* Copyright (C) 2007-2010 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 .
*/
//---------------------------------------------------------------------------
#include "checkclass.h"
#include "tokenize.h"
#include "token.h"
#include "errorlogger.h"
#include
#include
#include
#include
#include
//---------------------------------------------------------------------------
// Register CheckClass..
namespace
{
CheckClass instance;
}
//---------------------------------------------------------------------------
CheckClass::CheckClass(const Tokenizer *tokenizer, const Settings *settings, ErrorLogger *errorLogger)
: Check(tokenizer, settings, errorLogger),
hasSymbolDatabase(false)
{
}
static bool isFunction(const Token *tok, const Token **funcStart, const Token **argStart)
{
if (tok->previous()->str() == "::")
return false;
// function returning function pointer? '... ( ... %var% ( ... ))( ... ) {'
if (tok->str() == "(" &&
tok->link()->previous()->str() == ")" &&
tok->link()->next()->str() == "(" &&
Token::Match(tok->link()->next()->link()->next(), "{|;|const|="))
{
*funcStart = tok->link()->previous()->link()->previous();
*argStart = tok->link()->previous()->link();
return true;
}
// regular function?
else if (Token::Match(tok, "%var% (") && Token::Match(tok->next()->link(), ") const| ;|{|=|:"))
{
*funcStart = tok;
*argStart = tok->next();
return true;
}
// simple operator?
else if (Token::Match(tok, "operator %any% (") && Token::Match(tok->tokAt(2)->link(), ") const| ;|{|=|:"))
{
*funcStart = tok->next();
*argStart = tok->tokAt(2);
return true;
}
// complex operator?
else if (tok->str() == "operator")
{
// operator[] or operator()?
if ((Token::simpleMatch(tok->next(), "( ) (") || Token::simpleMatch(tok->next(), "[ ] (")) &&
Token::Match(tok->tokAt(3)->link(), ") const| ;|{|=|:"))
{
*funcStart = tok->next();
*argStart = tok->tokAt(3);
return true;
}
// operator new/delete []?
else if (Token::Match(tok->next(), "new|delete [ ] (") && Token::Match(tok->tokAt(4)->link(), ") ;|{"))
{
*funcStart = tok->next();
*argStart = tok->tokAt(4);
return true;
}
}
return false;
}
void CheckClass::createSymbolDatabase()
{
// Multiple calls => bail out
if (hasSymbolDatabase)
return;
hasSymbolDatabase = true;
// find all namespaces (class,struct and namespace)
SpaceInfo *info = 0;
for (const Token *tok = _tokenizer->tokens(); tok; tok = tok->next())
{
// Locate next class
if (Token::Match(tok, "class|struct|namespace %var% [{:]"))
{
SpaceInfo *new_info = new SpaceInfo(this, tok, info);
const Token *tok2 = tok->tokAt(2);
// only create variable list and base list if not namespace
if (!new_info->isNamespace)
{
new_info->getVarList();
// goto initial '{'
tok2 = initBaseInfo(new_info, tok);
}
new_info->classStart = tok2;
new_info->classEnd = new_info->classStart->link();
info = new_info;
// add namespace
spaceInfoMMap.insert(std::make_pair(info->className, info));
tok = tok2;
}
// check if in space
else if (info)
{
// check for end of space
if (tok == info->classEnd)
{
info = info->nestedIn;
}
// check if in class or structure
else if (!info->isNamespace)
{
const Token *funcStart = 0;
const Token *argStart = 0;
// What section are we in..
if (tok->str() == "private:")
info->access = Private;
else if (tok->str() == "protected:")
info->access = Protected;
else if (tok->str() == "public:")
info->access = Public;
else if (Token::Match(tok, "public|protected|private %var% :"))
{
if (tok->str() == "private")
info->access = Private;
else if (tok->str() == "protected")
info->access = Protected;
else if (tok->str() == "public")
info->access = Public;
tok = tok->tokAt(2);
}
// function?
else if (isFunction(tok, &funcStart, &argStart))
{
Func function;
// save the function definition argument start '('
function.argDef = argStart;
// save the access type
function.access = info->access;
// save the function name location
function.tokenDef = funcStart;
// operator function
if (function.tokenDef->previous()->str() == "operator")
{
function.isOperator = true;
// 'operator =' is special
if (function.tokenDef->str() == "=")
function.type = Func::OperatorEqual;
}
// class constructor/destructor
else if (function.tokenDef->str() == info->className)
{
if (function.tokenDef->previous()->str() == "~")
function.type = Func::Destructor;
else if ((Token::Match(function.tokenDef, "%var% ( const %var% & )") ||
Token::Match(function.tokenDef, "%var% ( const %var% & %var% )")) &&
function.tokenDef->strAt(3) == info->className)
function.type = Func::CopyConstructor;
else
function.type = Func::Constructor;
if (function.tokenDef->previous()->str() == "explicit")
function.isExplicit = true;
}
// function returning function pointer
else if (tok->str() == "(")
{
function.retFuncPtr = true;
}
const Token *tok1 = tok;
// look for end of previous statement
while (tok1->previous() && !Token::Match(tok1->previous(), ";|}|{|public:|protected:|private:"))
{
// virtual function
if (tok1->previous()->str() == "virtual")
{
function.isVirtual = true;
break;
}
// static function
else if (tok1->previous()->str() == "static")
{
function.isStatic = true;
break;
}
// friend function
else if (tok1->previous()->str() == "friend")
{
function.isFriend = true;
break;
}
tok1 = tok1->previous();
}
const Token *end;
if (!function.retFuncPtr)
end = function.argDef->link();
else
end = tok->link()->next()->link();
// const function
if (end->next()->str() == "const")
function.isConst = true;
// pure virtual function
if (Token::Match(end, ") const| = 0 ;"))
function.isPure = true;
// count the number of constructors
if (function.type == Func::Constructor || function.type == Func::CopyConstructor)
info->numConstructors++;
// assume implementation is inline (definition and implementation same)
function.token = function.tokenDef;
// out of line function
if (Token::Match(end, ") const| ;") ||
Token::Match(end, ") const| = 0 ;"))
{
// find the function implementation later
tok = end->next();
}
// inline function
else
{
function.isInline = true;
function.hasBody = true;
function.arg = function.argDef;
// skip over function body
tok = end->next();
while (tok && tok->str() != "{")
tok = tok->next();
if (!tok)
return;
tok = tok->link();
}
info->functionList.push_back(function);
}
// friend class declaration?
else if (Token::Match(tok, "friend class| %any% ;"))
{
FriendInfo friendInfo;
friendInfo.name = tok->strAt(1) == "class" ? tok->strAt(2) : tok->strAt(1);
/** @todo fill this in later after parsing is complete */
friendInfo.spaceInfo = 0;
info->friendList.push_back(friendInfo);
}
}
}
}
std::multimap::iterator it;
for (it = spaceInfoMMap.begin(); it != spaceInfoMMap.end(); ++it)
{
info = it->second;
// skip namespaces
if (info->isNamespace)
continue;
// finish filling in base class info
for (unsigned int i = 0; i < info->derivedFrom.size(); ++i)
{
std::multimap::iterator it1;
for (it1 = spaceInfoMMap.begin(); it1 != spaceInfoMMap.end(); ++it1)
{
SpaceInfo *spaceInfo = it1->second;
/** @todo handle derived base classes and namespaces */
if (!spaceInfo->isNamespace)
{
// do class names match?
if (spaceInfo->className == info->derivedFrom[i].name)
{
// are they in the same namespace or different namespaces with same name?
if ((spaceInfo->nestedIn == info->nestedIn) ||
((spaceInfo->nestedIn && spaceInfo->nestedIn->isNamespace) &&
(info->nestedIn && info->nestedIn->isNamespace) &&
(spaceInfo->nestedIn->className == info->nestedIn->className)))
{
info->derivedFrom[i].spaceInfo = spaceInfo;
break;
}
}
}
}
}
std::list::iterator func;
// find the function body if not implemented inline
for (func = info->functionList.begin(); func != info->functionList.end(); ++func)
{
if (!func->hasBody)
{
// find implementation using names on stack
SpaceInfo *nest = info;
unsigned int depth = 0;
std::string classPattern;
std::string classPath;
std::string searchPattern;
const Token *funcArgs = func->tokenDef->tokAt(2);
int offset = 1;
if (func->isOperator)
{
if (Token::Match(func->tokenDef, "(|["))
{
classPattern = "operator " + func->tokenDef->str() + " " + func->tokenDef->next()->str() + " (";
offset = 2;
}
else if (Token::Match(func->tokenDef, "new|delete ["))
{
classPattern = "operator " + func->tokenDef->str() + " " + func->tokenDef->next()->str() + " " + func->tokenDef->next()->strAt(2) + " (";
offset = 3;
}
else
classPattern = "operator " + func->tokenDef->str() + " (";
}
else if (func->type == Func::Destructor)
classPattern = "~ " + func->tokenDef->str() + " (";
else
classPattern = func->tokenDef->str() + " (";
// look for an implementation outside of class
while (!func->hasBody && nest)
{
classPath = nest->className + std::string(" :: ") + classPath;
searchPattern = classPath + classPattern;
depth++;
nest = nest->nestedIn;
// start looking at end of class
SpaceInfo *top = info;
const Token *found = top->classEnd;
while ((found = Token::findmatch(found, searchPattern.c_str(), nest ? nest->classEnd : 0)) != NULL)
{
// skip other classes
if (found->previous()->str() == "::")
break;
// goto function name
while (found->next()->str() != "(")
found = found->next();
if (Token::Match(found->tokAt(offset)->link(), func->isConst ? ") const {" : ") {") ||
(func->type == Func::Constructor && Token::Match(found->next()->link(), ") :|{")))
{
if (argsMatch(funcArgs, found->tokAt(offset + 1), classPath, depth))
{
func->token = found;
func->hasBody = true;
func->arg = found->tokAt(offset);
break;
}
// skip function body
while (found->str() != "{")
found = found->next();
found = found->link();
}
}
}
}
}
}
}
CheckClass::~CheckClass()
{
std::multimap::iterator it;
for (it = spaceInfoMMap.begin(); it != spaceInfoMMap.end(); ++it)
delete it->second;
}
const Token *CheckClass::initBaseInfo(SpaceInfo *info, const Token *tok)
{
// goto initial '{'
const Token *tok2 = tok->tokAt(2);
int level = 0;
while (tok2 && tok2->str() != "{")
{
// skip unsupported templates
if (tok2->str() == "<")
level++;
else if (tok2->str() == ">")
level--;
// check for base classes
else if (level == 0 && Token::Match(tok2, ":|,"))
{
BaseInfo base;
tok2 = tok2->next();
if (tok2->str() == "public")
{
base.access = Public;
tok2 = tok2->next();
}
else if (tok2->str() == "protected")
{
base.access = Protected;
tok2 = tok2->next();
}
else if (tok2->str() == "private")
{
base.access = Private;
tok2 = tok2->next();
}
else
{
if (tok->str() == "class")
base.access = Private;
else if (tok->str() == "struct")
base.access = Public;
}
// handle derived base classes
while (Token::Match(tok2, "%var% ::"))
{
base.name += tok2->str();
base.name += " :: ";
tok2 = tok2->tokAt(2);
}
base.name += tok2->str();
base.spaceInfo = 0;
// save pattern for base class name
info->derivedFrom.push_back(base);
}
tok2 = tok2->next();
}
return tok2;
}
//---------------------------------------------------------------------------
CheckClass::SpaceInfo::SpaceInfo(CheckClass *check_, const Token *classDef_, CheckClass::SpaceInfo *nestedIn_) :
check(check_),
classDef(classDef_),
classStart(NULL),
classEnd(NULL),
nestedIn(nestedIn_),
numConstructors(0)
{
isNamespace = classDef->str() == "namespace";
className = classDef->next()->str();
access = classDef->str() == "struct" ? Public : Private;
if (nestedIn)
nestedIn->nestedList.push_back(this);
}
void CheckClass::SpaceInfo::getVarList()
{
// Get variable list..
const Token *tok1 = classDef;
unsigned int indentlevel = 0;
AccessControl varaccess = tok1->str() == "struct" ? Public : Private;
for (const Token *tok = tok1; tok; tok = tok->next())
{
if (!tok->next())
break;
if (tok->str() == "{")
++indentlevel;
else if (tok->str() == "}")
{
if (indentlevel <= 1)
break;
--indentlevel;
}
if (indentlevel != 1)
continue;
// Borland C++: Skip all variables in the __published section.
// These are automaticly initialized.
if (tok->str() == "__published:")
{
for (; tok; tok = tok->next())
{
if (tok->str() == "{")
tok = tok->link();
if (Token::Match(tok->next(), "private:|protected:|public:"))
break;
}
if (tok)
continue;
else
break;
}
// "private:" "public:" "protected:" etc
bool b = false;
if (tok->str() == "public:")
{
varaccess = Public;
b = true;
}
else if (tok->str() == "protected:")
{
varaccess = Protected;
b = true;
}
else if (tok->str() == "private:")
{
varaccess = Private;
b = true;
}
else if (Token::Match(tok, "public|protected|private %var% :"))
{
if (tok->str() == "public")
varaccess = Public;
else if (tok->str() == "protected")
varaccess = Protected;
else if (tok->str() == "private")
varaccess = Private;
tok = tok->tokAt(2);
b = true;
}
// Search for start of statement..
if (! Token::Match(tok, "[;{}]") && ! b)
continue;
// This is the start of a statement
const Token *next = tok->next();
const Token *vartok = 0;
// If next token contains a ":".. it is not part of a variable declaration
if (next->str().find(":") != std::string::npos)
continue;
if (Token::Match(next, "public|protected|private %var% :"))
{
if (next->str() == "public")
varaccess = Public;
else if (next->str() == "protected")
varaccess = Protected;
else if (next->str() == "private")
varaccess = Private;
tok = tok->tokAt(2);
continue;
}
// Is it a forward declaration?
if (Token::Match(next, "class|struct|union %var% ;"))
{
tok = tok->tokAt(2);
continue;
}
// Borland C++: Ignore properties..
if (next->str() == "__property")
continue;
// Is it const..?
if (next->str() == "const")
{
next = next->next();
}
// Is it a static variable?
const bool isStatic(Token::simpleMatch(next, "static"));
if (isStatic)
{
next = next->next();
}
// Is it a mutable variable?
const bool isMutable(Token::simpleMatch(next, "mutable"));
if (isMutable)
{
next = next->next();
}
// Is it const..?
if (next->str() == "const")
{
next = next->next();
}
// It it a nested derived class or structure?
if (Token::Match(next, "class|struct %type% :"))
{
next = next->tokAt(2);
while (next->str() != "{")
next = next->next();
continue;
}
// Is it a variable declaration?
bool isClass = false;
if (Token::Match(next, "%type% %var% ;|:"))
{
if (!next->isStandardType())
isClass = true;
vartok = next->tokAt(1);
}
// Structure?
else if (Token::Match(next, "struct|union %type% %var% ;"))
{
vartok = next->tokAt(2);
}
// Pointer?
else if (Token::Match(next, "%type% * %var% ;"))
vartok = next->tokAt(2);
else if (Token::Match(next, "%type% %type% * %var% ;"))
vartok = next->tokAt(3);
else if (Token::Match(next, "%type% :: %type% * %var% ;"))
vartok = next->tokAt(4);
else if (Token::Match(next, "%type% :: %type% :: %type% * %var% ;"))
vartok = next->tokAt(6);
// Array?
else if (Token::Match(next, "%type% %var% [") && next->next()->str() != "operator")
{
if (!next->isStandardType())
isClass = true;
vartok = next->tokAt(1);
}
// Pointer array?
else if (Token::Match(next, "%type% * %var% ["))
vartok = next->tokAt(2);
else if (Token::Match(next, "%type% :: %type% * %var% ["))
vartok = next->tokAt(4);
else if (Token::Match(next, "%type% :: %type% :: %type% * %var% ["))
vartok = next->tokAt(6);
// std::string..
else if (Token::Match(next, "%type% :: %type% %var% ;"))
{
isClass = true;
vartok = next->tokAt(3);
}
else if (Token::Match(next, "%type% :: %type% :: %type% %var% ;"))
{
isClass = true;
vartok = next->tokAt(5);
}
// Container..
else if (Token::Match(next, "%type% :: %type% <") ||
Token::Match(next, "%type% <"))
{
isClass = true;
// find matching ">"
int level = 0;
for (; next; next = next->next())
{
if (next->str() == "<")
level++;
else if (next->str() == ">")
{
level--;
if (level == 0)
break;
}
}
if (next && Token::Match(next, "> %var% ;"))
vartok = next->tokAt(1);
else if (next && Token::Match(next, "> * %var% ;"))
vartok = next->tokAt(2);
}
// If the vartok was set in the if-blocks above, create a entry for this variable..
if (vartok && vartok->str() != "operator" && !Token::Match(vartok->next(), "; %varid% =", vartok->varId()))
{
if (vartok->varId() == 0 && check->_settings->debugwarnings)
{
check->reportError(vartok, Severity::debug, "debug", "CheckClass::SpaceInfo::getVarList found variable \'" + vartok->str() + "\' with varid 0.");
}
addVar(vartok, varaccess, isMutable, isStatic, isClass);
}
}
}
//---------------------------------------------------------------------------
void CheckClass::SpaceInfo::assignVar(const std::string &varname)
{
std::list::iterator i;
for (i = varlist.begin(); i != varlist.end(); ++i)
{
if (i->token->str() == varname)
{
i->assign = true;
return;
}
}
}
void CheckClass::SpaceInfo::initVar(const std::string &varname)
{
std::list::iterator i;
for (i = varlist.begin(); i != varlist.end(); ++i)
{
if (i->token->str() == varname)
{
i->init = true;
return;
}
}
}
void CheckClass::SpaceInfo::assignAllVar()
{
std::list::iterator i;
for (i = varlist.begin(); i != varlist.end(); ++i)
i->assign = true;
}
void CheckClass::SpaceInfo::clearAllVar()
{
std::list::iterator i;
for (i = varlist.begin(); i != varlist.end(); ++i)
{
i->assign = false;
i->init = false;
}
}
//---------------------------------------------------------------------------
bool CheckClass::SpaceInfo::isBaseClassFunc(const Token *tok)
{
// Iterate through each base class...
for (unsigned int i = 0; i < derivedFrom.size(); ++i)
{
const SpaceInfo *info = derivedFrom[i].spaceInfo;
// Check if base class exists in database
if (info)
{
std::list::const_iterator it;
for (it = info->functionList.begin(); it != info->functionList.end(); ++it)
{
if (it->tokenDef->str() == tok->str())
return true;
}
}
// Base class not found so assume it is in it.
else
return true;
}
return false;
}
void CheckClass::SpaceInfo::initializeVarList(const Func &func, std::list &callstack)
{
bool Assign = false;
unsigned int indentlevel = 0;
const Token *ftok = func.token;
for (; ftok; ftok = ftok->next())
{
if (!ftok->next())
break;
// Class constructor.. initializing variables like this
// clKalle::clKalle() : var(value) { }
if (indentlevel == 0)
{
if (Assign && Token::Match(ftok, "%var% ("))
{
initVar(ftok->str());
// assignment in the initializer..
// : var(value = x)
if (Token::Match(ftok->tokAt(2), "%var% ="))
assignVar(ftok->strAt(2));
}
Assign |= (ftok->str() == ":");
}
if (ftok->str() == "{")
{
++indentlevel;
Assign = false;
}
else if (ftok->str() == "}")
{
if (indentlevel <= 1)
break;
--indentlevel;
}
if (indentlevel < 1)
continue;
// Variable getting value from stream?
if (Token::Match(ftok, ">> %var%"))
{
assignVar(ftok->strAt(1));
}
// Before a new statement there is "[{};)=]"
if (! Token::Match(ftok, "[{};()=]"))
continue;
if (Token::simpleMatch(ftok, "( !"))
ftok = ftok->next();
// Using the operator= function to initialize all variables..
if (Token::simpleMatch(ftok->next(), "* this = "))
{
assignAllVar();
break;
}
if (Token::Match(ftok->next(), "%var% . %var% ("))
ftok = ftok->tokAt(2);
if (!Token::Match(ftok->next(), "%var%") &&
!Token::Match(ftok->next(), "this . %var%") &&
!Token::Match(ftok->next(), "* %var% =") &&
!Token::Match(ftok->next(), "( * this ) . %var%"))
continue;
// Goto the first token in this statement..
ftok = ftok->next();
// Skip "( * this )"
if (Token::simpleMatch(ftok, "( * this ) ."))
{
ftok = ftok->tokAt(5);
}
// Skip "this->"
if (Token::simpleMatch(ftok, "this ."))
ftok = ftok->tokAt(2);
// Skip "classname :: "
if (Token::Match(ftok, "%var% ::"))
ftok = ftok->tokAt(2);
// Clearing all variables..
if (Token::simpleMatch(ftok, "memset ( this ,"))
{
assignAllVar();
return;
}
// Clearing array..
else if (Token::Match(ftok, "memset ( %var% ,"))
{
assignVar(ftok->strAt(2));
ftok = ftok->next()->link();
continue;
}
// Calling member function?
else if (Token::Match(ftok, "%var% (") && ftok->str() != "if")
{
// Passing "this" => assume that everything is initialized
for (const Token *tok2 = ftok->next()->link(); tok2 && tok2 != ftok; tok2 = tok2->previous())
{
if (tok2->str() == "this")
{
assignAllVar();
return;
}
}
// recursive call / calling overloaded function
// assume that all variables are initialized
if (std::find(callstack.begin(), callstack.end(), ftok->str()) != callstack.end())
{
assignAllVar();
return;
}
// check if member function
std::list::const_iterator it;
for (it = functionList.begin(); it != functionList.end(); ++it)
{
if (ftok->str() == it->tokenDef->str() && it->type != Func::Constructor)
break;
}
// member function found
if (it != functionList.end())
{
// member function has implementation
if (it->hasBody)
{
// initialize variable use list using member function
callstack.push_back(ftok->str());
initializeVarList(*it, callstack);
callstack.pop_back();
}
// there is a called member function, but it has no implementation, so we assume it initializes everything
else
{
assignAllVar();
}
}
// not member function
else
{
// could be a base class virtual function, so we assume it initializes everything
if (func.type != Func::Constructor && isBaseClassFunc(ftok))
{
/** @todo False Negative: we should look at the base class functions to see if they
* call any derived class virtual functions that change the derived class state
*/
assignAllVar();
}
// has friends, so we assume it initializes everything
if (!friendList.empty())
assignAllVar();
// the function is external and it's neither friend nor inherited virtual function.
// assume all variables that are passed to it are initialized..
else
{
unsigned int indentlevel2 = 0;
for (const Token *tok = ftok->tokAt(2); tok; tok = tok->next())
{
if (tok->str() == "(")
++indentlevel2;
else if (tok->str() == ")")
{
if (indentlevel2 == 0)
break;
--indentlevel2;
}
if (tok->isName())
{
assignVar(tok->str());
}
}
}
}
}
// Assignment of member variable?
else if (Token::Match(ftok, "%var% ="))
{
assignVar(ftok->str());
}
// Assignment of array item of member variable?
else if (Token::Match(ftok, "%var% [ %any% ] ="))
{
assignVar(ftok->str());
}
// Assignment of array item of member variable?
else if (Token::Match(ftok, "%var% [ %any% ] [ %any% ] ="))
{
assignVar(ftok->str());
}
// Assignment of array item of member variable?
else if (Token::Match(ftok, "* %var% ="))
{
assignVar(ftok->next()->str());
}
// Assignment of struct member of member variable?
else if (Token::Match(ftok, "%var% . %any% ="))
{
assignVar(ftok->str());
}
// The functions 'clear' and 'Clear' are supposed to initialize variable.
if (Token::Match(ftok, "%var% . clear|Clear ("))
{
assignVar(ftok->str());
}
}
}
bool CheckClass::argsMatch(const Token *first, const Token *second, const std::string &path, unsigned int depth) const
{
bool match = false;
while (first->str() == second->str())
{
// at end of argument list
if (first->str() == ")")
{
match = true;
break;
}
// skip default value assignment
else if (first->next()->str() == "=")
first = first->tokAt(2);
// definition missing variable name
else if (first->next()->str() == "," && second->next()->str() != ",")
second = second->next();
else if (first->next()->str() == ")" && second->next()->str() != ")")
second = second->next();
// function missing variable name
else if (second->next()->str() == "," && first->next()->str() != ",")
first = first->next();
else if (second->next()->str() == ")" && first->next()->str() != ")")
first = first->next();
// argument list has different number of arguments
else if (second->str() == ")")
break;
// variable names are different
else if ((Token::Match(first->next(), "%var% ,|)|=") &&
Token::Match(second->next(), "%var% ,|)")) &&
(first->next()->str() != second->next()->str()))
{
// skip variable names
first = first->next();
second = second->next();
// skip default value assignment
if (first->next()->str() == "=")
first = first->tokAt(2);
}
// variable with class path
else if (depth && Token::Match(first->next(), "%var%"))
{
std::string param = path + first->next()->str();
if (Token::Match(second->next(), param.c_str()))
{
second = second->tokAt(int(depth) * 2);
}
else if (depth > 1)
{
std::string short_path = path;
// remove last " :: "
short_path.resize(short_path.size() - 4);
// remove last name
while (!short_path.empty() && short_path[short_path.size() - 1] != ' ')
short_path.resize(short_path.size() - 1);
param = short_path + first->next()->str();
if (Token::Match(second->next(), param.c_str()))
{
second = second->tokAt((int(depth) - 1) * 2);
}
}
}
first = first->next();
second = second->next();
}
return match;
}
//---------------------------------------------------------------------------
// ClassCheck: Check that all class constructors are ok.
//---------------------------------------------------------------------------
void CheckClass::constructors()
{
if (!_settings->_checkCodingStyle)
return;
createSymbolDatabase();
std::multimap::iterator i;
for (i = spaceInfoMMap.begin(); i != spaceInfoMMap.end(); ++i)
{
SpaceInfo *info = i->second;
// don't check namespaces
if (info->isNamespace)
continue;
// There are no constructors.
if (info->numConstructors == 0)
{
// If there is a private variable, there should be a constructor..
std::list::const_iterator var;
for (var = info->varlist.begin(); var != info->varlist.end(); ++var)
{
if (var->access == Private && !var->isClass && !var->isStatic)
{
noConstructorError(info->classDef, info->className, info->classDef->str() == "struct");
break;
}
}
}
std::list::const_iterator it;
for (it = info->functionList.begin(); it != info->functionList.end(); ++it)
{
if (!it->hasBody || !(it->type == Func::Constructor || it->type == Func::CopyConstructor || it->type == Func::OperatorEqual))
continue;
// Mark all variables not used
info->clearAllVar();
std::list callstack;
info->initializeVarList(*it, callstack);
// Check if any variables are uninitialized
std::list::const_iterator var;
for (var = info->varlist.begin(); var != info->varlist.end(); ++var)
{
// skip classes for regular constructor
if (var->isClass && it->type == Func::Constructor)
continue;
if (var->assign || var->init || var->isStatic)
continue;
// It's non-static and it's not initialized => error
if (it->type == Func::OperatorEqual)
{
const Token *operStart = 0;
if (it->token->str() == "=")
operStart = it->token->tokAt(1);
else
operStart = it->token->tokAt(3);
bool classNameUsed = false;
for (const Token *operTok = operStart; operTok != operStart->link(); operTok = operTok->next())
{
if (operTok->str() == info->className)
{
classNameUsed = true;
break;
}
}
if (classNameUsed)
operatorEqVarError(it->token, info->className, var->token->str());
}
else if (it->access != Private)
uninitVarError(it->token, info->className, var->token->str());
}
}
}
}
//---------------------------------------------------------------------------
// ClassCheck: Unused private functions
//---------------------------------------------------------------------------
void CheckClass::privateFunctions()
{
if (!_settings->_checkCodingStyle)
return;
// don't check code that contains templates. Templates that are
// "unused" are removed from the code. #2067
if (_tokenizer->codeWithTemplates())
return;
// dont check borland classes with properties..
if (Token::findmatch(_tokenizer->tokens(), "; __property ;"))
return;
createSymbolDatabase();
std::multimap::iterator i;
for (i = spaceInfoMMap.begin(); i != spaceInfoMMap.end(); ++i)
{
SpaceInfo *info = i->second;
// don't check namespaces
if (info->isNamespace)
continue;
// dont check derived classes
if (!info->derivedFrom.empty())
continue;
// Locate some class
const Token *tok1 = info->classDef;
// check that the whole class implementation is seen
bool whole = true;
std::list::const_iterator func;
for (func = info->functionList.begin(); func != info->functionList.end(); ++func)
{
if (!func->hasBody)
{
// empty private copy constructors and assignment operators are OK
if ((func->type == Func::CopyConstructor || func->type == Func::OperatorEqual) && func->access == Private)
continue;
whole = false;
break;
}
}
if (!whole)
continue;
const std::string &classname = tok1->next()->str();
std::list FuncList;
/** @todo embedded class have access to private functions */
if (info->nestedList.empty())
{
for (func = info->functionList.begin(); func != info->functionList.end(); ++func)
{
// Get private functions..
if (func->type == Func::Function &&
func->access == Private && func->hasBody)
FuncList.push_back(func->tokenDef);
}
}
// Check that all private functions are used..
bool HasFuncImpl = false;
bool inclass = false;
int indent_level = 0;
for (const Token *ftok = _tokenizer->tokens(); ftok; ftok = ftok->next())
{
if (ftok->str() == "{")
++indent_level;
else if (ftok->str() == "}")
{
if (indent_level > 0)
--indent_level;
if (indent_level == 0)
inclass = false;
}
else if (ftok->str() == "class" &&
ftok->next()->str() == classname &&
Token::Match(ftok->tokAt(2), ":|{"))
{
indent_level = 0;
inclass = true;
}
// Check member class functions to see what functions are used..
else if ((inclass && indent_level == 1 && Token::Match(ftok, "%var% (")) ||
(ftok->str() == classname && Token::Match(ftok->next(), ":: ~| %var% (")))
{
while (ftok && ftok->str() != ")")
ftok = ftok->next();
if (!ftok)
break;
if (Token::Match(ftok, ") : %var% ("))
{
while (!Token::Match(ftok->next(), "[{};]"))
{
if (Token::Match(ftok, "::|,|( %var% ,|)"))
{
// Remove function from FuncList
std::list::iterator it = FuncList.begin();
while (it != FuncList.end())
{
if (ftok->next()->str() == (*it)->str())
FuncList.erase(it++);
else
++it;
}
}
ftok = ftok->next();
}
}
if (!Token::Match(ftok, ") const| {"))
continue;
if (ftok->fileIndex() == 0)
HasFuncImpl = true;
// Parse function..
int indentlevel2 = 0;
for (const Token *tok2 = ftok; tok2; tok2 = tok2->next())
{
if (tok2->str() == "{")
++indentlevel2;
else if (tok2->str() == "}")
{
--indentlevel2;
if (indentlevel2 < 1)
break;
}
else if (Token::Match(tok2, "%var% ("))
{
// Remove function from FuncList
std::list::iterator it = FuncList.begin();
while (it != FuncList.end())
{
if (tok2->str() == (*it)->str())
FuncList.erase(it++);
else
++it;
}
}
}
}
}
while (HasFuncImpl && !FuncList.empty())
{
// Final check; check if the function pointer is used somewhere..
const std::string _pattern("return|(|)|,|= " + FuncList.front()->str());
// or if the function address is used somewhere...
// eg. sigc::mem_fun(this, &className::classFunction)
const std::string _pattern2("& " + classname + " :: " + FuncList.front()->str());
if (!Token::findmatch(_tokenizer->tokens(), _pattern.c_str()) &&
!Token::findmatch(_tokenizer->tokens(), _pattern2.c_str()))
{
unusedPrivateFunctionError(FuncList.front(), classname, FuncList.front()->str());
}
FuncList.pop_front();
}
}
}
//---------------------------------------------------------------------------
// ClassCheck: Check that memset is not used on classes
//---------------------------------------------------------------------------
void CheckClass::noMemset()
{
// Locate all 'memset' tokens..
for (const Token *tok = _tokenizer->tokens(); tok; tok = tok->next())
{
if (!Token::Match(tok, "memset|memcpy|memmove"))
continue;
std::string type;
if (Token::Match(tok, "memset ( %var% , %num% , sizeof ( %type% ) )"))
type = tok->strAt(8);
else if (Token::Match(tok, "memset ( & %var% , %num% , sizeof ( %type% ) )"))
type = tok->strAt(9);
else if (Token::Match(tok, "memset ( %var% , %num% , sizeof ( struct %type% ) )"))
type = tok->strAt(9);
else if (Token::Match(tok, "memset ( & %var% , %num% , sizeof ( struct %type% ) )"))
type = tok->strAt(10);
else if (Token::Match(tok, "%type% ( %var% , %var% , sizeof ( %type% ) )"))
type = tok->strAt(8);
// No type defined => The tokens didn't match
if (type.empty())
continue;
// Warn if type is a class or struct that contains any std::* variables
const std::string pattern2(std::string("struct|class ") + type + " {");
for (const Token *tstruct = Token::findmatch(_tokenizer->tokens(), pattern2.c_str()); tstruct; tstruct = tstruct->next())
{
if (tstruct->str() == "}")
break;
// struct with function? skip function body..
if (Token::simpleMatch(tstruct, ") {"))
{
tstruct = tstruct->next()->link();
if (!tstruct)
break;
}
// before a statement there must be either:
// * private:|protected:|public:
// * { } ;
if (Token::Match(tstruct, "[;{}]") ||
tstruct->str().find(":") != std::string::npos)
{
if (Token::Match(tstruct->next(), "std :: %type% %var% ;"))
memsetStructError(tok, tok->str(), tstruct->strAt(3));
else if (Token::Match(tstruct->next(), "std :: %type% < "))
{
// backup the type
const std::string typestr(tstruct->strAt(3));
// check if it's a pointer variable..
unsigned int level = 0;
while (0 != (tstruct = tstruct->next()))
{
if (tstruct->str() == "<")
++level;
else if (tstruct->str() == ">")
{
if (level <= 1)
break;
--level;
}
else if (tstruct->str() == "(")
tstruct = tstruct->link();
}
if (!tstruct)
break;
// found error => report
if (Token::Match(tstruct, "> %var% ;"))
memsetStructError(tok, tok->str(), typestr);
}
}
}
}
}
//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
// ClassCheck: "void operator=(" and "const type & operator=("
//---------------------------------------------------------------------------
void CheckClass::operatorEq()
{
if (!_settings->_checkCodingStyle)
return;
createSymbolDatabase();
std::multimap::const_iterator i;
for (i = spaceInfoMMap.begin(); i != spaceInfoMMap.end(); ++i)
{
std::list::const_iterator it;
for (it = i->second->functionList.begin(); it != i->second->functionList.end(); ++it)
{
if (it->type == Func::OperatorEqual && it->access != Private)
{
if (it->token->strAt(-2) == "void")
operatorEqReturnError(it->token->tokAt(-2));
}
}
}
}
//---------------------------------------------------------------------------
// ClassCheck: "C& operator=(const C&) { ... return *this; }"
// operator= should return a reference to *this
//---------------------------------------------------------------------------
void CheckClass::checkReturnPtrThis(const SpaceInfo *info, const Func *func, const Token *tok, const Token *last)
{
bool foundReturn = false;
for (; tok && tok != last; tok = tok->next())
{
// check for return of reference to this
if (tok->str() == "return")
{
foundReturn = true;
std::string cast("( " + info->className + " & )");
if (Token::Match(tok->next(), cast.c_str()))
tok = tok->tokAt(4);
// check if a function is called
if (Token::Match(tok->tokAt(1), "%any% (") &&
tok->tokAt(2)->link()->next()->str() == ";")
{
std::list::const_iterator it;
// check if it is a member function
for (it = info->functionList.begin(); it != info->functionList.end(); ++it)
{
// check for a regular function with the same name and a bofy
if (it->type == Func::Function && it->hasBody &&
it->token->str() == tok->next()->str())
{
// check for the proper return type
if (it->tokenDef->previous()->str() == "&" &&
it->tokenDef->strAt(-2) == info->className)
{
// make sure it's not a const function
if (it->arg->link()->next()->str() != "const")
checkReturnPtrThis(info, &*it, it->arg->link()->next(), it->arg->link()->next()->link());
}
}
}
}
// check of *this is returned
else if (!(Token::Match(tok->tokAt(1), "(| * this ;|=") ||
Token::Match(tok->tokAt(1), "(| * this +=") ||
Token::Match(tok->tokAt(1), "operator = (")))
operatorEqRetRefThisError(func->token);
}
}
if (!foundReturn)
operatorEqRetRefThisError(func->token);
}
void CheckClass::operatorEqRetRefThis()
{
if (!_settings->_checkCodingStyle)
return;
createSymbolDatabase();
std::multimap::const_iterator i;
for (i = spaceInfoMMap.begin(); i != spaceInfoMMap.end(); ++i)
{
const SpaceInfo *info = i->second;
std::list::const_iterator it;
for (it = info->functionList.begin(); it != info->functionList.end(); ++it)
{
if (it->type == Func::OperatorEqual && it->hasBody)
{
// make sure return signature is correct
if (Token::Match(it->tokenDef->tokAt(-4), ";|}|{|public:|protected:|private: %type% &") &&
it->tokenDef->strAt(-3) == info->className)
{
// find the ')'
const Token *tok = it->token->next()->link();
checkReturnPtrThis(info, &*it, tok->tokAt(2), tok->next()->link());
}
}
}
}
}
//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
// ClassCheck: "C& operator=(const C& rhs) { if (this == &rhs) ... }"
// operator= should check for assignment to self
//
// For simple classes, an assignment to self check is only a potential optimization.
//
// For classes that allocate dynamic memory, assignment to self can be a real error
// if it is deallocated and allocated again without being checked for.
//
// This check is not valid for classes with multiple inheritance because a
// class can have multiple addresses so there is no trivial way to check for
// assignment to self.
//---------------------------------------------------------------------------
static bool hasDeallocation(const Token *first, const Token *last)
{
// This function is called when no simple check was found for assignment
// to self. We are currently looking for a specific sequence of:
// deallocate member ; ... member = allocate
// This check is far from ideal because it can cause false negatives.
// Unfortunately, this is necessary to prevent false positives.
// This check needs to do careful analysis someday to get this
// correct with a high degree of certainty.
for (const Token *tok = first; tok && (tok != last); tok = tok->next())
{
// check for deallocating memory
if (Token::Match(tok, "{|;|, free ( %var%"))
{
const Token *var = tok->tokAt(3);
// we should probably check that var is a pointer in this class
const Token *tok1 = tok->tokAt(4);
while (tok1 && (tok1 != last))
{
if (Token::Match(tok1, "%var% ="))
{
if (tok1->str() == var->str())
return true;
}
tok1 = tok1->next();
}
}
else if (Token::Match(tok, "{|;|, delete [ ] %var%"))
{
const Token *var = tok->tokAt(4);
// we should probably check that var is a pointer in this class
const Token *tok1 = tok->tokAt(5);
while (tok1 && (tok1 != last))
{
if (Token::Match(tok1, "%var% = new %type% ["))
{
if (tok1->str() == var->str())
return true;
}
tok1 = tok1->next();
}
}
else if (Token::Match(tok, "{|;|, delete %var%"))
{
const Token *var = tok->tokAt(2);
// we should probably check that var is a pointer in this class
const Token *tok1 = tok->tokAt(3);
while (tok1 && (tok1 != last))
{
if (Token::Match(tok1, "%var% = new"))
{
if (tok1->str() == var->str())
return true;
}
tok1 = tok1->next();
}
}
}
return false;
}
static bool hasAssignSelf(const Token *first, const Token *last, const Token *rhs)
{
for (const Token *tok = first; tok && tok != last; tok = tok->next())
{
if (Token::Match(tok, "if ("))
{
const Token *tok1 = tok->tokAt(2);
const Token *tok2 = tok->tokAt(1)->link();
if (tok1 && tok2)
{
for (; tok1 && tok1 != tok2; tok1 = tok1->next())
{
if (Token::Match(tok1, "this ==|!= & %var%"))
{
if (tok1->tokAt(3)->str() == rhs->str())
return true;
}
else if (Token::Match(tok1, "& %var% ==|!= this"))
{
if (tok1->tokAt(1)->str() == rhs->str())
return true;
}
}
}
}
}
return false;
}
void CheckClass::operatorEqToSelf()
{
if (!_settings->_checkCodingStyle)
return;
createSymbolDatabase();
std::multimap::const_iterator i;
for (i = spaceInfoMMap.begin(); i != spaceInfoMMap.end(); ++i)
{
const SpaceInfo *info = i->second;
std::list::const_iterator it;
// skip classes with multiple inheritance
if (info->derivedFrom.size() > 1)
continue;
for (it = info->functionList.begin(); it != info->functionList.end(); ++it)
{
if (it->type == Func::OperatorEqual && it->hasBody)
{
// make sure return signature is correct
if (Token::Match(it->tokenDef->tokAt(-4), ";|}|{|public:|protected:|private: %type% &") &&
it->tokenDef->strAt(-3) == info->className)
{
// check for proper function parameter signature
if ((Token::Match(it->tokenDef->next(), "( const %var% & )") ||
Token::Match(it->tokenDef->next(), "( const %var% & %var% )")) &&
it->tokenDef->strAt(3) == info->className)
{
// find the parameter name
const Token *rhs = it->token;
while (rhs->str() != "&")
rhs = rhs->next();
rhs = rhs->next();
// find the ')'
const Token *tok = it->token->next()->link();
const Token *tok1 = tok;
if (tok1 && tok1->tokAt(1) && tok1->tokAt(1)->str() == "{" && tok1->tokAt(1)->link())
{
const Token *first = tok1->tokAt(1);
const Token *last = first->link();
if (!hasAssignSelf(first, last, rhs))
{
if (hasDeallocation(first, last))
operatorEqToSelfError(tok);
}
}
}
}
}
}
}
}
//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
// A destructor in a base class should be virtual
//---------------------------------------------------------------------------
void CheckClass::virtualDestructor()
{
// This error should only be given if:
// * base class doesn't have virtual destructor
// * derived class has non-empty destructor
// * base class is deleted
if (!_settings->inconclusive)
return;
createSymbolDatabase();
std::multimap::const_iterator i;
for (i = spaceInfoMMap.begin(); i != spaceInfoMMap.end(); ++i)
{
const SpaceInfo *info = i->second;
// Skip base classes and namespaces
if (info->derivedFrom.empty())
continue;
// Find the destructor
const Func *destructor = info->getDestructor();
// Check for destructor with implementation
if (!destructor || !destructor->hasBody)
continue;
// Empty destructor
if (destructor->token->tokAt(3)->link() == destructor->token->tokAt(4))
continue;
const Token *derived = info->classDef;
const Token *derivedClass = derived->tokAt(1);
// Iterate through each base class...
for (unsigned int j = 0; j < info->derivedFrom.size(); ++j)
{
// Check if base class is public and exists in database
if (info->derivedFrom[j].access == Public && info->derivedFrom[j].spaceInfo)
{
const SpaceInfo *spaceInfo = info->derivedFrom[j].spaceInfo;
// Name of base class..
const std::string baseName = spaceInfo->className;
// Find the destructor declaration for the base class.
const Func *base_destructor = spaceInfo->getDestructor();
const Token *base = 0;
if (base_destructor)
base = base_destructor->token;
// Check that there is a destructor..
if (!base_destructor)
{
if (spaceInfo->derivedFrom.empty())
virtualDestructorError(spaceInfo->classDef, baseName, derivedClass->str());
}
else if (!base_destructor->isVirtual)
{
// TODO: This is just a temporary fix, better solution is needed.
// Skip situations where base class has base classes of its own, because
// some of the base classes might have virtual destructor.
// Proper solution is to check all of the base classes. If base class is not
// found or if one of the base classes has virtual destructor, error should not
// be printed. See TODO test case "virtualDestructorInherited"
if (spaceInfo->derivedFrom.empty())
{
// Make sure that the destructor is public (protected or private
// would not compile if inheritance is used in a way that would
// cause the bug we are trying to find here.)
if (base_destructor->access == Public)
virtualDestructorError(base, baseName, derivedClass->str());
}
}
}
}
}
}
//---------------------------------------------------------------------------
void CheckClass::thisSubtractionError(const Token *tok)
{
reportError(tok, Severity::warning, "thisSubtraction", "Suspicious pointer subtraction");
}
void CheckClass::thisSubtraction()
{
if (!_settings->_checkCodingStyle)
return;
const Token *tok = _tokenizer->tokens();
for (;;)
{
tok = Token::findmatch(tok, "this - %var%");
if (!tok)
break;
if (!Token::simpleMatch(tok->previous(), "*"))
thisSubtractionError(tok);
tok = tok->next();
}
}
//---------------------------------------------------------------------------
// check if this function is defined virtual in the base classes
bool CheckClass::isVirtual(const SpaceInfo *info, const Token *functionToken) const
{
// check each base class
for (unsigned int i = 0; i < info->derivedFrom.size(); ++i)
{
// check if base class exists in database
if (info->derivedFrom[i].spaceInfo)
{
const SpaceInfo *spaceInfo = info->derivedFrom[i].spaceInfo;
std::list::const_iterator it;
// check if function defined in base class
for (it = spaceInfo->functionList.begin(); it != spaceInfo->functionList.end(); ++it)
{
if (it->isVirtual)
{
const Token *tok = it->tokenDef;
if (tok->str() == functionToken->str())
{
const Token *temp1 = tok->previous();
const Token *temp2 = functionToken->previous();
bool returnMatch = true;
// check for matching return parameters
while (temp1->str() != "virtual")
{
if (temp1->str() != temp2->str())
{
returnMatch = false;
break;
}
temp1 = temp1->previous();
temp2 = temp2->previous();
}
// check for matching function parameters
if (returnMatch && argsMatch(tok->tokAt(2), functionToken->tokAt(2), std::string(""), 0))
{
return true;
}
}
}
}
if (!spaceInfo->derivedFrom.empty())
{
if (isVirtual(spaceInfo, functionToken))
return true;
}
}
else
{
// unable to find base class so assume it has a virtual function
return true;
}
}
return false;
}
// Can a function be const?
void CheckClass::checkConst()
{
if (!_settings->_checkCodingStyle || _settings->ifcfg)
return;
// Don't check C# and JAVA classes
if (_tokenizer->getFiles()->at(0).find(".java") != std::string::npos ||
_tokenizer->getFiles()->at(0).find(".cs") != std::string::npos)
{
return;
}
createSymbolDatabase();
std::multimap::iterator it;
for (it = spaceInfoMMap.begin(); it != spaceInfoMMap.end(); ++it)
{
SpaceInfo *info = it->second;
std::list::iterator it1;
for (it1 = info->functionList.begin(); it1 != info->functionList.end(); ++it1)
{
const Func & func = *it1;
// does the function have a body?
if (func.type == Func::Function && func.hasBody && !func.isFriend && !func.isStatic && !func.isConst && !func.isVirtual)
{
// get last token of return type
const Token *previous = func.tokenDef->isName() ? func.token->previous() : func.token->tokAt(-2);
while (previous->str() == "::")
previous = previous->tokAt(-2);
// does the function return a pointer or reference?
if (Token::Match(previous, "*|&"))
{
const Token *temp = func.token->previous();
while (!Token::Match(temp->previous(), ";|}|{|public:|protected:|private:"))
temp = temp->previous();
if (temp->str() != "const")
continue;
}
else if (Token::Match(previous->previous(), "*|& >"))
{
const Token *temp = func.token->previous();
while (!Token::Match(temp->previous(), ";|}|{|public:|protected:|private:"))
{
temp = temp->previous();
if (temp->str() == "const")
break;
}
if (temp->str() != "const")
continue;
}
else
{
// don't warn for unknown types..
// LPVOID, HDC, etc
if (previous->isName())
{
bool allupper = true;
const std::string s(previous->str());
for (std::string::size_type pos = 0; pos < s.size(); ++pos)
{
const char ch = s[pos];
if (!(ch == '_' || (ch >= 'A' && ch <= 'Z')))
{
allupper = false;
break;
}
}
if (allupper && previous->str().size() > 2)
continue;
}
}
const Token *paramEnd = func.token->next()->link();
// check if base class function is virtual
if (!info->derivedFrom.empty())
{
if (isVirtual(info, func.tokenDef))
continue;
}
// if nothing non-const was found. write error..
if (checkConstFunc(info, paramEnd))
{
std::string classname = info->className;
SpaceInfo *nest = info->nestedIn;
while (nest)
{
classname = std::string(nest->className + "::" + classname);
nest = nest->nestedIn;
}
// get function name
std::string functionName((func.tokenDef->isName() ? "" : "operator") + func.tokenDef->str());
if (func.tokenDef->str() == "(")
functionName += ")";
else if (func.tokenDef->str() == "[")
functionName += "]";
if (func.isInline)
checkConstError(func.token, classname, functionName);
else // not inline
checkConstError2(func.token, func.tokenDef, classname, functionName);
}
}
}
}
}
bool CheckClass::isMemberVar(const SpaceInfo *info, const Token *tok)
{
while (tok->previous() && !Token::Match(tok->previous(), "}|{|;|public:|protected:|private:|return|:|?"))
{
if (Token::Match(tok->previous(), "* this"))
return true;
tok = tok->previous();
}
if (tok->str() == "this")
return true;
if (Token::Match(tok, "( * %var% ) ["))
tok = tok->tokAt(2);
// ignore class namespace
if (tok->str() == info->className && tok->next()->str() == "::")
tok = tok->tokAt(2);
std::list::const_iterator var;
for (var = info->varlist.begin(); var != info->varlist.end(); ++var)
{
if (var->token->str() == tok->str())
{
return !var->isMutable;
}
}
// not found in this class
if (!info->derivedFrom.empty())
{
// check each base class
for (unsigned int i = 0; i < info->derivedFrom.size(); ++i)
{
// find the base class
const SpaceInfo *spaceInfo = info->derivedFrom[i].spaceInfo;
// find the function in the base class
if (spaceInfo)
{
if (isMemberVar(spaceInfo, tok))
return true;
}
}
}
return false;
}
bool CheckClass::isConstMemberFunc(const SpaceInfo *info, const Token *tok)
{
std::list::const_iterator func;
for (func = info->functionList.begin(); func != info->functionList.end(); ++func)
{
if (func->tokenDef->str() == tok->str() && func->isConst)
return true;
}
// not found in this class
if (!info->derivedFrom.empty())
{
// check each base class
for (unsigned int i = 0; i < info->derivedFrom.size(); ++i)
{
// find the base class
const SpaceInfo *spaceInfo = info->derivedFrom[i].spaceInfo;
// find the function in the base class
if (spaceInfo)
{
if (isConstMemberFunc(spaceInfo, tok))
return true;
}
}
}
return false;
}
bool CheckClass::checkConstFunc(const SpaceInfo *info, const Token *tok)
{
// if the function doesn't have any assignment nor function call,
// it can be a const function..
unsigned int indentlevel = 0;
bool isconst = true;
for (const Token *tok1 = tok; tok1; tok1 = tok1->next())
{
if (tok1->str() == "{")
++indentlevel;
else if (tok1->str() == "}")
{
if (indentlevel <= 1)
break;
--indentlevel;
}
// assignment.. = += |= ..
else if (tok1->str() == "=" ||
(tok1->str().find("=") == 1 &&
tok1->str().find_first_of("") == std::string::npos))
{
if (tok1->previous()->varId() == 0 && !info->derivedFrom.empty())
{
isconst = false;
break;
}
else if (isMemberVar(info, tok1->previous()))
{
isconst = false;
break;
}
else if (tok1->previous()->str() == "]")
{
// TODO: I assume that the assigned variable is a member variable
// don't assume it
isconst = false;
break;
}
else if (tok1->next()->str() == "this")
{
isconst = false;
break;
}
}
// streaming: <<
else if (tok1->str() == "<<" && isMemberVar(info, tok1->previous()))
{
isconst = false;
break;
}
// increment/decrement (member variable?)..
else if (Token::Match(tok1, "++|--"))
{
isconst = false;
break;
}
// function call..
else if (Token::Match(tok1, "%var% (") &&
!(Token::Match(tok1, "return|c_str|if|string") || tok1->isStandardType()))
{
if (!isConstMemberFunc(info, tok1))
{
isconst = false;
break;
}
}
else if (Token::Match(tok1, "%var% < %any% > ("))
{
isconst = false;
break;
}
// delete..
else if (tok1->str() == "delete")
{
isconst = false;
break;
}
}
return isconst;
}
void CheckClass::checkConstError(const Token *tok, const std::string &classname, const std::string &funcname)
{
reportError(tok, Severity::style, "functionConst", "The function '" + classname + "::" + funcname + "' can be const");
}
void CheckClass::checkConstError2(const Token *tok1, const Token *tok2, const std::string &classname, const std::string &funcname)
{
std::list toks;
toks.push_back(tok1);
toks.push_back(tok2);
reportError(toks, Severity::style, "functionConst", "The function '" + classname + "::" + funcname + "' can be const");
}
void CheckClass::noConstructorError(const Token *tok, const std::string &classname, bool isStruct)
{
// For performance reasons the constructor might be intentionally missing. Therefore this is not a "warning"
reportError(tok, Severity::style, "noConstructor", "The " + std::string(isStruct ? "struct" : "class") + " '" + classname + "' has no constructor. Member variables not initialized.");
}
void CheckClass::uninitVarError(const Token *tok, const std::string &classname, const std::string &varname)
{
reportError(tok, Severity::warning, "uninitVar", "Member variable not initialized in the constructor '" + classname + "::" + varname + "'");
}
void CheckClass::operatorEqVarError(const Token *tok, const std::string &classname, const std::string &varname)
{
reportError(tok, Severity::warning, "operatorEqVarError", "Member variable '" + classname + "::" + varname + "' is not assigned a value in '" + classname + "::operator=" + "'");
}
void CheckClass::unusedPrivateFunctionError(const Token *tok, const std::string &classname, const std::string &funcname)
{
reportError(tok, Severity::style, "unusedPrivateFunction", "Unused private function '" + classname + "::" + funcname + "'");
}
void CheckClass::memsetClassError(const Token *tok, const std::string &memfunc)
{
reportError(tok, Severity::error, "memsetClass", "Using '" + memfunc + "' on class");
}
void CheckClass::memsetStructError(const Token *tok, const std::string &memfunc, const std::string &classname)
{
reportError(tok, Severity::error, "memsetStruct", "Using '" + memfunc + "' on struct that contains a 'std::" + classname + "'");
}
void CheckClass::operatorEqReturnError(const Token *tok)
{
reportError(tok, Severity::style, "operatorEq", "'operator=' should return something");
}
void CheckClass::virtualDestructorError(const Token *tok, const std::string &Base, const std::string &Derived)
{
reportError(tok, Severity::error, "virtualDestructor", "Class " + Base + " which is inherited by class " + Derived + " does not have a virtual destructor");
}
void CheckClass::operatorEqRetRefThisError(const Token *tok)
{
reportError(tok, Severity::style, "operatorEqRetRefThis", "'operator=' should return reference to self");
}
void CheckClass::operatorEqToSelfError(const Token *tok)
{
reportError(tok, Severity::warning, "operatorEqToSelf", "'operator=' should check for assignment to self");
}