summaryrefslogtreecommitdiff
path: root/clang/readability-redundant-pp.cxx
blob: 0ec266e539b24c6431a7bd5d5e48b885f8896495 (plain)
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
#include <iostream>
#include <stack>

#include <clang/Frontend/CompilerInstance.h>
#include <clang/Frontend/FrontendActions.h>
#include <clang/Tooling/CommonOptionsParser.h>
#include <clang/Tooling/Refactoring.h>
#include <llvm/Support/Signals.h>

namespace
{

struct Entry
{
    clang::SourceLocation m_aLoc;
    std::string m_aMacroName;
};

/// Finds preprocessor usage which is redundant (only #ifndef for now).
class RedundantPPCallbacks : public clang::PPCallbacks
{
  public:
    RedundantPPCallbacks(clang::Preprocessor& rPP);
    void Ifndef(clang::SourceLocation aLoc, const clang::Token& rMacroNameTok,
                const clang::MacroDefinition& rMacroDefinition) override;
    void Endif(clang::SourceLocation aLoc,
               clang::SourceLocation aIfLoc) override;
    ~RedundantPPCallbacks() override;

  private:
    clang::DiagnosticBuilder reportWarning(llvm::StringRef aString,
                                           clang::SourceLocation aLocation);
    clang::DiagnosticBuilder report(clang::DiagnosticIDs::Level eLevel,
                                    llvm::StringRef aString,
                                    clang::SourceLocation aLocation);

    clang::Preprocessor& m_rPP;
    std::vector<Entry> m_aStack;
};

RedundantPPCallbacks::RedundantPPCallbacks(clang::Preprocessor& rPP)
    : m_rPP(rPP)
{
}

RedundantPPCallbacks::~RedundantPPCallbacks() {}

void RedundantPPCallbacks::Ifndef(
    clang::SourceLocation aLoc, const clang::Token& rMacroNameTok,
    const clang::MacroDefinition& /*rMacroDefinition*/)
{
    if (m_rPP.getSourceManager().isInMainFile(aLoc))
    {
        std::string aMacroName = m_rPP.getSpelling(rMacroNameTok);
        for (const auto& rEntry : m_aStack)
        {
            if (rEntry.m_aMacroName == aMacroName)
            {
                reportWarning("nested ifdef", aLoc);
                report(clang::DiagnosticIDs::Note, "previous ifdef",
                       rEntry.m_aLoc);
            }
        }
    }

    Entry aEntry;
    aEntry.m_aLoc = aLoc;
    aEntry.m_aMacroName = m_rPP.getSpelling(rMacroNameTok);
    m_aStack.push_back(aEntry);
}

void RedundantPPCallbacks::Endif(clang::SourceLocation /*aLoc*/,
                                 clang::SourceLocation aIfLoc)
{
    if (m_aStack.empty())
        return;

    if (aIfLoc == m_aStack.back().m_aLoc)
        m_aStack.pop_back();
}

clang::DiagnosticBuilder
RedundantPPCallbacks::reportWarning(llvm::StringRef aString,
                                    clang::SourceLocation aLocation)
{
    clang::DiagnosticsEngine& rEngine = m_rPP.getDiagnostics();
    clang::DiagnosticIDs::Level eLevel = clang::DiagnosticIDs::Level::Warning;
    if (rEngine.getWarningsAsErrors())
        eLevel = clang::DiagnosticIDs::Level::Error;
    return report(eLevel, aString, aLocation);
}

clang::DiagnosticBuilder
RedundantPPCallbacks::report(clang::DiagnosticIDs::Level eLevel,
                             llvm::StringRef aString,
                             clang::SourceLocation aLocation)
{
    clang::DiagnosticsEngine& rEngine = m_rPP.getDiagnostics();
    return rEngine.Report(
        aLocation,
        rEngine.getDiagnosticIDs()->getCustomDiagID(eLevel, aString));
}

class RedundantPPConsumer : public clang::ASTConsumer
{
  public:
    RedundantPPConsumer(clang::Preprocessor& rPP)
    {
        rPP.addPPCallbacks(llvm::make_unique<RedundantPPCallbacks>(rPP));
    }
};

class RedundantPPAction : public clang::SyntaxOnlyAction
{
  public:
    RedundantPPAction() {}

  protected:
    std::unique_ptr<clang::ASTConsumer>
    CreateASTConsumer(clang::CompilerInstance& rInstance,
                      StringRef /*aFile*/) override
    {
        return llvm::make_unique<RedundantPPConsumer>(
            rInstance.getPreprocessor());
    }
};

class RedundantPPFrontendActionFactory
    : public clang::tooling::FrontendActionFactory
{
  public:
    RedundantPPFrontendActionFactory() {}

    RedundantPPAction* create() override { return new RedundantPPAction(); }
};

llvm::cl::OptionCategory aCategory("redundant-pp options");
}

int main(int argc, const char** argv)
{
    llvm::sys::PrintStackTraceOnErrorSignal(argv[0]);
    clang::tooling::CommonOptionsParser aOptionsParser(argc, argv, aCategory);
    clang::tooling::RefactoringTool aTool(aOptionsParser.getCompilations(),
                                          aOptionsParser.getSourcePathList());
    RedundantPPFrontendActionFactory aFactory;
    return aTool.run(&aFactory);
}

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */