clang-tidy/readability/EnumInitialValueCheck.h

0001 //===--- EnumInitialValueCheck.h - clang-tidy -------------------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_ENUMINITIALVALUECHECK_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_ENUMINITIALVALUECHECK_H
0011
0012 #include "../ClangTidyCheck.h"
0013
0014 namespace clang::tidy::readability {
0015
0016 /// Enforces consistent style for enumerators' initialization, covering three
0017 /// styles: none, first only, or all initialized explicitly.
0018 ///
0019 /// For the user-facing documentation see:
0020 /// http://clang.llvm.org/extra/clang-tidy/checks/readability/enum-initial-value.html
0021 class EnumInitialValueCheck : public ClangTidyCheck {
0022 public:
0023   EnumInitialValueCheck(StringRef Name, ClangTidyContext *Context);
0024   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
0025   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
0026   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
0027   std::optional<TraversalKind> getCheckTraversalKind() const override {
0028     return TK_IgnoreUnlessSpelledInSource;
0029   }
0030
0031 private:
0032   const bool AllowExplicitZeroFirstInitialValue;
0033   const bool AllowExplicitSequentialInitialValues;
0034 };
0035
0036 } // namespace clang::tidy::readability
0037
0038 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_ENUMINITIALVALUECHECK_H