std_set_std_string.h File Reference

#include <MRCMisc/common.h>
#include <MRCMisc/exports.h>
#include <stdbool.h>
#include <stddef.h>

Go to the source code of this file.

Typedefs
typedef struct MR_std_string	MR_std_string
typedef struct MR_std_set_std_string	MR_std_set_std_string
typedef struct MR_std_set_std_string_const_iterator	MR_std_set_std_string_const_iterator

Functions
MRC_API MR_std_set_std_string *	MR_std_set_std_string_DefaultConstruct (void)
MRC_API MR_std_set_std_string *	MR_std_set_std_string_DefaultConstructArray (size_t num_elems)
MRC_API MR_std_set_std_string *	MR_std_set_std_string_ConstructFromAnother (MR_PassBy other_pass_by, MR_std_set_std_string *other)
MRC_API void	MR_std_set_std_string_AssignFromAnother (MR_std_set_std_string *_this, MR_PassBy other_pass_by, MR_std_set_std_string *other)
MRC_API void	MR_std_set_std_string_Destroy (const MR_std_set_std_string *_this)
	Destroys a heap-allocated instance of MR_std_set_std_string. Does nothing if the pointer is null.
MRC_API void	MR_std_set_std_string_DestroyArray (const MR_std_set_std_string *_this)
	Destroys a heap-allocated array of MR_std_set_std_string. Does nothing if the pointer is null.
MRC_API const MR_std_set_std_string *	MR_std_set_std_string_OffsetPtr (const MR_std_set_std_string *ptr, ptrdiff_t i)
MRC_API MR_std_set_std_string *	MR_std_set_std_string_OffsetMutablePtr (MR_std_set_std_string *ptr, ptrdiff_t i)
MRC_API size_t	MR_std_set_std_string_Size (const MR_std_set_std_string *_this)
MRC_API bool	MR_std_set_std_string_IsEmpty (const MR_std_set_std_string *_this)
MRC_API void	MR_std_set_std_string_Clear (MR_std_set_std_string *_this)
MRC_API bool	MR_std_set_std_string_Contains (const MR_std_set_std_string *_this, const char *key, const char *key_end)
MRC_API MR_std_set_std_string_const_iterator *	MR_std_set_std_string_Find (const MR_std_set_std_string *_this, const char *key, const char *key_end)
MRC_API void	MR_std_set_std_string_Insert (MR_std_set_std_string *_this, const char *new_elem, const char *new_elem_end)
MRC_API MR_std_set_std_string_const_iterator *	MR_std_set_std_string_Begin (const MR_std_set_std_string *_this)
MRC_API bool	MR_std_set_std_string_IsBegin (const MR_std_set_std_string *_this, const MR_std_set_std_string_const_iterator *iter)
MRC_API MR_std_set_std_string_const_iterator *	MR_std_set_std_string_End (const MR_std_set_std_string *_this)
MRC_API bool	MR_std_set_std_string_IsEnd (const MR_std_set_std_string *_this, const MR_std_set_std_string_const_iterator *iter)
MRC_API MR_std_set_std_string_const_iterator *	MR_std_set_std_string_const_iterator_DefaultConstruct (void)
MRC_API MR_std_set_std_string_const_iterator *	MR_std_set_std_string_const_iterator_DefaultConstructArray (size_t num_elems)
MRC_API MR_std_set_std_string_const_iterator *	MR_std_set_std_string_const_iterator_ConstructFromAnother (const MR_std_set_std_string_const_iterator *other)
MRC_API void	MR_std_set_std_string_const_iterator_AssignFromAnother (MR_std_set_std_string_const_iterator *_this, const MR_std_set_std_string_const_iterator *other)
MRC_API void	MR_std_set_std_string_const_iterator_Destroy (const MR_std_set_std_string_const_iterator *_this)
	Destroys a heap-allocated instance of MR_std_set_std_string_const_iterator. Does nothing if the pointer is null.
