clang-tools  14.0.0git
StructPackAlignCheck.h
Go to the documentation of this file.
1 //===--- StructPackAlignCheck.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_ALTERA_STRUCTPACKALIGNCHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ALTERA_STRUCTPACKALIGNCHECK_H
11 
12 #include "../ClangTidyCheck.h"
13 
14 namespace clang {
15 namespace tidy {
16 namespace altera {
17 
18 /// Finds structs that are inefficiently packed or aligned, and recommends
19 /// packing and/or aligning of said structs as needed.
20 ///
21 /// For the user-facing documentation see:
22 /// http://clang.llvm.org/extra/clang-tidy/checks/altera-struct-pack-align.html
24 public:
26  : ClangTidyCheck(Name, Context),
27  MaxConfiguredAlignment(Options.get("MaxConfiguredAlignment", 128)) {}
28  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
29  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
30  void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
31 
32 private:
33  const unsigned MaxConfiguredAlignment;
34  CharUnits computeRecommendedAlignment(CharUnits MinByteSize);
35 };
36 
37 } // namespace altera
38 } // namespace tidy
39 } // namespace clang
40 
41 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ALTERA_STRUCTPACKALIGNCHECK_H
clang::tidy::ClangTidyOptions::OptionMap
llvm::StringMap< ClangTidyValue > OptionMap
Definition: ClangTidyOptions.h:115
clang::tidy::altera::StructPackAlignCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: StructPackAlignCheck.cpp:21
clang::tidy::altera::StructPackAlignCheck::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: StructPackAlignCheck.cpp:141
clang::tidy::altera::StructPackAlignCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: StructPackAlignCheck.cpp:46
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::altera::StructPackAlignCheck
Finds structs that are inefficiently packed or aligned, and recommends packing and/or aligning of sai...
Definition: StructPackAlignCheck.h:23
clang::tidy::altera::StructPackAlignCheck::StructPackAlignCheck
StructPackAlignCheck(StringRef Name, ClangTidyContext *Context)
Definition: StructPackAlignCheck.h:25
clang::tidy::ClangTidyCheck::Options
OptionsView Options
Definition: ClangTidyCheck.h:416
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:72
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27