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
|
/*
This file is part of the clazy static checker.
Copyright (C) 2015 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com
Author: Sérgio Martins <sergio.martins@kdab.com>
Copyright (C) 2015-2016 Sergio Martins <smartins@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library 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
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef CLANG_LAZY_CHECK_MANAGER_H
#define CLANG_LAZY_CHECK_MANAGER_H
#include "clazy_export.h"
#include "checkbase.h"
#include <clang/Lex/PreprocessorOptions.h>
#include <functional>
#include <mutex>
#include <unordered_map>
struct CLAZYLIB_EXPORT RegisteredFixIt {
typedef std::vector<RegisteredFixIt> List;
RegisteredFixIt() : id(-1) {}
RegisteredFixIt(int id, const std::string &name) : id(id), name(name) {}
int id = -1;
std::string name;
bool operator==(const RegisteredFixIt &other) const { return id == other.id; }
};
using FactoryFunction = std::function<CheckBase*(ClazyContext *context)>;
struct CLAZYLIB_EXPORT RegisteredCheck {
enum Option {
Option_None = 0,
Option_Qt4Incompatible
};
typedef std::vector<RegisteredCheck> List;
typedef int Options;
std::string name;
std::string className;
CheckLevel level;
FactoryFunction factory;
Options options;
bool operator==(const RegisteredCheck &other) const { return name == other.name; }
};
inline bool checkLessThan(const RegisteredCheck &c1, const RegisteredCheck &c2)
{
return c1.name < c2.name;
}
inline bool checkLessThanByLevel(const RegisteredCheck &c1, const RegisteredCheck &c2)
{
if (c1.level == c2.level)
return checkLessThan(c1, c2);
return c1.level < c2.level;
}
class CLAZYLIB_EXPORT CheckManager
{
public:
/**
* @note You must hold the CheckManager lock when operating on the instance
*
* @sa lock()
*/
static CheckManager *instance();
static std::mutex &lock() { return m_lock; }
int registerCheck(const std::string &name, const std::string &className,
CheckLevel level, const FactoryFunction &, RegisteredCheck::Options = RegisteredCheck::Option_None);
int registerFixIt(int id, const std::string &fititName, const std::string &checkName);
RegisteredCheck::List availableChecks(CheckLevel maxLevel) const;
RegisteredCheck::List requestedChecksThroughEnv(const ClazyContext *context) const;
RegisteredCheck::List requestedChecksThroughEnv(const ClazyContext *context, std::vector<std::string> &userDisabledChecks) const;
RegisteredCheck::List::const_iterator checkForName(const RegisteredCheck::List &checks, const std::string &name) const;
RegisteredCheck::List checksForCommaSeparatedString(const std::string &str) const;
RegisteredCheck::List checksForCommaSeparatedString(const std::string &str,
std::vector<std::string> &userDisabledChecks) const;
RegisteredFixIt::List availableFixIts(const std::string &checkName) const;
/**
* Returns all the requested checks.
* This is a union of the requested checks via env variable and via arguments passed to compiler
*/
RegisteredCheck::List requestedChecks(const ClazyContext *context, std::vector<std::string> &args);
CheckBase::List createChecks(const RegisteredCheck::List &requestedChecks, ClazyContext *context);
static void removeChecksFromList(RegisteredCheck::List &list, std::vector<std::string> &checkNames);
private:
CheckManager();
static std::mutex m_lock;
bool checkExists(const std::string &name) const;
RegisteredCheck::List checksForLevel(int level) const;
bool isReservedCheckName(const std::string &name) const;
CheckBase* createCheck(const std::string &name, ClazyContext *context);
std::string checkNameForFixIt(const std::string &) const;
RegisteredCheck::List m_registeredChecks;
std::unordered_map<std::string, std::vector<RegisteredFixIt> > m_fixitsByCheckName;
std::unordered_map<std::string, RegisteredFixIt > m_fixitByName;
};
#define CLAZY_STRINGIFY2(X) #X
#define CLAZY_STRINGIFY(X) CLAZY_STRINGIFY2(X)
#define REGISTER_CHECK_WITH_FLAGS(CHECK_NAME, CLASS_NAME, LEVEL, OPTIONS) \
volatile int ClazyAnchor_##CLASS_NAME = CheckManager::instance()->registerCheck(CHECK_NAME, CLAZY_STRINGIFY(CLASS_NAME), LEVEL, [](ClazyContext *context){ return new CLASS_NAME(CHECK_NAME, context); }, OPTIONS);
#define REGISTER_CHECK(CHECK_NAME, CLASS_NAME, LEVEL) \
volatile int ClazyAnchor_##CLASS_NAME = CheckManager::instance()->registerCheck(CHECK_NAME, CLAZY_STRINGIFY(CLASS_NAME), LEVEL, [](ClazyContext *context){ return new CLASS_NAME(CHECK_NAME, context); });
#define REGISTER_FIXIT(FIXIT_ID, FIXIT_NAME, CHECK_NAME) \
static int dummy_##FIXIT_ID = CheckManager::instance()->registerFixIt(FIXIT_ID, FIXIT_NAME, CHECK_NAME); \
inline void silence_warning_dummy_##FIXIT_ID() { (void)dummy_##FIXIT_ID; }
#endif
|