MRC_API void	MR_std_set_std_string_const_iterator_DestroyArray (const MR_std_set_std_string_const_iterator *_this)
	Destroys a heap-allocated array of MR_std_set_std_string_const_iterator. Does nothing if the pointer is null.
MRC_API const MR_std_set_std_string_const_iterator *	MR_std_set_std_string_const_iterator_OffsetPtr (const MR_std_set_std_string_const_iterator *ptr, ptrdiff_t i)
MRC_API MR_std_set_std_string_const_iterator *	MR_std_set_std_string_const_iterator_OffsetMutablePtr (MR_std_set_std_string_const_iterator *ptr, ptrdiff_t i)
MRC_API const MR_std_string *	MR_std_set_std_string_const_iterator_Deref (const MR_std_set_std_string_const_iterator *_this)
MRC_API void	MR_std_set_std_string_const_iterator_Incr (MR_std_set_std_string_const_iterator *_this)
MRC_API void	MR_std_set_std_string_const_iterator_Decr (MR_std_set_std_string_const_iterator *_this)

Typedef Documentation

MR_std_set_std_string

typedef struct MR_std_set_std_string MR_std_set_std_string

Generated from C++ container std::set<std::string>. Supported MR_PassBy modes: MR_PassBy_DefaultConstruct, MR_PassBy_Copy, MR_PassBy_Move (and MR_PassBy_DefaultArgument and MR_PassBy_NoObject if supported by the callee).

MR_std_set_std_string_const_iterator

typedef struct MR_std_set_std_string_const_iterator MR_std_set_std_string_const_iterator

Read-only iterator for MR_std_set_std_string. Supported MR_PassBy modes: MR_PassBy_DefaultConstruct, MR_PassBy_Copy, MR_PassBy_Move (and MR_PassBy_DefaultArgument and MR_PassBy_NoObject if supported by the callee).

MR_std_string

typedef struct MR_std_string MR_std_string

Function Documentation

MR_std_set_std_string_AssignFromAnother()

MRC_API void MR_std_set_std_string_AssignFromAnother	(	MR_std_set_std_string *	_this,
		MR_PassBy	other_pass_by,
		MR_std_set_std_string *	other )

Assigns the contents from another instance. Both objects remain alive after the call. Parameter _this can not be null. It is a single object. The reference to the parameter other might be preserved in this object. When this function is called, this object will drop any object references it had previously.

MR_std_set_std_string_Begin()

MRC_API MR_std_set_std_string_const_iterator * MR_std_set_std_string_Begin

(

const MR_std_set_std_string *

_this

)

The begin iterator, const. Parameter _this can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_std_set_std_string_const_iterator_Destroy() to free it when you're done using it.

MR_std_set_std_string_Clear()

MRC_API void MR_std_set_std_string_Clear

(

MR_std_set_std_string *

_this

)

Removes all elements from the container. Parameter _this can not be null. It is a single object. When this function is called, this object will drop any object references it had previously.

MR_std_set_std_string_const_iterator_AssignFromAnother()

MRC_API void MR_std_set_std_string_const_iterator_AssignFromAnother	(	MR_std_set_std_string_const_iterator *	_this,
		const MR_std_set_std_string_const_iterator *	other )

Assigns the contents from another instance. Both objects remain alive after the call. Parameter _this can not be null. It is a single object. Parameter other can not be null. It is a single object. The reference to the parameter other might be preserved in this object. When this function is called, this object will drop any object references it had previously.

MR_std_set_std_string_const_iterator_ConstructFromAnother()

MRC_API MR_std_set_std_string_const_iterator * MR_std_set_std_string_const_iterator_ConstructFromAnother

(

const MR_std_set_std_string_const_iterator *

other

)

Constructs a copy of another instance. The source remains alive. Parameter other can not be null. It is a single object. The reference to the parameter other might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_std_set_std_string_const_iterator_Destroy() to free it when you're done using it. When this function is called, this object will drop any object references it had previously.

MR_std_set_std_string_const_iterator_Decr()

MRC_API void MR_std_set_std_string_const_iterator_Decr

