clang-tools
20.0.0git
llvm-project
clang-tools-extra
clang-tidy
readability
EnumInitialValueCheck.h
Go to the documentation of this file.
1
//===--- EnumInitialValueCheck.h - clang-tidy -------------------*- C++ -*-===//
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_ENUMINITIALVALUECHECK_H
10
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_ENUMINITIALVALUECHECK_H
11
12
#include "../ClangTidyCheck.h"
13
14
namespace
clang::tidy::readability
{
15
16
/// Enforces consistent style for enumerators' initialization, covering three
17
/// styles: none, first only, or all initialized explicitly.
18
///
19
/// For the user-facing documentation see:
20
/// http://clang.llvm.org/extra/clang-tidy/checks/readability/enum-initial-value.html
21
class
EnumInitialValueCheck
:
public
ClangTidyCheck
{
22
public
:
23
EnumInitialValueCheck
(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
std::optional<TraversalKind>
getCheckTraversalKind
()
const override
{
28
return
TK_IgnoreUnlessSpelledInSource;
29
}
30
31
private
:
32
const
bool
AllowExplicitZeroFirstInitialValue;
33
const
bool
AllowExplicitSequentialInitialValues;
34
};
35
36
}
// namespace clang::tidy::readability
37
38
#endif
// LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_ENUMINITIALVALUECHECK_H
Name
llvm::SmallString< 256U > Name
Definition:
ChainedComparisonCheck.cpp:42
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition:
ClangTidyCheck.h:53
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition:
ClangTidyDiagnosticConsumer.h:69
clang::tidy::readability::EnumInitialValueCheck
Enforces consistent style for enumerators' initialization, covering three styles: none,...
Definition:
EnumInitialValueCheck.h:21
clang::tidy::readability::EnumInitialValueCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition:
EnumInitialValueCheck.cpp:158
clang::tidy::readability::EnumInitialValueCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition:
EnumInitialValueCheck.cpp:143
clang::tidy::readability::EnumInitialValueCheck::storeOptions
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
Definition:
EnumInitialValueCheck.cpp:136
clang::tidy::readability::EnumInitialValueCheck::getCheckTraversalKind
std::optional< TraversalKind > getCheckTraversalKind() const override
Definition:
EnumInitialValueCheck.h:27
clang::tidy::readability
Definition:
AvoidConstParamsInDecls.cpp:17
clang::tidy::ClangTidyOptions::OptionMap
llvm::StringMap< ClangTidyValue > OptionMap
Definition:
ClangTidyOptions.h:126
Generated on Sat Dec 7 2024 15:50:29 for clang-tools by
1.9.6