Defines the interface file. More...

#include "llvm/TextAPI/InterfaceFile.h"

Classes
struct	const_symbol_iterator

Public Types
using	const_target_iterator = TargetList::const_iterator

using	const_target_range = llvm::iterator_range< const_target_iterator >

using	const_filtered_target_iterator = llvm::filter_iterator< const_target_iterator, std::function< bool(const Target &)> >

using	const_filtered_target_range = llvm::iterator_range< const_filtered_target_iterator >

using	SymbolMapType = DenseMap< SymbolsMapKey, Symbol * >

using	const_symbol_range = iterator_range< const_symbol_iterator >

using	const_filtered_symbol_iterator = filter_iterator< const_symbol_iterator, std::function< bool(const Symbol *)> >

using	const_filtered_symbol_range = iterator_range< const_filtered_symbol_iterator >

Public Member Functions
void	setPath (StringRef Path_)
	Set the path from which this file was generated (if applicable).

StringRef	getPath () const
	Get the path from which this file was generated (if applicable).

void	setFileType (FileType Kind)
	Set the file type.

FileType	getFileType () const
	Get the file type.

ArchitectureSet	getArchitectures () const
	Get the architectures.

PlatformSet	getPlatforms () const
	Get the platforms.

void	addTarget (const Target &Target)
	Set and add target.

template<typename RangeT >
void	addTargets (RangeT &&Targets)
	Set and add targets.

const_target_range	targets () const

const_filtered_target_range	targets (ArchitectureSet Archs) const

void	setInstallName (StringRef InstallName_)
	Set the install name of the library.

StringRef	getInstallName () const
	Get the install name of the library.

void	setCurrentVersion (PackedVersion Version)
	Set the current version of the library.

PackedVersion	getCurrentVersion () const
	Get the current version of the library.

void	setCompatibilityVersion (PackedVersion Version)
	Set the compatibility version of the library.

PackedVersion	getCompatibilityVersion () const
	Get the compatibility version of the library.

void	setSwiftABIVersion (uint8_t Version)
	Set the Swift ABI version of the library.

uint8_t	getSwiftABIVersion () const
	Get the Swift ABI version of the library.

void	setTwoLevelNamespace (bool V=true)
	Specify if the library uses two-level namespace (or flat namespace).

bool	isTwoLevelNamespace () const
	Check if the library uses two-level namespace.

void	setApplicationExtensionSafe (bool V=true)
	Specify if the library is application extension safe (or not).

bool	isApplicationExtensionSafe () const
	Check if the library is application extension safe.

void	setObjCConstraint (ObjCConstraintType Constraint)
	Set the Objective-C constraint.

ObjCConstraintType	getObjCConstraint () const
	Get the Objective-C constraint.

void	setInstallAPI (bool V=true)
	Specify if this file was generated during InstallAPI (or not).

bool	isInstallAPI () const
	Check if this file was generated during InstallAPI.

void	addParentUmbrella (const Target &Target_, StringRef Parent)
	Set the parent umbrella frameworks.

const std::vector< std::pair< Target, std::string > > &	umbrellas () const
	Get the list of Parent Umbrella frameworks.

void	addAllowableClient (StringRef InstallName, const Target &Target)
	Add an allowable client.

const std::vector< InterfaceFileRef > &	allowableClients () const
	Get the list of allowable clients.

void	addReexportedLibrary (StringRef InstallName, const Target &Target)
	Add a re-exported library.

const std::vector< InterfaceFileRef > &	reexportedLibraries () const
	Get the list of re-exported libraries.

void	addUUID (const Target &Target, StringRef UUID)
	Add an Target/UUID pair.

void	addUUID (const Target &Target, uint8_t UUID[16])
	Add an Target/UUID pair.

const std::vector< std::pair< Target, std::string > > &	uuids () const
	Get the list of Target/UUID pairs.

void	addDocument (std::shared_ptr< InterfaceFile > &&Document)
	Add a library for inlining to top level library.

InterfaceFile *	getParent () const
	Returns the pointer to parent document if exists or nullptr otherwise.

const std::vector< std::shared_ptr< InterfaceFile > > &	documents () const
	Get the list of inlined libraries.

void	addRPath (const Target &InputTarget, StringRef RPath)
	Set the runpath search paths.

