cppcheck/src/cppcheck.cpp

372 lines
12 KiB
C++
Raw Normal View History

2008-12-18 22:28:57 +01:00
/*
* cppcheck - c/c++ syntax checking
2009-01-02 20:02:35 +01:00
* Copyright (C) 2007-2009 Daniel Marjamäki, Reijo Tomperi, Nicolas Le Cam
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/
*/
#include "cppcheck.h"
#include "preprocessor.h" // preprocessor.
#include "tokenize.h" // <- Tokenizer
#include "checkmemoryleak.h"
#include "checkbufferoverrun.h"
#include "checkclass.h"
#include "checkheaders.h"
#include "checkother.h"
#include "checkfunctionusage.h"
#include "filelister.h"
#include "errormessage.h"
2008-12-18 22:28:57 +01:00
#include <algorithm>
#include <sstream>
#include <cstring>
#include <fstream>
#include <map>
//---------------------------------------------------------------------------
CppCheck::CppCheck(ErrorLogger &errorLogger)
2008-12-18 22:28:57 +01:00
{
_errorLogger = &errorLogger;
}
CppCheck::~CppCheck()
{
}
void CppCheck::settings(const Settings &settings)
2008-12-18 22:28:57 +01:00
{
_settings = settings;
}
void CppCheck::addFile(const std::string &path)
2008-12-18 22:28:57 +01:00
{
_filenames.push_back(path);
2008-12-18 22:28:57 +01:00
}
void CppCheck::addFile(const std::string &path, const std::string &content)
2008-12-18 22:28:57 +01:00
{
_filenames.push_back(path);
2008-12-18 22:28:57 +01:00
_fileContents[ path ] = content;
}
std::string CppCheck::parseFromArgs(int argc, const char* const argv[])
2008-12-18 22:28:57 +01:00
{
std::vector<std::string> pathnames;
for (int i = 1; i < argc; i++)
{
// Flag used for various purposes during debugging
if (strcmp(argv[i], "--debug") == 0)
2008-12-18 22:28:57 +01:00
_settings._debug = true;
// Show all messages
else if (strcmp(argv[i], "-a") == 0 || strcmp(argv[i], "--all") == 0)
2008-12-18 22:28:57 +01:00
_settings._showAll = true;
// Only print something when there are errors
else if (strcmp(argv[i], "-q") == 0 || strcmp(argv[i], "--quiet") == 0)
2008-12-18 22:28:57 +01:00
_settings._errorsOnly = true;
// Checking coding style
else if (strcmp(argv[i], "-s") == 0 || strcmp(argv[i], "--style") == 0)
2008-12-18 22:28:57 +01:00
_settings._checkCodingStyle = true;
// Verbose error messages (configuration info)
else if (strcmp(argv[i], "-v") == 0 || strcmp(argv[i], "--verbose") == 0)
2008-12-18 22:28:57 +01:00
_settings._verbose = true;
// Force checking of files that have "too many" configurations
else if (strcmp(argv[i], "-f") == 0 || strcmp(argv[i], "--force") == 0)
_settings._force = true;
2008-12-18 22:28:57 +01:00
else
pathnames.push_back(argv[i]);
2008-12-18 22:28:57 +01:00
}
if (pathnames.size() > 0)
2008-12-18 22:28:57 +01:00
{
// Execute RecursiveAddFiles() to each given file parameter
2008-12-18 22:28:57 +01:00
std::vector<std::string>::const_iterator iter;
for (iter = pathnames.begin(); iter != pathnames.end(); iter++)
FileLister::RecursiveAddFiles(_filenames, iter->c_str(), true);
2008-12-18 22:28:57 +01:00
}
if (_filenames.empty())
{
std::ostringstream oss;
2008-12-30 19:45:17 +01:00
oss << "cppcheck 1.27\n"
"\n"
"C/C++ code checking\n"
"\n"
"Syntax:\n"
" cppcheck [--all] [--force] [--quiet] [--style] [--verbose] [file or path1] [file or path]\n"
"\n"
"If path is given instead of filename, *.cpp, *.cxx, *.cc and *.c files are \n"
"checked recursively from given directory.\n\n"
"Options:\n"
" -a, --all Make the checking more sensitive. More bugs are detected,\n"
" but there are also more false positives\n"
" -f, --force Force checking on files that have \"too many\" configurations\n"
" -q, --quiet Only print error messages\n"
" -s, --style Check coding style\n"
" -v, --verbose More detailed error reports\n"
"\n"
"Example usage:\n"
" # Recursively check the current folder. Print the progress on the screen and write errors in a file:\n"
" cppcheck . 2> err.txt\n"
" # Recursively check ../myproject/ and print only most fatal errors:\n"
" cppcheck --quiet ../myproject/\n"
" # Check only files one.cpp and two.cpp and give all information there is:\n"
" cppcheck -v -a -s one.cpp two.cpp\n";
2008-12-18 22:28:57 +01:00
return oss.str();
}
return "";
}
unsigned int CppCheck::check()
2008-12-18 22:28:57 +01:00
{
_checkFunctionUsage.setErrorLogger(this);
std::sort(_filenames.begin(), _filenames.end());
2008-12-18 22:28:57 +01:00
for (unsigned int c = 0; c < _filenames.size(); c++)
{
_errout.str("");
std::string fname = _filenames[c];
Preprocessor preprocessor;
std::list<std::string> configurations;
std::string filedata = "";
if (_fileContents.size() > 0 && _fileContents.find(_filenames[c]) != _fileContents.end())
2008-12-18 22:28:57 +01:00
{
// File content was given as a string
std::istringstream iss(_fileContents[ _filenames[c] ]);
preprocessor.preprocess(iss, filedata, configurations);
2008-12-18 22:28:57 +01:00
}
else
{
// Only file name was given, read the content from file
std::ifstream fin(fname.c_str());
preprocessor.preprocess(fin, filedata, configurations);
2008-12-18 22:28:57 +01:00
}
int checkCount = 0;
for (std::list<std::string>::const_iterator it = configurations.begin(); it != configurations.end(); ++it)
2008-12-18 22:28:57 +01:00
{
// Check only 12 first configurations, after that bail out, unless --force
// was used.
if (!_settings._force && checkCount > 11)
{
if (_settings._errorsOnly == false)
_errorLogger->reportOut(std::string("Bailing out from checking ") + fname + ": Too many configurations. Recheck this file with --force if you want to check them all.");
break;
}
cfg = *it;
std::string codeWithoutCfg = Preprocessor::getcode(filedata, *it);
// If only errors are printed, print filename after the check
if (_settings._errorsOnly == false)
_errorLogger->reportOut(std::string("Checking ") + fname + ": " + cfg + std::string("..."));
checkFile(codeWithoutCfg, _filenames[c].c_str());
2009-01-01 23:22:28 +01:00
++checkCount;
2008-12-18 22:28:57 +01:00
}
if (_settings._errorsOnly == false && _errout.str().empty())
_errorLogger->reportOut("No errors found");
2008-12-18 22:28:57 +01:00
}
// This generates false positives - especially for libraries
_settings._verbose = false;
2009-01-11 07:44:32 +01:00
if (ErrorMessage::unusedFunction(_settings))
2008-12-18 22:28:57 +01:00
{
_errout.str("");
if (_settings._errorsOnly == false)
_errorLogger->reportOut("Checking usage of global functions (this may take several minutes)..");
2008-12-18 22:28:57 +01:00
_checkFunctionUsage.check();
}
unsigned int result = _errorList.size();
2008-12-18 22:28:57 +01:00
_errorList.clear();
return result;
2008-12-18 22:28:57 +01:00
}
//---------------------------------------------------------------------------
// CppCheck - A function that checks a specified file
//---------------------------------------------------------------------------
void CppCheck::checkFile(const std::string &code, const char FileName[])
{
Tokenizer _tokenizer;
// Tokenize the file
{
std::istringstream istr(code);
_tokenizer.tokenize(istr, FileName);
2008-12-18 22:28:57 +01:00
}
// Set variable id
_tokenizer.setVarId();
_tokenizer.fillFunctionList();
// Check that the memsets are valid.
// The 'memset' function can do dangerous things if used wrong.
// Important: The checking doesn't work on simplified tokens list.
CheckClass checkClass(&_tokenizer, _settings, this);
if (ErrorMessage::memsetClass(_settings))
checkClass.noMemset();
2008-12-18 22:28:57 +01:00
// Coding style checks that must be run before the simplifyTokenList
2009-01-12 18:12:14 +01:00
CheckOther checkOther(&_tokenizer, _settings, this);
// Check for unsigned divisions where one operand is signed
if (ErrorMessage::udivWarning(_settings) || ErrorMessage::udivError(_settings))
2008-12-18 22:28:57 +01:00
checkOther.CheckUnsignedDivision();
// Give warning when using char variable as array index
if (ErrorMessage::charArrayIndex(_settings) || ErrorMessage::charBitOp(_settings))
2008-12-18 22:28:57 +01:00
checkOther.CheckCharVariable();
// Usage of local variables
if (ErrorMessage::unusedVariable(_settings))
checkOther.functionVariableUsage();
2008-12-18 22:28:57 +01:00
_tokenizer.simplifyTokenList();
2009-01-11 07:44:32 +01:00
if (ErrorMessage::unusedFunction(_settings))
2008-12-18 22:28:57 +01:00
_checkFunctionUsage.parseTokens(_tokenizer);
// Class for detecting buffer overruns and related problems
CheckBufferOverrunClass checkBufferOverrun(&_tokenizer, _settings, this);
2008-12-18 22:28:57 +01:00
// Memory leak
CheckMemoryLeakClass checkMemoryLeak(&_tokenizer, _settings, this);
if (ErrorMessage::memleak(_settings) && ErrorMessage::mismatchAllocDealloc(_settings))
checkMemoryLeak.CheckMemoryLeak();
2008-12-18 22:28:57 +01:00
// Check that all class constructors are ok.
2009-01-10 20:24:23 +01:00
if (ErrorMessage::noConstructor(_settings) && ErrorMessage::uninitVar(_settings))
checkClass.constructors();
2008-12-18 22:28:57 +01:00
// Check that all base classes have virtual destructors
if (ErrorMessage::virtualDestructor(_settings))
checkClass.virtualDestructor();
2008-12-18 22:28:57 +01:00
// Array index out of bounds / Buffer overruns..
if (ErrorMessage::arrayIndexOutOfBounds(_settings) && ErrorMessage::bufferOverrun(_settings))
checkBufferOverrun.bufferOverrun();
// Check for "if (a=b)"
if (ErrorMessage::ifAssignment(_settings))
2008-12-18 22:28:57 +01:00
checkOther.CheckIfAssignment();
// Dangerous functions, such as 'gets' and 'scanf'
checkBufferOverrun.dangerousFunctions();
2008-12-18 22:28:57 +01:00
// Warning upon c-style pointer casts
if (ErrorMessage::cstyleCast(_settings))
2008-12-18 22:28:57 +01:00
{
const char *ext = strrchr(FileName, '.');
if (ext && strcmp(ext, ".cpp") == 0)
2008-12-18 22:28:57 +01:00
checkOther.WarningOldStylePointerCast();
}
2008-12-18 22:28:57 +01:00
// if (a) delete a;
if (ErrorMessage::redundantIfDelete0(_settings))
2008-12-18 22:28:57 +01:00
checkOther.WarningRedundantCode();
// strtol and strtoul usage
if (ErrorMessage::dangerousUsageStrtol(_settings) ||
ErrorMessage::sprintfOverlappingData(_settings))
checkOther.InvalidFunctionUsage();
// Check that all private functions are called.
if (ErrorMessage::unusedPrivateFunction(_settings))
checkClass.privateFunctions();
// 'operator=' should return something..
if (ErrorMessage::operatorEq(_settings))
checkClass.operatorEq();
// if (condition);
if (ErrorMessage::ifNoAction(_settings) || ErrorMessage::conditionAlwaysTrueFalse(_settings))
2008-12-18 22:28:57 +01:00
checkOther.WarningIf();
2009-01-12 18:21:25 +01:00
// Unused struct members..
if (ErrorMessage::unusedStructMember(_settings))
checkOther.CheckStructMemberUsage();
// Unreachable code below a 'return' statement
if (ErrorMessage::unreachableCode(_settings))
checkOther.unreachableCode();
// Check if a constant function parameter is passed by value
if (ErrorMessage::passedByValue(_settings))
checkOther.CheckConstantFunctionParameter();
2009-01-13 07:25:36 +01:00
// Variable scope (check if the scope could be limited)
if (ErrorMessage::variableScope(_settings))
checkOther.CheckVariableScope();
2008-12-18 22:28:57 +01:00
// Check for various types of incomplete statements that could for example
// mean that an ';' has been added by accident
if (ErrorMessage::constStatement(_settings))
2008-12-18 22:28:57 +01:00
checkOther.CheckIncompleteStatement();
// Unusual pointer arithmetic
if (ErrorMessage::strPlusChar(_settings))
checkOther.strPlusChar();
2008-12-18 22:28:57 +01:00
}
//---------------------------------------------------------------------------
void CppCheck::reportErr(const std::string &errmsg)
2008-12-18 22:28:57 +01:00
{
if (/*OnlyReportUniqueErrors*/ true)
2008-12-18 22:28:57 +01:00
{
if (std::find(_errorList.begin(), _errorList.end(), errmsg) != _errorList.end())
2008-12-18 22:28:57 +01:00
return;
_errorList.push_back(errmsg);
2008-12-18 22:28:57 +01:00
}
std::string errmsg2(errmsg);
if (_settings._verbose)
2008-12-18 22:28:57 +01:00
{
errmsg2 += "\n Defines=\'" + cfg + "\'\n";
}
_errorLogger->reportErr(errmsg2);
2008-12-18 22:28:57 +01:00
_errout << errmsg2 << std::endl;
}
void CppCheck::reportOut(const std::string &outmsg)
2008-12-18 22:28:57 +01:00
{
// This is currently never called. It is here just to comply with
// the interface.
}