moved settings-related code from `CppCheckExecutor` to `CmdLineParser` (#5672)
`CppCheckExecutor` contains some code which is not related to the execution but actually to the creation of the settings. This is causing inconsistencies in the error handling/logging as well as interfering with the testability.
This commit is contained in:
Oliver Stöneberg
GitHub
parent
56c7ac3771
commit
4addad1643
4
Makefile
4
Makefile
|
|
@ -647,10 +647,10 @@ $(libcppdir)/utils.o: lib/utils.cpp lib/config.h lib/utils.h
|
|||
$(libcppdir)/vfvalue.o: lib/vfvalue.cpp lib/config.h lib/errortypes.h lib/mathlib.h lib/templatesimplifier.h lib/token.h lib/utils.h lib/vfvalue.h
|
||||
$(CXX) ${INCLUDE_FOR_LIB} $(CPPFLAGS) $(CXXFLAGS) -c -o $@ $(libcppdir)/vfvalue.cpp
|
||||
|
||||
cli/cmdlineparser.o: cli/cmdlineparser.cpp cli/cmdlinelogger.h cli/cmdlineparser.h cli/cppcheckexecutor.h externals/tinyxml2/tinyxml2.h lib/addoninfo.h lib/check.h lib/color.h lib/config.h lib/errorlogger.h lib/errortypes.h lib/filesettings.h lib/importproject.h lib/library.h lib/mathlib.h lib/path.h lib/platform.h lib/settings.h lib/standards.h lib/suppressions.h lib/timer.h lib/utils.h
|
||||
cli/cmdlineparser.o: cli/cmdlineparser.cpp cli/cmdlinelogger.h cli/cmdlineparser.h cli/cppcheckexecutor.h cli/filelister.h externals/tinyxml2/tinyxml2.h lib/addoninfo.h lib/analyzerinfo.h lib/check.h lib/color.h lib/config.h lib/cppcheck.h lib/errorlogger.h lib/errortypes.h lib/filesettings.h lib/importproject.h lib/library.h lib/mathlib.h lib/path.h lib/pathmatch.h lib/platform.h lib/settings.h lib/standards.h lib/suppressions.h lib/timer.h lib/utils.h
|
||||
$(CXX) ${INCLUDE_FOR_CLI} $(CPPFLAGS) $(CXXFLAGS) -c -o $@ cli/cmdlineparser.cpp
|
||||
|
||||
cli/cppcheckexecutor.o: cli/cppcheckexecutor.cpp cli/cmdlinelogger.h cli/cmdlineparser.h cli/cppcheckexecutor.h cli/cppcheckexecutorseh.h cli/cppcheckexecutorsig.h cli/executor.h cli/filelister.h cli/processexecutor.h cli/singleexecutor.h cli/threadexecutor.h lib/addoninfo.h lib/analyzerinfo.h lib/check.h lib/checkersreport.h lib/checkunusedfunctions.h lib/color.h lib/config.h lib/cppcheck.h lib/errorlogger.h lib/errortypes.h lib/filesettings.h lib/library.h lib/mathlib.h lib/path.h lib/pathmatch.h lib/platform.h lib/settings.h lib/standards.h lib/suppressions.h lib/utils.h
|
||||
cli/cppcheckexecutor.o: cli/cppcheckexecutor.cpp cli/cmdlinelogger.h cli/cmdlineparser.h cli/cppcheckexecutor.h cli/cppcheckexecutorseh.h cli/cppcheckexecutorsig.h cli/executor.h cli/processexecutor.h cli/singleexecutor.h cli/threadexecutor.h lib/addoninfo.h lib/analyzerinfo.h lib/check.h lib/checkersreport.h lib/checkunusedfunctions.h lib/color.h lib/config.h lib/cppcheck.h lib/errorlogger.h lib/errortypes.h lib/filesettings.h lib/library.h lib/mathlib.h lib/platform.h lib/settings.h lib/standards.h lib/suppressions.h lib/utils.h
|
||||
$(CXX) ${INCLUDE_FOR_CLI} $(CPPFLAGS) $(CXXFLAGS) -c -o $@ cli/cppcheckexecutor.cpp
|
||||
|
||||
cli/cppcheckexecutorseh.o: cli/cppcheckexecutorseh.cpp cli/cppcheckexecutor.h cli/cppcheckexecutorseh.h lib/config.h lib/filesettings.h lib/platform.h lib/standards.h lib/utils.h
|
||||
|
|
|
|||
|
|
@ -18,14 +18,20 @@
|
|||
|
||||
#include "cmdlineparser.h"
|
||||
|
||||
#include "addoninfo.h"
|
||||
#include "check.h"
|
||||
#include "color.h"
|
||||
#include "config.h"
|
||||
#include "cppcheck.h"
|
||||
#include "cppcheckexecutor.h"
|
||||
#include "errorlogger.h"
|
||||
#include "errortypes.h"
|
||||
#include "filelister.h"
|
||||
#include "filesettings.h"
|
||||
#include "importproject.h"
|
||||
#include "library.h"
|
||||
#include "path.h"
|
||||
#include "pathmatch.h"
|
||||
#include "platform.h"
|
||||
#include "settings.h"
|
||||
#include "standards.h"
|
||||
|
|
@ -34,6 +40,7 @@
|
|||
#include "utils.h"
|
||||
|
||||
#include <algorithm>
|
||||
#include <cassert>
|
||||
#include <climits>
|
||||
#include <cstdio>
|
||||
#include <cstdlib> // EXIT_FAILURE
|
||||
|
|
@ -109,6 +116,24 @@ static bool addPathsToSet(const std::string& fileName, std::set<std::string>& se
|
|||
return true;
|
||||
}
|
||||
|
||||
namespace {
|
||||
class XMLErrorMessagesLogger : public ErrorLogger
|
||||
{
|
||||
void reportOut(const std::string & outmsg, Color /*c*/ = Color::Reset) override
|
||||
{
|
||||
std::cout << outmsg << std::endl;
|
||||
}
|
||||
|
||||
void reportErr(const ErrorMessage &msg) override
|
||||
{
|
||||
reportOut(msg.toXML());
|
||||
}
|
||||
|
||||
void reportProgress(const std::string & /*filename*/, const char /*stage*/[], const std::size_t /*value*/) override
|
||||
{}
|
||||
};
|
||||
}
|
||||
|
||||
CmdLineParser::CmdLineParser(CmdLineLogger &logger, Settings &settings, Suppressions &suppressions, Suppressions &suppressionsNoFail)
|
||||
: mLogger(logger)
|
||||
, mSettings(settings)
|
||||
|
|
@ -116,6 +141,161 @@ CmdLineParser::CmdLineParser(CmdLineLogger &logger, Settings &settings, Suppress
|
|||
, mSuppressionsNoFail(suppressionsNoFail)
|
||||
{}
|
||||
|
||||
bool CmdLineParser::fillSettingsFromArgs(int argc, const char* const argv[])
|
||||
{
|
||||
const bool success = parseFromArgs(argc, argv);
|
||||
|
||||
if (success) {
|
||||
if (getShowVersion() && !getShowErrorMessages()) {
|
||||
if (!mSettings.cppcheckCfgProductName.empty()) {
|
||||
mLogger.printRaw(mSettings.cppcheckCfgProductName);
|
||||
} else {
|
||||
const char * const extraVersion = CppCheck::extraVersion();
|
||||
if (*extraVersion != 0)
|
||||
mLogger.printRaw(std::string("Cppcheck ") + CppCheck::version() + " ("+ extraVersion + ')');
|
||||
else
|
||||
mLogger.printRaw(std::string("Cppcheck ") + CppCheck::version());
|
||||
}
|
||||
}
|
||||
|
||||
if (getShowErrorMessages()) {
|
||||
XMLErrorMessagesLogger xmlLogger;
|
||||
std::cout << ErrorMessage::getXMLHeader(mSettings.cppcheckCfgProductName);
|
||||
CppCheck::getErrorMessages(xmlLogger);
|
||||
std::cout << ErrorMessage::getXMLFooter() << std::endl;
|
||||
}
|
||||
|
||||
if (exitAfterPrinting()) {
|
||||
Settings::terminate();
|
||||
return true;
|
||||
}
|
||||
} else {
|
||||
return false;
|
||||
}
|
||||
|
||||
// Libraries must be loaded before FileLister is executed to ensure markup files will be
|
||||
// listed properly.
|
||||
if (!loadLibraries(mSettings))
|
||||
return false;
|
||||
|
||||
if (!loadAddons(mSettings))
|
||||
return false;
|
||||
|
||||
// Check that all include paths exist
|
||||
{
|
||||
for (std::list<std::string>::iterator iter = mSettings.includePaths.begin();
|
||||
iter != mSettings.includePaths.end();
|
||||
) {
|
||||
const std::string path(Path::toNativeSeparators(*iter));
|
||||
if (Path::isDirectory(path))
|
||||
++iter;
|
||||
else {
|
||||
// TODO: this bypasses the template format and other settings
|
||||
// If the include path is not found, warn user and remove the non-existing path from the list.
|
||||
if (mSettings.severity.isEnabled(Severity::information))
|
||||
std::cout << "(information) Couldn't find path given by -I '" << path << '\'' << std::endl;
|
||||
iter = mSettings.includePaths.erase(iter);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Output a warning for the user if he tries to exclude headers
|
||||
const std::vector<std::string>& ignored = getIgnoredPaths();
|
||||
const bool warn = std::any_of(ignored.cbegin(), ignored.cend(), [](const std::string& i) {
|
||||
return Path::isHeader(i);
|
||||
});
|
||||
if (warn) {
|
||||
mLogger.printMessage("filename exclusion does not apply to header (.h and .hpp) files.");
|
||||
mLogger.printMessage("Please use --suppress for ignoring results from the header files.");
|
||||
}
|
||||
|
||||
const std::vector<std::string>& pathnamesRef = getPathNames();
|
||||
const std::list<FileSettings>& fileSettingsRef = getFileSettings();
|
||||
|
||||
// the inputs can only be used exclusively - CmdLineParser should already handle this
|
||||
assert(!(!pathnamesRef.empty() && !fileSettingsRef.empty()));
|
||||
|
||||
if (!fileSettingsRef.empty()) {
|
||||
std::list<FileSettings> fileSettings;
|
||||
if (!mSettings.fileFilters.empty()) {
|
||||
// filter only for the selected filenames from all project files
|
||||
std::copy_if(fileSettingsRef.cbegin(), fileSettingsRef.cend(), std::back_inserter(fileSettings), [&](const FileSettings &fs) {
|
||||
return matchglobs(mSettings.fileFilters, fs.filename);
|
||||
});
|
||||
if (fileSettings.empty()) {
|
||||
mLogger.printError("could not find any files matching the filter.");
|
||||
return false;
|
||||
}
|
||||
}
|
||||
else {
|
||||
fileSettings = fileSettingsRef;
|
||||
}
|
||||
|
||||
mFileSettings.clear();
|
||||
|
||||
// sort the markup last
|
||||
std::copy_if(fileSettings.cbegin(), fileSettings.cend(), std::back_inserter(mFileSettings), [&](const FileSettings &fs) {
|
||||
return !mSettings.library.markupFile(fs.filename) || !mSettings.library.processMarkupAfterCode(fs.filename);
|
||||
});
|
||||
|
||||
std::copy_if(fileSettings.cbegin(), fileSettings.cend(), std::back_inserter(mFileSettings), [&](const FileSettings &fs) {
|
||||
return mSettings.library.markupFile(fs.filename) && mSettings.library.processMarkupAfterCode(fs.filename);
|
||||
});
|
||||
}
|
||||
|
||||
if (!pathnamesRef.empty()) {
|
||||
std::list<std::pair<std::string, std::size_t>> filesResolved;
|
||||
// TODO: this needs to be inlined into PathMatch as it depends on the underlying filesystem
|
||||
#if defined(_WIN32)
|
||||
// For Windows we want case-insensitive path matching
|
||||
const bool caseSensitive = false;
|
||||
#else
|
||||
const bool caseSensitive = true;
|
||||
#endif
|
||||
// Execute recursiveAddFiles() to each given file parameter
|
||||
const PathMatch matcher(ignored, caseSensitive);
|
||||
for (const std::string &pathname : pathnamesRef) {
|
||||
const std::string err = FileLister::recursiveAddFiles(filesResolved, Path::toNativeSeparators(pathname), mSettings.library.markupExtensions(), matcher);
|
||||
if (!err.empty()) {
|
||||
// TODO: bail out?
|
||||
mLogger.printMessage(err);
|
||||
}
|
||||
}
|
||||
|
||||
std::list<std::pair<std::string, std::size_t>> files;
|
||||
if (!mSettings.fileFilters.empty()) {
|
||||
std::copy_if(filesResolved.cbegin(), filesResolved.cend(), std::inserter(files, files.end()), [&](const decltype(filesResolved)::value_type& entry) {
|
||||
return matchglobs(mSettings.fileFilters, entry.first);
|
||||
});
|
||||
if (files.empty()) {
|
||||
mLogger.printError("could not find any files matching the filter.");
|
||||
return false;
|
||||
}
|
||||
}
|
||||
else {
|
||||
files = std::move(filesResolved);
|
||||
}
|
||||
|
||||
// sort the markup last
|
||||
std::copy_if(files.cbegin(), files.cend(), std::inserter(mFiles, mFiles.end()), [&](const decltype(files)::value_type& entry) {
|
||||
return !mSettings.library.markupFile(entry.first) || !mSettings.library.processMarkupAfterCode(entry.first);
|
||||
});
|
||||
|
||||
std::copy_if(files.cbegin(), files.cend(), std::inserter(mFiles, mFiles.end()), [&](const decltype(files)::value_type& entry) {
|
||||
return mSettings.library.markupFile(entry.first) && mSettings.library.processMarkupAfterCode(entry.first);
|
||||
});
|
||||
}
|
||||
|
||||
if (mFiles.empty() && mFileSettings.empty()) {
|
||||
mLogger.printError("could not find or open any of the paths given.");
|
||||
if (!ignored.empty())
|
||||
mLogger.printMessage("Maybe all paths were ignored?");
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
// TODO: normalize/simplify/native all path parameters
|
||||
// TODO: error out on all missing given files/paths
|
||||
bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
|
||||
|
|
@ -1444,3 +1624,90 @@ bool CmdLineParser::isCppcheckPremium() const {
|
|||
mSettings.loadCppcheckCfg();
|
||||
return startsWith(mSettings.cppcheckCfgProductName, "Cppcheck Premium");
|
||||
}
|
||||
|
||||
bool CmdLineParser::tryLoadLibrary(Library& destination, const std::string& basepath, const char* filename)
|
||||
{
|
||||
const Library::Error err = destination.load(basepath.c_str(), filename);
|
||||
|
||||
if (err.errorcode == Library::ErrorCode::UNKNOWN_ELEMENT)
|
||||
std::cout << "cppcheck: Found unknown elements in configuration file '" << filename << "': " << err.reason << std::endl;
|
||||
else if (err.errorcode != Library::ErrorCode::OK) {
|
||||
std::cout << "cppcheck: Failed to load library configuration file '" << filename << "'. ";
|
||||
switch (err.errorcode) {
|
||||
case Library::ErrorCode::OK:
|
||||
break;
|
||||
case Library::ErrorCode::FILE_NOT_FOUND:
|
||||
std::cout << "File not found";
|
||||
break;
|
||||
case Library::ErrorCode::BAD_XML:
|
||||
std::cout << "Bad XML";
|
||||
break;
|
||||
case Library::ErrorCode::UNKNOWN_ELEMENT:
|
||||
std::cout << "Unexpected element";
|
||||
break;
|
||||
case Library::ErrorCode::MISSING_ATTRIBUTE:
|
||||
std::cout << "Missing attribute";
|
||||
break;
|
||||
case Library::ErrorCode::BAD_ATTRIBUTE_VALUE:
|
||||
std::cout << "Bad attribute value";
|
||||
break;
|
||||
case Library::ErrorCode::UNSUPPORTED_FORMAT:
|
||||
std::cout << "File is of unsupported format version";
|
||||
break;
|
||||
case Library::ErrorCode::DUPLICATE_PLATFORM_TYPE:
|
||||
std::cout << "Duplicate platform type";
|
||||
break;
|
||||
case Library::ErrorCode::PLATFORM_TYPE_REDEFINED:
|
||||
std::cout << "Platform type redefined";
|
||||
break;
|
||||
}
|
||||
if (!err.reason.empty())
|
||||
std::cout << " '" + err.reason + "'";
|
||||
std::cout << std::endl;
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
bool CmdLineParser::loadLibraries(Settings& settings)
|
||||
{
|
||||
if (!tryLoadLibrary(settings.library, settings.exename, "std.cfg")) {
|
||||
const std::string msg("Failed to load std.cfg. Your Cppcheck installation is broken, please re-install.");
|
||||
#ifdef FILESDIR
|
||||
const std::string details("The Cppcheck binary was compiled with FILESDIR set to \""
|
||||
FILESDIR "\" and will therefore search for "
|
||||
"std.cfg in " FILESDIR "/cfg.");
|
||||
#else
|
||||
const std::string cfgfolder(Path::fromNativeSeparators(Path::getPathFromFilename(settings.exename)) + "cfg");
|
||||
const std::string details("The Cppcheck binary was compiled without FILESDIR set. Either the "
|
||||
"std.cfg should be available in " + cfgfolder + " or the FILESDIR "
|
||||
"should be configured.");
|
||||
#endif
|
||||
std::cout << msg << " " << details << std::endl;
|
||||
return false;
|
||||
}
|
||||
|
||||
bool result = true;
|
||||
for (const auto& lib : settings.libraries) {
|
||||
if (!tryLoadLibrary(settings.library, settings.exename, lib.c_str())) {
|
||||
result = false;
|
||||
}
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
bool CmdLineParser::loadAddons(Settings& settings)
|
||||
{
|
||||
bool result = true;
|
||||
for (const std::string &addon: settings.addons) {
|
||||
AddonInfo addonInfo;
|
||||
const std::string failedToGetAddonInfo = addonInfo.getAddonInfo(addon, settings.exename);
|
||||
if (!failedToGetAddonInfo.empty()) {
|
||||
std::cout << failedToGetAddonInfo << std::endl;
|
||||
result = false;
|
||||
continue;
|
||||
}
|
||||
settings.addonInfos.emplace_back(std::move(addonInfo));
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -22,6 +22,7 @@
|
|||
#include <cstddef>
|
||||
#include <list>
|
||||
#include <string>
|
||||
#include <utility>
|
||||
#include <vector>
|
||||
|
||||
#include "cmdlinelogger.h"
|
||||
|
|
@ -30,6 +31,7 @@
|
|||
|
||||
class Settings;
|
||||
class Suppressions;
|
||||
class Library;
|
||||
|
||||
/// @addtogroup CLI
|
||||
/// @{
|
||||
|
|
@ -55,6 +57,16 @@ public:
|
|||
*/
|
||||
CmdLineParser(CmdLineLogger &logger, Settings &settings, Suppressions &suppressions, Suppressions &suppressionsNoFail);
|
||||
|
||||
/**
|
||||
* @brief Parse command line args and fill settings and file lists
|
||||
* from there.
|
||||
*
|
||||
* @param argc argc from main()
|
||||
* @param argv argv from main()
|
||||
* @return false when errors are found in the input
|
||||
*/
|
||||
bool fillSettingsFromArgs(int argc, const char* const argv[]);
|
||||
|
||||
/**
|
||||
* Parse given command line.
|
||||
* @return true if command line was ok, false if there was an error.
|
||||
|
|
@ -82,6 +94,13 @@ public:
|
|||
return mPathNames;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the files user gave to command line.
|
||||
*/
|
||||
const std::list<std::pair<std::string, std::size_t>>& getFiles() const {
|
||||
return mFiles;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the file settings read from command line.
|
||||
*/
|
||||
|
|
@ -130,9 +149,30 @@ private:
|
|||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Tries to load a library and prints warning/error messages
|
||||
* @return false, if an error occurred (except unknown XML elements)
|
||||
*/
|
||||
static bool tryLoadLibrary(Library& destination, const std::string& basepath, const char* filename);
|
||||
|
||||
/**
|
||||
* @brief Load libraries
|
||||
* @param settings Settings
|
||||
* @return Returns true if successful
|
||||
*/
|
||||
static bool loadLibraries(Settings& settings);
|
||||
|
||||
/**
|
||||
* @brief Load addons
|
||||
* @param settings Settings
|
||||
* @return Returns true if successful
|
||||
*/
|
||||
static bool loadAddons(Settings& settings);
|
||||
|
||||
CmdLineLogger &mLogger;
|
||||
|
||||
std::vector<std::string> mPathNames;
|
||||
std::list<std::pair<std::string, std::size_t>> mFiles;
|
||||
std::list<FileSettings> mFileSettings;
|
||||
std::vector<std::string> mIgnoredPaths;
|
||||
Settings &mSettings;
|
||||
|
|
|
|||
|
|
@ -18,7 +18,6 @@
|
|||
|
||||
#include "cppcheckexecutor.h"
|
||||
|
||||
#include "addoninfo.h"
|
||||
#include "analyzerinfo.h"
|
||||
#include "checkersreport.h"
|
||||
#include "cmdlinelogger.h"
|
||||
|
|
@ -28,11 +27,7 @@
|
|||
#include "cppcheck.h"
|
||||
#include "errorlogger.h"
|
||||
#include "errortypes.h"
|
||||
#include "filelister.h"
|
||||
#include "filesettings.h"
|
||||
#include "library.h"
|
||||
#include "path.h"
|
||||
#include "pathmatch.h"
|
||||
#include "settings.h"
|
||||
#include "singleexecutor.h"
|
||||
#include "suppressions.h"
|
||||
|
|
@ -47,16 +42,13 @@
|
|||
#endif
|
||||
|
||||
#include <algorithm>
|
||||
#include <cassert>
|
||||
#include <cstdio>
|
||||
#include <cstdlib> // EXIT_SUCCESS and EXIT_FAILURE
|
||||
#include <ctime>
|
||||
#include <iostream>
|
||||
#include <iterator>
|
||||
#include <list>
|
||||
#include <set>
|
||||
#include <sstream> // IWYU pragma: keep
|
||||
#include <unordered_set>
|
||||
#include <utility>
|
||||
#include <vector>
|
||||
|
||||
|
|
@ -72,44 +64,26 @@
|
|||
#include <windows.h>
|
||||
#endif
|
||||
|
||||
namespace {
|
||||
class XMLErrorMessagesLogger : public ErrorLogger
|
||||
class CmdLineLoggerStd : public CmdLineLogger
|
||||
{
|
||||
public:
|
||||
CmdLineLoggerStd() = default;
|
||||
|
||||
void printMessage(const std::string &message) override
|
||||
{
|
||||
void reportOut(const std::string & outmsg, Color /*c*/ = Color::Reset) override
|
||||
{
|
||||
std::cout << outmsg << std::endl;
|
||||
}
|
||||
printRaw("cppcheck: " + message);
|
||||
}
|
||||
|
||||
void reportErr(const ErrorMessage &msg) override
|
||||
{
|
||||
reportOut(msg.toXML());
|
||||
}
|
||||
|
||||
void reportProgress(const std::string & /*filename*/, const char /*stage*/[], const std::size_t /*value*/) override
|
||||
{}
|
||||
};
|
||||
|
||||
class CmdLineLoggerStd : public CmdLineLogger
|
||||
void printError(const std::string &message) override
|
||||
{
|
||||
public:
|
||||
CmdLineLoggerStd() = default;
|
||||
printMessage("error: " + message);
|
||||
}
|
||||
|
||||
void printMessage(const std::string &message) override
|
||||
{
|
||||
printRaw("cppcheck: " + message);
|
||||
}
|
||||
|
||||
void printError(const std::string &message) override
|
||||
{
|
||||
printMessage("error: " + message);
|
||||
}
|
||||
|
||||
void printRaw(const std::string &message) override
|
||||
{
|
||||
std::cout << message << std::endl;
|
||||
}
|
||||
};
|
||||
}
|
||||
void printRaw(const std::string &message) override
|
||||
{
|
||||
std::cout << message << std::endl;
|
||||
}
|
||||
};
|
||||
|
||||
class CppCheckExecutor::StdLogger : public ErrorLogger
|
||||
{
|
||||
|
|
@ -195,173 +169,23 @@ private:
|
|||
/*static*/ FILE* CppCheckExecutor::mExceptionOutput = stdout;
|
||||
#endif
|
||||
|
||||
bool CppCheckExecutor::parseFromArgs(Settings &settings, int argc, const char* const argv[])
|
||||
{
|
||||
CmdLineLoggerStd logger;
|
||||
CmdLineParser parser(logger, settings, settings.nomsg, settings.nofail);
|
||||
const bool success = parser.parseFromArgs(argc, argv);
|
||||
|
||||
if (success) {
|
||||
if (parser.getShowVersion() && !parser.getShowErrorMessages()) {
|
||||
if (!settings.cppcheckCfgProductName.empty()) {
|
||||
logger.printRaw(settings.cppcheckCfgProductName);
|
||||
} else {
|
||||
const char * const extraVersion = CppCheck::extraVersion();
|
||||
if (*extraVersion != 0)
|
||||
logger.printRaw(std::string("Cppcheck ") + CppCheck::version() + " ("+ extraVersion + ')');
|
||||
else
|
||||
logger.printRaw(std::string("Cppcheck ") + CppCheck::version());
|
||||
}
|
||||
}
|
||||
|
||||
if (parser.getShowErrorMessages()) {
|
||||
XMLErrorMessagesLogger xmlLogger;
|
||||
std::cout << ErrorMessage::getXMLHeader(settings.cppcheckCfgProductName);
|
||||
CppCheck::getErrorMessages(xmlLogger);
|
||||
std::cout << ErrorMessage::getXMLFooter() << std::endl;
|
||||
}
|
||||
|
||||
if (parser.exitAfterPrinting()) {
|
||||
Settings::terminate();
|
||||
return true;
|
||||
}
|
||||
} else {
|
||||
return false;
|
||||
}
|
||||
|
||||
// Libraries must be loaded before FileLister is executed to ensure markup files will be
|
||||
// listed properly.
|
||||
if (!loadLibraries(settings))
|
||||
return false;
|
||||
|
||||
if (!loadAddons(settings))
|
||||
return false;
|
||||
|
||||
// Check that all include paths exist
|
||||
{
|
||||
for (std::list<std::string>::iterator iter = settings.includePaths.begin();
|
||||
iter != settings.includePaths.end();
|
||||
) {
|
||||
const std::string path(Path::toNativeSeparators(*iter));
|
||||
if (Path::isDirectory(path))
|
||||
++iter;
|
||||
else {
|
||||
// TODO: this bypasses the template format and other settings
|
||||
// If the include path is not found, warn user and remove the non-existing path from the list.
|
||||
if (settings.severity.isEnabled(Severity::information))
|
||||
std::cout << "(information) Couldn't find path given by -I '" << path << '\'' << std::endl;
|
||||
iter = settings.includePaths.erase(iter);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Output a warning for the user if he tries to exclude headers
|
||||
const std::vector<std::string>& ignored = parser.getIgnoredPaths();
|
||||
const bool warn = std::any_of(ignored.cbegin(), ignored.cend(), [](const std::string& i) {
|
||||
return Path::isHeader(i);
|
||||
});
|
||||
if (warn) {
|
||||
logger.printMessage("filename exclusion does not apply to header (.h and .hpp) files.");
|
||||
logger.printMessage("Please use --suppress for ignoring results from the header files.");
|
||||
}
|
||||
|
||||
const std::vector<std::string>& pathnamesRef = parser.getPathNames();
|
||||
const std::list<FileSettings>& fileSettingsRef = parser.getFileSettings();
|
||||
|
||||
// the inputs can only be used exclusively - CmdLineParser should already handle this
|
||||
assert(!(!pathnamesRef.empty() && !fileSettingsRef.empty()));
|
||||
|
||||
if (!fileSettingsRef.empty()) {
|
||||
std::list<FileSettings> fileSettings;
|
||||
if (!settings.fileFilters.empty()) {
|
||||
// filter only for the selected filenames from all project files
|
||||
std::copy_if(fileSettingsRef.cbegin(), fileSettingsRef.cend(), std::back_inserter(fileSettings), [&](const FileSettings &fs) {
|
||||
return matchglobs(settings.fileFilters, fs.filename);
|
||||
});
|
||||
if (fileSettings.empty()) {
|
||||
logger.printError("could not find any files matching the filter.");
|
||||
return false;
|
||||
}
|
||||
}
|
||||
else {
|
||||
fileSettings = fileSettingsRef;
|
||||
}
|
||||
|
||||
// sort the markup last
|
||||
std::copy_if(fileSettings.cbegin(), fileSettings.cend(), std::back_inserter(mFileSettings), [&](const FileSettings &fs) {
|
||||
return !settings.library.markupFile(fs.filename) || !settings.library.processMarkupAfterCode(fs.filename);
|
||||
});
|
||||
|
||||
std::copy_if(fileSettings.cbegin(), fileSettings.cend(), std::back_inserter(mFileSettings), [&](const FileSettings &fs) {
|
||||
return settings.library.markupFile(fs.filename) && settings.library.processMarkupAfterCode(fs.filename);
|
||||
});
|
||||
}
|
||||
|
||||
if (!pathnamesRef.empty()) {
|
||||
std::list<std::pair<std::string, std::size_t>> filesResolved;
|
||||
// TODO: this needs to be inlined into PathMatch as it depends on the underlying filesystem
|
||||
#if defined(_WIN32)
|
||||
// For Windows we want case-insensitive path matching
|
||||
const bool caseSensitive = false;
|
||||
#else
|
||||
const bool caseSensitive = true;
|
||||
#endif
|
||||
// Execute recursiveAddFiles() to each given file parameter
|
||||
const PathMatch matcher(ignored, caseSensitive);
|
||||
for (const std::string &pathname : pathnamesRef) {
|
||||
const std::string err = FileLister::recursiveAddFiles(filesResolved, Path::toNativeSeparators(pathname), settings.library.markupExtensions(), matcher);
|
||||
if (!err.empty()) {
|
||||
// TODO: bail out?
|
||||
logger.printMessage(err);
|
||||
}
|
||||
}
|
||||
|
||||
std::list<std::pair<std::string, std::size_t>> files;
|
||||
if (!settings.fileFilters.empty()) {
|
||||
std::copy_if(filesResolved.cbegin(), filesResolved.cend(), std::inserter(files, files.end()), [&](const decltype(filesResolved)::value_type& entry) {
|
||||
return matchglobs(settings.fileFilters, entry.first);
|
||||
});
|
||||
if (files.empty()) {
|
||||
logger.printError("could not find any files matching the filter.");
|
||||
return false;
|
||||
}
|
||||
}
|
||||
else {
|
||||
files = std::move(filesResolved);
|
||||
}
|
||||
|
||||
// sort the markup last
|
||||
std::copy_if(files.cbegin(), files.cend(), std::inserter(mFiles, mFiles.end()), [&](const decltype(files)::value_type& entry) {
|
||||
return !settings.library.markupFile(entry.first) || !settings.library.processMarkupAfterCode(entry.first);
|
||||
});
|
||||
|
||||
std::copy_if(files.cbegin(), files.cend(), std::inserter(mFiles, mFiles.end()), [&](const decltype(files)::value_type& entry) {
|
||||
return settings.library.markupFile(entry.first) && settings.library.processMarkupAfterCode(entry.first);
|
||||
});
|
||||
}
|
||||
|
||||
if (mFiles.empty() && mFileSettings.empty()) {
|
||||
logger.printError("could not find or open any of the paths given.");
|
||||
if (!ignored.empty())
|
||||
logger.printMessage("Maybe all paths were ignored?");
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
int CppCheckExecutor::check(int argc, const char* const argv[])
|
||||
{
|
||||
CheckUnusedFunctions::clear();
|
||||
|
||||
Settings settings;
|
||||
if (!parseFromArgs(settings, argc, argv)) {
|
||||
CmdLineLoggerStd logger;
|
||||
CmdLineParser parser(logger, settings, settings.nomsg, settings.nofail);
|
||||
if (!parser.fillSettingsFromArgs(argc, argv)) {
|
||||
return EXIT_FAILURE;
|
||||
}
|
||||
if (Settings::terminated()) {
|
||||
return EXIT_SUCCESS;
|
||||
}
|
||||
|
||||
mFiles = parser.getFiles();
|
||||
mFileSettings = parser.getFileSettings();
|
||||
|
||||
mStdLogger = new StdLogger(settings);
|
||||
CppCheck cppCheck(*mStdLogger, true, executeCommand);
|
||||
cppCheck.settings() = settings;
|
||||
|
|
@ -490,49 +314,6 @@ void CppCheckExecutor::StdLogger::writeCheckersReport() const
|
|||
|
||||
}
|
||||
|
||||
bool CppCheckExecutor::loadLibraries(Settings& settings)
|
||||
{
|
||||
if (!tryLoadLibrary(settings.library, settings.exename, "std.cfg")) {
|
||||
const std::string msg("Failed to load std.cfg. Your Cppcheck installation is broken, please re-install.");
|
||||
#ifdef FILESDIR
|
||||
const std::string details("The Cppcheck binary was compiled with FILESDIR set to \""
|
||||
FILESDIR "\" and will therefore search for "
|
||||
"std.cfg in " FILESDIR "/cfg.");
|
||||
#else
|
||||
const std::string cfgfolder(Path::fromNativeSeparators(Path::getPathFromFilename(settings.exename)) + "cfg");
|
||||
const std::string details("The Cppcheck binary was compiled without FILESDIR set. Either the "
|
||||
"std.cfg should be available in " + cfgfolder + " or the FILESDIR "
|
||||
"should be configured.");
|
||||
#endif
|
||||
std::cout << msg << " " << details << std::endl;
|
||||
return false;
|
||||
}
|
||||
|
||||
bool result = true;
|
||||
for (const auto& lib : settings.libraries) {
|
||||
if (!tryLoadLibrary(settings.library, settings.exename, lib.c_str())) {
|
||||
result = false;
|
||||
}
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
bool CppCheckExecutor::loadAddons(Settings& settings)
|
||||
{
|
||||
bool result = true;
|
||||
for (const std::string &addon: settings.addons) {
|
||||
AddonInfo addonInfo;
|
||||
const std::string failedToGetAddonInfo = addonInfo.getAddonInfo(addon, settings.exename);
|
||||
if (!failedToGetAddonInfo.empty()) {
|
||||
std::cout << failedToGetAddonInfo << std::endl;
|
||||
result = false;
|
||||
continue;
|
||||
}
|
||||
settings.addonInfos.emplace_back(std::move(addonInfo));
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
#ifdef _WIN32
|
||||
// fix trac ticket #439 'Cppcheck reports wrong filename for filenames containing 8-bit ASCII'
|
||||
static inline std::string ansiToOEM(const std::string &msg, bool doConvert)
|
||||
|
|
@ -635,50 +416,6 @@ FILE* CppCheckExecutor::getExceptionOutput()
|
|||
}
|
||||
#endif
|
||||
|
||||
bool CppCheckExecutor::tryLoadLibrary(Library& destination, const std::string& basepath, const char* filename)
|
||||
{
|
||||
const Library::Error err = destination.load(basepath.c_str(), filename);
|
||||
|
||||
if (err.errorcode == Library::ErrorCode::UNKNOWN_ELEMENT)
|
||||
std::cout << "cppcheck: Found unknown elements in configuration file '" << filename << "': " << err.reason << std::endl;
|
||||
else if (err.errorcode != Library::ErrorCode::OK) {
|
||||
std::cout << "cppcheck: Failed to load library configuration file '" << filename << "'. ";
|
||||
switch (err.errorcode) {
|
||||
case Library::ErrorCode::OK:
|
||||
break;
|
||||
case Library::ErrorCode::FILE_NOT_FOUND:
|
||||
std::cout << "File not found";
|
||||
break;
|
||||
case Library::ErrorCode::BAD_XML:
|
||||
std::cout << "Bad XML";
|
||||
break;
|
||||
case Library::ErrorCode::UNKNOWN_ELEMENT:
|
||||
std::cout << "Unexpected element";
|
||||
break;
|
||||
case Library::ErrorCode::MISSING_ATTRIBUTE:
|
||||
std::cout << "Missing attribute";
|
||||
break;
|
||||
case Library::ErrorCode::BAD_ATTRIBUTE_VALUE:
|
||||
std::cout << "Bad attribute value";
|
||||
break;
|
||||
case Library::ErrorCode::UNSUPPORTED_FORMAT:
|
||||
std::cout << "File is of unsupported format version";
|
||||
break;
|
||||
case Library::ErrorCode::DUPLICATE_PLATFORM_TYPE:
|
||||
std::cout << "Duplicate platform type";
|
||||
break;
|
||||
case Library::ErrorCode::PLATFORM_TYPE_REDEFINED:
|
||||
std::cout << "Platform type redefined";
|
||||
break;
|
||||
}
|
||||
if (!err.reason.empty())
|
||||
std::cout << " '" + err.reason + "'";
|
||||
std::cout << std::endl;
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Execute a shell command and read the output from it. Returns true if command terminated successfully.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -29,7 +29,6 @@
|
|||
#include <vector>
|
||||
|
||||
class CppCheck;
|
||||
class Library;
|
||||
class Settings;
|
||||
class ErrorLogger;
|
||||
|
||||
|
|
@ -75,12 +74,6 @@ public:
|
|||
|
||||
private:
|
||||
|
||||
/**
|
||||
* Tries to load a library and prints warning/error messages
|
||||
* @return false, if an error occurred (except unknown XML elements)
|
||||
*/
|
||||
static bool tryLoadLibrary(Library& destination, const std::string& basepath, const char* filename);
|
||||
|
||||
/**
|
||||
* Execute a shell command and read the output from it. Returns exitcode of the executed command,.
|
||||
*/
|
||||
|
|
@ -88,17 +81,6 @@ private:
|
|||
|
||||
protected:
|
||||
|
||||
/**
|
||||
* @brief Parse command line args and get settings and file lists
|
||||
* from there.
|
||||
*
|
||||
* @param settings the settings to store into
|
||||
* @param argc argc from main()
|
||||
* @param argv argv from main()
|
||||
* @return false when errors are found in the input
|
||||
*/
|
||||
bool parseFromArgs(Settings &settings, int argc, const char* const argv[]);
|
||||
|
||||
static bool reportSuppressions(const Settings &settings, bool unusedFunctionCheckEnabled, const std::list<std::pair<std::string, std::size_t>> &files, ErrorLogger& errorLogger);
|
||||
|
||||
/**
|
||||
|
|
@ -121,20 +103,6 @@ protected:
|
|||
*/
|
||||
int check_internal(CppCheck& cppcheck);
|
||||
|
||||
/**
|
||||
* @brief Load libraries
|
||||
* @param settings Settings
|
||||
* @return Returns true if successful
|
||||
*/
|
||||
static bool loadLibraries(Settings& settings);
|
||||
|
||||
/**
|
||||
* @brief Load addons
|
||||
* @param settings Settings
|
||||
* @return Returns true if successful
|
||||
*/
|
||||
static bool loadAddons(Settings& settings);
|
||||
|
||||
/**
|
||||
* Filename associated with size of file
|
||||
*/
|
||||
|
|
|
|||
Loading…
Reference in New Issue