const std::vector< std::pair< Target, std::string > > &	rpaths () const
	Get the list of runpath search paths.

void	addSymbol (SymbolKind Kind, StringRef Name, const TargetList &Targets, SymbolFlags Flags=SymbolFlags::None)
	Add a symbol to the symbols list or extend an existing one.

const_symbol_range	symbols () const

size_t	symbolsCount () const

const_filtered_symbol_range	exports () const

const_filtered_symbol_range	reexports () const

const_filtered_symbol_range	undefineds () const

bool	operator== (const InterfaceFile &O) const
	The equality is determined by attributes that impact linking compatibilities.

bool	operator!= (const InterfaceFile &O) const

Detailed Description

Defines the interface file.

Definition at line 155 of file InterfaceFile.h.

Member Typedef Documentation

◆ const_filtered_symbol_iterator

using llvm::MachO::InterfaceFile::const_filtered_symbol_iterator = filter_iterator<const_symbol_iterator, std::function<bool(const Symbol *)> >

Definition at line 385 of file InterfaceFile.h.

◆ const_filtered_symbol_range

using llvm::MachO::InterfaceFile::const_filtered_symbol_range = iterator_range<const_filtered_symbol_iterator>

Definition at line 388 of file InterfaceFile.h.

◆ const_filtered_target_iterator

using llvm::MachO::InterfaceFile::const_filtered_target_iterator = llvm::filter_iterator<const_target_iterator, std::function<bool(const Target &)> >

Definition at line 211 of file InterfaceFile.h.

◆ const_filtered_target_range

using llvm::MachO::InterfaceFile::const_filtered_target_range = llvm::iterator_range<const_filtered_target_iterator>

Definition at line 214 of file InterfaceFile.h.

◆ const_symbol_range

using llvm::MachO::InterfaceFile::const_symbol_range = iterator_range<const_symbol_iterator>

Definition at line 383 of file InterfaceFile.h.

◆ const_target_iterator

using llvm::MachO::InterfaceFile::const_target_iterator = TargetList::const_iterator

Definition at line 207 of file InterfaceFile.h.

◆ const_target_range

using llvm::MachO::InterfaceFile::const_target_range = llvm::iterator_range<const_target_iterator>

Definition at line 208 of file InterfaceFile.h.

◆ SymbolMapType

using llvm::MachO::InterfaceFile::SymbolMapType = DenseMap<SymbolsMapKey, Symbol *>

Definition at line 367 of file InterfaceFile.h.

Member Function Documentation

◆ addAllowableClient()

void InterfaceFile::addAllowableClient	(	StringRef	InstallName,
		const Target &	Target
	)

Add an allowable client.

Mach-O Dynamic libraries have the concept of allowable clients that are checked during static link time. The name of the application or library that is being generated needs to match one of the allowable clients or the linker refuses to link this library.

Parameters

InstallName	The name of the client that is allowed to link this library.
Target	The target triple for which this applies.

Definition at line 49 of file InterfaceFile.cpp.

References InstallName.

◆ addDocument()

void InterfaceFile::addDocument ( std::shared_ptr< InterfaceFile > && Document )

Add a library for inlining to top level library.

Parameters

Document The library to inline with top level library.

Definition at line 134 of file InterfaceFile.cpp.

References LHS, llvm::lower_bound(), and RHS.

◆ addParentUmbrella()

void InterfaceFile::addParentUmbrella	(	const Target &	Target_,
		StringRef	Parent
	)

Set the parent umbrella frameworks.

Parameters

Target_	The target applicable to Parent
Parent	The name of Parent

Definition at line 61 of file InterfaceFile.cpp.

References LHS, llvm::lower_bound(), and RHS.

◆ addReexportedLibrary()

void InterfaceFile::addReexportedLibrary	(	StringRef	InstallName,
		const Target &	Target
	)

Add a re-exported library.

Parameters

InstallName	The name of the library to re-export.
Target	The target triple for which this applies.

Definition at line 55 of file InterfaceFile.cpp.

References InstallName, and llvm::Lib.

◆ addRPath()

void InterfaceFile::addRPath	(	const Target &	InputTarget,
		StringRef	RPath
	)

Set the runpath search paths.

Parameters

InputTarget	The target applicable to runpath search path.
RPath	The name of runpath.

Definition at line 74 of file InterfaceFile.cpp.

