cppcheck/src/cppcheck.cpp

542 lines
18 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, Reijo Tomperi, Nicolas Le Cam,
2009-03-01 20:52:33 +01:00
* Leandro Penz, Kimmo Varis, Vesa Pikki
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 "checkdangerousfunctions.h"
2008-12-18 22:28:57 +01:00
#include "checkclass.h"
#include "checkheaders.h"
#include "checkother.h"
#include "checkfunctionusage.h"
2009-02-10 20:40:21 +01:00
#include "checkstl.h"
2008-12-18 22:28:57 +01:00
#include "filelister.h"
#include <algorithm>
#include <iostream>
2008-12-18 22:28:57 +01:00
#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
{
FileLister::RecursiveAddFiles(_filenames, path.c_str(), true);
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;
}
2009-02-27 20:39:50 +01:00
void CppCheck::clearFiles()
{
_filenames.clear();
_fileContents.clear();
}
std::string CppCheck::parseFromArgs(int argc, const char* const argv[])
2008-12-18 22:28:57 +01:00
{
std::vector<std::string> pathnames;
bool showHelp = false;
2008-12-18 22:28:57 +01:00
for (int i = 1; i < argc; i++)
{
if (strcmp(argv[i], "--version") == 0)
2009-03-08 16:15:25 +01:00
return "Cppcheck 1.30\n";
2008-12-18 22:28:57 +01:00
// 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;
// Write results in results.xml
2009-02-01 19:00:47 +01:00
else if (strcmp(argv[i], "--xml") == 0)
_settings._xml = true;
// Check if there are unused functions
else if (strcmp(argv[i], "--unused-functions") == 0)
_settings._unusedFunctions = true;
// Print help
else if (strcmp(argv[i], "-h") == 0 || strcmp(argv[i], "--help") == 0)
{
pathnames.clear();
_filenames.clear();
showHelp = true;
break;
}
// --error-exitcode=1
else if (strncmp(argv[i], "--error-exitcode=", 17) == 0)
{
std::string temp = argv[i];
temp = temp.substr(17);
std::istringstream iss(temp);
if (!(iss >> _settings._exitCode))
{
_settings._exitCode = 0;
return "cppcheck: Argument must be an integer. Try something like '--error-exitcode=1'\n";
}
}
// Include paths
else if (strcmp(argv[i], "-I") == 0 || strncmp(argv[i], "-I", 2) == 0)
{
std::string path;
// "-I path/"
if (strcmp(argv[i], "-I") == 0)
{
++i;
if (i >= argc)
return "cppcheck: argument to '-I' is missing\n";
path = argv[i];
}
// "-Ipath/"
else
{
path = argv[i];
path = path.substr(2);
}
// If path doesn't end with / or \, add it
if (path[path.length()-1] != '/' && path[path.length()-1] != '\\')
path += '/';
_includePaths.push_back(path);
}
// Include paths
else if (strcmp(argv[i], "-j") == 0 ||
strncmp(argv[i], "-j", 2) == 0)
{
std::string numberString;
// "-j 3"
if (strcmp(argv[i], "-j") == 0)
{
++i;
if (i >= argc)
return "cppcheck: argument to '-j' is missing\n";
numberString = argv[i];
}
// "-j3"
else if (strncmp(argv[i], "-j", 2) == 0)
{
numberString = argv[i];
numberString = numberString.substr(2);
}
std::istringstream iss(numberString);
if (!(iss >> _settings._jobs))
return "cppcheck: argument to '-j' is not a number\n";
if (_settings._jobs > 1000)
{
return "cppcheck: argument for '-j' is allowed to be 1000 at max\n";
}
}
// auto deallocated classes..
2009-03-06 18:13:41 +01:00
else if (strcmp(argv[i], "--auto-dealloc") == 0)
{
++i;
2009-03-06 18:13:41 +01:00
if (i >= argc || !strstr(argv[i], ".lst"))
return "No .lst file specified for the --auto-dealloc option\n";
std::ifstream f(argv[i]);
if (!f.is_open())
return "couldn't open the file \"" + std::string(argv[i+1]) + "\"\n";
_settings.autoDealloc(f);
}
else if (strncmp(argv[i], "-", 1) == 0 || strncmp(argv[i], "--", 2) == 0)
{
return "cppcheck: error: unrecognized command line option \"" + std::string(argv[i]) + "\"\n";
}
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 (argc <= 1 || showHelp)
2008-12-18 22:28:57 +01:00
{
std::ostringstream oss;
oss << "Cppcheck - A tool for static C/C++ code analysis\n"
"\n"
"Syntax:\n"
" cppcheck [--all] [--auto-dealloc file.lst] [--error-exitcode=[n]] [--force]\n"
" [--help] [-Idir] [-j [jobs]] [--quiet] [--style] [--unused-functions]\n"
" [--verbose] [--version] [--xml] [file or path1] [file or path] ...\n"
"\n"
2009-01-16 23:42:08 +01:00
"If path is given instead of filename, *.cpp, *.cxx, *.cc, *.c++ and *.c files\n"
"are checked recursively from given directory.\n\n"
"Options:\n"
" -a, --all Make the checking more sensitive. More bugs are\n"
" detected, but there are also more false positives\n"
" --auto-dealloc file Suppress warnings about classes that have automatic\n"
" deallocation.\n"
" The classnames must be provided in plain text - one\n"
" classname / line - in a .lst file.\n"
" This option can be used several times, allowing you to\n"
" specify several .lst files.\n"
" --error-exitcode=[n] If errors are found, integer [n] is returned instead\n"
" of default 0. EXIT_FAILURE is returned\n"
" if arguments are not valid or if no input files are\n"
" provided. Note that your operating system can\n"
" modify this value, e.g. 256 can become 0.\n"
" -f, --force Force checking on files that have \"too many\"\n"
" configurations\n"
" -h, --help Print this help\n"
" -I [dir] Give include path. Give several -I parameters to give\n"
" several paths. First given path is checked first. If\n"
" paths are relative to source files, this is not needed\n"
" -j [jobs] Start [jobs] threads to do the checking simultaneously.\n"
" -q, --quiet Only print error messages\n"
" -s, --style Check coding style\n"
" --unused-functions Check if there are unused functions\n"
" -v, --verbose More detailed error reports\n"
" --version Print out version number\n"
" --xml Write results in xml to error stream.\n"
"\n"
"Example usage:\n"
" # Recursively check the current folder. Print the progress on the screen and\n"
" 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"
" # Check f.cpp and search include files from inc1/ and inc2/:\n"
" cppcheck -I inc1/ -I inc2/ f.cpp\n";
2008-12-18 22:28:57 +01:00
return oss.str();
}
else if (_filenames.empty())
{
return "cppcheck: No C or C++ source files found.\n";
}
2008-12-18 22:28:57 +01:00
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];
if (_settings._errorsOnly == false)
_errorLogger->reportOut(std::string("Checking ") + fname + std::string("..."));
2008-12-18 22:28:57 +01:00
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, fname, _includePaths);
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, fname, _includePaths);
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 && it != configurations.begin())
_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
}
_errorLogger->reportStatus(c + 1, _filenames.size());
2008-12-18 22:28:57 +01:00
}
// This generates false positives - especially for libraries
_settings._verbose = false;
if (_settings._unusedFunctions)
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 = static_cast<unsigned int>(_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 (ErrorLogger::memsetClass())
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 (ErrorLogger::udivWarning(_settings) || ErrorLogger::udivError())
2008-12-18 22:28:57 +01:00
checkOther.CheckUnsignedDivision();
// Give warning when using char variable as array index
if (ErrorLogger::charArrayIndex(_settings) || ErrorLogger::charBitOp(_settings))
2008-12-18 22:28:57 +01:00
checkOther.CheckCharVariable();
_tokenizer.simplifyTokenList();
// Write simplified token list to a file..
//std::cout << _tokenizer.tokens()->stringifyList(true) << std::endl;
if (_settings._unusedFunctions)
2008-12-18 22:28:57 +01:00
_checkFunctionUsage.parseTokens(_tokenizer);
// Class for detecting buffer overruns and related problems
CheckBufferOverrunClass checkBufferOverrun(&_tokenizer, _settings, this);
// Class for checking functions that should not be used
CheckDangerousFunctionsClass checkDangerousFunctions(&_tokenizer, _settings, this);
2008-12-18 22:28:57 +01:00
// Memory leak
CheckMemoryLeakClass checkMemoryLeak(&_tokenizer, _settings, this);
if (ErrorLogger::memleak() || ErrorLogger::mismatchAllocDealloc())
checkMemoryLeak.CheckMemoryLeak();
2008-12-18 22:28:57 +01:00
// Check that all class constructors are ok.
if (ErrorLogger::noConstructor(_settings) || ErrorLogger::uninitVar(_settings))
checkClass.constructors();
2008-12-18 22:28:57 +01:00
// Check that all base classes have virtual destructors
if (ErrorLogger::virtualDestructor())
checkClass.virtualDestructor();
2008-12-18 22:28:57 +01:00
// Array index out of bounds / Buffer overruns..
if (ErrorLogger::arrayIndexOutOfBounds(_settings) || ErrorLogger::bufferOverrun(_settings))
checkBufferOverrun.bufferOverrun();
// Warning upon c-style pointer casts
if (ErrorLogger::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 (ErrorLogger::redundantIfDelete0(_settings))
2008-12-18 22:28:57 +01:00
checkOther.WarningRedundantCode();
// strtol and strtoul usage
if (ErrorLogger::dangerousUsageStrtol() ||
ErrorLogger::sprintfOverlappingData())
checkOther.InvalidFunctionUsage();
// Check that all private functions are called.
if (ErrorLogger::unusedPrivateFunction(_settings))
checkClass.privateFunctions();
// 'operator=' should return something..
if (ErrorLogger::operatorEq(_settings))
checkClass.operatorEq();
// if (condition);
if (ErrorLogger::ifNoAction(_settings) || ErrorLogger::conditionAlwaysTrueFalse(_settings))
2008-12-18 22:28:57 +01:00
checkOther.WarningIf();
2009-01-12 18:21:25 +01:00
// Unused struct members..
if (ErrorLogger::unusedStructMember(_settings))
2009-01-12 18:21:25 +01:00
checkOther.CheckStructMemberUsage();
// Check if a constant function parameter is passed by value
if (ErrorLogger::passedByValue(_settings))
checkOther.CheckConstantFunctionParameter();
2009-01-13 07:25:36 +01:00
// Variable scope (check if the scope could be limited)
if (ErrorLogger::variableScope())
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 (ErrorLogger::constStatement(_settings))
2008-12-18 22:28:57 +01:00
checkOther.CheckIncompleteStatement();
// Unusual pointer arithmetic
if (ErrorLogger::strPlusChar())
checkOther.strPlusChar();
2009-02-10 20:40:21 +01:00
CheckStl checkStl(&_tokenizer, this);
if (ErrorLogger::iteratorUsage())
checkStl.iterators();
if (ErrorLogger::stlOutOfBounds())
checkStl.stlOutOfBounds();
2009-02-11 06:08:29 +01:00
if (ErrorLogger::erase())
checkStl.erase();
if (ErrorLogger::pushback())
checkStl.pushback();
2008-12-18 22:28:57 +01:00
}
Settings CppCheck::settings() const
{
return _settings;
}
2008-12-18 22:28:57 +01:00
//---------------------------------------------------------------------------
void CppCheck::reportErr(const ErrorLogger::ErrorMessage &msg)
2008-12-18 22:28:57 +01:00
{
std::string errmsg = msg.toText();
// Alert only about unique errors
if (std::find(_errorList.begin(), _errorList.end(), errmsg) != _errorList.end())
return;
2008-12-18 22:28:57 +01:00
_errorList.push_back(errmsg);
std::string errmsg2(errmsg);
if (_settings._verbose)
2008-12-18 22:28:57 +01:00
{
errmsg2 += "\n Defines=\'" + cfg + "\'\n";
}
_errorLogger->reportErr(msg);
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.
}
const std::vector<std::string> &CppCheck::filenames() const
{
return _filenames;
}
void CppCheck::reportStatus(unsigned int /*index*/, unsigned int /*max*/)
{
}