dan*_*ard 10 c++ clang abstract-syntax-tree oclint libtooling
我正在尝试创建一个匹配typedef enum和typedef NS_ENUM声明的OCLint规则,但收效甚微.我有一个Objective-C文件(TestClass.m),其中包含以下枚举声明:
typedef NS_ENUM(NSInteger, TestEnum) {
TestEnumNone,
TestEnumSome,
TestEnumAll
};
typedef enum {
othertestvalue = 0,
othertestvalue1,
othertestvalue2
} OtherTestEnum;
Run Code Online (Sandbox Code Playgroud)
使用此命令转储AST:
clang -Xclang -ast-dump -fsyntax-only Classes/TestClass.m -- | grep Enum
Run Code Online (Sandbox Code Playgroud)
给我这个输出包含这个:
|-TypedefDecl 0x7f9d3accd630 <col:1, col:28> col:28 TestEnum 'enum TestEnum':'enum TestEnum'
|-EnumDecl 0x7f9d3accd6a8 prev 0x7f9d3accd530 </System/Library/Frameworks/CoreFoundation.framework/Headers/CFAvailability.h:171:57, Classes/TestClass.m:71:1> line:67:28 TestEnum 'NSInteger':'long'
| |-EnumConstantDecl 0x7f9d3accd738 <line:68:5> col:5 TestEnumNone 'NSInteger':'long'
| |-EnumConstantDecl 0x7f9d3accd788 <line:69:5> col:5 TestEnumSome 'NSInteger':'long'
| `-EnumConstantDecl 0x7f9d3accd7d8 <line:70:5> col:5 TestEnumAll 'NSInteger':'long'
|-EnumDecl 0x7f9d3accd828 <line:73:9, line:77:1> line:73:9
| |-EnumConstantDecl 0x7f9d3accd900 <line:74:5, col:22> col:5 othertestvalue 'int'
| |-EnumConstantDecl 0x7f9d3accd950 <line:75:5> col:5 othertestvalue1 'int'
| `-EnumConstantDecl 0x7f9d3accd9a0 <line:76:5> col:5 othertestvalue2 'int'
|-TypedefDecl 0x7f9d3accda40 <line:73:1, line:77:3> col:3 OtherTestEnum 'enum OtherTestEnum':'OtherTestEnum'
Run Code Online (Sandbox Code Playgroud)
我有一个ASTMatcherRule(ObjCNsEnumRule),我试图匹配它们typedef enum以及typedef NS_ENUM以下代码:
#include "oclint/AbstractASTMatcherRule.h"
#include "oclint/RuleSet.h"
using namespace std;
using namespace clang;
using namespace clang::ast_matchers;
using namespace oclint;
class ObjCNsEnumRuleRule : public AbstractASTMatcherRule
{
public:
virtual const string name() const override
{
return "obj c ns enum rule";
}
virtual int priority() const override
{
return 3;
}
virtual void callback(const MatchFinder::MatchResult &result) override
{
const EnumDecl *enumDecl = result.Nodes.getNodeAs<EnumDecl>("enum");
if (enumDecl) {
addViolation(enumDecl, this, "Found enum");
}
}
virtual void setUpMatcher() override
{
addMatcher(enumDecl().bind("enum"));
}
};
static RuleSet rules(new ObjCNsEnumRuleRule());
Run Code Online (Sandbox Code Playgroud)
但是,当我运行此规则时,我只获得typedef enum声明的输出.
Classes/TestClass.m:73:9: obj c ns enum rule P3 Found enum
Run Code Online (Sandbox Code Playgroud)
我在这做错了什么?两个枚举都显示在AST转储中,但在OCLint规则中只有一个匹配.
编辑
我认为这可能与AST转储有关,显示了在不同源文件中定义EnumDecl的NS_ENUMas(可能是因为NS_ENUM宏),因为我可以匹配typedef,但不能匹配enumdecl.
目前 oclint 中似乎没有办法做到这一点。宏不会暴露于 oclint 规则ASTVisitor或ASTMatcher规则。请参阅此处: https: //github.com/oclint/oclint/issues/148
我最终将其实现为一个简单的SourceCodeReaderRule,如下所示:
#include "oclint/AbstractSourceCodeReaderRule.h"
#include "oclint/RuleSet.h"
#include <iostream>
#include <string>
#include <regex>
using namespace std;
using namespace oclint;
class TypedefEnumStatementRule : public AbstractSourceCodeReaderRule
{
public:
virtual const string name() const override {
return "typedef enum statement";
}
virtual int priority() const override {
return 1;
}
virtual void eachLine(int lineNumber, string line) override {
regex rgx("typedef\\senum");
smatch match;
if (regex_search(line, rgx, regex_constants::match_continuous)) {
string description = "Enums should not be declared with 'typedef enum' use 'typedef NS_ENUM' instead";
addViolation(lineNumber, 1, lineNumber, 1, this, description);
}
}
};
static RuleSet rules(new TypedefEnumStatementRule());
Run Code Online (Sandbox Code Playgroud)