References LHS, llvm::lower_bound(), RHS, and RPath.

◆ addSymbol()

void InterfaceFile::addSymbol	(	SymbolKind	Kind,
		StringRef	Name,
		const TargetList &	Targets,
		SymbolFlags	Flags = `SymbolFlags::None`
	)

Add a symbol to the symbols list or extend an existing one.

Definition at line 123 of file InterfaceFile.cpp.

References Flags, Name, Targets, and llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::try_emplace().

◆ addTarget()

void InterfaceFile::addTarget ( const Target & Target )

Set and add target.

Parameters

Target the target to add into.

Definition at line 111 of file InterfaceFile.cpp.

Referenced by addTargets().

◆ addTargets()

template<typename RangeT >

void llvm::MachO::InterfaceFile::addTargets ( RangeT && Targets )

inline

Set and add targets.

Add the subset of llvm::triples that is supported by Tapi

Parameters

Targets the collection of targets.

Definition at line 202 of file InterfaceFile.h.

References addTarget().

◆ addUUID() [1/2]

void InterfaceFile::addUUID	(	const Target &	Target,
		StringRef	UUID
	)

Add an Target/UUID pair.

Parameters

Target	The target triple for which this applies.
UUID	The UUID of the library for the specified architecture.

Definition at line 87 of file InterfaceFile.cpp.

References LHS, llvm::lower_bound(), and RHS.

Referenced by addUUID().

◆ addUUID() [2/2]

void InterfaceFile::addUUID	(	const Target &	Target,
		uint8_t	UUID[16]
	)

Add an Target/UUID pair.

Parameters

Target	The target triple for which this applies.
UUID	The UUID of the library for the specified architecture.

Definition at line 100 of file InterfaceFile.cpp.

References addUUID().

◆ allowableClients()

const std::vector< InterfaceFileRef > & llvm::MachO::InterfaceFile::allowableClients ( ) const

inline

Get the list of allowable clients.

Returns: Returns a list of allowable clients.

Definition at line 300 of file InterfaceFile.h.

◆ documents()

const std::vector< std::shared_ptr< InterfaceFile > > & llvm::MachO::InterfaceFile::documents ( ) const

inline

Get the list of inlined libraries.

Returns: Returns a list of the inlined frameworks.

Definition at line 347 of file InterfaceFile.h.

◆ exports()

const_filtered_symbol_range llvm::MachO::InterfaceFile::exports ( ) const

inline

Definition at line 397 of file InterfaceFile.h.

References llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::begin(), llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::end(), llvm::MachO::Symbol::isReexported(), llvm::MachO::Symbol::isUndefined(), and llvm::make_filter_range().

◆ getArchitectures()

ArchitectureSet llvm::MachO::InterfaceFile::getArchitectures ( ) const

inline

Get the architectures.

Returns: The applicable architectures.

Definition at line 183 of file InterfaceFile.h.

References llvm::MachO::mapToArchitectureSet().

◆ getCompatibilityVersion()

PackedVersion llvm::MachO::InterfaceFile::getCompatibilityVersion ( ) const

inline

Get the compatibility version of the library.

Definition at line 238 of file InterfaceFile.h.

◆ getCurrentVersion()

PackedVersion llvm::MachO::InterfaceFile::getCurrentVersion ( ) const

inline

Get the current version of the library.

Definition at line 230 of file InterfaceFile.h.

◆ getFileType()

FileType llvm::MachO::InterfaceFile::getFileType ( ) const

inline

Get the file type.

Returns: The file type.

Definition at line 178 of file InterfaceFile.h.

◆ getInstallName()

StringRef llvm::MachO::InterfaceFile::getInstallName ( ) const

inline

Get the install name of the library.

Definition at line 224 of file InterfaceFile.h.

◆ getObjCConstraint()

ObjCConstraintType llvm::MachO::InterfaceFile::getObjCConstraint ( ) const

inline

Get the Objective-C constraint.

Definition at line 264 of file InterfaceFile.h.

◆ getParent()

InterfaceFile * llvm::MachO::InterfaceFile::getParent ( ) const

inline

Returns the pointer to parent document if exists or nullptr otherwise.

Definition at line 342 of file InterfaceFile.h.

◆ getPath()

StringRef llvm::MachO::InterfaceFile::getPath ( ) const

inline

