cppcheck/lib/settings.h

225 lines
5.7 KiB
C++

/*
* 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 settingsH
#define settingsH
#include <list>
#include <string>
#include <istream>
#include <set>
#include "suppressions.h"
/// @addtogroup Core
/// @{
/**
* @brief This is just a container for general settings so that we don't need
* to pass individual values to functions or constructors now or in the
* future when we might have even more detailed settings.
*/
class Settings
{
private:
/** @brief Code to append in the checks */
std::string _append;
/** @brief enable extra checks by id */
std::set<std::string> _enabled;
/** @brief terminate checking */
bool _terminate;
public:
Settings();
/** @brief Is --debug given? */
bool debug;
/** @brief Is --debug-warnings given? */
bool debugwarnings;
/** @brief Is --debug-fp given? */
bool debugFalsePositive;
/** @brief Inconclusive checks */
bool inconclusive;
/**
* When this flag is false (default) then experimental
* heuristics and checks are disabled.
*
* It should not be possible to enable this from any client.
*/
bool experimental;
/** @brief Is --quiet given? */
bool _errorsOnly;
/** @brief Is --inline-suppr given? */
bool _inlineSuppressions;
/** @brief Is --verbose given? */
bool _verbose;
/** @brief Request termination of checking */
void terminate()
{
_terminate = true;
}
/** @brief termination requested? */
bool terminated() const
{
return _terminate;
}
/** @brief Force checking the files with "too many" configurations (--force). */
bool _force;
/** @brief write XML results (--xml) */
bool _xml;
/** @brief XML version (--xmlver=..) */
int _xml_version;
/** @brief How many processes/threads should do checking at the same
time. Default is 1. (-j N) */
unsigned int _jobs;
/** @brief If errors are found, this value is returned from main().
Default value is 0. */
int _exitCode;
/** @brief The output format in which the errors are printed in text mode,
e.g. "{severity} {file}:{line} {message} {id}" */
std::string _outputFormat;
/** @brief show timing information (--showtime=file|summary|top5) */
unsigned int _showtime;
/** @brief List of include paths, e.g. "my/includes/" which should be used
for finding include files inside source files. (-I) */
std::list<std::string> _includePaths;
/** @brief assign append code (--append) */
void append(const std::string &filename);
/** @brief get append code (--append) */
std::string append() const;
/**
* @brief Returns true if given id is in the list of
* enabled extra checks (--enable)
* @param str id for the extra check, e.g. "style"
* @return true if the check is enabled.
*/
bool isEnabled(const std::string &str) const;
/**
* @brief Enable extra checks by id. See isEnabled()
* @param str single id or list of id values to be enabled
* or empty string to enable all. e.g. "style,possibleError"
* @return error message. empty upon success
*/
std::string addEnabled(const std::string &str);
/** @brief suppress message (--suppressions) */
Suppressions nomsg;
/** @brief suppress exitcode */
Suppressions nofail;
/** @brief defines given by the user */
std::string userDefines;
/** @brief Experimental 2 pass checking of files */
bool test_2_pass;
/** @brief --report-progress */
bool reportProgress;
/**
* @brief Is there any preprocessor configurations in the source code?
* As usual, include guards are not counted.
*/
bool ifcfg;
/** Rule */
class Rule
{
public:
Rule()
{
// default id
id = "rule";
// default severity
severity = "style";
}
std::string pattern;
std::string id;
std::string severity;
std::string summary;
};
/**
* @brief Extra rules
*/
std::list<Rule> rules;
/** Is the 'configuration checking' wanted? */
bool checkConfiguration;
/** Code is posix - it is not compatible with non-posix environments */
bool posix;
/** size of standard types */
unsigned int sizeof_bool;
unsigned int sizeof_short;
unsigned int sizeof_int;
unsigned int sizeof_long;
unsigned int sizeof_long_long;
unsigned int sizeof_float;
unsigned int sizeof_double;
unsigned int sizeof_long_double;
unsigned int sizeof_size_t;
unsigned int sizeof_pointer;
enum PlatformType
{
Host, // whatever system this code was compiled on
Win32,
Win64,
Unix32,
Unix64
};
/** set the platform type for predefined platforms */
bool platform(PlatformType type);
/** set the platform type for user specified platforms */
bool platformFile(const std::string &filename);
};
/// @}
#endif // SETTINGS_H