#include <apibaseid.h>

Inheritance diagram for Id:

Detailed Description

Id represents an identifier consisting of a c-string. Such identifiers are used mainly to identify entities such as interfaces, components, classes, registries, entries, modules or published objects.

Public Member Functions
constexpr	Id ()

	Id (const volatile Char *str)

template<UInt N>
constexpr	Id (const Char(&str)[N])

	Id (Id &&other)

	Id (const Id &other)

	~Id ()

void	Reset ()

	MAXON_OPERATOR_MOVE_ASSIGNMENT (Id)

Id &	operator= (const Id &other)

ResultMem	Init (const Char *str, Bool copyString)

ResultMem	Init (const Block< const Char > &str)

ResultMem	Init (const CString &str)

ResultMem	Init (CString &&str)

ResultMem	Init (const String &str)

void	Init (const InternedId &id)

void	Init (const RefCountedCString *str)

Public Member Functions inherited from LiteralId
constexpr	LiteralId ()

constexpr	LiteralId (const LiteralId &)=default

MAXON_IMPLICIT	LiteralId (const Id &)=delete

constexpr LiteralId &	operator= (const LiteralId &)=default

LiteralId &	operator= (const Id &)=delete

template<UInt N>
constexpr	LiteralId (const Char(&str)[N])

Bool	operator== (const LiteralId &other) const

Bool	operator< (const LiteralId &other) const

	MAXON_OPERATOR_COMPARISON (LiteralId)

COMPARERESULT	Compare (const LiteralId &other) const

constexpr HashInt	GetHashCode () const

UniqueHash	GetUniqueHashCode () const

constexpr Bool	IsEmpty () const

constexpr Bool	IsPopulated () const

constexpr const Char *	GetCString () const

constexpr Int	GetCStringLength () const

String	ToString (const FormatStatement *formatStatement=nullptr) const

CString	ToCString () const

Block< const Char >	ToBlock () const

const Id &	Get () const

	operator const Id & () const

Bool	UsesRefCountedCString () const

template<UInt N>
constexpr	LiteralId (bool dummy, const Char(&str)[N])

constexpr	LiteralId (bool dummy, const LiteralId &src)

template<typename T , typename = typename T::DeclarationHelper>
constexpr	LiteralId (bool dummy, const T &decl)

Static Public Member Functions
static MAXON_ATTRIBUTE_FORCE_INLINE const Id &	NullValue ()

template<typename... INPUTTYPE>
static Result< Id >	Create (INPUTTYPE &&... inputId)

Static Public Member Functions inherited from LiteralId
static constexpr HashInt	GetHashCode (const Char *str)

Private Member Functions
	Id (const CString &)=delete

const RefCountedCString *	GetRCString () const

Additional Inherited Members
Static Public Attributes inherited from LiteralId
static const Int	MAX_LENGTH_EXPONENT

static const UInt	LOW_HASH_MASK

static const Int	MAX_LENGTH

Protected Member Functions inherited from LiteralId
constexpr	LiteralId (const Char *value, UInt hash)

	LiteralId (ENUM_DONT_INITIALIZE)

Protected Attributes inherited from LiteralId
const Char *	_value

UInt	_hash

Static Protected Attributes inherited from LiteralId
static const Int	RC_STRING_BIT

static const UInt	RC_STRING_MASK

static const UInt	HASH_MASK

Constructor & Destructor Documentation

◆ Id() [1/6]

constexpr Id ( )

constexpr

Constructs a null Id. The internal c-string will be nullptr.

◆ Id() [2/6]

Id ( const volatile Char * str )

explicit

Constructs an Id for a given c-string. str is used directly for the internal c-string pointer.

Warning: The c-string has to exist at least as long as the constructed Id. If you can't guarantee that, you have to use the Init function.

Parameters

[in] str Identifier as c-string, may be nullptr. This will always be used directly, i.e., no copy is made.

◆ Id() [3/6]

constexpr Id ( const Char(&) str[N] )

explicitconstexpr

◆ Id() [4/6]

Id ( Id && other )

Constructs an Id by moving the values from another Id.

Parameters

[in] other Another Id to move from.

◆ Id() [5/6]

Id ( const Id & other )

Copy constructs an Id from another Id.

Parameters

[in] other Another Id to copy from.

◆ ~Id()

~Id ( )

Destructs the Id. If the Id uses a RefCountedCString, the reference will be removed.

◆ Id() [6/6]

Id ( const CString & )

explicitprivatedelete

Member Function Documentation

◆ NullValue()

static MAXON_ATTRIBUTE_FORCE_INLINE const Id& NullValue ( )

static

◆ Reset()

void Reset ( void )

Resets the Id. Afterwards, its internal c-string will be nullptr.

◆ MAXON_OPERATOR_MOVE_ASSIGNMENT()

MAXON_OPERATOR_MOVE_ASSIGNMENT ( Id )

◆ operator=()

Id& operator= ( const Id & other )

◆ Init() [1/7]

ResultMem Init	(	const Char *	str,
		Bool	copyString
	)

Sets this Id to a new value. If copyString is false, str is used directly for the internal c-string pointer, and it is assumed that the c-string exists at least as long as this Id. Otherwise, if copyString is true, a RefCountedCString is created for str and used for the internal c-string.

Parameters

[in]	str	Identifier as c-string, may be nullptr.
[in]	copyString	If true, a copy of str is made at first (as a RefCountedCString).

Returns: False if a copy had to be made, but the allocation failed. True otherwise.

◆ Init() [2/7]

ResultMem Init ( const Block< const Char > & str )

Sets this Id to str. A RefCountedCString is created for str and used for the internal c-string.

Parameters

[in] str Identifier as a block of characters (no null termination required).

Returns: False if the allocation for the RefCountedCString failed. True otherwise.

◆ Init() [3/7]

ResultMem Init ( const CString & str )

Sets this Id to str. A RefCountedCString is created for str and used for the internal c-string.

Parameters

[in] str Identifier as CString.

Returns: False if the allocation for the RefCountedCString failed. True otherwise.

◆ Init() [4/7]

ResultMem Init ( CString && str )

Sets this Id to str. A RefCountedCString is created for str and used for the internal c-string.

Parameters

[in] str Identifier as CString, The string is empty afterwards!

Returns: False if the allocation for the RefCountedCString failed. True otherwise.

◆ Init() [5/7]

ResultMem Init ( const String & str )

Sets this Id to str.

Parameters

[in] str Identifier as String.

Returns: False if the allocation failed. True otherwise.

◆ Init() [6/7]

void Init ( const InternedId & id )

Sets this Id to id.

Parameters

[in] id Interned Id.

◆ Init() [7/7]

void Init ( const RefCountedCString * str )

Sets this Id to a RefCountedCString.

Parameters

[in] str Identifier as RefCountedCString.

◆ Create()

Result< Id > Create ( INPUTTYPE &&... inputId )

static

Creates a new Id for the given inputId. All types for which there is an Id::Init function are supported.

Parameters

[in] inputId The id to use.

Template Parameters

INPUTTYPE The type of inputId. All types for which there is an Id::Init function are supported.

Returns: The inputId converted to Id.

◆ GetRCString()

const RefCountedCString* GetRCString ( ) const

private

Detailed Description

Public Member Functions

Static Public Member Functions

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ Id() [1/6]

◆ Id() [2/6]

◆ Id() [3/6]

◆ Id() [4/6]

◆ Id() [5/6]

◆ ~Id()

◆ Id() [6/6]

Member Function Documentation

◆ NullValue()

◆ Reset()

◆ MAXON_OPERATOR_MOVE_ASSIGNMENT()

◆ operator=()

◆ Init() [1/7]

◆ Init() [2/7]

◆ Init() [3/7]

◆ Init() [4/7]

◆ Init() [5/7]

◆ Init() [6/7]

◆ Init() [7/7]

◆ Create()

◆ GetRCString()