2008-12-18 22:28:57 +01:00
|
|
|
/*
|
2009-01-21 21:04:20 +01:00
|
|
|
* Cppcheck - A tool for static C/C++ code analysis
|
2012-01-01 00:05:37 +01:00
|
|
|
* Copyright (C) 2007-2012 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
|
2009-09-27 17:08:31 +02:00
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
2008-12-18 22:28:57 +01:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef CPPCHECK_H
|
|
|
|
#define CPPCHECK_H
|
|
|
|
|
2012-06-10 14:19:09 +02:00
|
|
|
#include "config.h"
|
2010-08-03 16:36:21 +02:00
|
|
|
#include "settings.h"
|
|
|
|
#include "errorlogger.h"
|
|
|
|
#include "checkunusedfunctions.h"
|
|
|
|
|
2008-12-18 22:28:57 +01:00
|
|
|
#include <string>
|
|
|
|
#include <list>
|
2012-04-08 14:18:13 +02:00
|
|
|
#include <istream>
|
2008-12-18 22:28:57 +01:00
|
|
|
|
2009-07-17 10:49:01 +02:00
|
|
|
/// @addtogroup Core
|
|
|
|
/// @{
|
|
|
|
|
2008-12-18 22:28:57 +01:00
|
|
|
/**
|
2010-03-14 18:55:33 +01:00
|
|
|
* @brief This is the base class which will use other classes to do
|
2008-12-18 22:28:57 +01:00
|
|
|
* static code analysis for C and C++ code to find possible
|
|
|
|
* errors or places that could be improved.
|
|
|
|
* Usage: See check() for more info.
|
|
|
|
*/
|
2012-06-10 14:19:09 +02:00
|
|
|
class CPPCHECKLIB CppCheck : ErrorLogger {
|
2009-01-05 16:49:57 +01:00
|
|
|
public:
|
|
|
|
/**
|
2010-03-14 18:55:33 +01:00
|
|
|
* @brief Constructor.
|
2009-01-05 16:49:57 +01:00
|
|
|
*/
|
2011-02-16 02:12:15 +01:00
|
|
|
CppCheck(ErrorLogger &errorLogger, bool useGlobalSuppressions);
|
2008-12-18 22:28:57 +01:00
|
|
|
|
2009-01-05 16:49:57 +01:00
|
|
|
/**
|
2010-03-14 18:55:33 +01:00
|
|
|
* @brief Destructor.
|
2009-01-05 16:49:57 +01:00
|
|
|
*/
|
|
|
|
virtual ~CppCheck();
|
2008-12-18 22:28:57 +01:00
|
|
|
|
2009-01-05 16:49:57 +01:00
|
|
|
/**
|
2010-03-14 18:55:33 +01:00
|
|
|
* @brief This starts the actual checking. Note that you must call
|
2009-01-05 16:49:57 +01:00
|
|
|
* parseFromArgs() or settings() and addFile() before calling this.
|
2009-01-08 22:30:25 +01:00
|
|
|
* @return amount of errors found or 0 if none were found.
|
2009-01-05 16:49:57 +01:00
|
|
|
*/
|
2011-04-24 18:10:25 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Check the file.
|
|
|
|
* This function checks one given file for errors.
|
|
|
|
* @param path Path to the file to check.
|
|
|
|
* @return amount of errors found or 0 if none were found.
|
|
|
|
* @note You must set settings before calling this function (by calling
|
|
|
|
* settings()).
|
|
|
|
*/
|
|
|
|
unsigned int check(const std::string &path);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Check the file.
|
|
|
|
* This function checks one "virtual" file. The file is not read from
|
|
|
|
* the disk but the content is given in @p content. In errors the @p path
|
|
|
|
* is used as a filename.
|
|
|
|
* @param path Path to the file to check.
|
|
|
|
* @param content File content as a string.
|
|
|
|
* @return amount of errors found or 0 if none were found.
|
|
|
|
* @note You must set settings before calling this function (by calling
|
|
|
|
* settings()).
|
|
|
|
*/
|
|
|
|
unsigned int check(const std::string &path, const std::string &content);
|
2008-12-18 22:28:57 +01:00
|
|
|
|
2011-07-25 13:25:09 +02:00
|
|
|
/**
|
|
|
|
* @brief Check function usage.
|
|
|
|
* @note Call this after all files has been checked
|
|
|
|
*/
|
|
|
|
void checkFunctionUsage();
|
|
|
|
|
2009-02-09 21:51:04 +01:00
|
|
|
/**
|
2011-02-16 02:12:15 +01:00
|
|
|
* @brief Get reference to current settings.
|
|
|
|
* @return a reference to current settings
|
2009-02-09 21:51:04 +01:00
|
|
|
*/
|
2011-02-16 02:12:15 +01:00
|
|
|
Settings &settings();
|
2009-02-09 21:51:04 +01:00
|
|
|
|
2009-10-25 21:06:58 +01:00
|
|
|
/**
|
2010-03-14 18:55:33 +01:00
|
|
|
* @brief Returns current version number as a string.
|
2009-10-25 21:06:58 +01:00
|
|
|
* @return version, e.g. "1.38"
|
|
|
|
*/
|
|
|
|
static const char * version();
|
2009-10-17 11:34:17 +02:00
|
|
|
|
2011-08-11 16:34:59 +02:00
|
|
|
/**
|
|
|
|
* @brief Returns extra version info as a string.
|
|
|
|
* This is for returning extra version info, like Git commit id, build
|
|
|
|
* time/date etc.
|
|
|
|
* @return extra version info, e.g. "04d42151" (Git commit id).
|
|
|
|
*/
|
|
|
|
static const char * extraVersion();
|
|
|
|
|
2012-02-19 17:22:59 +01:00
|
|
|
virtual void reportStatus(unsigned int fileindex, unsigned int filecount, size_t sizedone, size_t sizetotal);
|
2009-02-19 23:21:18 +01:00
|
|
|
|
2010-01-18 20:23:50 +01:00
|
|
|
/**
|
2010-03-14 18:55:33 +01:00
|
|
|
* @brief Terminate checking. The checking will be terminated as soon as possible.
|
2010-01-18 20:23:50 +01:00
|
|
|
*/
|
2011-10-13 20:53:06 +02:00
|
|
|
void terminate() {
|
2010-01-18 20:23:50 +01:00
|
|
|
_settings.terminate();
|
|
|
|
}
|
|
|
|
|
2010-04-03 21:53:06 +02:00
|
|
|
/**
|
|
|
|
* @brief Call all "getErrorMessages" in all registered Check classes.
|
2010-12-15 18:45:53 +01:00
|
|
|
* Also print out XML header and footer.
|
2010-04-03 21:53:06 +02:00
|
|
|
*/
|
|
|
|
void getErrorMessages();
|
|
|
|
|
2010-05-21 21:06:11 +02:00
|
|
|
/**
|
|
|
|
* @brief Analyse file - It's public so unit tests can be written
|
|
|
|
*/
|
|
|
|
void analyseFile(std::istream &f, const std::string &filename);
|
|
|
|
|
2012-02-15 08:08:28 +01:00
|
|
|
/**
|
|
|
|
* @brief Get dependencies. Use this after calling 'check'.
|
|
|
|
*/
|
2012-02-18 23:43:51 +01:00
|
|
|
const std::set<std::string>& dependencies() const {
|
2012-02-15 08:08:28 +01:00
|
|
|
return _dependencies;
|
|
|
|
}
|
|
|
|
|
2009-01-05 16:49:57 +01:00
|
|
|
private:
|
2011-04-24 18:10:25 +02:00
|
|
|
|
|
|
|
/** @brief Process one file. */
|
2012-02-24 20:45:56 +01:00
|
|
|
unsigned int processFile(const std::string& filename);
|
2011-04-24 18:10:25 +02:00
|
|
|
|
2010-05-21 21:06:11 +02:00
|
|
|
/** @brief Check file */
|
2009-01-05 16:49:57 +01:00
|
|
|
void checkFile(const std::string &code, const char FileName[]);
|
2008-12-18 22:28:57 +01:00
|
|
|
|
2009-01-05 16:49:57 +01:00
|
|
|
/**
|
2010-03-14 18:55:33 +01:00
|
|
|
* @brief Errors and warnings are directed here.
|
2009-01-05 16:49:57 +01:00
|
|
|
*
|
2009-06-20 11:54:49 +02:00
|
|
|
* @param msg Errors messages are normally in format
|
2009-01-05 16:49:57 +01:00
|
|
|
* "[filepath:line number] Message", e.g.
|
|
|
|
* "[main.cpp:4] Uninitialized member variable"
|
|
|
|
*/
|
2009-02-10 22:51:52 +01:00
|
|
|
virtual void reportErr(const ErrorLogger::ErrorMessage &msg);
|
2008-12-18 22:28:57 +01:00
|
|
|
|
2009-01-05 16:49:57 +01:00
|
|
|
/**
|
2010-03-14 18:55:33 +01:00
|
|
|
* @brief Information about progress is directed here.
|
2009-01-05 16:49:57 +01:00
|
|
|
*
|
2009-06-20 11:54:49 +02:00
|
|
|
* @param outmsg Message to show, e.g. "Checking main.cpp..."
|
2009-01-05 16:49:57 +01:00
|
|
|
*/
|
|
|
|
virtual void reportOut(const std::string &outmsg);
|
2008-12-18 22:28:57 +01:00
|
|
|
|
2011-08-16 21:58:27 +02:00
|
|
|
/**
|
|
|
|
* @brief Check given code. If error is found, return true
|
|
|
|
* and print out source of the file. Try to reduce the code
|
|
|
|
* while still showing the error.
|
|
|
|
*/
|
|
|
|
bool findError(std::string code, const char FileName[]);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Replace "from" strings with "to" strings in "code"
|
|
|
|
* and return it.
|
|
|
|
*/
|
2012-02-24 20:45:56 +01:00
|
|
|
static void replaceAll(std::string& code, const std::string &from, const std::string &to);
|
2011-08-16 21:58:27 +02:00
|
|
|
|
2009-01-05 16:49:57 +01:00
|
|
|
std::list<std::string> _errorList;
|
|
|
|
Settings _settings;
|
2011-04-24 18:10:25 +02:00
|
|
|
std::string _fileContent;
|
2012-02-15 08:08:28 +01:00
|
|
|
std::set<std::string> _dependencies;
|
2010-03-14 18:55:33 +01:00
|
|
|
|
2012-07-06 13:17:08 +02:00
|
|
|
void reportProgress(const std::string &filename, const char stage[], const size_t value);
|
2010-08-08 08:45:37 +02:00
|
|
|
|
2012-06-18 23:15:48 +02:00
|
|
|
/**
|
|
|
|
* Output information messages.
|
|
|
|
*/
|
|
|
|
virtual void reportInfo(const ErrorLogger::ErrorMessage &msg);
|
|
|
|
|
2009-06-07 22:12:20 +02:00
|
|
|
CheckUnusedFunctions _checkUnusedFunctions;
|
2009-10-26 21:31:36 +01:00
|
|
|
ErrorLogger &_errorLogger;
|
2008-12-18 22:28:57 +01:00
|
|
|
|
2010-03-14 18:55:33 +01:00
|
|
|
/** @brief Current preprocessor configuration */
|
2012-02-18 23:43:51 +01:00
|
|
|
std::string cfg;
|
2012-05-14 20:46:23 +02:00
|
|
|
|
|
|
|
unsigned int exitcode;
|
|
|
|
|
|
|
|
bool _useGlobalSuppressions;
|
2008-12-18 22:28:57 +01:00
|
|
|
};
|
|
|
|
|
2009-07-17 10:49:01 +02:00
|
|
|
/// @}
|
|
|
|
|
2008-12-18 22:28:57 +01:00
|
|
|
#endif // CPPCHECK_H
|