1 //=- LocalizationChecker.cpp -------------------------------------*- C++ -*-==//
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
7 //===----------------------------------------------------------------------===//
9 // This file defines a set of checks for localizability including:
10 // 1) A checker that warns about uses of non-localized NSStrings passed to
11 // UI methods expecting localized strings
12 // 2) A syntactic checker that warns against the bad practice of
13 // not including a comment in NSLocalizedString macros.
15 //===----------------------------------------------------------------------===//
17 #include "clang/StaticAnalyzer/Checkers/BuiltinCheckerRegistration.h"
18 #include "clang/AST/Attr.h"
19 #include "clang/AST/Decl.h"
20 #include "clang/AST/DeclObjC.h"
21 #include "clang/AST/RecursiveASTVisitor.h"
22 #include "clang/AST/StmtVisitor.h"
23 #include "clang/Lex/Lexer.h"
24 #include "clang/StaticAnalyzer/Core/BugReporter/BugReporter.h"
25 #include "clang/StaticAnalyzer/Core/BugReporter/BugType.h"
26 #include "clang/StaticAnalyzer/Core/Checker.h"
27 #include "clang/StaticAnalyzer/Core/CheckerManager.h"
28 #include "clang/StaticAnalyzer/Core/PathSensitive/CallEvent.h"
29 #include "clang/StaticAnalyzer/Core/PathSensitive/CheckerContext.h"
30 #include "clang/StaticAnalyzer/Core/PathSensitive/ExprEngine.h"
31 #include "llvm/Support/Unicode.h"
33 using namespace clang;
37 struct LocalizedState {
39 enum Kind { NonLocalized, Localized } K;
40 LocalizedState(Kind InK) : K(InK) {}
43 bool isLocalized() const { return K == Localized; }
44 bool isNonLocalized() const { return K == NonLocalized; }
46 static LocalizedState getLocalized() { return LocalizedState(Localized); }
47 static LocalizedState getNonLocalized() {
48 return LocalizedState(NonLocalized);
51 // Overload the == operator
52 bool operator==(const LocalizedState &X) const { return K == X.K; }
54 // LLVMs equivalent of a hash function
55 void Profile(llvm::FoldingSetNodeID &ID) const { ID.AddInteger(K); }
58 class NonLocalizedStringChecker
59 : public Checker<check::PreCall, check::PostCall, check::PreObjCMessage,
60 check::PostObjCMessage,
61 check::PostStmt<ObjCStringLiteral>> {
63 mutable std::unique_ptr<BugType> BT;
65 // Methods that require a localized string
66 mutable llvm::DenseMap<const IdentifierInfo *,
67 llvm::DenseMap<Selector, uint8_t>> UIMethods;
68 // Methods that return a localized string
69 mutable llvm::SmallSet<std::pair<const IdentifierInfo *, Selector>, 12> LSM;
70 // C Functions that return a localized string
71 mutable llvm::SmallSet<const IdentifierInfo *, 5> LSF;
73 void initUIMethods(ASTContext &Ctx) const;
74 void initLocStringsMethods(ASTContext &Ctx) const;
76 bool hasNonLocalizedState(SVal S, CheckerContext &C) const;
77 bool hasLocalizedState(SVal S, CheckerContext &C) const;
78 void setNonLocalizedState(SVal S, CheckerContext &C) const;
79 void setLocalizedState(SVal S, CheckerContext &C) const;
81 bool isAnnotatedAsReturningLocalized(const Decl *D) const;
82 bool isAnnotatedAsTakingLocalized(const Decl *D) const;
83 void reportLocalizationError(SVal S, const CallEvent &M, CheckerContext &C,
84 int argumentNumber = 0) const;
86 int getLocalizedArgumentForSelector(const IdentifierInfo *Receiver,
90 NonLocalizedStringChecker();
92 // When this parameter is set to true, the checker assumes all
93 // methods that return NSStrings are unlocalized. Thus, more false
94 // positives will be reported.
95 DefaultBool IsAggressive;
97 void checkPreObjCMessage(const ObjCMethodCall &msg, CheckerContext &C) const;
98 void checkPostObjCMessage(const ObjCMethodCall &msg, CheckerContext &C) const;
99 void checkPostStmt(const ObjCStringLiteral *SL, CheckerContext &C) const;
100 void checkPreCall(const CallEvent &Call, CheckerContext &C) const;
101 void checkPostCall(const CallEvent &Call, CheckerContext &C) const;
104 } // end anonymous namespace
106 REGISTER_MAP_WITH_PROGRAMSTATE(LocalizedMemMap, const MemRegion *,
109 NonLocalizedStringChecker::NonLocalizedStringChecker() {
110 BT.reset(new BugType(this, "Unlocalizable string",
111 "Localizability Issue (Apple)"));
115 class NonLocalizedStringBRVisitor final : public BugReporterVisitor {
117 const MemRegion *NonLocalizedString;
121 NonLocalizedStringBRVisitor(const MemRegion *NonLocalizedString)
122 : NonLocalizedString(NonLocalizedString), Satisfied(false) {
123 assert(NonLocalizedString);
126 PathDiagnosticPieceRef VisitNode(const ExplodedNode *Succ,
127 BugReporterContext &BRC,
128 PathSensitiveBugReport &BR) override;
130 void Profile(llvm::FoldingSetNodeID &ID) const override {
131 ID.Add(NonLocalizedString);
134 } // End anonymous namespace.
136 #define NEW_RECEIVER(receiver) \
137 llvm::DenseMap<Selector, uint8_t> &receiver##M = \
138 UIMethods.insert({&Ctx.Idents.get(#receiver), \
139 llvm::DenseMap<Selector, uint8_t>()}) \
141 #define ADD_NULLARY_METHOD(receiver, method, argument) \
142 receiver##M.insert( \
143 {Ctx.Selectors.getNullarySelector(&Ctx.Idents.get(#method)), argument});
144 #define ADD_UNARY_METHOD(receiver, method, argument) \
145 receiver##M.insert( \
146 {Ctx.Selectors.getUnarySelector(&Ctx.Idents.get(#method)), argument});
147 #define ADD_METHOD(receiver, method_list, count, argument) \
148 receiver##M.insert({Ctx.Selectors.getSelector(count, method_list), argument});
150 /// Initializes a list of methods that require a localized string
151 /// Format: {"ClassName", {{"selectorName:", LocStringArg#}, ...}, ...}
152 void NonLocalizedStringChecker::initUIMethods(ASTContext &Ctx) const {
153 if (!UIMethods.empty())
157 NEW_RECEIVER(UISearchDisplayController)
158 ADD_UNARY_METHOD(UISearchDisplayController, setSearchResultsTitle, 0)
160 NEW_RECEIVER(UITabBarItem)
161 IdentifierInfo *initWithTitleUITabBarItemTag[] = {
162 &Ctx.Idents.get("initWithTitle"), &Ctx.Idents.get("image"),
163 &Ctx.Idents.get("tag")};
164 ADD_METHOD(UITabBarItem, initWithTitleUITabBarItemTag, 3, 0)
165 IdentifierInfo *initWithTitleUITabBarItemImage[] = {
166 &Ctx.Idents.get("initWithTitle"), &Ctx.Idents.get("image"),
167 &Ctx.Idents.get("selectedImage")};
168 ADD_METHOD(UITabBarItem, initWithTitleUITabBarItemImage, 3, 0)
170 NEW_RECEIVER(NSDockTile)
171 ADD_UNARY_METHOD(NSDockTile, setBadgeLabel, 0)
173 NEW_RECEIVER(NSStatusItem)
174 ADD_UNARY_METHOD(NSStatusItem, setTitle, 0)
175 ADD_UNARY_METHOD(NSStatusItem, setToolTip, 0)
177 NEW_RECEIVER(UITableViewRowAction)
178 IdentifierInfo *rowActionWithStyleUITableViewRowAction[] = {
179 &Ctx.Idents.get("rowActionWithStyle"), &Ctx.Idents.get("title"),
180 &Ctx.Idents.get("handler")};
181 ADD_METHOD(UITableViewRowAction, rowActionWithStyleUITableViewRowAction, 3, 1)
182 ADD_UNARY_METHOD(UITableViewRowAction, setTitle, 0)
185 ADD_UNARY_METHOD(NSBox, setTitle, 0)
187 NEW_RECEIVER(NSButton)
188 ADD_UNARY_METHOD(NSButton, setTitle, 0)
189 ADD_UNARY_METHOD(NSButton, setAlternateTitle, 0)
190 IdentifierInfo *radioButtonWithTitleNSButton[] = {
191 &Ctx.Idents.get("radioButtonWithTitle"), &Ctx.Idents.get("target"),
192 &Ctx.Idents.get("action")};
193 ADD_METHOD(NSButton, radioButtonWithTitleNSButton, 3, 0)
194 IdentifierInfo *buttonWithTitleNSButtonImage[] = {
195 &Ctx.Idents.get("buttonWithTitle"), &Ctx.Idents.get("image"),
196 &Ctx.Idents.get("target"), &Ctx.Idents.get("action")};
197 ADD_METHOD(NSButton, buttonWithTitleNSButtonImage, 4, 0)
198 IdentifierInfo *checkboxWithTitleNSButton[] = {
199 &Ctx.Idents.get("checkboxWithTitle"), &Ctx.Idents.get("target"),
200 &Ctx.Idents.get("action")};
201 ADD_METHOD(NSButton, checkboxWithTitleNSButton, 3, 0)
202 IdentifierInfo *buttonWithTitleNSButtonTarget[] = {
203 &Ctx.Idents.get("buttonWithTitle"), &Ctx.Idents.get("target"),
204 &Ctx.Idents.get("action")};
205 ADD_METHOD(NSButton, buttonWithTitleNSButtonTarget, 3, 0)
207 NEW_RECEIVER(NSSavePanel)
208 ADD_UNARY_METHOD(NSSavePanel, setPrompt, 0)
209 ADD_UNARY_METHOD(NSSavePanel, setTitle, 0)
210 ADD_UNARY_METHOD(NSSavePanel, setNameFieldLabel, 0)
211 ADD_UNARY_METHOD(NSSavePanel, setNameFieldStringValue, 0)
212 ADD_UNARY_METHOD(NSSavePanel, setMessage, 0)
214 NEW_RECEIVER(UIPrintInfo)
215 ADD_UNARY_METHOD(UIPrintInfo, setJobName, 0)
217 NEW_RECEIVER(NSTabViewItem)
218 ADD_UNARY_METHOD(NSTabViewItem, setLabel, 0)
219 ADD_UNARY_METHOD(NSTabViewItem, setToolTip, 0)
221 NEW_RECEIVER(NSBrowser)
222 IdentifierInfo *setTitleNSBrowser[] = {&Ctx.Idents.get("setTitle"),
223 &Ctx.Idents.get("ofColumn")};
224 ADD_METHOD(NSBrowser, setTitleNSBrowser, 2, 0)
226 NEW_RECEIVER(UIAccessibilityElement)
227 ADD_UNARY_METHOD(UIAccessibilityElement, setAccessibilityLabel, 0)
228 ADD_UNARY_METHOD(UIAccessibilityElement, setAccessibilityHint, 0)
229 ADD_UNARY_METHOD(UIAccessibilityElement, setAccessibilityValue, 0)
231 NEW_RECEIVER(UIAlertAction)
232 IdentifierInfo *actionWithTitleUIAlertAction[] = {
233 &Ctx.Idents.get("actionWithTitle"), &Ctx.Idents.get("style"),
234 &Ctx.Idents.get("handler")};
235 ADD_METHOD(UIAlertAction, actionWithTitleUIAlertAction, 3, 0)
237 NEW_RECEIVER(NSPopUpButton)
238 ADD_UNARY_METHOD(NSPopUpButton, addItemWithTitle, 0)
239 IdentifierInfo *insertItemWithTitleNSPopUpButton[] = {
240 &Ctx.Idents.get("insertItemWithTitle"), &Ctx.Idents.get("atIndex")};
241 ADD_METHOD(NSPopUpButton, insertItemWithTitleNSPopUpButton, 2, 0)
242 ADD_UNARY_METHOD(NSPopUpButton, removeItemWithTitle, 0)
243 ADD_UNARY_METHOD(NSPopUpButton, selectItemWithTitle, 0)
244 ADD_UNARY_METHOD(NSPopUpButton, setTitle, 0)
246 NEW_RECEIVER(NSTableViewRowAction)
247 IdentifierInfo *rowActionWithStyleNSTableViewRowAction[] = {
248 &Ctx.Idents.get("rowActionWithStyle"), &Ctx.Idents.get("title"),
249 &Ctx.Idents.get("handler")};
250 ADD_METHOD(NSTableViewRowAction, rowActionWithStyleNSTableViewRowAction, 3, 1)
251 ADD_UNARY_METHOD(NSTableViewRowAction, setTitle, 0)
253 NEW_RECEIVER(NSImage)
254 ADD_UNARY_METHOD(NSImage, setAccessibilityDescription, 0)
256 NEW_RECEIVER(NSUserActivity)
257 ADD_UNARY_METHOD(NSUserActivity, setTitle, 0)
259 NEW_RECEIVER(NSPathControlItem)
260 ADD_UNARY_METHOD(NSPathControlItem, setTitle, 0)
263 ADD_UNARY_METHOD(NSCell, initTextCell, 0)
264 ADD_UNARY_METHOD(NSCell, setTitle, 0)
265 ADD_UNARY_METHOD(NSCell, setStringValue, 0)
267 NEW_RECEIVER(NSPathControl)
268 ADD_UNARY_METHOD(NSPathControl, setPlaceholderString, 0)
270 NEW_RECEIVER(UIAccessibility)
271 ADD_UNARY_METHOD(UIAccessibility, setAccessibilityLabel, 0)
272 ADD_UNARY_METHOD(UIAccessibility, setAccessibilityHint, 0)
273 ADD_UNARY_METHOD(UIAccessibility, setAccessibilityValue, 0)
275 NEW_RECEIVER(NSTableColumn)
276 ADD_UNARY_METHOD(NSTableColumn, setTitle, 0)
277 ADD_UNARY_METHOD(NSTableColumn, setHeaderToolTip, 0)
279 NEW_RECEIVER(NSSegmentedControl)
280 IdentifierInfo *setLabelNSSegmentedControl[] = {
281 &Ctx.Idents.get("setLabel"), &Ctx.Idents.get("forSegment")};
282 ADD_METHOD(NSSegmentedControl, setLabelNSSegmentedControl, 2, 0)
283 IdentifierInfo *setToolTipNSSegmentedControl[] = {
284 &Ctx.Idents.get("setToolTip"), &Ctx.Idents.get("forSegment")};
285 ADD_METHOD(NSSegmentedControl, setToolTipNSSegmentedControl, 2, 0)
287 NEW_RECEIVER(NSButtonCell)
288 ADD_UNARY_METHOD(NSButtonCell, setTitle, 0)
289 ADD_UNARY_METHOD(NSButtonCell, setAlternateTitle, 0)
291 NEW_RECEIVER(NSDatePickerCell)
292 ADD_UNARY_METHOD(NSDatePickerCell, initTextCell, 0)
294 NEW_RECEIVER(NSSliderCell)
295 ADD_UNARY_METHOD(NSSliderCell, setTitle, 0)
297 NEW_RECEIVER(NSControl)
298 ADD_UNARY_METHOD(NSControl, setStringValue, 0)
300 NEW_RECEIVER(NSAccessibility)
301 ADD_UNARY_METHOD(NSAccessibility, setAccessibilityValueDescription, 0)
302 ADD_UNARY_METHOD(NSAccessibility, setAccessibilityLabel, 0)
303 ADD_UNARY_METHOD(NSAccessibility, setAccessibilityTitle, 0)
304 ADD_UNARY_METHOD(NSAccessibility, setAccessibilityPlaceholderValue, 0)
305 ADD_UNARY_METHOD(NSAccessibility, setAccessibilityHelp, 0)
307 NEW_RECEIVER(NSMatrix)
308 IdentifierInfo *setToolTipNSMatrix[] = {&Ctx.Idents.get("setToolTip"),
309 &Ctx.Idents.get("forCell")};
310 ADD_METHOD(NSMatrix, setToolTipNSMatrix, 2, 0)
312 NEW_RECEIVER(NSPrintPanel)
313 ADD_UNARY_METHOD(NSPrintPanel, setDefaultButtonTitle, 0)
315 NEW_RECEIVER(UILocalNotification)
316 ADD_UNARY_METHOD(UILocalNotification, setAlertBody, 0)
317 ADD_UNARY_METHOD(UILocalNotification, setAlertAction, 0)
318 ADD_UNARY_METHOD(UILocalNotification, setAlertTitle, 0)
320 NEW_RECEIVER(NSSlider)
321 ADD_UNARY_METHOD(NSSlider, setTitle, 0)
323 NEW_RECEIVER(UIMenuItem)
324 IdentifierInfo *initWithTitleUIMenuItem[] = {&Ctx.Idents.get("initWithTitle"),
325 &Ctx.Idents.get("action")};
326 ADD_METHOD(UIMenuItem, initWithTitleUIMenuItem, 2, 0)
327 ADD_UNARY_METHOD(UIMenuItem, setTitle, 0)
329 NEW_RECEIVER(UIAlertController)
330 IdentifierInfo *alertControllerWithTitleUIAlertController[] = {
331 &Ctx.Idents.get("alertControllerWithTitle"), &Ctx.Idents.get("message"),
332 &Ctx.Idents.get("preferredStyle")};
333 ADD_METHOD(UIAlertController, alertControllerWithTitleUIAlertController, 3, 1)
334 ADD_UNARY_METHOD(UIAlertController, setTitle, 0)
335 ADD_UNARY_METHOD(UIAlertController, setMessage, 0)
337 NEW_RECEIVER(UIApplicationShortcutItem)
338 IdentifierInfo *initWithTypeUIApplicationShortcutItemIcon[] = {
339 &Ctx.Idents.get("initWithType"), &Ctx.Idents.get("localizedTitle"),
340 &Ctx.Idents.get("localizedSubtitle"), &Ctx.Idents.get("icon"),
341 &Ctx.Idents.get("userInfo")};
342 ADD_METHOD(UIApplicationShortcutItem,
343 initWithTypeUIApplicationShortcutItemIcon, 5, 1)
344 IdentifierInfo *initWithTypeUIApplicationShortcutItem[] = {
345 &Ctx.Idents.get("initWithType"), &Ctx.Idents.get("localizedTitle")};
346 ADD_METHOD(UIApplicationShortcutItem, initWithTypeUIApplicationShortcutItem,
349 NEW_RECEIVER(UIActionSheet)
350 IdentifierInfo *initWithTitleUIActionSheet[] = {
351 &Ctx.Idents.get("initWithTitle"), &Ctx.Idents.get("delegate"),
352 &Ctx.Idents.get("cancelButtonTitle"),
353 &Ctx.Idents.get("destructiveButtonTitle"),
354 &Ctx.Idents.get("otherButtonTitles")};
355 ADD_METHOD(UIActionSheet, initWithTitleUIActionSheet, 5, 0)
356 ADD_UNARY_METHOD(UIActionSheet, addButtonWithTitle, 0)
357 ADD_UNARY_METHOD(UIActionSheet, setTitle, 0)
359 NEW_RECEIVER(UIAccessibilityCustomAction)
360 IdentifierInfo *initWithNameUIAccessibilityCustomAction[] = {
361 &Ctx.Idents.get("initWithName"), &Ctx.Idents.get("target"),
362 &Ctx.Idents.get("selector")};
363 ADD_METHOD(UIAccessibilityCustomAction,
364 initWithNameUIAccessibilityCustomAction, 3, 0)
365 ADD_UNARY_METHOD(UIAccessibilityCustomAction, setName, 0)
367 NEW_RECEIVER(UISearchBar)
368 ADD_UNARY_METHOD(UISearchBar, setText, 0)
369 ADD_UNARY_METHOD(UISearchBar, setPrompt, 0)
370 ADD_UNARY_METHOD(UISearchBar, setPlaceholder, 0)
372 NEW_RECEIVER(UIBarItem)
373 ADD_UNARY_METHOD(UIBarItem, setTitle, 0)
375 NEW_RECEIVER(UITextView)
376 ADD_UNARY_METHOD(UITextView, setText, 0)
379 ADD_UNARY_METHOD(NSView, setToolTip, 0)
381 NEW_RECEIVER(NSTextField)
382 ADD_UNARY_METHOD(NSTextField, setPlaceholderString, 0)
383 ADD_UNARY_METHOD(NSTextField, textFieldWithString, 0)
384 ADD_UNARY_METHOD(NSTextField, wrappingLabelWithString, 0)
385 ADD_UNARY_METHOD(NSTextField, labelWithString, 0)
387 NEW_RECEIVER(NSAttributedString)
388 ADD_UNARY_METHOD(NSAttributedString, initWithString, 0)
389 IdentifierInfo *initWithStringNSAttributedString[] = {
390 &Ctx.Idents.get("initWithString"), &Ctx.Idents.get("attributes")};
391 ADD_METHOD(NSAttributedString, initWithStringNSAttributedString, 2, 0)
394 ADD_UNARY_METHOD(NSText, setString, 0)
396 NEW_RECEIVER(UIKeyCommand)
397 IdentifierInfo *keyCommandWithInputUIKeyCommand[] = {
398 &Ctx.Idents.get("keyCommandWithInput"), &Ctx.Idents.get("modifierFlags"),
399 &Ctx.Idents.get("action"), &Ctx.Idents.get("discoverabilityTitle")};
400 ADD_METHOD(UIKeyCommand, keyCommandWithInputUIKeyCommand, 4, 3)
401 ADD_UNARY_METHOD(UIKeyCommand, setDiscoverabilityTitle, 0)
403 NEW_RECEIVER(UILabel)
404 ADD_UNARY_METHOD(UILabel, setText, 0)
406 NEW_RECEIVER(NSAlert)
407 IdentifierInfo *alertWithMessageTextNSAlert[] = {
408 &Ctx.Idents.get("alertWithMessageText"), &Ctx.Idents.get("defaultButton"),
409 &Ctx.Idents.get("alternateButton"), &Ctx.Idents.get("otherButton"),
410 &Ctx.Idents.get("informativeTextWithFormat")};
411 ADD_METHOD(NSAlert, alertWithMessageTextNSAlert, 5, 0)
412 ADD_UNARY_METHOD(NSAlert, addButtonWithTitle, 0)
413 ADD_UNARY_METHOD(NSAlert, setMessageText, 0)
414 ADD_UNARY_METHOD(NSAlert, setInformativeText, 0)
415 ADD_UNARY_METHOD(NSAlert, setHelpAnchor, 0)
417 NEW_RECEIVER(UIMutableApplicationShortcutItem)
418 ADD_UNARY_METHOD(UIMutableApplicationShortcutItem, setLocalizedTitle, 0)
419 ADD_UNARY_METHOD(UIMutableApplicationShortcutItem, setLocalizedSubtitle, 0)
421 NEW_RECEIVER(UIButton)
422 IdentifierInfo *setTitleUIButton[] = {&Ctx.Idents.get("setTitle"),
423 &Ctx.Idents.get("forState")};
424 ADD_METHOD(UIButton, setTitleUIButton, 2, 0)
426 NEW_RECEIVER(NSWindow)
427 ADD_UNARY_METHOD(NSWindow, setTitle, 0)
428 IdentifierInfo *minFrameWidthWithTitleNSWindow[] = {
429 &Ctx.Idents.get("minFrameWidthWithTitle"), &Ctx.Idents.get("styleMask")};
430 ADD_METHOD(NSWindow, minFrameWidthWithTitleNSWindow, 2, 0)
431 ADD_UNARY_METHOD(NSWindow, setMiniwindowTitle, 0)
433 NEW_RECEIVER(NSPathCell)
434 ADD_UNARY_METHOD(NSPathCell, setPlaceholderString, 0)
436 NEW_RECEIVER(UIDocumentMenuViewController)
437 IdentifierInfo *addOptionWithTitleUIDocumentMenuViewController[] = {
438 &Ctx.Idents.get("addOptionWithTitle"), &Ctx.Idents.get("image"),
439 &Ctx.Idents.get("order"), &Ctx.Idents.get("handler")};
440 ADD_METHOD(UIDocumentMenuViewController,
441 addOptionWithTitleUIDocumentMenuViewController, 4, 0)
443 NEW_RECEIVER(UINavigationItem)
444 ADD_UNARY_METHOD(UINavigationItem, initWithTitle, 0)
445 ADD_UNARY_METHOD(UINavigationItem, setTitle, 0)
446 ADD_UNARY_METHOD(UINavigationItem, setPrompt, 0)
448 NEW_RECEIVER(UIAlertView)
449 IdentifierInfo *initWithTitleUIAlertView[] = {
450 &Ctx.Idents.get("initWithTitle"), &Ctx.Idents.get("message"),
451 &Ctx.Idents.get("delegate"), &Ctx.Idents.get("cancelButtonTitle"),
452 &Ctx.Idents.get("otherButtonTitles")};
453 ADD_METHOD(UIAlertView, initWithTitleUIAlertView, 5, 0)
454 ADD_UNARY_METHOD(UIAlertView, addButtonWithTitle, 0)
455 ADD_UNARY_METHOD(UIAlertView, setTitle, 0)
456 ADD_UNARY_METHOD(UIAlertView, setMessage, 0)
458 NEW_RECEIVER(NSFormCell)
459 ADD_UNARY_METHOD(NSFormCell, initTextCell, 0)
460 ADD_UNARY_METHOD(NSFormCell, setTitle, 0)
461 ADD_UNARY_METHOD(NSFormCell, setPlaceholderString, 0)
463 NEW_RECEIVER(NSUserNotification)
464 ADD_UNARY_METHOD(NSUserNotification, setTitle, 0)
465 ADD_UNARY_METHOD(NSUserNotification, setSubtitle, 0)
466 ADD_UNARY_METHOD(NSUserNotification, setInformativeText, 0)
467 ADD_UNARY_METHOD(NSUserNotification, setActionButtonTitle, 0)
468 ADD_UNARY_METHOD(NSUserNotification, setOtherButtonTitle, 0)
469 ADD_UNARY_METHOD(NSUserNotification, setResponsePlaceholder, 0)
471 NEW_RECEIVER(NSToolbarItem)
472 ADD_UNARY_METHOD(NSToolbarItem, setLabel, 0)
473 ADD_UNARY_METHOD(NSToolbarItem, setPaletteLabel, 0)
474 ADD_UNARY_METHOD(NSToolbarItem, setToolTip, 0)
476 NEW_RECEIVER(NSProgress)
477 ADD_UNARY_METHOD(NSProgress, setLocalizedDescription, 0)
478 ADD_UNARY_METHOD(NSProgress, setLocalizedAdditionalDescription, 0)
480 NEW_RECEIVER(NSSegmentedCell)
481 IdentifierInfo *setLabelNSSegmentedCell[] = {&Ctx.Idents.get("setLabel"),
482 &Ctx.Idents.get("forSegment")};
483 ADD_METHOD(NSSegmentedCell, setLabelNSSegmentedCell, 2, 0)
484 IdentifierInfo *setToolTipNSSegmentedCell[] = {&Ctx.Idents.get("setToolTip"),
485 &Ctx.Idents.get("forSegment")};
486 ADD_METHOD(NSSegmentedCell, setToolTipNSSegmentedCell, 2, 0)
488 NEW_RECEIVER(NSUndoManager)
489 ADD_UNARY_METHOD(NSUndoManager, setActionName, 0)
490 ADD_UNARY_METHOD(NSUndoManager, undoMenuTitleForUndoActionName, 0)
491 ADD_UNARY_METHOD(NSUndoManager, redoMenuTitleForUndoActionName, 0)
493 NEW_RECEIVER(NSMenuItem)
494 IdentifierInfo *initWithTitleNSMenuItem[] = {
495 &Ctx.Idents.get("initWithTitle"), &Ctx.Idents.get("action"),
496 &Ctx.Idents.get("keyEquivalent")};
497 ADD_METHOD(NSMenuItem, initWithTitleNSMenuItem, 3, 0)
498 ADD_UNARY_METHOD(NSMenuItem, setTitle, 0)
499 ADD_UNARY_METHOD(NSMenuItem, setToolTip, 0)
501 NEW_RECEIVER(NSPopUpButtonCell)
502 IdentifierInfo *initTextCellNSPopUpButtonCell[] = {
503 &Ctx.Idents.get("initTextCell"), &Ctx.Idents.get("pullsDown")};
504 ADD_METHOD(NSPopUpButtonCell, initTextCellNSPopUpButtonCell, 2, 0)
505 ADD_UNARY_METHOD(NSPopUpButtonCell, addItemWithTitle, 0)
506 IdentifierInfo *insertItemWithTitleNSPopUpButtonCell[] = {
507 &Ctx.Idents.get("insertItemWithTitle"), &Ctx.Idents.get("atIndex")};
508 ADD_METHOD(NSPopUpButtonCell, insertItemWithTitleNSPopUpButtonCell, 2, 0)
509 ADD_UNARY_METHOD(NSPopUpButtonCell, removeItemWithTitle, 0)
510 ADD_UNARY_METHOD(NSPopUpButtonCell, selectItemWithTitle, 0)
511 ADD_UNARY_METHOD(NSPopUpButtonCell, setTitle, 0)
513 NEW_RECEIVER(NSViewController)
514 ADD_UNARY_METHOD(NSViewController, setTitle, 0)
517 ADD_UNARY_METHOD(NSMenu, initWithTitle, 0)
518 IdentifierInfo *insertItemWithTitleNSMenu[] = {
519 &Ctx.Idents.get("insertItemWithTitle"), &Ctx.Idents.get("action"),
520 &Ctx.Idents.get("keyEquivalent"), &Ctx.Idents.get("atIndex")};
521 ADD_METHOD(NSMenu, insertItemWithTitleNSMenu, 4, 0)
522 IdentifierInfo *addItemWithTitleNSMenu[] = {
523 &Ctx.Idents.get("addItemWithTitle"), &Ctx.Idents.get("action"),
524 &Ctx.Idents.get("keyEquivalent")};
525 ADD_METHOD(NSMenu, addItemWithTitleNSMenu, 3, 0)
526 ADD_UNARY_METHOD(NSMenu, setTitle, 0)
528 NEW_RECEIVER(UIMutableUserNotificationAction)
529 ADD_UNARY_METHOD(UIMutableUserNotificationAction, setTitle, 0)
532 ADD_UNARY_METHOD(NSForm, addEntry, 0)
533 IdentifierInfo *insertEntryNSForm[] = {&Ctx.Idents.get("insertEntry"),
534 &Ctx.Idents.get("atIndex")};
535 ADD_METHOD(NSForm, insertEntryNSForm, 2, 0)
537 NEW_RECEIVER(NSTextFieldCell)
538 ADD_UNARY_METHOD(NSTextFieldCell, setPlaceholderString, 0)
540 NEW_RECEIVER(NSUserNotificationAction)
541 IdentifierInfo *actionWithIdentifierNSUserNotificationAction[] = {
542 &Ctx.Idents.get("actionWithIdentifier"), &Ctx.Idents.get("title")};
543 ADD_METHOD(NSUserNotificationAction,
544 actionWithIdentifierNSUserNotificationAction, 2, 1)
546 NEW_RECEIVER(UITextField)
547 ADD_UNARY_METHOD(UITextField, setText, 0)
548 ADD_UNARY_METHOD(UITextField, setPlaceholder, 0)
550 NEW_RECEIVER(UIBarButtonItem)
551 IdentifierInfo *initWithTitleUIBarButtonItem[] = {
552 &Ctx.Idents.get("initWithTitle"), &Ctx.Idents.get("style"),
553 &Ctx.Idents.get("target"), &Ctx.Idents.get("action")};
554 ADD_METHOD(UIBarButtonItem, initWithTitleUIBarButtonItem, 4, 0)
556 NEW_RECEIVER(UIViewController)
557 ADD_UNARY_METHOD(UIViewController, setTitle, 0)
559 NEW_RECEIVER(UISegmentedControl)
560 IdentifierInfo *insertSegmentWithTitleUISegmentedControl[] = {
561 &Ctx.Idents.get("insertSegmentWithTitle"), &Ctx.Idents.get("atIndex"),
562 &Ctx.Idents.get("animated")};
563 ADD_METHOD(UISegmentedControl, insertSegmentWithTitleUISegmentedControl, 3, 0)
564 IdentifierInfo *setTitleUISegmentedControl[] = {
565 &Ctx.Idents.get("setTitle"), &Ctx.Idents.get("forSegmentAtIndex")};
566 ADD_METHOD(UISegmentedControl, setTitleUISegmentedControl, 2, 0)
568 NEW_RECEIVER(NSAccessibilityCustomRotorItemResult)
570 *initWithItemLoadingTokenNSAccessibilityCustomRotorItemResult[] = {
571 &Ctx.Idents.get("initWithItemLoadingToken"),
572 &Ctx.Idents.get("customLabel")};
573 ADD_METHOD(NSAccessibilityCustomRotorItemResult,
574 initWithItemLoadingTokenNSAccessibilityCustomRotorItemResult, 2, 1)
575 ADD_UNARY_METHOD(NSAccessibilityCustomRotorItemResult, setCustomLabel, 0)
577 NEW_RECEIVER(UIContextualAction)
578 IdentifierInfo *contextualActionWithStyleUIContextualAction[] = {
579 &Ctx.Idents.get("contextualActionWithStyle"), &Ctx.Idents.get("title"),
580 &Ctx.Idents.get("handler")};
581 ADD_METHOD(UIContextualAction, contextualActionWithStyleUIContextualAction, 3,
583 ADD_UNARY_METHOD(UIContextualAction, setTitle, 0)
585 NEW_RECEIVER(NSAccessibilityCustomRotor)
586 IdentifierInfo *initWithLabelNSAccessibilityCustomRotor[] = {
587 &Ctx.Idents.get("initWithLabel"), &Ctx.Idents.get("itemSearchDelegate")};
588 ADD_METHOD(NSAccessibilityCustomRotor,
589 initWithLabelNSAccessibilityCustomRotor, 2, 0)
590 ADD_UNARY_METHOD(NSAccessibilityCustomRotor, setLabel, 0)
592 NEW_RECEIVER(NSWindowTab)
593 ADD_UNARY_METHOD(NSWindowTab, setTitle, 0)
594 ADD_UNARY_METHOD(NSWindowTab, setToolTip, 0)
596 NEW_RECEIVER(NSAccessibilityCustomAction)
597 IdentifierInfo *initWithNameNSAccessibilityCustomAction[] = {
598 &Ctx.Idents.get("initWithName"), &Ctx.Idents.get("handler")};
599 ADD_METHOD(NSAccessibilityCustomAction,
600 initWithNameNSAccessibilityCustomAction, 2, 0)
601 IdentifierInfo *initWithNameTargetNSAccessibilityCustomAction[] = {
602 &Ctx.Idents.get("initWithName"), &Ctx.Idents.get("target"),
603 &Ctx.Idents.get("selector")};
604 ADD_METHOD(NSAccessibilityCustomAction,
605 initWithNameTargetNSAccessibilityCustomAction, 3, 0)
606 ADD_UNARY_METHOD(NSAccessibilityCustomAction, setName, 0)
609 #define LSF_INSERT(function_name) LSF.insert(&Ctx.Idents.get(function_name));
610 #define LSM_INSERT_NULLARY(receiver, method_name) \
611 LSM.insert({&Ctx.Idents.get(receiver), Ctx.Selectors.getNullarySelector( \
612 &Ctx.Idents.get(method_name))});
613 #define LSM_INSERT_UNARY(receiver, method_name) \
614 LSM.insert({&Ctx.Idents.get(receiver), \
615 Ctx.Selectors.getUnarySelector(&Ctx.Idents.get(method_name))});
616 #define LSM_INSERT_SELECTOR(receiver, method_list, arguments) \
617 LSM.insert({&Ctx.Idents.get(receiver), \
618 Ctx.Selectors.getSelector(arguments, method_list)});
620 /// Initializes a list of methods and C functions that return a localized string
621 void NonLocalizedStringChecker::initLocStringsMethods(ASTContext &Ctx) const {
625 IdentifierInfo *LocalizedStringMacro[] = {
626 &Ctx.Idents.get("localizedStringForKey"), &Ctx.Idents.get("value"),
627 &Ctx.Idents.get("table")};
628 LSM_INSERT_SELECTOR("NSBundle", LocalizedStringMacro, 3)
629 LSM_INSERT_UNARY("NSDateFormatter", "stringFromDate")
630 IdentifierInfo *LocalizedStringFromDate[] = {
631 &Ctx.Idents.get("localizedStringFromDate"), &Ctx.Idents.get("dateStyle"),
632 &Ctx.Idents.get("timeStyle")};
633 LSM_INSERT_SELECTOR("NSDateFormatter", LocalizedStringFromDate, 3)
634 LSM_INSERT_UNARY("NSNumberFormatter", "stringFromNumber")
635 LSM_INSERT_NULLARY("UITextField", "text")
636 LSM_INSERT_NULLARY("UITextView", "text")
637 LSM_INSERT_NULLARY("UILabel", "text")
639 LSF_INSERT("CFDateFormatterCreateStringWithDate");
640 LSF_INSERT("CFDateFormatterCreateStringWithAbsoluteTime");
641 LSF_INSERT("CFNumberFormatterCreateStringWithNumber");
644 /// Checks to see if the method / function declaration includes
645 /// __attribute__((annotate("returns_localized_nsstring")))
646 bool NonLocalizedStringChecker::isAnnotatedAsReturningLocalized(
647 const Decl *D) const {
651 D->specific_attr_begin<AnnotateAttr>(),
652 D->specific_attr_end<AnnotateAttr>(), [](const AnnotateAttr *Ann) {
653 return Ann->getAnnotation() == "returns_localized_nsstring";
657 /// Checks to see if the method / function declaration includes
658 /// __attribute__((annotate("takes_localized_nsstring")))
659 bool NonLocalizedStringChecker::isAnnotatedAsTakingLocalized(
660 const Decl *D) const {
664 D->specific_attr_begin<AnnotateAttr>(),
665 D->specific_attr_end<AnnotateAttr>(), [](const AnnotateAttr *Ann) {
666 return Ann->getAnnotation() == "takes_localized_nsstring";
670 /// Returns true if the given SVal is marked as Localized in the program state
671 bool NonLocalizedStringChecker::hasLocalizedState(SVal S,
672 CheckerContext &C) const {
673 const MemRegion *mt = S.getAsRegion();
675 const LocalizedState *LS = C.getState()->get<LocalizedMemMap>(mt);
676 if (LS && LS->isLocalized())
682 /// Returns true if the given SVal is marked as NonLocalized in the program
684 bool NonLocalizedStringChecker::hasNonLocalizedState(SVal S,
685 CheckerContext &C) const {
686 const MemRegion *mt = S.getAsRegion();
688 const LocalizedState *LS = C.getState()->get<LocalizedMemMap>(mt);
689 if (LS && LS->isNonLocalized())
695 /// Marks the given SVal as Localized in the program state
696 void NonLocalizedStringChecker::setLocalizedState(const SVal S,
697 CheckerContext &C) const {
698 const MemRegion *mt = S.getAsRegion();
700 ProgramStateRef State =
701 C.getState()->set<LocalizedMemMap>(mt, LocalizedState::getLocalized());
702 C.addTransition(State);
706 /// Marks the given SVal as NonLocalized in the program state
707 void NonLocalizedStringChecker::setNonLocalizedState(const SVal S,
708 CheckerContext &C) const {
709 const MemRegion *mt = S.getAsRegion();
711 ProgramStateRef State = C.getState()->set<LocalizedMemMap>(
712 mt, LocalizedState::getNonLocalized());
713 C.addTransition(State);
718 static bool isDebuggingName(std::string name) {
719 return StringRef(name).lower().find("debug") != StringRef::npos;
722 /// Returns true when, heuristically, the analyzer may be analyzing debugging
723 /// code. We use this to suppress localization diagnostics in un-localized user
724 /// interfaces that are only used for debugging and are therefore not user
726 static bool isDebuggingContext(CheckerContext &C) {
727 const Decl *D = C.getCurrentAnalysisDeclContext()->getDecl();
731 if (auto *ND = dyn_cast<NamedDecl>(D)) {
732 if (isDebuggingName(ND->getNameAsString()))
736 const DeclContext *DC = D->getDeclContext();
738 if (auto *CD = dyn_cast<ObjCContainerDecl>(DC)) {
739 if (isDebuggingName(CD->getNameAsString()))
747 /// Reports a localization error for the passed in method call and SVal
748 void NonLocalizedStringChecker::reportLocalizationError(
749 SVal S, const CallEvent &M, CheckerContext &C, int argumentNumber) const {
751 // Don't warn about localization errors in classes and methods that
752 // may be debug code.
753 if (isDebuggingContext(C))
756 static CheckerProgramPointTag Tag("NonLocalizedStringChecker",
757 "UnlocalizedString");
758 ExplodedNode *ErrNode = C.addTransition(C.getState(), C.getPredecessor(), &Tag);
763 // Generate the bug report.
764 auto R = std::make_unique<PathSensitiveBugReport>(
765 *BT, "User-facing text should use localized string macro", ErrNode);
766 if (argumentNumber) {
767 R->addRange(M.getArgExpr(argumentNumber - 1)->getSourceRange());
769 R->addRange(M.getSourceRange());
771 R->markInteresting(S);
773 const MemRegion *StringRegion = S.getAsRegion();
775 R->addVisitor(std::make_unique<NonLocalizedStringBRVisitor>(StringRegion));
777 C.emitReport(std::move(R));
780 /// Returns the argument number requiring localized string if it exists
781 /// otherwise, returns -1
782 int NonLocalizedStringChecker::getLocalizedArgumentForSelector(
783 const IdentifierInfo *Receiver, Selector S) const {
784 auto method = UIMethods.find(Receiver);
786 if (method == UIMethods.end())
789 auto argumentIterator = method->getSecond().find(S);
791 if (argumentIterator == method->getSecond().end())
794 int argumentNumber = argumentIterator->getSecond();
795 return argumentNumber;
798 /// Check if the string being passed in has NonLocalized state
799 void NonLocalizedStringChecker::checkPreObjCMessage(const ObjCMethodCall &msg,
800 CheckerContext &C) const {
801 initUIMethods(C.getASTContext());
803 const ObjCInterfaceDecl *OD = msg.getReceiverInterface();
806 const IdentifierInfo *odInfo = OD->getIdentifier();
808 Selector S = msg.getSelector();
810 std::string SelectorString = S.getAsString();
811 StringRef SelectorName = SelectorString;
812 assert(!SelectorName.empty());
814 if (odInfo->isStr("NSString")) {
815 // Handle the case where the receiver is an NSString
816 // These special NSString methods draw to the screen
818 if (!(SelectorName.startswith("drawAtPoint") ||
819 SelectorName.startswith("drawInRect") ||
820 SelectorName.startswith("drawWithRect")))
823 SVal svTitle = msg.getReceiverSVal();
825 bool isNonLocalized = hasNonLocalizedState(svTitle, C);
827 if (isNonLocalized) {
828 reportLocalizationError(svTitle, msg, C);
832 int argumentNumber = getLocalizedArgumentForSelector(odInfo, S);
833 // Go up each hierarchy of superclasses and their protocols
834 while (argumentNumber < 0 && OD->getSuperClass() != nullptr) {
835 for (const auto *P : OD->all_referenced_protocols()) {
836 argumentNumber = getLocalizedArgumentForSelector(P->getIdentifier(), S);
837 if (argumentNumber >= 0)
840 if (argumentNumber < 0) {
841 OD = OD->getSuperClass();
842 argumentNumber = getLocalizedArgumentForSelector(OD->getIdentifier(), S);
846 if (argumentNumber < 0) { // There was no match in UIMethods
847 if (const Decl *D = msg.getDecl()) {
848 if (const ObjCMethodDecl *OMD = dyn_cast_or_null<ObjCMethodDecl>(D)) {
849 auto formals = OMD->parameters();
850 for (unsigned i = 0, ei = formals.size(); i != ei; ++i) {
851 if (isAnnotatedAsTakingLocalized(formals[i])) {
860 if (argumentNumber < 0) // Still no match
863 SVal svTitle = msg.getArgSVal(argumentNumber);
865 if (const ObjCStringRegion *SR =
866 dyn_cast_or_null<ObjCStringRegion>(svTitle.getAsRegion())) {
867 StringRef stringValue =
868 SR->getObjCStringLiteral()->getString()->getString();
869 if ((stringValue.trim().size() == 0 && stringValue.size() > 0) ||
872 if (!IsAggressive && llvm::sys::unicode::columnWidthUTF8(stringValue) < 2)
876 bool isNonLocalized = hasNonLocalizedState(svTitle, C);
878 if (isNonLocalized) {
879 reportLocalizationError(svTitle, msg, C, argumentNumber + 1);
883 void NonLocalizedStringChecker::checkPreCall(const CallEvent &Call,
884 CheckerContext &C) const {
885 const auto *FD = dyn_cast_or_null<FunctionDecl>(Call.getDecl());
889 auto formals = FD->parameters();
890 for (unsigned i = 0, ei = std::min(static_cast<unsigned>(formals.size()),
891 Call.getNumArgs()); i != ei; ++i) {
892 if (isAnnotatedAsTakingLocalized(formals[i])) {
893 auto actual = Call.getArgSVal(i);
894 if (hasNonLocalizedState(actual, C)) {
895 reportLocalizationError(actual, Call, C, i + 1);
901 static inline bool isNSStringType(QualType T, ASTContext &Ctx) {
903 const ObjCObjectPointerType *PT = T->getAs<ObjCObjectPointerType>();
907 ObjCInterfaceDecl *Cls = PT->getObjectType()->getInterface();
911 IdentifierInfo *ClsName = Cls->getIdentifier();
913 // FIXME: Should we walk the chain of classes?
914 return ClsName == &Ctx.Idents.get("NSString") ||
915 ClsName == &Ctx.Idents.get("NSMutableString");
918 /// Marks a string being returned by any call as localized
919 /// if it is in LocStringFunctions (LSF) or the function is annotated.
920 /// Otherwise, we mark it as NonLocalized (Aggressive) or
921 /// NonLocalized only if it is not backed by a SymRegion (Non-Aggressive),
922 /// basically leaving only string literals as NonLocalized.
923 void NonLocalizedStringChecker::checkPostCall(const CallEvent &Call,
924 CheckerContext &C) const {
925 initLocStringsMethods(C.getASTContext());
927 if (!Call.getOriginExpr())
930 // Anything that takes in a localized NSString as an argument
931 // and returns an NSString will be assumed to be returning a
932 // localized NSString. (Counter: Incorrectly combining two LocalizedStrings)
933 const QualType RT = Call.getResultType();
934 if (isNSStringType(RT, C.getASTContext())) {
935 for (unsigned i = 0; i < Call.getNumArgs(); ++i) {
936 SVal argValue = Call.getArgSVal(i);
937 if (hasLocalizedState(argValue, C)) {
938 SVal sv = Call.getReturnValue();
939 setLocalizedState(sv, C);
945 const Decl *D = Call.getDecl();
949 const IdentifierInfo *Identifier = Call.getCalleeIdentifier();
951 SVal sv = Call.getReturnValue();
952 if (isAnnotatedAsReturningLocalized(D) || LSF.count(Identifier) != 0) {
953 setLocalizedState(sv, C);
954 } else if (isNSStringType(RT, C.getASTContext()) &&
955 !hasLocalizedState(sv, C)) {
957 setNonLocalizedState(sv, C);
959 const SymbolicRegion *SymReg =
960 dyn_cast_or_null<SymbolicRegion>(sv.getAsRegion());
962 setNonLocalizedState(sv, C);
967 /// Marks a string being returned by an ObjC method as localized
968 /// if it is in LocStringMethods or the method is annotated
969 void NonLocalizedStringChecker::checkPostObjCMessage(const ObjCMethodCall &msg,
970 CheckerContext &C) const {
971 initLocStringsMethods(C.getASTContext());
973 if (!msg.isInstanceMessage())
976 const ObjCInterfaceDecl *OD = msg.getReceiverInterface();
979 const IdentifierInfo *odInfo = OD->getIdentifier();
981 Selector S = msg.getSelector();
982 std::string SelectorName = S.getAsString();
984 std::pair<const IdentifierInfo *, Selector> MethodDescription = {odInfo, S};
986 if (LSM.count(MethodDescription) ||
987 isAnnotatedAsReturningLocalized(msg.getDecl())) {
988 SVal sv = msg.getReturnValue();
989 setLocalizedState(sv, C);
993 /// Marks all empty string literals as localized
994 void NonLocalizedStringChecker::checkPostStmt(const ObjCStringLiteral *SL,
995 CheckerContext &C) const {
996 SVal sv = C.getSVal(SL);
997 setNonLocalizedState(sv, C);
1000 PathDiagnosticPieceRef
1001 NonLocalizedStringBRVisitor::VisitNode(const ExplodedNode *Succ,
1002 BugReporterContext &BRC,
1003 PathSensitiveBugReport &BR) {
1007 Optional<StmtPoint> Point = Succ->getLocation().getAs<StmtPoint>();
1008 if (!Point.hasValue())
1011 auto *LiteralExpr = dyn_cast<ObjCStringLiteral>(Point->getStmt());
1015 SVal LiteralSVal = Succ->getSVal(LiteralExpr);
1016 if (LiteralSVal.getAsRegion() != NonLocalizedString)
1021 PathDiagnosticLocation L =
1022 PathDiagnosticLocation::create(*Point, BRC.getSourceManager());
1024 if (!L.isValid() || !L.asLocation().isValid())
1027 auto Piece = std::make_shared<PathDiagnosticEventPiece>(
1028 L, "Non-localized string literal here");
1029 Piece->addRange(LiteralExpr->getSourceRange());
1031 return std::move(Piece);
1035 class EmptyLocalizationContextChecker
1036 : public Checker<check::ASTDecl<ObjCImplementationDecl>> {
1038 // A helper class, which walks the AST
1039 class MethodCrawler : public ConstStmtVisitor<MethodCrawler> {
1040 const ObjCMethodDecl *MD;
1042 AnalysisManager &Mgr;
1043 const CheckerBase *Checker;
1044 LocationOrAnalysisDeclContext DCtx;
1047 MethodCrawler(const ObjCMethodDecl *InMD, BugReporter &InBR,
1048 const CheckerBase *Checker, AnalysisManager &InMgr,
1049 AnalysisDeclContext *InDCtx)
1050 : MD(InMD), BR(InBR), Mgr(InMgr), Checker(Checker), DCtx(InDCtx) {}
1052 void VisitStmt(const Stmt *S) { VisitChildren(S); }
1054 void VisitObjCMessageExpr(const ObjCMessageExpr *ME);
1056 void reportEmptyContextError(const ObjCMessageExpr *M) const;
1058 void VisitChildren(const Stmt *S) {
1059 for (const Stmt *Child : S->children()) {
1067 void checkASTDecl(const ObjCImplementationDecl *D, AnalysisManager &Mgr,
1068 BugReporter &BR) const;
1070 } // end anonymous namespace
1072 void EmptyLocalizationContextChecker::checkASTDecl(
1073 const ObjCImplementationDecl *D, AnalysisManager &Mgr,
1074 BugReporter &BR) const {
1076 for (const ObjCMethodDecl *M : D->methods()) {
1077 AnalysisDeclContext *DCtx = Mgr.getAnalysisDeclContext(M);
1079 const Stmt *Body = M->getBody();
1081 assert(M->isSynthesizedAccessorStub());
1085 MethodCrawler MC(M->getCanonicalDecl(), BR, this, Mgr, DCtx);
1090 /// This check attempts to match these macros, assuming they are defined as
1093 /// #define NSLocalizedString(key, comment) \
1094 /// [[NSBundle mainBundle] localizedStringForKey:(key) value:@"" table:nil]
1095 /// #define NSLocalizedStringFromTable(key, tbl, comment) \
1096 /// [[NSBundle mainBundle] localizedStringForKey:(key) value:@"" table:(tbl)]
1097 /// #define NSLocalizedStringFromTableInBundle(key, tbl, bundle, comment) \
1098 /// [bundle localizedStringForKey:(key) value:@"" table:(tbl)]
1099 /// #define NSLocalizedStringWithDefaultValue(key, tbl, bundle, val, comment)
1101 /// We cannot use the path sensitive check because the macro argument we are
1102 /// checking for (comment) is not used and thus not present in the AST,
1103 /// so we use Lexer on the original macro call and retrieve the value of
1104 /// the comment. If it's empty or nil, we raise a warning.
1105 void EmptyLocalizationContextChecker::MethodCrawler::VisitObjCMessageExpr(
1106 const ObjCMessageExpr *ME) {
1108 // FIXME: We may be able to use PPCallbacks to check for empty context
1109 // comments as part of preprocessing and avoid this re-lexing hack.
1110 const ObjCInterfaceDecl *OD = ME->getReceiverInterface();
1114 const IdentifierInfo *odInfo = OD->getIdentifier();
1116 if (!(odInfo->isStr("NSBundle") &&
1117 ME->getSelector().getAsString() ==
1118 "localizedStringForKey:value:table:")) {
1122 SourceRange R = ME->getSourceRange();
1123 if (!R.getBegin().isMacroID())
1126 // getImmediateMacroCallerLoc gets the location of the immediate macro
1127 // caller, one level up the stack toward the initial macro typed into the
1128 // source, so SL should point to the NSLocalizedString macro.
1130 Mgr.getSourceManager().getImmediateMacroCallerLoc(R.getBegin());
1131 std::pair<FileID, unsigned> SLInfo =
1132 Mgr.getSourceManager().getDecomposedLoc(SL);
1134 SrcMgr::SLocEntry SE = Mgr.getSourceManager().getSLocEntry(SLInfo.first);
1136 // If NSLocalizedString macro is wrapped in another macro, we need to
1137 // unwrap the expansion until we get to the NSLocalizedStringMacro.
1138 while (SE.isExpansion()) {
1139 SL = SE.getExpansion().getSpellingLoc();
1140 SLInfo = Mgr.getSourceManager().getDecomposedLoc(SL);
1141 SE = Mgr.getSourceManager().getSLocEntry(SLInfo.first);
1144 bool Invalid = false;
1145 const llvm::MemoryBuffer *BF =
1146 Mgr.getSourceManager().getBuffer(SLInfo.first, SL, &Invalid);
1150 Lexer TheLexer(SL, LangOptions(), BF->getBufferStart(),
1151 BF->getBufferStart() + SLInfo.second, BF->getBufferEnd());
1154 Token Result; // This will hold the token just before the last ')'
1155 int p_count = 0; // This is for parenthesis matching
1156 while (!TheLexer.LexFromRawLexer(I)) {
1157 if (I.getKind() == tok::l_paren)
1159 if (I.getKind() == tok::r_paren) {
1167 if (isAnyIdentifier(Result.getKind())) {
1168 if (Result.getRawIdentifier().equals("nil")) {
1169 reportEmptyContextError(ME);
1174 if (!isStringLiteral(Result.getKind()))
1178 StringRef(Result.getLiteralData(), Result.getLength()).trim('"');
1180 if ((Comment.trim().size() == 0 && Comment.size() > 0) || // Is Whitespace
1182 reportEmptyContextError(ME);
1186 void EmptyLocalizationContextChecker::MethodCrawler::reportEmptyContextError(
1187 const ObjCMessageExpr *ME) const {
1188 // Generate the bug report.
1189 BR.EmitBasicReport(MD, Checker, "Context Missing",
1190 "Localizability Issue (Apple)",
1191 "Localized string macro should include a non-empty "
1192 "comment for translators",
1193 PathDiagnosticLocation(ME, BR.getSourceManager(), DCtx));
1197 class PluralMisuseChecker : public Checker<check::ASTCodeBody> {
1199 // A helper class, which walks the AST
1200 class MethodCrawler : public RecursiveASTVisitor<MethodCrawler> {
1202 const CheckerBase *Checker;
1203 AnalysisDeclContext *AC;
1205 // This functions like a stack. We push on any IfStmt or
1206 // ConditionalOperator that matches the condition
1207 // and pop it off when we leave that statement
1208 llvm::SmallVector<const clang::Stmt *, 8> MatchingStatements;
1209 // This is true when we are the direct-child of a
1210 // matching statement
1211 bool InMatchingStatement = false;
1214 explicit MethodCrawler(BugReporter &InBR, const CheckerBase *Checker,
1215 AnalysisDeclContext *InAC)
1216 : BR(InBR), Checker(Checker), AC(InAC) {}
1218 bool VisitIfStmt(const IfStmt *I);
1219 bool EndVisitIfStmt(IfStmt *I);
1220 bool TraverseIfStmt(IfStmt *x);
1221 bool VisitConditionalOperator(const ConditionalOperator *C);
1222 bool TraverseConditionalOperator(ConditionalOperator *C);
1223 bool VisitCallExpr(const CallExpr *CE);
1224 bool VisitObjCMessageExpr(const ObjCMessageExpr *ME);
1227 void reportPluralMisuseError(const Stmt *S) const;
1228 bool isCheckingPlurality(const Expr *E) const;
1232 void checkASTCodeBody(const Decl *D, AnalysisManager &Mgr,
1233 BugReporter &BR) const {
1234 MethodCrawler Visitor(BR, this, Mgr.getAnalysisDeclContext(D));
1235 Visitor.TraverseDecl(const_cast<Decl *>(D));
1238 } // end anonymous namespace
1240 // Checks the condition of the IfStmt and returns true if one
1241 // of the following heuristics are met:
1242 // 1) The conidtion is a variable with "singular" or "plural" in the name
1243 // 2) The condition is a binary operator with 1 or 2 on the right-hand side
1244 bool PluralMisuseChecker::MethodCrawler::isCheckingPlurality(
1245 const Expr *Condition) const {
1246 const BinaryOperator *BO = nullptr;
1247 // Accounts for when a VarDecl represents a BinaryOperator
1248 if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(Condition)) {
1249 if (const VarDecl *VD = dyn_cast<VarDecl>(DRE->getDecl())) {
1250 const Expr *InitExpr = VD->getInit();
1252 if (const BinaryOperator *B =
1253 dyn_cast<BinaryOperator>(InitExpr->IgnoreParenImpCasts())) {
1257 if (VD->getName().lower().find("plural") != StringRef::npos ||
1258 VD->getName().lower().find("singular") != StringRef::npos) {
1262 } else if (const BinaryOperator *B = dyn_cast<BinaryOperator>(Condition)) {
1269 if (IntegerLiteral *IL = dyn_cast_or_null<IntegerLiteral>(
1270 BO->getRHS()->IgnoreParenImpCasts())) {
1271 llvm::APInt Value = IL->getValue();
1272 if (Value == 1 || Value == 2) {
1279 // A CallExpr with "LOC" in its identifier that takes in a string literal
1280 // has been shown to almost always be a function that returns a localized
1281 // string. Raise a diagnostic when this is in a statement that matches
1283 bool PluralMisuseChecker::MethodCrawler::VisitCallExpr(const CallExpr *CE) {
1284 if (InMatchingStatement) {
1285 if (const FunctionDecl *FD = CE->getDirectCallee()) {
1286 std::string NormalizedName =
1287 StringRef(FD->getNameInfo().getAsString()).lower();
1288 if (NormalizedName.find("loc") != std::string::npos) {
1289 for (const Expr *Arg : CE->arguments()) {
1290 if (isa<ObjCStringLiteral>(Arg))
1291 reportPluralMisuseError(CE);
1299 // The other case is for NSLocalizedString which also returns
1300 // a localized string. It's a macro for the ObjCMessageExpr
1301 // [NSBundle localizedStringForKey:value:table:] Raise a
1302 // diagnostic when this is in a statement that matches
1304 bool PluralMisuseChecker::MethodCrawler::VisitObjCMessageExpr(
1305 const ObjCMessageExpr *ME) {
1306 const ObjCInterfaceDecl *OD = ME->getReceiverInterface();
1310 const IdentifierInfo *odInfo = OD->getIdentifier();
1312 if (odInfo->isStr("NSBundle") &&
1313 ME->getSelector().getAsString() == "localizedStringForKey:value:table:") {
1314 if (InMatchingStatement) {
1315 reportPluralMisuseError(ME);
1321 /// Override TraverseIfStmt so we know when we are done traversing an IfStmt
1322 bool PluralMisuseChecker::MethodCrawler::TraverseIfStmt(IfStmt *I) {
1323 RecursiveASTVisitor<MethodCrawler>::TraverseIfStmt(I);
1324 return EndVisitIfStmt(I);
1327 // EndVisit callbacks are not provided by the RecursiveASTVisitor
1328 // so we override TraverseIfStmt and make a call to EndVisitIfStmt
1329 // after traversing the IfStmt
1330 bool PluralMisuseChecker::MethodCrawler::EndVisitIfStmt(IfStmt *I) {
1331 MatchingStatements.pop_back();
1332 if (!MatchingStatements.empty()) {
1333 if (MatchingStatements.back() != nullptr) {
1334 InMatchingStatement = true;
1338 InMatchingStatement = false;
1342 bool PluralMisuseChecker::MethodCrawler::VisitIfStmt(const IfStmt *I) {
1343 const Expr *Condition = I->getCond()->IgnoreParenImpCasts();
1344 if (isCheckingPlurality(Condition)) {
1345 MatchingStatements.push_back(I);
1346 InMatchingStatement = true;
1348 MatchingStatements.push_back(nullptr);
1349 InMatchingStatement = false;
1355 // Preliminary support for conditional operators.
1356 bool PluralMisuseChecker::MethodCrawler::TraverseConditionalOperator(
1357 ConditionalOperator *C) {
1358 RecursiveASTVisitor<MethodCrawler>::TraverseConditionalOperator(C);
1359 MatchingStatements.pop_back();
1360 if (!MatchingStatements.empty()) {
1361 if (MatchingStatements.back() != nullptr)
1362 InMatchingStatement = true;
1364 InMatchingStatement = false;
1366 InMatchingStatement = false;
1371 bool PluralMisuseChecker::MethodCrawler::VisitConditionalOperator(
1372 const ConditionalOperator *C) {
1373 const Expr *Condition = C->getCond()->IgnoreParenImpCasts();
1374 if (isCheckingPlurality(Condition)) {
1375 MatchingStatements.push_back(C);
1376 InMatchingStatement = true;
1378 MatchingStatements.push_back(nullptr);
1379 InMatchingStatement = false;
1384 void PluralMisuseChecker::MethodCrawler::reportPluralMisuseError(
1385 const Stmt *S) const {
1386 // Generate the bug report.
1387 BR.EmitBasicReport(AC->getDecl(), Checker, "Plural Misuse",
1388 "Localizability Issue (Apple)",
1389 "Plural cases are not supported across all languages. "
1390 "Use a .stringsdict file instead",
1391 PathDiagnosticLocation(S, BR.getSourceManager(), AC));
1394 //===----------------------------------------------------------------------===//
1395 // Checker registration.
1396 //===----------------------------------------------------------------------===//
1398 void ento::registerNonLocalizedStringChecker(CheckerManager &mgr) {
1399 NonLocalizedStringChecker *checker =
1400 mgr.registerChecker<NonLocalizedStringChecker>();
1401 checker->IsAggressive =
1402 mgr.getAnalyzerOptions().getCheckerBooleanOption(
1403 checker, "AggressiveReport");
1406 bool ento::shouldRegisterNonLocalizedStringChecker(const LangOptions &LO) {
1410 void ento::registerEmptyLocalizationContextChecker(CheckerManager &mgr) {
1411 mgr.registerChecker<EmptyLocalizationContextChecker>();
1414 bool ento::shouldRegisterEmptyLocalizationContextChecker(
1415 const LangOptions &LO) {
1419 void ento::registerPluralMisuseChecker(CheckerManager &mgr) {
1420 mgr.registerChecker<PluralMisuseChecker>();
1423 bool ento::shouldRegisterPluralMisuseChecker(const LangOptions &LO) {