clang-tools 23.0.0git
TrailingCommaCheck.h
Go to the documentation of this file.
1//===----------------------------------------------------------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_TRAILINGCOMMACHECK_H
10#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_TRAILINGCOMMACHECK_H
11
12#include "../ClangTidyCheck.h"
13
15
16/// Checks for presence or absence of trailing commas in enum definitions
17/// and initializer lists.
18///
19/// For the user-facing documentation see:
20/// https://clang.llvm.org/extra/clang-tidy/checks/readability/trailing-comma.html
22public:
23 TrailingCommaCheck(StringRef Name, ClangTidyContext *Context);
24 void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
25 void registerMatchers(ast_matchers::MatchFinder *Finder) override;
26 void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
27 bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
28 return LangOpts.CPlusPlus || LangOpts.C99;
29 }
30 std::optional<TraversalKind> getCheckTraversalKind() const override {
31 return TK_IgnoreUnlessSpelledInSource;
32 }
33
35
36private:
37 const CommaPolicyKind SingleLineCommaPolicy;
38 const CommaPolicyKind MultiLineCommaPolicy;
39
40 void checkEnumDecl(const EnumDecl *Enum,
41 const ast_matchers::MatchFinder::MatchResult &Result);
42 void checkInitListExpr(const InitListExpr *InitList,
43 const ast_matchers::MatchFinder::MatchResult &Result);
44
45 // Values correspond to %select{initializer list|enum}0 indices
46 enum DiagKind { InitList = 0, Enum = 1 };
47 void emitDiag(SourceLocation LastLoc, std::optional<Token> Token,
48 DiagKind Kind,
49 const ast_matchers::MatchFinder::MatchResult &Result,
50 CommaPolicyKind Policy);
51};
52
53} // namespace clang::tidy::readability
54
55#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_TRAILINGCOMMACHECK_H
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
std::optional< TraversalKind > getCheckTraversalKind() const override
TrailingCommaCheck(StringRef Name, ClangTidyContext *Context)
void registerMatchers(ast_matchers::MatchFinder *Finder) override
llvm::StringMap< ClangTidyValue > OptionMap