/* * Cppcheck - A tool for static C/C++ code analysis * Copyright (C) 2007-2011 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 <http://www.gnu.org/licenses/>. */ #ifndef CPPCHECK_H #define CPPCHECK_H #include "settings.h" #include "errorlogger.h" #include "checkunusedfunctions.h" #include <string> #include <list> #include <sstream> #include <vector> /// @addtogroup Core /// @{ /** * @brief This is the base class which will use other classes to do * static code analysis for C and C++ code to find possible * errors or places that could be improved. * Usage: See check() for more info. */ class CppCheck : public ErrorLogger { public: /** * @brief Constructor. */ CppCheck(ErrorLogger &errorLogger, bool useGlobalSuppressions); /** * @brief Destructor. */ virtual ~CppCheck(); /** * @brief This starts the actual checking. Note that you must call * parseFromArgs() or settings() and addFile() before calling this. * @return amount of errors found or 0 if none were found. */ /** * @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); /** * @brief Adjust the settings before doing the check. E.g. show only * actual bugs or also coding style issues. * * @param settings New settings which will overwrite the old. */ void settings(const Settings &settings); /** * @brief Get reference to current settings. * @return a reference to current settings */ Settings &settings(); /** * @brief Returns current version number as a string. * @return version, e.g. "1.38" */ static const char * version(); virtual void reportStatus(unsigned int fileindex, unsigned int filecount, long sizedone, long sizetotal); /** * @brief Terminate checking. The checking will be terminated as soon as possible. */ void terminate() { _settings.terminate(); } /** * @brief Call all "getErrorMessages" in all registered Check classes. * Also print out XML header and footer. */ void getErrorMessages(); /** * @brief Analyse file - It's public so unit tests can be written */ void analyseFile(std::istream &f, const std::string &filename); private: /** @brief Process one file. */ unsigned int processFile(); /** @brief Check file */ void checkFile(const std::string &code, const char FileName[]); /** * @brief Errors and warnings are directed here. * * @param msg Errors messages are normally in format * "[filepath:line number] Message", e.g. * "[main.cpp:4] Uninitialized member variable" */ virtual void reportErr(const ErrorLogger::ErrorMessage &msg); /** * @brief Information about progress is directed here. * * @param outmsg Message to show, e.g. "Checking main.cpp..." */ virtual void reportOut(const std::string &outmsg); unsigned int exitcode; std::list<std::string> _errorList; std::ostringstream _errout; Settings _settings; bool _useGlobalSuppressions; std::string _filename; std::string _fileContent; void reportProgress(const std::string &filename, const char stage[], const unsigned int value); CheckUnusedFunctions _checkUnusedFunctions; ErrorLogger &_errorLogger; /** @brief Current preprocessor configuration */ std::string cfg; }; /// @} #endif // CPPCHECK_H