Get the path from which this file was generated (if applicable).

Returns: The path to the source file or empty.

Definition at line 165 of file InterfaceFile.h.

◆ getPlatforms()

PlatformSet llvm::MachO::InterfaceFile::getPlatforms ( ) const

inline

Get the platforms.

Returns: The applicable platforms.

Definition at line 190 of file InterfaceFile.h.

References llvm::MachO::mapToPlatformSet().

◆ getSwiftABIVersion()

uint8_t llvm::MachO::InterfaceFile::getSwiftABIVersion ( ) const

inline

Get the Swift ABI version of the library.

Definition at line 244 of file InterfaceFile.h.

◆ isApplicationExtensionSafe()

bool llvm::MachO::InterfaceFile::isApplicationExtensionSafe ( ) const

inline

Check if the library is application extension safe.

Definition at line 256 of file InterfaceFile.h.

◆ isInstallAPI()

bool llvm::MachO::InterfaceFile::isInstallAPI ( ) const

inline

Check if this file was generated during InstallAPI.

Definition at line 270 of file InterfaceFile.h.

◆ isTwoLevelNamespace()

bool llvm::MachO::InterfaceFile::isTwoLevelNamespace ( ) const

inline

Check if the library uses two-level namespace.

Definition at line 250 of file InterfaceFile.h.

◆ operator!=()

bool llvm::MachO::InterfaceFile::operator!= ( const InterfaceFile & O ) const

inline

Definition at line 430 of file InterfaceFile.h.

◆ operator==()

bool InterfaceFile::operator== ( const InterfaceFile & O ) const

The equality is determined by attributes that impact linking compatibilities.

UUIDs, Path, & FileKind are irrelevant since these by itself should not impact linking. This is an expensive operation.

Definition at line 148 of file InterfaceFile.cpp.

References InstallName, isYAMLTextStub(), LHS, llvm::MachO::mapToPlatformVersionSet(), and RHS.

◆ reexportedLibraries()

const std::vector< InterfaceFileRef > & llvm::MachO::InterfaceFile::reexportedLibraries ( ) const

inline

Get the list of re-exported libraries.

Returns: Returns a list of re-exported libraries.

Definition at line 313 of file InterfaceFile.h.

◆ reexports()

const_filtered_symbol_range llvm::MachO::InterfaceFile::reexports ( ) const

inline

Definition at line 406 of file InterfaceFile.h.

References llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::begin(), llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::end(), llvm::MachO::Symbol::isReexported(), and llvm::make_filter_range().

◆ rpaths()

const std::vector< std::pair< Target, std::string > > & llvm::MachO::InterfaceFile::rpaths ( ) const

inline

Get the list of runpath search paths.

Returns: Returns a list of the rpaths per target.

Definition at line 359 of file InterfaceFile.h.

◆ setApplicationExtensionSafe()

void llvm::MachO::InterfaceFile::setApplicationExtensionSafe ( bool V = true )

inline

Specify if the library is application extension safe (or not).

Definition at line 253 of file InterfaceFile.h.

◆ setCompatibilityVersion()

void llvm::MachO::InterfaceFile::setCompatibilityVersion ( PackedVersion Version )

inline

Set the compatibility version of the library.

Definition at line 233 of file InterfaceFile.h.

◆ setCurrentVersion()

void llvm::MachO::InterfaceFile::setCurrentVersion ( PackedVersion Version )

inline

Set the current version of the library.

Definition at line 227 of file InterfaceFile.h.

◆ setFileType()

void llvm::MachO::InterfaceFile::setFileType ( FileType Kind )

inline

Set the file type.

This is used by the YAML writer to identify the specification it should use for writing the file.

Parameters

Kind	The file type.

Definition at line 173 of file InterfaceFile.h.

◆ setInstallAPI()

void llvm::MachO::InterfaceFile::setInstallAPI ( bool V = true )

inline

Specify if this file was generated during InstallAPI (or not).

Definition at line 267 of file InterfaceFile.h.

◆ setInstallName()

void llvm::MachO::InterfaceFile::setInstallName ( StringRef InstallName_ )

inline

Set the install name of the library.

Definition at line 219 of file InterfaceFile.h.

◆ setObjCConstraint()

void llvm::MachO::InterfaceFile::setObjCConstraint ( ObjCConstraintType Constraint )

inline

