2010-08-31 20:32:26 +02:00
|
|
|
/*
|
|
|
|
* Cppcheck - A tool for static C/C++ code analysis
|
2022-02-05 11:45:17 +01:00
|
|
|
* Copyright (C) 2007-2022 Cppcheck team.
|
2010-08-31 20:32:26 +02: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/>.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef CMDLINE_PARSER_H
|
|
|
|
#define CMDLINE_PARSER_H
|
|
|
|
|
|
|
|
#include <string>
|
2017-05-27 04:33:47 +02:00
|
|
|
#include <vector>
|
2010-08-31 20:32:26 +02:00
|
|
|
|
|
|
|
class Settings;
|
|
|
|
|
2010-09-06 19:50:48 +02:00
|
|
|
/// @addtogroup CLI
|
|
|
|
/// @{
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief The command line parser.
|
|
|
|
* The command line parser parses options and parameters user gives to
|
|
|
|
* cppcheck command line.
|
|
|
|
*
|
|
|
|
* The parser takes a pointer to Settings instance which it will update
|
|
|
|
* based on options user has given. Couple of options are handled as
|
|
|
|
* class internal options.
|
|
|
|
*/
|
2011-10-13 20:53:06 +02:00
|
|
|
class CmdLineParser {
|
2010-08-31 20:32:26 +02:00
|
|
|
public:
|
2010-09-06 19:50:48 +02:00
|
|
|
/**
|
|
|
|
* The constructor.
|
2010-12-15 18:45:53 +01:00
|
|
|
* @param settings Settings instance that will be modified according to
|
2010-09-06 19:50:48 +02:00
|
|
|
* options user has given.
|
|
|
|
*/
|
2011-10-31 23:40:37 +01:00
|
|
|
explicit CmdLineParser(Settings *settings);
|
2010-09-06 19:50:48 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Parse given command line.
|
|
|
|
* @return true if command line was ok, false if there was an error.
|
|
|
|
*/
|
2018-04-23 12:39:47 +02:00
|
|
|
bool parseFromArgs(int argc, const char* const argv[]);
|
2010-09-06 19:50:48 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Return if user wanted to see program version.
|
|
|
|
*/
|
2018-04-23 12:39:47 +02:00
|
|
|
bool getShowVersion() const {
|
2018-08-18 15:45:42 +02:00
|
|
|
return mShowVersion;
|
2010-08-31 20:32:26 +02:00
|
|
|
}
|
2010-09-06 19:50:48 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Return if user wanted to see list of error messages.
|
|
|
|
*/
|
2018-04-23 12:39:47 +02:00
|
|
|
bool getShowErrorMessages() const {
|
2018-08-18 15:45:42 +02:00
|
|
|
return mShowErrorMessages;
|
2010-08-31 20:32:26 +02:00
|
|
|
}
|
2010-09-06 19:50:48 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Return the path names user gave to command line.
|
|
|
|
*/
|
2018-04-23 12:39:47 +02:00
|
|
|
const std::vector<std::string>& getPathNames() const {
|
2018-08-18 15:45:42 +02:00
|
|
|
return mPathNames;
|
2010-08-31 20:32:26 +02:00
|
|
|
}
|
|
|
|
|
2010-09-06 21:31:06 +02:00
|
|
|
/**
|
|
|
|
* Return if help is shown to user.
|
|
|
|
*/
|
2018-04-23 12:39:47 +02:00
|
|
|
bool getShowHelp() const {
|
2018-08-18 15:45:42 +02:00
|
|
|
return mShowHelp;
|
2010-09-06 21:31:06 +02:00
|
|
|
}
|
|
|
|
|
2011-01-27 09:30:53 +01:00
|
|
|
/**
|
|
|
|
* Return if we should exit after printing version, help etc.
|
|
|
|
*/
|
2018-04-23 12:39:47 +02:00
|
|
|
bool exitAfterPrinting() const {
|
2018-08-18 15:45:42 +02:00
|
|
|
return mExitAfterPrint;
|
2011-01-27 09:30:53 +01:00
|
|
|
}
|
|
|
|
|
2011-01-31 14:25:51 +01:00
|
|
|
/**
|
|
|
|
* Return a list of paths user wants to ignore.
|
|
|
|
*/
|
2018-04-23 12:39:47 +02:00
|
|
|
const std::vector<std::string>& getIgnoredPaths() const {
|
2018-08-18 15:45:42 +02:00
|
|
|
return mIgnoredPaths;
|
2011-01-31 14:25:51 +01:00
|
|
|
}
|
|
|
|
|
2023-01-27 10:46:48 +01:00
|
|
|
#if defined(_WIN64) || defined(_WIN32)
|
|
|
|
// temporary variable to "un-break" tests
|
|
|
|
static bool SHOW_DEF_PLATFORM_MSG;
|
|
|
|
#endif
|
|
|
|
|
2010-08-31 20:32:26 +02:00
|
|
|
protected:
|
2010-09-06 19:50:48 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Print help text to the console.
|
|
|
|
*/
|
2022-08-24 08:46:35 +02:00
|
|
|
void printHelp();
|
2010-08-31 20:32:26 +02:00
|
|
|
|
2010-09-10 17:39:36 +02:00
|
|
|
/**
|
2021-10-30 13:30:48 +02:00
|
|
|
* Print message (to stdout).
|
2010-09-10 17:39:36 +02:00
|
|
|
*/
|
2018-04-23 12:39:47 +02:00
|
|
|
static void printMessage(const std::string &message);
|
2021-10-30 13:30:48 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Print error message (to stdout).
|
|
|
|
*/
|
|
|
|
static void printError(const std::string &message);
|
2010-09-10 17:39:36 +02:00
|
|
|
|
2010-08-31 20:32:26 +02:00
|
|
|
private:
|
2022-08-24 08:46:35 +02:00
|
|
|
bool isCppcheckPremium() const;
|
|
|
|
|
2018-08-18 15:45:42 +02:00
|
|
|
std::vector<std::string> mPathNames;
|
|
|
|
std::vector<std::string> mIgnoredPaths;
|
|
|
|
Settings *mSettings;
|
|
|
|
bool mShowHelp;
|
|
|
|
bool mShowVersion;
|
|
|
|
bool mShowErrorMessages;
|
|
|
|
bool mExitAfterPrint;
|
2020-04-19 18:19:28 +02:00
|
|
|
std::string mVSConfig;
|
2010-08-31 20:32:26 +02:00
|
|
|
};
|
|
|
|
|
2010-09-06 19:50:48 +02:00
|
|
|
/// @}
|
|
|
|
|
2010-08-31 20:32:26 +02:00
|
|
|
#endif // CMDLINE_PARSER_H
|