Smart pointer class that efficiently represents Objective-C method names. More...

#include "clang/Basic/IdentifierTable.h"

Public Member Functions
	Selector ()=default
	The default ctor should only be used when creating data structures that will contain selectors. More...

	Selector (uintptr_t V)

bool	operator== (Selector RHS) const
	operator==/!= - Indicate whether the specified selectors are identical. More...

bool	operator!= (Selector RHS) const

void *	getAsOpaquePtr () const

bool	isNull () const
	Determine whether this is the empty selector. More...

bool	isKeywordSelector () const

bool	isUnarySelector () const

bool	isKeywordSelector (ArrayRef< StringRef > Names) const
	If this selector is the specific keyword selector described by Names. More...

bool	isUnarySelector (StringRef Name) const
	If this selector is the specific unary selector described by Name. More...

unsigned	getNumArgs () const

IdentifierInfo *	getIdentifierInfoForSlot (unsigned argIndex) const
	Retrieve the identifier at a given position in the selector. More...

StringRef	getNameForSlot (unsigned argIndex) const
	Retrieve the name at a given position in the selector. More...

std::string	getAsString () const
	Derive the full selector name (e.g. More...

void	print (llvm::raw_ostream &OS) const
	Prints the full selector name (e.g. "foo:bar:"). More...

void	dump () const

ObjCMethodFamily	getMethodFamily () const
	Derive the conventional family of this method. More...

ObjCStringFormatFamily	getStringFormatFamily () const

Static Public Member Functions
static Selector	getEmptyMarker ()

static Selector	getTombstoneMarker ()

static ObjCInstanceTypeFamily	getInstTypeMethodFamily (Selector sel)

Friends
class	Diagnostic

class	SelectorTable

class	DeclarationName

Detailed Description

Smart pointer class that efficiently represents Objective-C method names.

This class will either point to an IdentifierInfo or a MultiKeywordSelector (which is private). This enables us to optimize selectors that take no arguments and selectors that take 1 argument, which accounts for 78% of all selectors in Cocoa.h.

Definition at line 759 of file IdentifierTable.h.

Constructor & Destructor Documentation

◆ Selector() [1/2]

clang::Selector::Selector ( )

default

The default ctor should only be used when creating data structures that will contain selectors.

◆ Selector() [2/2]

clang::Selector::Selector ( uintptr_t V )

inlineexplicit

Definition at line 814 of file IdentifierTable.h.

Member Function Documentation

◆ dump()

LLVM_DUMP_METHOD void Selector::dump ( ) const

Definition at line 629 of file IdentifierTable.cpp.

References print().

◆ getAsOpaquePtr()

void* clang::Selector::getAsOpaquePtr ( ) const

inline

Definition at line 824 of file IdentifierTable.h.

Referenced by clang::ASTWriter::getSelectorRef().

◆ getAsString()

std::string Selector::getAsString ( ) const

Derive the full selector name (e.g.

"foo:bar:") and return it as an std::string.

Definition at line 602 of file IdentifierTable.cpp.

References clang::IdentifierInfo::getName(), and string().

Referenced by clang::ast_matchers::AST_MATCHER_P(), clang::Sema::CheckMessageArgumentTypes(), clang::Sema::ParseObjCSelectorExpression(), and clang::Sema::SelectorsForTypoCorrection().

◆ getEmptyMarker()

static Selector clang::Selector::getEmptyMarker ( )

inlinestatic

Definition at line 891 of file IdentifierTable.h.

Referenced by llvm::DenseMapInfo< clang::Selector >::getEmptyKey().

◆ getIdentifierInfoForSlot()

IdentifierInfo * Selector::getIdentifierInfoForSlot ( unsigned argIndex ) const

Retrieve the identifier at a given position in the selector.

Note that the identifier pointer returned may be NULL. Clients that only care about the text of the identifier string, and not the specific, uniqued identifier pointer, should use getNameForSlot(), which returns an empty string when the identifier pointer would be NULL.

Parameters

argIndex The index for which we want to retrieve the identifier. This index shall be less than getNumArgs() unless this is a keyword selector, in which case 0 is the only permissible value.

Returns: the uniqued identifier for this slot, or NULL if this slot has no corresponding identifier.

Definition at line 574 of file IdentifierTable.cpp.

References clang::MultiKeywordSelector::getIdentifierInfoForSlot().

Referenced by clang::ento::ObjCMethodCall::argumentsMayEscape(), clang::serialization::ComputeHash(), clang::CodeCompletionResult::createCodeCompletionStringForDecl(), GetAssumedMessageSendExprType(), getInstTypeMethodFamily(), clang::ASTImporter::Import(), isAcceptableObjCSelector(), IsStructurallyEquivalent(), and clang::CodeGen::CodeGenFunction::StartObjCMethod().

◆ getInstTypeMethodFamily()

ObjCInstanceTypeFamily Selector::getInstTypeMethodFamily ( Selector sel )

static

Definition at line 688 of file IdentifierTable.cpp.

References getIdentifierInfoForSlot(), clang::IdentifierInfo::getName(), clang::transformer::name(), clang::OIT_Array, clang::OIT_Dictionary, clang::OIT_Init, clang::OIT_None, clang::OIT_ReturnsSelf, clang::OIT_Singleton, and startsWithWord().

◆ getMethodFamily()

ObjCMethodFamily clang::Selector::getMethodFamily ( ) const

inline

Derive the conventional family of this method.

Definition at line 883 of file IdentifierTable.h.

Referenced by clang::ObjCMethodDecl::getMethodFamily(), clang::ObjCMessageExpr::getMethodFamily(), clang::Sema::ParseObjCSelectorExpression(), and tryGenerateSpecializedMessageSend().

◆ getNameForSlot()

StringRef Selector::getNameForSlot ( unsigned argIndex ) const

Retrieve the name at a given position in the selector.

Parameters

argIndex The index for which we want to retrieve the name. This index shall be less than getNumArgs() unless this is a keyword selector, in which case 0 is the only permissible value.

Returns: the name for this slot, which may be the empty string if no name was supplied.

Definition at line 585 of file IdentifierTable.cpp.

References clang::IdentifierInfo::getName().

Referenced by clang::DeclarationName::compare(), clang::CodeCompletionResult::createCodeCompletionStringForDecl(), clang::Sema::DiagnoseAssignmentAsCondition(), clang::extractapi::DeclarationFragmentsBuilder::getFragmentsForObjCMethod(), hasDefaultGetterName(), hasDefaultSetterName(), isAcceptableMethodMismatch(), isSetterLikeSelector(), isUnitTest(), rewriteToObjCProperty(), tryEmitSpecializedAllocInit(), and tryGenerateSpecializedMessageSend().

◆ getNumArgs()

unsigned Selector::getNumArgs ( ) const

Definition at line 563 of file IdentifierTable.cpp.

References clang::detail::DeclarationNameExtra::getNumArgs().

Referenced by clang::ento::ObjCMethodCall::argumentsMayEscape(), clang::Sema::CheckMessageArgumentTypes(), clang::DeclarationName::compare(), clang::serialization::ComputeHash(), clang::CodeCompletionResult::createCodeCompletionStringForDecl(), clang::ObjCMethodDecl::findPropertyDecl(), clang::extractapi::DeclarationFragmentsBuilder::getFragmentsForObjCMethod(), clang::ObjCSelectorExpr::getNumArgs(), clang::ObjCMethodDecl::getNumSelectorLocs(), clang::ObjCMessageExpr::getNumSelectorLocs(), clang::ASTImporter::Import(), isAcceptableObjCSelector(), isSetterLikeSelector(), IsStructurallyEquivalent(), clang::ObjCMethodDecl::sel_param_end(), clang::Sema::SelectorsForTypoCorrection(), and tryGenerateSpecializedMessageSend().

◆ getStringFormatFamily()

ObjCStringFormatFamily clang::Selector::getStringFormatFamily ( ) const

inline

Definition at line 887 of file IdentifierTable.h.

◆ getTombstoneMarker()

static Selector clang::Selector::getTombstoneMarker ( )

inlinestatic

Definition at line 895 of file IdentifierTable.h.

Referenced by llvm::DenseMapInfo< clang::Selector >::getTombstoneKey().

◆ isKeywordSelector() [1/2]

bool clang::Selector::isKeywordSelector ( ) const

inline

Definition at line 832 of file IdentifierTable.h.

Referenced by tryGenerateSpecializedMessageSend().

◆ isKeywordSelector() [2/2]

bool Selector::isKeywordSelector ( ArrayRef< StringRef > Names ) const

If this selector is the specific keyword selector described by Names.

Definition at line 548 of file IdentifierTable.cpp.

◆ isNull()

bool clang::Selector::isNull ( ) const

inline

Determine whether this is the empty selector.

Definition at line 829 of file IdentifierTable.h.

Referenced by GetAssumedMessageSendExprType(), clang::MultiplexExternalSemaSource::GetExternalSelector(), clang::ASTImporter::Import(), and clang::lazyInitKeywordSelector().

◆ isUnarySelector() [1/2]

bool clang::Selector::isUnarySelector ( ) const

inline

Definition at line 836 of file IdentifierTable.h.

Referenced by clang::Sema::CheckMessageArgumentTypes(), clang::CodeCompletionResult::createCodeCompletionStringForDecl(), clang::Sema::DiagnoseAssignmentAsCondition(), clang::ObjCMethodDecl::getNumSelectorLocs(), clang::ObjCMessageExpr::getNumSelectorLocs(), isAcceptableMethodMismatch(), isAcceptableObjCSelector(), isSetterLikeSelector(), clang::CodeGen::CodeGenFunction::StartObjCMethod(), tryEmitSpecializedAllocInit(), and tryGenerateSpecializedMessageSend().

◆ isUnarySelector() [2/2]

bool Selector::isUnarySelector ( StringRef Name ) const

If this selector is the specific unary selector described by Name.

Definition at line 559 of file IdentifierTable.cpp.

◆ operator!=()

bool clang::Selector::operator!= ( Selector RHS ) const

inline

Definition at line 820 of file IdentifierTable.h.

◆ operator==()

bool clang::Selector::operator== ( Selector RHS ) const

inline

operator==/!= - Indicate whether the specified selectors are identical.

Definition at line 817 of file IdentifierTable.h.

◆ print()

void Selector::print ( llvm::raw_ostream & OS ) const

Prints the full selector name (e.g. "foo:bar:").

Definition at line 625 of file IdentifierTable.cpp.

References clang::getAsString().

Referenced by CompareReturnTypes(), clang::MangleContext::mangleObjCMethodName(), clang::JSONNodeDumper::VisitObjCMessageExpr(), and clang::JSONNodeDumper::VisitObjCSelectorExpr().

Friends And Related Function Documentation

◆ DeclarationName

friend class DeclarationName

friend

Definition at line 762 of file IdentifierTable.h.

◆ Diagnostic

friend class Diagnostic

friend

Definition at line 760 of file IdentifierTable.h.

◆ SelectorTable

friend class SelectorTable

friend

Definition at line 761 of file IdentifierTable.h.

The documentation for this class was generated from the following files:

include/clang/Basic/IdentifierTable.h
lib/Basic/IdentifierTable.cpp

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Selector() [1/2]

◆ Selector() [2/2]

Member Function Documentation

◆ dump()

◆ getAsOpaquePtr()

◆ getAsString()

◆ getEmptyMarker()

◆ getIdentifierInfoForSlot()

◆ getInstTypeMethodFamily()

◆ getMethodFamily()

◆ getNameForSlot()

◆ getNumArgs()

◆ getStringFormatFamily()

◆ getTombstoneMarker()

◆ isKeywordSelector() [1/2]

◆ isKeywordSelector() [2/2]

◆ isNull()

◆ isUnarySelector() [1/2]

◆ isUnarySelector() [2/2]

◆ operator!=()

◆ operator==()

◆ print()

Friends And Related Function Documentation

◆ DeclarationName

◆ Diagnostic

◆ SelectorTable