Set the Objective-C constraint.

Definition at line 259 of file InterfaceFile.h.

◆ setPath()

void llvm::MachO::InterfaceFile::setPath ( StringRef Path_ )

inline

Set the path from which this file was generated (if applicable).

Parameters

Path_ The path to the source file.

Definition at line 160 of file InterfaceFile.h.

◆ setSwiftABIVersion()

void llvm::MachO::InterfaceFile::setSwiftABIVersion ( uint8_t Version )

inline

Set the Swift ABI version of the library.

Definition at line 241 of file InterfaceFile.h.

◆ setTwoLevelNamespace()

void llvm::MachO::InterfaceFile::setTwoLevelNamespace ( bool V = true )

inline

Specify if the library uses two-level namespace (or flat namespace).

Definition at line 247 of file InterfaceFile.h.

◆ symbols()

const_symbol_range llvm::MachO::InterfaceFile::symbols ( ) const

inline

Definition at line 391 of file InterfaceFile.h.

References llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::begin(), and llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::end().

◆ symbolsCount()

size_t llvm::MachO::InterfaceFile::symbolsCount ( ) const

inline

Definition at line 395 of file InterfaceFile.h.

References llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::size().

◆ targets() [1/2]

const_target_range llvm::MachO::InterfaceFile::targets ( ) const

inline

Definition at line 209 of file InterfaceFile.h.

◆ targets() [2/2]

InterfaceFile::const_filtered_target_range InterfaceFile::targets ( ArchitectureSet Archs ) const

Definition at line 116 of file InterfaceFile.cpp.

References llvm::MachO::ArchitectureSet::has(), and llvm::make_filter_range().

◆ umbrellas()

const std::vector< std::pair< Target, std::string > > & llvm::MachO::InterfaceFile::umbrellas ( ) const

inline

Get the list of Parent Umbrella frameworks.

Returns: Returns a list of target information and install name of parent umbrellas.

Definition at line 281 of file InterfaceFile.h.

◆ undefineds()

const_filtered_symbol_range llvm::MachO::InterfaceFile::undefineds ( ) const

inline

Definition at line 415 of file InterfaceFile.h.

References llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::begin(), llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::end(), llvm::MachO::Symbol::isUndefined(), and llvm::make_filter_range().

◆ uuids()

const std::vector< std::pair< Target, std::string > > & llvm::MachO::InterfaceFile::uuids ( ) const

inline

Get the list of Target/UUID pairs.

Returns: Returns a list of Target/UUID pairs.

Definition at line 332 of file InterfaceFile.h.

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

include/llvm/TextAPI/InterfaceFile.h
lib/TextAPI/InterfaceFile.cpp

Classes

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ const_filtered_symbol_iterator

◆ const_filtered_symbol_range

◆ const_filtered_target_iterator

◆ const_filtered_target_range

◆ const_symbol_range

◆ const_target_iterator

◆ const_target_range

◆ SymbolMapType

Member Function Documentation

◆ addAllowableClient()

◆ addDocument()

◆ addParentUmbrella()

◆ addReexportedLibrary()

◆ addRPath()

◆ addSymbol()

◆ addTarget()

◆ addTargets()

◆ addUUID() [1/2]

◆ addUUID() [2/2]

◆ allowableClients()

◆ documents()

◆ exports()

◆ getArchitectures()

◆ getCompatibilityVersion()

◆ getCurrentVersion()

◆ getFileType()

◆ getInstallName()

◆ getObjCConstraint()

◆ getParent()

◆ getPath()

◆ getPlatforms()

◆ getSwiftABIVersion()

◆ isApplicationExtensionSafe()

◆ isInstallAPI()

◆ isTwoLevelNamespace()

◆ operator!=()

◆ operator==()

◆ reexportedLibraries()

◆ reexports()

◆ rpaths()

◆ setApplicationExtensionSafe()

◆ setCompatibilityVersion()

◆ setCurrentVersion()

◆ setFileType()

◆ setInstallAPI()

◆ setInstallName()

◆ setObjCConstraint()

◆ setPath()

◆ setSwiftABIVersion()

◆ setTwoLevelNamespace()

◆ symbols()

◆ symbolsCount()

◆ targets() [1/2]

◆ targets() [2/2]

◆ umbrellas()

◆ undefineds()

◆ uuids()