SemaAvailability.cpp File Reference

#include "clang/AST/Attr.h"
#include "clang/AST/Decl.h"
#include "clang/AST/RecursiveASTVisitor.h"
#include "clang/Basic/DiagnosticSema.h"
#include "clang/Basic/TargetInfo.h"
#include "clang/Lex/Preprocessor.h"
#include "clang/Sema/DelayedDiagnostic.h"
#include "clang/Sema/ScopeInfo.h"
#include "clang/Sema/Sema.h"
#include <optional>

Include dependency graph for SemaAvailability.cpp:

Go to the source code of this file.

Functions
static const AvailabilityAttr *	getAttrForPlatform (ASTContext &Context, const Decl *D)
static std::pair< AvailabilityResult, const NamedDecl * >	ShouldDiagnoseAvailabilityOfDecl (Sema &S, const NamedDecl *D, std::string *Message, ObjCInterfaceDecl *ClassReceiver)
	The diagnostic we should emit for D, and the declaration that originated it, or AR_Available.
static bool	ShouldDiagnoseAvailabilityInContext (Sema &S, AvailabilityResult K, VersionTuple DeclVersion, Decl *Ctx, const NamedDecl *OffendingDecl)
	whether we should emit a diagnostic for K and DeclVersion in the context of Ctx.
static bool	shouldDiagnoseAvailabilityByDefault (const ASTContext &Context, const VersionTuple &DeploymentVersion, const VersionTuple &DeclVersion)
static NamedDecl *	findEnclosingDeclToAnnotate (Decl *OrigCtx)
static std::optional< unsigned >	tryParseObjCMethodName (StringRef Name, SmallVectorImpl< StringRef > &SlotNames, const LangOptions &LangOpts)
	Tries to parse a string as ObjC method name.
static std::optional< AttributeInsertion >	createAttributeInsertion (const NamedDecl *D, const SourceManager &SM, const LangOptions &LangOpts)
	Returns a source location in which it's appropriate to insert a new attribute for the given declaration \D.
static void	DoEmitAvailabilityWarning (Sema &S, AvailabilityResult K, Decl *Ctx, const NamedDecl *ReferringDecl, const NamedDecl *OffendingDecl, StringRef Message, ArrayRef< SourceLocation > Locs, const ObjCInterfaceDecl *UnknownObjCClass, const ObjCPropertyDecl *ObjCProperty, bool ObjCPropertyAccess)
	Actually emit an availability diagnostic for a reference to an unavailable decl.
static void	EmitAvailabilityWarning (Sema &S, AvailabilityResult AR, const NamedDecl *ReferringDecl, const NamedDecl *OffendingDecl, StringRef Message, ArrayRef< SourceLocation > Locs, const ObjCInterfaceDecl *UnknownObjCClass, const ObjCPropertyDecl *ObjCProperty, bool ObjCPropertyAccess)

Function Documentation

createAttributeInsertion()

static std::optional< AttributeInsertion > createAttributeInsertion ( const NamedDecl *  D, const SourceManager &  SM, const LangOptions &  LangOpts  )

static

Returns a source location in which it's appropriate to insert a new attribute for the given declaration \D.

Definition at line 284 of file SemaAvailability.cpp.

References clang::Lexer::getLocForEndOfToken(), clang::SourceLocation::isInvalid(), and SM.

Referenced by DoEmitAvailabilityWarning().

DoEmitAvailabilityWarning()

static void DoEmitAvailabilityWarning ( Sema &  S, AvailabilityResult  K, Decl *  Ctx, const NamedDecl *  ReferringDecl, const NamedDecl *  OffendingDecl, StringRef  Message, ArrayRef< SourceLocation >  Locs, const ObjCInterfaceDecl *  UnknownObjCClass, const ObjCPropertyDecl *  ObjCProperty, bool  ObjCPropertyAccess  )

static

Actually emit an availability diagnostic for a reference to an unavailable decl.

Parameters

Ctx	The context that the reference occurred in
ReferringDecl	The exact declaration that was referenced.
OffendingDecl	A related decl to ReferringDecl that has an availability attribute corresponding to K attached to it. Note that this may not be the same as ReferringDecl, i.e. if an EnumDecl is annotated and we refer to a member EnumConstantDecl, ReferringDecl is the EnumConstantDecl and OffendingDecl is the EnumDecl.

Definition at line 314 of file SemaAvailability.cpp.

References clang::AR_Available, clang::AR_Deprecated, clang::AR_NotYetIntroduced, clang::AR_Unavailable, clang::Sema::Context, createAttributeInsertion(), clang::FixItHint::CreateInsertion(), clang::FixItHint::CreateReplacement(), clang::Sema::Diag(), findEnclosingDeclToAnnotate(), clang::Sema::getASTContext(), clang::Decl::getAttr(), getAttrForPlatform(), clang::CharSourceRange::getCharRange(), clang::NamedDecl::getDeclName(), clang::Sema::getLangOpts(), clang::Decl::getLocation(), clang::Sema::getLocForEndOfToken(), clang::NamedDecl::getMostRecentDecl(), clang::Selector::getNameForSlot(), clang::Selector::getNumArgs(), clang::TargetInfo::getPlatformMinVersion(), clang::TargetInfo::getPlatformName(), clang::Sema::getPreprocessor(), clang::Decl::getPreviousDecl(), clang::Sema::getSourceManager(), clang::ASTContext::getTargetInfo(), clang::Decl::getVersionIntroduced(), clang::SourceManager::isInSystemHeader(), clang::Preprocessor::isMacroDefined(), clang::CharSourceRange::isValid(), shouldDiagnoseAvailabilityByDefault(), ShouldDiagnoseAvailabilityInContext(), tryParseObjCMethodName(), and clang::Warning.

