clang-tools  15.0.0git
MisleadingIdentifier.cpp
Go to the documentation of this file.
1 //===--- MisleadingIdentifier.cpp - clang-tidy-----------------------------===//
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 #include "MisleadingIdentifier.h"
10 
11 #include "clang/Frontend/CompilerInstance.h"
12 #include "llvm/Support/ConvertUTF.h"
13 
14 namespace clang {
15 namespace tidy {
16 namespace misc {
17 
18 // See https://www.unicode.org/Public/14.0.0/ucd/extracted/DerivedBidiClass.txt
19 static bool isUnassignedAL(llvm::UTF32 CP) {
20  return (0x0600 <= CP && CP <= 0x07BF) || (0x0860 <= CP && CP <= 0x08FF) ||
21  (0xFB50 <= CP && CP <= 0xFDCF) || (0xFDF0 <= CP && CP <= 0xFDFF) ||
22  (0xFE70 <= CP && CP <= 0xFEFF) ||
23  (0x00010D00 <= CP && CP <= 0x00010D3F) ||
24  (0x00010F30 <= CP && CP <= 0x00010F6F) ||
25  (0x0001EC70 <= CP && CP <= 0x0001ECBF) ||
26  (0x0001ED00 <= CP && CP <= 0x0001ED4F) ||
27  (0x0001EE00 <= CP && CP <= 0x0001EEFF);
28 }
29 
30 // See https://www.unicode.org/Public/14.0.0/ucd/extracted/DerivedBidiClass.txt
31 static bool isUnassignedR(llvm::UTF32 CP) {
32  return (0x0590 <= CP && CP <= 0x05FF) || (0x07C0 <= CP && CP <= 0x085F) ||
33  (0xFB1D <= CP && CP <= 0xFB4F) ||
34  (0x00010800 <= CP && CP <= 0x00010CFF) ||
35  (0x00010D40 <= CP && CP <= 0x00010F2F) ||
36  (0x00010F70 <= CP && CP <= 0x00010FFF) ||
37  (0x0001E800 <= CP && CP <= 0x0001EC6F) ||
38  (0x0001ECC0 <= CP && CP <= 0x0001ECFF) ||
39  (0x0001ED50 <= CP && CP <= 0x0001EDFF) ||
40  (0x0001EF00 <= CP && CP <= 0x0001EFFF);
41 }
42 
43 // See https://www.unicode.org/Public/14.0.0/ucd/extracted/DerivedBidiClass.txt
44 static bool isR(llvm::UTF32 CP) {
45  return (CP == 0x0590) || (CP == 0x05BE) || (CP == 0x05C0) || (CP == 0x05C3) ||
46  (CP == 0x05C6) || (0x05C8 <= CP && CP <= 0x05CF) ||
47  (0x05D0 <= CP && CP <= 0x05EA) || (0x05EB <= CP && CP <= 0x05EE) ||
48  (0x05EF <= CP && CP <= 0x05F2) || (0x05F3 <= CP && CP <= 0x05F4) ||
49  (0x05F5 <= CP && CP <= 0x05FF) || (0x07C0 <= CP && CP <= 0x07C9) ||
50  (0x07CA <= CP && CP <= 0x07EA) || (0x07F4 <= CP && CP <= 0x07F5) ||
51  (CP == 0x07FA) || (0x07FB <= CP && CP <= 0x07FC) ||
52  (0x07FE <= CP && CP <= 0x07FF) || (0x0800 <= CP && CP <= 0x0815) ||
53  (CP == 0x081A) || (CP == 0x0824) || (CP == 0x0828) ||
54  (0x082E <= CP && CP <= 0x082F) || (0x0830 <= CP && CP <= 0x083E) ||
55  (CP == 0x083F) || (0x0840 <= CP && CP <= 0x0858) ||
56  (0x085C <= CP && CP <= 0x085D) || (CP == 0x085E) || (CP == 0x085F) ||
57  (CP == 0x200F) || (CP == 0xFB1D) || (0xFB1F <= CP && CP <= 0xFB28) ||
58  (0xFB2A <= CP && CP <= 0xFB36) || (CP == 0xFB37) ||
59  (0xFB38 <= CP && CP <= 0xFB3C) || (CP == 0xFB3D) || (CP == 0xFB3E) ||
60  (CP == 0xFB3F) || (0xFB40 <= CP && CP <= 0xFB41) || (CP == 0xFB42) ||
61  (0xFB43 <= CP && CP <= 0xFB44) || (CP == 0xFB45) ||
62  (0xFB46 <= CP && CP <= 0xFB4F) || (0x10800 <= CP && CP <= 0x10805) ||
63  (0x10806 <= CP && CP <= 0x10807) || (CP == 0x10808) ||
64  (CP == 0x10809) || (0x1080A <= CP && CP <= 0x10835) ||
65  (CP == 0x10836) || (0x10837 <= CP && CP <= 0x10838) ||
66  (0x10839 <= CP && CP <= 0x1083B) || (CP == 0x1083C) ||
67  (0x1083D <= CP && CP <= 0x1083E) || (0x1083F <= CP && CP <= 0x10855) ||
68  (CP == 0x10856) || (CP == 0x10857) ||
69  (0x10858 <= CP && CP <= 0x1085F) || (0x10860 <= CP && CP <= 0x10876) ||
70  (0x10877 <= CP && CP <= 0x10878) || (0x10879 <= CP && CP <= 0x1087F) ||
71  (0x10880 <= CP && CP <= 0x1089E) || (0x1089F <= CP && CP <= 0x108A6) ||
72  (0x108A7 <= CP && CP <= 0x108AF) || (0x108B0 <= CP && CP <= 0x108DF) ||
73  (0x108E0 <= CP && CP <= 0x108F2) || (CP == 0x108F3) ||
74  (0x108F4 <= CP && CP <= 0x108F5) || (0x108F6 <= CP && CP <= 0x108FA) ||
75  (0x108FB <= CP && CP <= 0x108FF) || (0x10900 <= CP && CP <= 0x10915) ||
76  (0x10916 <= CP && CP <= 0x1091B) || (0x1091C <= CP && CP <= 0x1091E) ||
77  (0x10920 <= CP && CP <= 0x10939) || (0x1093A <= CP && CP <= 0x1093E) ||
78  (CP == 0x1093F) || (0x10940 <= CP && CP <= 0x1097F) ||
79  (0x10980 <= CP && CP <= 0x109B7) || (0x109B8 <= CP && CP <= 0x109BB) ||
80  (0x109BC <= CP && CP <= 0x109BD) || (0x109BE <= CP && CP <= 0x109BF) ||
81  (0x109C0 <= CP && CP <= 0x109CF) || (0x109D0 <= CP && CP <= 0x109D1) ||
82  (0x109D2 <= CP && CP <= 0x109FF) || (CP == 0x10A00) ||
83  (CP == 0x10A04) || (0x10A07 <= CP && CP <= 0x10A0B) ||
84  (0x10A10 <= CP && CP <= 0x10A13) || (CP == 0x10A14) ||
85  (0x10A15 <= CP && CP <= 0x10A17) || (CP == 0x10A18) ||
86  (0x10A19 <= CP && CP <= 0x10A35) || (0x10A36 <= CP && CP <= 0x10A37) ||
87  (0x10A3B <= CP && CP <= 0x10A3E) || (0x10A40 <= CP && CP <= 0x10A48) ||
88  (0x10A49 <= CP && CP <= 0x10A4F) || (0x10A50 <= CP && CP <= 0x10A58) ||
89  (0x10A59 <= CP && CP <= 0x10A5F) || (0x10A60 <= CP && CP <= 0x10A7C) ||
90  (0x10A7D <= CP && CP <= 0x10A7E) || (CP == 0x10A7F) ||
91  (0x10A80 <= CP && CP <= 0x10A9C) || (0x10A9D <= CP && CP <= 0x10A9F) ||
92  (0x10AA0 <= CP && CP <= 0x10ABF) || (0x10AC0 <= CP && CP <= 0x10AC7) ||
93  (CP == 0x10AC8) || (0x10AC9 <= CP && CP <= 0x10AE4) ||
94  (0x10AE7 <= CP && CP <= 0x10AEA) || (0x10AEB <= CP && CP <= 0x10AEF) ||
95  (0x10AF0 <= CP && CP <= 0x10AF6) || (0x10AF7 <= CP && CP <= 0x10AFF) ||
96  (0x10B00 <= CP && CP <= 0x10B35) || (0x10B36 <= CP && CP <= 0x10B38) ||
97  (0x10B40 <= CP && CP <= 0x10B55) || (0x10B56 <= CP && CP <= 0x10B57) ||
98  (0x10B58 <= CP && CP <= 0x10B5F) || (0x10B60 <= CP && CP <= 0x10B72) ||
99  (0x10B73 <= CP && CP <= 0x10B77) || (0x10B78 <= CP && CP <= 0x10B7F) ||
100  (0x10B80 <= CP && CP <= 0x10B91) || (0x10B92 <= CP && CP <= 0x10B98) ||
101  (0x10B99 <= CP && CP <= 0x10B9C) || (0x10B9D <= CP && CP <= 0x10BA8) ||
102  (0x10BA9 <= CP && CP <= 0x10BAF) || (0x10BB0 <= CP && CP <= 0x10BFF) ||
103  (0x10C00 <= CP && CP <= 0x10C48) || (0x10C49 <= CP && CP <= 0x10C7F) ||
104  (0x10C80 <= CP && CP <= 0x10CB2) || (0x10CB3 <= CP && CP <= 0x10CBF) ||
105  (0x10CC0 <= CP && CP <= 0x10CF2) || (0x10CF3 <= CP && CP <= 0x10CF9) ||
106  (0x10CFA <= CP && CP <= 0x10CFF) || (0x10D40 <= CP && CP <= 0x10E5F) ||
107  (CP == 0x10E7F) || (0x10E80 <= CP && CP <= 0x10EA9) ||
108  (CP == 0x10EAA) || (CP == 0x10EAD) ||
109  (0x10EAE <= CP && CP <= 0x10EAF) || (0x10EB0 <= CP && CP <= 0x10EB1) ||
110  (0x10EB2 <= CP && CP <= 0x10EFF) || (0x10F00 <= CP && CP <= 0x10F1C) ||
111  (0x10F1D <= CP && CP <= 0x10F26) || (CP == 0x10F27) ||
112  (0x10F28 <= CP && CP <= 0x10F2F) || (0x10F70 <= CP && CP <= 0x10F81) ||
113  (0x10F86 <= CP && CP <= 0x10F89) || (0x10F8A <= CP && CP <= 0x10FAF) ||
114  (0x10FB0 <= CP && CP <= 0x10FC4) || (0x10FC5 <= CP && CP <= 0x10FCB) ||
115  (0x10FCC <= CP && CP <= 0x10FDF) || (0x10FE0 <= CP && CP <= 0x10FF6) ||
116  (0x10FF7 <= CP && CP <= 0x10FFF) || (0x1E800 <= CP && CP <= 0x1E8C4) ||
117  (0x1E8C5 <= CP && CP <= 0x1E8C6) || (0x1E8C7 <= CP && CP <= 0x1E8CF) ||
118  (0x1E8D7 <= CP && CP <= 0x1E8FF) || (0x1E900 <= CP && CP <= 0x1E943) ||
119  (CP == 0x1E94B) || (0x1E94C <= CP && CP <= 0x1E94F) ||
120  (0x1E950 <= CP && CP <= 0x1E959) || (0x1E95A <= CP && CP <= 0x1E95D) ||
121  (0x1E95E <= CP && CP <= 0x1E95F) || (0x1E960 <= CP && CP <= 0x1EC6F) ||
122  (0x1ECC0 <= CP && CP <= 0x1ECFF) || (0x1ED50 <= CP && CP <= 0x1EDFF);
123 }
124 
125 static bool hasRTLCharacters(StringRef Buffer) {
126  const char *CurPtr = Buffer.begin();
127  const char *EndPtr = Buffer.end();
128  while (CurPtr < EndPtr) {
129  llvm::UTF32 CodePoint;
130  llvm::ConversionResult Result = llvm::convertUTF8Sequence(
131  (const llvm::UTF8 **)&CurPtr, (const llvm::UTF8 *)EndPtr, &CodePoint,
132  llvm::strictConversion);
133  if (Result != llvm::conversionOK)
134  break;
135  if (isUnassignedAL(CodePoint) || isUnassignedR(CodePoint) || isR(CodePoint))
136  return true;
137  }
138  return false;
139 }
140 
142  ClangTidyContext *Context)
143  : ClangTidyCheck(Name, Context) {}
144 
146 
148  const ast_matchers::MatchFinder::MatchResult &Result) {
149  if (const auto *ND = Result.Nodes.getNodeAs<NamedDecl>("nameddecl")) {
150  IdentifierInfo *II = ND->getIdentifier();
151  if (II) {
152  StringRef NDName = II->getName();
153  if (hasRTLCharacters(NDName))
154  diag(ND->getBeginLoc(), "identifier has right-to-left codepoints");
155  }
156  }
157 }
158 
160  ast_matchers::MatchFinder *Finder) {
161  Finder->addMatcher(ast_matchers::namedDecl().bind("nameddecl"), this);
162 }
163 
164 } // namespace misc
165 } // namespace tidy
166 } // namespace clang
clang::tidy::misc::MisleadingIdentifierCheck::~MisleadingIdentifierCheck
~MisleadingIdentifierCheck()
clang::tidy::misc::isUnassignedR
static bool isUnassignedR(llvm::UTF32 CP)
Definition: MisleadingIdentifier.cpp:31
clang::tidy::misc::MisleadingIdentifierCheck::MisleadingIdentifierCheck
MisleadingIdentifierCheck(StringRef Name, ClangTidyContext *Context)
Definition: MisleadingIdentifier.cpp:141
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:53
clang::tidy::misc::isR
static bool isR(llvm::UTF32 CP)
Definition: MisleadingIdentifier.cpp:44
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:66
clang::tidy::misc::MisleadingIdentifierCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: MisleadingIdentifier.cpp:147
clang::tidy::ClangTidyCheck::diag
DiagnosticBuilder diag(SourceLocation Loc, StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning)
Add a diagnostic with the check's name.
Definition: ClangTidyCheck.cpp:25
Name
Token Name
Definition: MacroToEnumCheck.cpp:89
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
MisleadingIdentifier.h
clang::tidy::misc::isUnassignedAL
static bool isUnassignedAL(llvm::UTF32 CP)
Definition: MisleadingIdentifier.cpp:19
clang::tidy::misc::hasRTLCharacters
static bool hasRTLCharacters(StringRef Buffer)
Definition: MisleadingIdentifier.cpp:125
clang::tidy::misc::MisleadingIdentifierCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: MisleadingIdentifier.cpp:159