-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
cppcheck.h
201 lines (165 loc) · 5.86 KB
/
cppcheck.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
/*
* Cppcheck - A tool for static C/C++ code analysis
* Copyright (C) 2007-2013 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 "config.h"
#include "settings.h"
#include "errorlogger.h"
#include "checkunusedfunctions.h"
#include <string>
#include <list>
#include <istream>
/// @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 CPPCHECKLIB CppCheck : 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 Check function usage.
* @note Call this after all files has been checked
*/
void checkFunctionUsage();
/**
* @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();
/**
* @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();
virtual void reportStatus(unsigned int fileindex, unsigned int filecount, std::size_t sizedone, std::size_t 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);
/**
* @brief Get dependencies. Use this after calling 'check'.
*/
const std::set<std::string>& dependencies() const {
return _dependencies;
}
void tooManyConfigsError(const std::string &file, const std::size_t numberOfConfigurations);
private:
/** @brief Process one file. */
unsigned int processFile(const std::string& filename);
/** @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);
/**
* @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.
*/
static void replaceAll(std::string& code, const std::string &from, const std::string &to);
std::list<std::string> _errorList;
Settings _settings;
std::string _fileContent;
std::set<std::string> _dependencies;
void reportProgress(const std::string &filename, const char stage[], const std::size_t value);
/**
* Output information messages.
*/
virtual void reportInfo(const ErrorLogger::ErrorMessage &msg);
CheckUnusedFunctions _checkUnusedFunctions;
ErrorLogger &_errorLogger;
/** @brief Current preprocessor configuration */
std::string cfg;
unsigned int exitcode;
bool _useGlobalSuppressions;
/** Are there too many configs? */
bool tooManyConfigs;
};
/// @}
#endif // CPPCHECK_H