Referenced by EmitAvailabilityWarning(), and clang::Sema::handleDelayedAvailabilityCheck().

EmitAvailabilityWarning()

static void EmitAvailabilityWarning ( Sema &  S, AvailabilityResult  AR, const NamedDecl *  ReferringDecl, const NamedDecl *  OffendingDecl, StringRef  Message, ArrayRef< SourceLocation >  Locs, const ObjCInterfaceDecl *  UnknownObjCClass, const ObjCPropertyDecl *  ObjCProperty, bool  ObjCPropertyAccess  )

static

Definition at line 558 of file SemaAvailability.cpp.

References clang::Sema::DelayedDiagnostics::add(), clang::Sema::DelayedDiagnostics, DoEmitAvailabilityWarning(), clang::Sema::getCurLexicalContext(), clang::sema::DelayedDiagnostic::makeAvailability(), and clang::Sema::DelayedDiagnostics::shouldDelayDiagnostics().

Referenced by clang::Sema::DiagnoseAvailabilityOfDecl().

findEnclosingDeclToAnnotate()

static NamedDecl * findEnclosingDeclToAnnotate ( Decl *  OrigCtx )

static

Definition at line 207 of file SemaAvailability.cpp.

Referenced by DoEmitAvailabilityWarning().

getAttrForPlatform()

static const AvailabilityAttr * getAttrForPlatform ( ASTContext &  Context, const Decl *  D  )

static

Definition at line 27 of file SemaAvailability.cpp.

References clang::Decl::attrs(), clang::ASTContext::getLangOpts(), clang::TargetInfo::getPlatformName(), and clang::ASTContext::getTargetInfo().

Referenced by DoEmitAvailabilityWarning(), and ShouldDiagnoseAvailabilityInContext().

shouldDiagnoseAvailabilityByDefault()

static bool shouldDiagnoseAvailabilityByDefault ( const ASTContext &  Context, const VersionTuple &  DeploymentVersion, const VersionTuple &  DeclVersion  )

static

Definition at line 179 of file SemaAvailability.cpp.

References clang::ASTContext::getTargetInfo(), and clang::TargetInfo::getTriple().

Referenced by DoEmitAvailabilityWarning().

ShouldDiagnoseAvailabilityInContext()

static bool ShouldDiagnoseAvailabilityInContext ( Sema &  S, AvailabilityResult  K, VersionTuple  DeclVersion, Decl *  Ctx, const NamedDecl *  OffendingDecl  )

static

whether we should emit a diagnostic for K and DeclVersion in the context of Ctx.

For example, we should emit an unavailable diagnostic in a deprecated context, but not the other way around.

Definition at line 121 of file SemaAvailability.cpp.

References clang::AR_Available, clang::AR_Deprecated, clang::AR_NotYetIntroduced, clang::AR_Unavailable, clang::C, clang::Sema::Context, getAttrForPlatform(), and clang::Decl::getDeclContext().

Referenced by DoEmitAvailabilityWarning().

ShouldDiagnoseAvailabilityOfDecl()

static std::pair< AvailabilityResult, const NamedDecl * > ShouldDiagnoseAvailabilityOfDecl ( Sema &  S, const NamedDecl *  D, std::string *  Message, ObjCInterfaceDecl *  ClassReceiver  )

static

The diagnostic we should emit for D, and the declaration that originated it, or AR_Available.

Parameters

D	The declaration to check.
Message	If non-null, this will be populated with the message from the availability attribute that is selected.
ClassReceiver	If we're checking the method of a class message send, the class. Otherwise nullptr.

Definition at line 64 of file SemaAvailability.cpp.

References clang::AR_Available, clang::Sema::getASTContext(), clang::Decl::getAvailability(), clang::ObjCInterfaceDecl::lookupInstanceMethod(), and clang::Sema::NSAPIObj.

Referenced by clang::Sema::DiagnoseAvailabilityOfDecl().

tryParseObjCMethodName()

static std::optional< unsigned > tryParseObjCMethodName ( StringRef  Name, SmallVectorImpl< StringRef > &  SlotNames, const LangOptions &  LangOpts  )

static

Tries to parse a string as ObjC method name.

Parameters

Name	The string to parse. Expected to originate from availability attribute argument.
SlotNames	The vector that will be populated with slot names. In case of unsuccessful parsing can contain invalid data.

Returns

A number of method parameters if parsing was successful, std::nullopt otherwise.

Definition at line 251 of file SemaAvailability.cpp.

References clang::isValidAsciiIdentifier().

Referenced by DoEmitAvailabilityWarning().