/
projectfile.h
648 lines (522 loc) · 15.7 KB
/
projectfile.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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
/*
* Cppcheck - A tool for static C/C++ code analysis
* Copyright (C) 2007-2024 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 PROJECT_FILE_H
#define PROJECT_FILE_H
#include "settings.h"
#include "suppressions.h"
#include <cstddef>
#include <map>
#include <utility>
#include <QList>
#include <QObject>
#include <QString>
#include <QStringList>
class QXmlStreamReader;
class QXmlStreamWriter;
/// @addtogroup GUI
/// @{
/**
* @brief A class that reads and writes project files.
* The project files contain project-specific settings for checking. For
* example a list of include paths.
*/
class ProjectFile : public QObject {
Q_OBJECT
public:
explicit ProjectFile(QObject *parent = nullptr);
explicit ProjectFile(QString filename, QObject *parent = nullptr);
~ProjectFile() override {
if (this == mActiveProject) mActiveProject = nullptr;
}
enum class CheckLevel {
normal,
exhaustive
};
static ProjectFile* getActiveProject() {
return mActiveProject;
}
void setActiveProject() {
mActiveProject = this;
}
/**
* @brief Read the project file.
* @param filename Filename (can be also given to constructor).
*/
bool read(const QString &filename = QString());
/**
* @brief Get project root path.
* @return project root path.
*/
const QString& getRootPath() const {
return mRootPath;
}
const QString& getBuildDir() const {
return mBuildDir;
}
const QString& getImportProject() const {
return mImportProject;
}
bool getAnalyzeAllVsConfigs() const {
return mAnalyzeAllVsConfigs;
}
bool getCheckHeaders() const {
return mCheckHeaders;
}
void setCheckHeaders(bool b) {
mCheckHeaders = b;
}
bool getCheckUnusedTemplates() const {
return mCheckUnusedTemplates;
}
void setCheckUnusedTemplates(bool b) {
mCheckUnusedTemplates = b;
}
/**
* @brief Get list of include directories.
* @return list of directories.
*/
QStringList getIncludeDirs() const {
return ProjectFile::fromNativeSeparators(mIncludeDirs);
}
/**
* @brief Get list of defines.
* @return list of defines.
*/
const QStringList& getDefines() const {
return mDefines;
}
/**
* @brief Get list of undefines.
* @return list of undefines.
*/
const QStringList& getUndefines() const {
return mUndefines;
}
/**
* @brief Get list of paths to check.
* @return list of paths.
*/
QStringList getCheckPaths() const {
return ProjectFile::fromNativeSeparators(mPaths);
}
/**
* @brief Get list of paths to exclude from the check.
* @return list of paths.
*/
QStringList getExcludedPaths() const {
return ProjectFile::fromNativeSeparators(mExcludedPaths);
}
/**
* @brief Get list of paths to exclude from the check.
* @return list of paths.
*/
const QStringList& getVsConfigurations() const {
return mVsConfigurations;
}
/**
* @brief Get list libraries.
* @return list of libraries.
*/
const QStringList& getLibraries() const {
return mLibraries;
}
/**
* @brief Get platform.
* @return Current platform. If it ends with .xml then it is a file. Otherwise it must match one of the return values from @sa cppcheck::Platform::toString() ("win32A", "unix32", ..)
*/
const QString& getPlatform() const {
return mPlatform;
}
const QString& getProjectName() const {
return mProjectName;
}
void setProjectName(QString projectName) {
mProjectName = std::move(projectName);
}
/**
* @brief Get "raw" suppressions.
* @return list of suppressions.
*/
const QList<SuppressionList::Suppression>& getSuppressions() const {
return mSuppressions;
}
/**
* @brief Get "checking" suppressions. Relative paths are converted to absolute paths.
* @return list of suppressions.
*/
QList<SuppressionList::Suppression> getCheckingSuppressions() const;
/**
* @brief Get list addons.
* @return list of addons.
*/
const QStringList& getAddons() const {
return mAddons;
}
/**
* @brief Get path to addon python script
* @param filesDir Data files folder set by --data-dir
* @param addon addon i.e. "misra" to lookup
*/
static QString getAddonFilePath(QString filesDir, const QString &addon);
/**
* @brief Get list of addons and tools.
* @return list of addons and tools.
*/
QStringList getAddonsAndTools() const;
bool getClangAnalyzer() const {
return false; //mClangAnalyzer;
}
void setClangAnalyzer(bool c) {
mClangAnalyzer = c;
}
bool getClangTidy() const {
return mClangTidy;
}
void setClangTidy(bool c) {
mClangTidy = c;
}
const QStringList& getTags() const {
return mTags;
}
int getMaxCtuDepth() const {
return mMaxCtuDepth;
}
void setMaxCtuDepth(int maxCtuDepth) {
mMaxCtuDepth = maxCtuDepth;
}
int getMaxTemplateRecursion() const {
return mMaxTemplateRecursion;
}
void setMaxTemplateRecursion(int maxTemplateRecursion) {
mMaxTemplateRecursion = maxTemplateRecursion;
}
/**
* @brief Get filename for the project file.
* @return file name.
*/
const QString& getFilename() const {
return mFilename;
}
/**
* @brief Set project root path.
* @param rootpath new project root path.
*/
void setRootPath(const QString &rootpath) {
mRootPath = rootpath;
}
void setBuildDir(const QString &buildDir) {
mBuildDir = buildDir;
}
void setImportProject(const QString &importProject) {
mImportProject = importProject;
}
void setAnalyzeAllVsConfigs(bool b) {
mAnalyzeAllVsConfigs = b;
}
/**
* @brief Set list of includes.
* @param includes List of defines.
*/
void setIncludes(const QStringList &includes);
/**
* @brief Set list of defines.
* @param defines List of defines.
*/
void setDefines(const QStringList &defines);
/**
* @brief Set list of undefines.
* @param undefines List of undefines.
*/
void setUndefines(const QStringList &undefines);
/**
* @brief Set list of paths to check.
* @param paths List of paths.
*/
void setCheckPaths(const QStringList &paths);
/**
* @brief Set list of paths to exclude from the check.
* @param paths List of paths.
*/
void setExcludedPaths(const QStringList &paths);
/**
* @brief Set list of libraries.
* @param libraries List of libraries.
*/
void setLibraries(const QStringList &libraries);
/**
* @brief Set platform.
* @param platform platform.
*/
void setPlatform(const QString &platform);
/**
* @brief Set list of suppressions.
* @param suppressions List of suppressions.
*/
void setSuppressions(const QList<SuppressionList::Suppression> &suppressions);
/** Add suppression */
void addSuppression(const SuppressionList::Suppression &suppression);
/**
* @brief Set list of addons.
* @param addons List of addons.
*/
void setAddons(const QStringList &addons);
/** @brief Set list of Visual Studio configurations to be checked
* @param vsConfigs List of configurations
*/
void setVSConfigurations(const QStringList &vsConfigs);
/** CheckLevel: normal/exhaustive */
void setCheckLevel(CheckLevel checkLevel);
bool isCheckLevelExhaustive() const;
/**
* @brief Set tags.
* @param tags tag list
*/
void setTags(const QStringList &tags) {
mTags = tags;
}
/** Set tags for a warning */
void setWarningTags(std::size_t hash, const QString& tags);
/** Get tags for a warning */
QString getWarningTags(std::size_t hash) const;
/** Bughunting (Cppcheck Premium) */
void setBughunting(bool bughunting) {
mBughunting = bughunting;
}
bool getBughunting() const {
return mBughunting;
}
/** @brief Get list of coding standards (checked by Cppcheck Premium). */
const QStringList& getCodingStandards() const {
return mCodingStandards;
}
/**
* @brief Set list of coding standards (checked by Cppcheck Premium).
* @param codingStandards List of coding standards.
*/
void setCodingStandards(QStringList codingStandards) {
mCodingStandards = std::move(codingStandards);
}
/** Cert C: int precision */
void setCertIntPrecision(int p) {
mCertIntPrecision = p;
}
int getCertIntPrecision() const {
return mCertIntPrecision;
}
/**
* @brief Write project file (to disk).
* @param filename Filename to use.
*/
bool write(const QString &filename = QString());
/**
* @brief Set filename for the project file.
* @param filename Filename to use.
*/
void setFilename(const QString &filename) {
mFilename = filename;
}
/** Do not only check how interface is used. Also check that interface is safe. */
class SafeChecks : public Settings::SafeChecks {
public:
SafeChecks() : Settings::SafeChecks() {}
void loadFromXml(QXmlStreamReader &xmlReader);
void saveToXml(QXmlStreamWriter &xmlWriter) const;
};
SafeChecks safeChecks;
/** Check unknown function return values */
const QStringList& getCheckUnknownFunctionReturn() const {
return mCheckUnknownFunctionReturn;
}
/*
void setCheckUnknownFunctionReturn(const QStringList &s) {
mCheckUnknownFunctionReturn = s;
}
*/
/** Use Clang parser */
bool clangParser;
protected:
/**
* @brief Read optional root path from XML.
* @param reader XML stream reader.
*/
void readRootPath(const QXmlStreamReader &reader);
void readBuildDir(QXmlStreamReader &reader);
/**
* @brief Read importproject from XML.
* @param reader XML stream reader.
*/
void readImportProject(QXmlStreamReader &reader);
static bool readBool(QXmlStreamReader &reader);
static int readInt(QXmlStreamReader &reader, int defaultValue);
static QString readString(QXmlStreamReader &reader);
/**
* @brief Read list of include directories from XML.
* @param reader XML stream reader.
*/
void readIncludeDirs(QXmlStreamReader &reader);
/**
* @brief Read list of defines from XML.
* @param reader XML stream reader.
*/
void readDefines(QXmlStreamReader &reader);
/**
* @brief Read list paths to check.
* @param reader XML stream reader.
*/
void readCheckPaths(QXmlStreamReader &reader);
/**
* @brief Read lists of excluded paths.
* @param reader XML stream reader.
*/
void readExcludes(QXmlStreamReader &reader);
/**
* @brief Read lists of Visual Studio configurations
* @param reader XML stream reader.
*/
void readVsConfigurations(QXmlStreamReader &reader);
/**
* @brief Read platform text.
* @param reader XML stream reader.
*/
void readPlatform(QXmlStreamReader &reader);
/**
* @brief Read suppressions.
* @param reader XML stream reader.
*/
void readSuppressions(QXmlStreamReader &reader);
/**
* @brief Read tag warnings, what warnings are tagged with a specific tag
* @param reader XML stream reader.
*/
void readTagWarnings(QXmlStreamReader &reader, const QString &tag);
/**
* @brief Read string list
* @param stringlist destination string list
* @param reader XML stream reader
* @param elementname elementname for each string
*/
static void readStringList(QStringList &stringlist, QXmlStreamReader &reader, const char elementname[]);
/**
* @brief Write string list
* @param xmlWriter xml writer
* @param stringlist string list to write
* @param startelementname name of start element
* @param stringelementname name of each string element
*/
static void writeStringList(QXmlStreamWriter &xmlWriter, const QStringList &stringlist, const char startelementname[], const char stringelementname[]);
private:
void clear();
/**
* @brief Convert paths
*/
static QStringList fromNativeSeparators(const QStringList &paths);
/**
* @brief Filename (+path) of the project file.
*/
QString mFilename;
/**
* @brief Root path (optional) for the project.
* This is the project root path. If it is present then all relative paths in
* the project file are relative to this path. Otherwise paths are relative
* to project file's path.
*/
QString mRootPath;
/** Cppcheck build dir */
QString mBuildDir;
/** Visual studio project/solution , compile database */
QString mImportProject;
/**
* Should all visual studio configurations be analyzed?
* If this is false then only the Debug configuration
* for the set platform is analyzed.
*/
bool mAnalyzeAllVsConfigs;
/** Check only a selected VS configuration */
QStringList mVsConfigurations;
/** Check code in headers */
bool mCheckHeaders;
/** Check code in unused templates */
bool mCheckUnusedTemplates;
/**
* @brief List of include directories used to search include files.
*/
QStringList mIncludeDirs;
/**
* @brief List of defines.
*/
QStringList mDefines;
/**
* @brief List of undefines.
*/
QStringList mUndefines;
/**
* @brief List of paths to check.
*/
QStringList mPaths;
/**
* @brief Paths excluded from the check.
*/
QStringList mExcludedPaths;
/**
* @brief List of libraries.
*/
QStringList mLibraries;
/**
* @brief Platform
*/
QString mPlatform;
/**
* @brief List of suppressions.
*/
QList<SuppressionList::Suppression> mSuppressions;
/**
* @brief List of addons.
*/
QStringList mAddons;
bool mBughunting = false;
/** @brief Should Cppcheck run normal or exhaustive analysis? */
CheckLevel mCheckLevel = CheckLevel::normal;
/**
* @brief List of coding standards, checked by Cppcheck Premium.
*/
QStringList mCodingStandards;
/** @brief Project name, used when generating compliance report */
QString mProjectName;
/** @brief Cppcheck Premium: This value is passed to the Cert C checker if that is enabled */
int mCertIntPrecision;
/** @brief Execute clang analyzer? */
bool mClangAnalyzer;
/** @brief Execute clang-tidy? */
bool mClangTidy;
/**
* @brief Tags
*/
QStringList mTags;
/**
* @brief Warning tags
*/
std::map<std::size_t, QString> mWarningTags;
/** Max CTU depth */
int mMaxCtuDepth;
/** Max template instantiation recursion */
int mMaxTemplateRecursion;
QStringList mCheckUnknownFunctionReturn;
static ProjectFile *mActiveProject;
};
/// @}
#endif // PROJECT_FILE_H