cppcheck/lib/checkunusedfunctions.cpp

201 lines
6.4 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-2010 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/>.
2008-12-18 22:28:57 +01:00
*/
//---------------------------------------------------------------------------
#include "checkunusedfunctions.h"
2008-12-18 22:28:57 +01:00
#include "tokenize.h"
#include "token.h"
2008-12-18 22:28:57 +01:00
//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
// FUNCTION USAGE - Check for unused functions etc
//---------------------------------------------------------------------------
void CheckUnusedFunctions::parseTokens(const Tokenizer &tokenizer)
2008-12-18 22:28:57 +01:00
{
// Function declarations..
for (const Token *tok = tokenizer.tokens(); tok; tok = tok->next())
2008-12-18 22:28:57 +01:00
{
if (tok->fileIndex() != 0)
2008-12-18 22:28:57 +01:00
continue;
// token contains a ':' => skip to next ; or {
if (tok->str().find(":") != std::string::npos)
{
while (tok && tok->str().find_first_of(";{"))
tok = tok->next();
if (tok)
continue;
break;
}
// If this is a template function, skip it
if (tok->previous() && tok->previous()->str() == ">")
continue;
const Token *funcname = 0;
2008-12-18 22:28:57 +01:00
if (Token::Match(tok, "%type% %var% ("))
2008-12-18 22:28:57 +01:00
funcname = tok->tokAt(1);
else if (Token::Match(tok, "%type% * %var% ("))
2008-12-18 22:28:57 +01:00
funcname = tok->tokAt(2);
else if (Token::Match(tok, "%type% :: %var% (") && !Token::Match(tok, tok->strAt(2).c_str()))
2008-12-18 22:28:57 +01:00
funcname = tok->tokAt(2);
// Don't assume throw as a function name: void foo() throw () {}
if (Token::Match(tok->previous(), ")|const"))
funcname = 0;
2008-12-18 22:28:57 +01:00
// Check that ") {" is found..
for (const Token *tok2 = funcname; tok2; tok2 = tok2->next())
2008-12-18 22:28:57 +01:00
{
if (tok2->str() == ")")
2008-12-18 22:28:57 +01:00
{
if (! Token::simpleMatch(tok2, ") {") &&
! Token::simpleMatch(tok2, ") const {") &&
! Token::simpleMatch(tok2, ") const throw ( ) {") &&
! Token::simpleMatch(tok2, ") throw ( ) {"))
2008-12-18 22:28:57 +01:00
funcname = NULL;
break;
}
}
if (funcname)
2008-12-18 22:28:57 +01:00
{
FunctionUsage &func = _functions[ funcname->str()];
2008-12-18 22:28:57 +01:00
// No filename set yet..
if (func.filename.empty())
2008-12-18 22:28:57 +01:00
func.filename = tokenizer.getFiles()->at(0);
// Multiple files => filename = "+"
else if (func.filename != tokenizer.getFiles()->at(0))
2008-12-18 22:28:57 +01:00
{
func.filename = "+";
func.usedOtherFile |= func.usedSameFile;
}
}
}
// Function usage..
for (const Token *tok = tokenizer.tokens(); tok; tok = tok->next())
2008-12-18 22:28:57 +01:00
{
const Token *funcname = 0;
if (Token::Match(tok->next(), "%var% ("))
{
funcname = tok->next();
}
else if (Token::Match(tok, "[;{}.,()[=+-/&|!?:] %var% [(),;:}]"))
2008-12-18 22:28:57 +01:00
funcname = tok->next();
else if (Token::Match(tok, "[=(,] & %var% :: %var% [,);]"))
funcname = tok->tokAt(4);
2009-06-05 15:02:26 +02:00
else
continue;
2008-12-18 22:28:57 +01:00
// funcname ( => Assert that the end paranthesis isn't followed by {
if (Token::Match(funcname, "%var% ("))
2008-12-18 22:28:57 +01:00
{
int parlevel = 0;
for (const Token *tok2 = funcname; tok2; tok2 = tok2->next())
2008-12-18 22:28:57 +01:00
{
if (tok2->str() == "(")
2008-12-18 22:28:57 +01:00
++parlevel;
else if (tok2->str() == ")")
2008-12-18 22:28:57 +01:00
{
--parlevel;
if (parlevel == 0 && (Token::Match(tok2, ") const|{")))
2008-12-18 22:28:57 +01:00
funcname = NULL;
if (parlevel <= 0)
2008-12-18 22:28:57 +01:00
break;
}
}
}
if (funcname)
2008-12-18 22:28:57 +01:00
{
FunctionUsage &func = _functions[ funcname->str()];
2008-12-18 22:28:57 +01:00
if (func.filename.empty() || func.filename == "+")
2008-12-18 22:28:57 +01:00
func.usedOtherFile = true;
else
func.usedSameFile = true;
}
}
}
2010-07-08 13:01:53 +02:00
void CheckUnusedFunctions::check(ErrorLogger * const errorLogger)
2008-12-18 22:28:57 +01:00
{
for (std::map<std::string, FunctionUsage>::const_iterator it = _functions.begin(); it != _functions.end(); ++it)
2008-12-18 22:28:57 +01:00
{
const FunctionUsage &func = it->second;
if (func.usedOtherFile || func.filename.empty())
2008-12-18 22:28:57 +01:00
continue;
if (it->first == "main" || it->first == "WinMain" || it->first == "if")
continue;
if (! func.usedSameFile)
2008-12-18 22:28:57 +01:00
{
2009-01-11 07:44:32 +01:00
std::string filename;
if (func.filename == "+")
2009-01-11 07:44:32 +01:00
filename = "";
else
filename = func.filename;
2010-07-08 13:01:53 +02:00
unusedFunctionError(errorLogger, filename, it->first);
2008-12-18 22:28:57 +01:00
}
else if (! func.usedOtherFile)
2008-12-18 22:28:57 +01:00
{
/** @todo add error message "function is only used in <file> it can be static" */
/*
2008-12-18 22:28:57 +01:00
std::ostringstream errmsg;
errmsg << "The function '" << it->first << "' is only used in the file it was declared in so it should have local linkage.";
_errorLogger->reportErr( errmsg.str() );
*/
}
}
}
2010-07-08 13:01:53 +02:00
void CheckUnusedFunctions::unusedFunctionError(ErrorLogger * const errorLogger, const std::string &filename, const std::string &funcname)
{
2010-07-08 13:01:53 +02:00
std::list<ErrorLogger::ErrorMessage::FileLocation> locationList;
if (!filename.empty())
{
ErrorLogger::ErrorMessage::FileLocation fileLoc;
fileLoc.file = filename;
fileLoc.line = 1;
locationList.push_back(fileLoc);
}
const ErrorLogger::ErrorMessage errmsg(locationList, Severity::style, "The function '" + funcname + "' is never used", "unusedFunction");
2010-07-08 13:01:53 +02:00
if (errorLogger)
errorLogger->reportErr(errmsg);
else
reportError(errmsg);
}