(

MR_std_set_std_string_const_iterator *

_this

)

Decrements a const iterator. Parameter _this can not be null. It is a single object.

MR_std_set_std_string_const_iterator_DefaultConstruct()

MRC_API MR_std_set_std_string_const_iterator * MR_std_set_std_string_const_iterator_DefaultConstruct

(

void

)

Constructs an empty (default-constructed) instance. Never returns null. Returns an instance allocated on the heap! Must call MR_std_set_std_string_const_iterator_Destroy() to free it when you're done using it.

MR_std_set_std_string_const_iterator_DefaultConstructArray()

MRC_API MR_std_set_std_string_const_iterator * MR_std_set_std_string_const_iterator_DefaultConstructArray

(

size_t

num_elems

)

Constructs an array of empty (default-constructed) instances, of the specified size. Will never return null. The array must be destroyed using MR_std_set_std_string_const_iterator_DestroyArray(). Use MR_std_set_std_string_const_iterator_OffsetMutablePtr() and MR_std_set_std_string_const_iterator_OffsetPtr() to access the array elements.

MR_std_set_std_string_const_iterator_Deref()

MRC_API const MR_std_string * MR_std_set_std_string_const_iterator_Deref

(

const MR_std_set_std_string_const_iterator *

_this

)

Dereferences a const iterator. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it.

MR_std_set_std_string_const_iterator_Destroy()

MRC_API void MR_std_set_std_string_const_iterator_Destroy

(

const MR_std_set_std_string_const_iterator *

_this

)

Destroys a heap-allocated instance of MR_std_set_std_string_const_iterator. Does nothing if the pointer is null.

MR_std_set_std_string_const_iterator_DestroyArray()

MRC_API void MR_std_set_std_string_const_iterator_DestroyArray

(

const MR_std_set_std_string_const_iterator *

_this

)

Destroys a heap-allocated array of MR_std_set_std_string_const_iterator. Does nothing if the pointer is null.

MR_std_set_std_string_const_iterator_Incr()

MRC_API void MR_std_set_std_string_const_iterator_Incr

(

MR_std_set_std_string_const_iterator *

_this

)

Increments a const iterator. Parameter _this can not be null. It is a single object.

MR_std_set_std_string_const_iterator_OffsetMutablePtr()

MRC_API MR_std_set_std_string_const_iterator * MR_std_set_std_string_const_iterator_OffsetMutablePtr	(	MR_std_set_std_string_const_iterator *	ptr,
		ptrdiff_t	i )

Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element. The reference to the parameter ptr might be preserved in the return value.

MR_std_set_std_string_const_iterator_OffsetPtr()

MRC_API const MR_std_set_std_string_const_iterator * MR_std_set_std_string_const_iterator_OffsetPtr	(	const MR_std_set_std_string_const_iterator *	ptr,
		ptrdiff_t	i )

Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element. The reference to the parameter ptr might be preserved in the return value.

MR_std_set_std_string_ConstructFromAnother()

MRC_API MR_std_set_std_string * MR_std_set_std_string_ConstructFromAnother	(	MR_PassBy	other_pass_by,
		MR_std_set_std_string *	other )

Constructs a copy of another instance. The source remains alive. The reference to the parameter other might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_std_set_std_string_Destroy() to free it when you're done using it. When this function is called, this object will drop any object references it had previously.

MR_std_set_std_string_Contains()

MRC_API bool MR_std_set_std_string_Contains	(	const MR_std_set_std_string *	_this,
		const char *	key,
		const char *	key_end )

Checks if the contain contains this key. Parameter _this can not be null. It is a single object. Parameter key can not be null. If key_end is null, then key is assumed to be null-terminated.

MR_std_set_std_string_DefaultConstruct()

MRC_API MR_std_set_std_string * MR_std_set_std_string_DefaultConstruct

(

void

)

Constructs an empty (default-constructed) instance. Never returns null. Returns an instance allocated on the heap! Must call MR_std_set_std_string_Destroy() to free it when you're done using it.

