clang-tools 18.0.0git
IntegerTypesCheck.cpp
Go to the documentation of this file.
1//===--- IntegerTypesCheck.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 "IntegerTypesCheck.h"
10#include "clang/AST/ASTContext.h"
11#include "clang/ASTMatchers/ASTMatchFinder.h"
12#include "clang/ASTMatchers/ASTMatchers.h"
13#include "clang/Basic/AttrKinds.h"
14#include "clang/Basic/CharInfo.h"
15#include "clang/Basic/IdentifierTable.h"
16#include "clang/Basic/TargetInfo.h"
17#include "clang/Lex/Lexer.h"
18
19namespace clang {
20
21using namespace ast_matchers;
22
23static Token getTokenAtLoc(SourceLocation Loc,
24 const MatchFinder::MatchResult &MatchResult,
25 IdentifierTable &IdentTable) {
26 Token Tok;
27 if (Lexer::getRawToken(Loc, Tok, *MatchResult.SourceManager,
28 MatchResult.Context->getLangOpts(), false))
29 return Tok;
30
31 if (Tok.is(tok::raw_identifier)) {
32 IdentifierInfo &Info = IdentTable.get(Tok.getRawIdentifier());
33 Tok.setIdentifierInfo(&Info);
34 Tok.setKind(Info.getTokenID());
35 }
36 return Tok;
37}
38
39namespace tidy::google::runtime {
40
42 : ClangTidyCheck(Name, Context),
43 UnsignedTypePrefix(Options.get("UnsignedTypePrefix", "uint")),
44 SignedTypePrefix(Options.get("SignedTypePrefix", "int")),
45 TypeSuffix(Options.get("TypeSuffix", "")) {}
46
48 Options.store(Opts, "UnsignedTypePrefix", UnsignedTypePrefix);
49 Options.store(Opts, "SignedTypePrefix", SignedTypePrefix);
50 Options.store(Opts, "TypeSuffix", TypeSuffix);
51}
52
53void IntegerTypesCheck::registerMatchers(MatchFinder *Finder) {
54 // Match any integer types, unless they are passed to a printf-based API:
55 //
56 // http://google.github.io/styleguide/cppguide.html#64-bit_Portability
57 // "Where possible, avoid passing arguments of types specified by
58 // bitwidth typedefs to printf-based APIs."
59 Finder->addMatcher(typeLoc(loc(isInteger()),
60 unless(hasAncestor(callExpr(
61 callee(functionDecl(hasAttr(attr::Format)))))))
62 .bind("tl"),
63 this);
64 IdentTable = std::make_unique<IdentifierTable>(getLangOpts());
65}
66
67void IntegerTypesCheck::check(const MatchFinder::MatchResult &Result) {
68 auto TL = *Result.Nodes.getNodeAs<TypeLoc>("tl");
69 SourceLocation Loc = TL.getBeginLoc();
70
71 if (Loc.isInvalid() || Loc.isMacroID())
72 return;
73
74 // Look through qualification.
75 if (auto QualLoc = TL.getAs<QualifiedTypeLoc>())
76 TL = QualLoc.getUnqualifiedLoc();
77
78 auto BuiltinLoc = TL.getAs<BuiltinTypeLoc>();
79 if (!BuiltinLoc)
80 return;
81
82 Token Tok = getTokenAtLoc(Loc, Result, *IdentTable);
83 // Ensure the location actually points to one of the builting integral type
84 // names we're interested in. Otherwise, we might be getting this match from
85 // implicit code (e.g. an implicit assignment operator of a class containing
86 // an array of non-POD types).
87 if (!Tok.isOneOf(tok::kw_short, tok::kw_long, tok::kw_unsigned,
88 tok::kw_signed))
89 return;
90
91 bool IsSigned = false;
92 unsigned Width = 0;
93 const TargetInfo &TargetInfo = Result.Context->getTargetInfo();
94
95 // Look for uses of short, long, long long and their unsigned versions.
96 switch (BuiltinLoc.getTypePtr()->getKind()) {
97 case BuiltinType::Short:
98 Width = TargetInfo.getShortWidth();
99 IsSigned = true;
100 break;
101 case BuiltinType::Long:
102 Width = TargetInfo.getLongWidth();
103 IsSigned = true;
104 break;
105 case BuiltinType::LongLong:
106 Width = TargetInfo.getLongLongWidth();
107 IsSigned = true;
108 break;
109 case BuiltinType::UShort:
110 Width = TargetInfo.getShortWidth();
111 IsSigned = false;
112 break;
113 case BuiltinType::ULong:
114 Width = TargetInfo.getLongWidth();
115 IsSigned = false;
116 break;
117 case BuiltinType::ULongLong:
118 Width = TargetInfo.getLongLongWidth();
119 IsSigned = false;
120 break;
121 default:
122 return;
123 }
124
125 // We allow "unsigned short port" as that's reasonably common and required by
126 // the sockets API.
127 const StringRef Port = "unsigned short port";
128 const char *Data = Result.SourceManager->getCharacterData(Loc);
129 if (!std::strncmp(Data, Port.data(), Port.size()) &&
130 !isAsciiIdentifierContinue(Data[Port.size()]))
131 return;
132
133 std::string Replacement =
134 ((IsSigned ? SignedTypePrefix : UnsignedTypePrefix) + Twine(Width) +
135 TypeSuffix)
136 .str();
137
138 // We don't add a fix-it as changing the type can easily break code,
139 // e.g. when a function requires a 'long' argument on all platforms.
140 // QualTypes are printed with implicit quotes.
141 diag(Loc, "consider replacing %0 with '%1'") << BuiltinLoc.getType()
142 << Replacement;
143}
144
145} // namespace tidy::google::runtime
146} // namespace clang
FunctionInfo Info
llvm::StringRef Name
SourceLocation Loc
void store(ClangTidyOptions::OptionMap &Options, StringRef LocalName, StringRef Value) const
Stores an option with the check-local name LocalName with string value Value to Options.
Base class for all clang-tidy checks.
DiagnosticBuilder diag(SourceLocation Loc, StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning)
Add a diagnostic with the check's name.
const LangOptions & getLangOpts() const
Returns the language options from the context.
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
IntegerTypesCheck(StringRef Name, ClangTidyContext *Context)
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
static Token getTokenAtLoc(SourceLocation Loc, const MatchFinder::MatchResult &MatchResult, IdentifierTable &IdentTable)
llvm::StringMap< ClangTidyValue > OptionMap