xref: /llvm-project/clang-tools-extra/clang-tidy/llvm/PreferRegisterOverUnsignedCheck.h (revision 4718da506091a37ca4863d979bc541e359b79b10)
1 //===--- PreferRegisterOverUnsignedCheck.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_LLVM_PREFERREGISTEROVERUNSIGNEDCHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_LLVM_PREFERREGISTEROVERUNSIGNEDCHECK_H
11 
12 #include "../ClangTidyCheck.h"
13 
14 namespace clang::tidy::llvm_check {
15 
16 /// Historically, LLVM has used `unsigned` to represent registers. Since then
17 /// a `Register` object has been introduced for improved type-safety and make
18 /// the code more explicit.
19 ///
20 /// For the user-facing documentation see:
21 /// http://clang.llvm.org/extra/clang-tidy/checks/llvm/prefer-register-over-unsigned.html
22 class PreferRegisterOverUnsignedCheck : public ClangTidyCheck {
23 public:
PreferRegisterOverUnsignedCheck(StringRef Name,ClangTidyContext * Context)24   PreferRegisterOverUnsignedCheck(StringRef Name, ClangTidyContext *Context)
25       : ClangTidyCheck(Name, Context) {}
26   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
27   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
28 };
29 
30 } // namespace clang::tidy::llvm_check
31 
32 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_LLVM_PREFERREGISTEROVERUNSIGNEDCHECK_H
33