MR_std_set_std_string_DefaultConstructArray()

MRC_API MR_std_set_std_string * MR_std_set_std_string_DefaultConstructArray

(

size_t

num_elems

)

Constructs an array of empty (default-constructed) instances, of the specified size. Will never return null. The array must be destroyed using MR_std_set_std_string_DestroyArray(). Use MR_std_set_std_string_OffsetMutablePtr() and MR_std_set_std_string_OffsetPtr() to access the array elements.

MR_std_set_std_string_Destroy()

MRC_API void MR_std_set_std_string_Destroy

(

const MR_std_set_std_string *

_this

)

Destroys a heap-allocated instance of MR_std_set_std_string. Does nothing if the pointer is null.

MR_std_set_std_string_DestroyArray()

MRC_API void MR_std_set_std_string_DestroyArray

(

const MR_std_set_std_string *

_this

)

Destroys a heap-allocated array of MR_std_set_std_string. Does nothing if the pointer is null.

MR_std_set_std_string_End()

MRC_API MR_std_set_std_string_const_iterator * MR_std_set_std_string_End

(

const MR_std_set_std_string *

_this

)

The end iterator, const. Parameter _this can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_std_set_std_string_const_iterator_Destroy() to free it when you're done using it.

MR_std_set_std_string_Find()

MRC_API MR_std_set_std_string_const_iterator * MR_std_set_std_string_Find	(	const MR_std_set_std_string *	_this,
		const char *	key,
		const char *	key_end )

Finds the element by key, or returns the end iterator if no such key. Returns a read-only iterator. Parameter _this can not be null. It is a single object. Parameter key can not be null. If key_end is null, then key is assumed to be null-terminated. Never returns null. Returns an instance allocated on the heap! Must call MR_std_set_std_string_const_iterator_Destroy() to free it when you're done using it.

MR_std_set_std_string_Insert()

MRC_API void MR_std_set_std_string_Insert	(	MR_std_set_std_string *	_this,
		const char *	new_elem,
		const char *	new_elem_end )

Inserts a new element. Parameter _this can not be null. It is a single object. Parameter new_elem can not be null. If new_elem_end is null, then new_elem is assumed to be null-terminated. The reference to the parameter new_elem might be preserved in this object.

MR_std_set_std_string_IsBegin()

MRC_API bool MR_std_set_std_string_IsBegin	(	const MR_std_set_std_string *	_this,
		const MR_std_set_std_string_const_iterator *	iter )

Tests whether a const iterator is the begin iterator. Parameter _this can not be null. It is a single object. Parameter iter can not be null. It is a single object.

MR_std_set_std_string_IsEmpty()

MRC_API bool MR_std_set_std_string_IsEmpty

(

const MR_std_set_std_string *

_this

)

Returns true if the size is zero. Parameter _this can not be null. It is a single object.

MR_std_set_std_string_IsEnd()

MRC_API bool MR_std_set_std_string_IsEnd	(	const MR_std_set_std_string *	_this,
		const MR_std_set_std_string_const_iterator *	iter )

Tests whether a const iterator is the end iterator. Parameter _this can not be null. It is a single object. Parameter iter can not be null. It is a single object.

MR_std_set_std_string_OffsetMutablePtr()

MRC_API MR_std_set_std_string * MR_std_set_std_string_OffsetMutablePtr	(	MR_std_set_std_string *	ptr,
		ptrdiff_t	i )

Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element. The reference to the parameter ptr might be preserved in the return value.

MR_std_set_std_string_OffsetPtr()

MRC_API const MR_std_set_std_string * MR_std_set_std_string_OffsetPtr	(	const MR_std_set_std_string *	ptr,
		ptrdiff_t	i )

Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element. The reference to the parameter ptr might be preserved in the return value.

MR_std_set_std_string_Size()

MRC_API size_t MR_std_set_std_string_Size

(

const MR_std_set_std_string *

_this

)

The number of elements. Parameter _this can not be null. It is a single object.