std_pair_std_string_float.h File Reference

#include <MRCMisc/common.h>
#include <MRCMisc/exports.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_pair_std_string_float	MR_std_pair_std_string_float

Functions
MRC_API MR_std_pair_std_string_float *	MR_std_pair_std_string_float_DefaultConstruct (void)
MRC_API MR_std_pair_std_string_float *	MR_std_pair_std_string_float_DefaultConstructArray (size_t num_elems)
MRC_API MR_std_pair_std_string_float *	MR_std_pair_std_string_float_ConstructFromAnother (MR_PassBy other_pass_by, MR_std_pair_std_string_float *other)
MRC_API void	MR_std_pair_std_string_float_AssignFromAnother (MR_std_pair_std_string_float *_this, MR_PassBy other_pass_by, MR_std_pair_std_string_float *other)
MRC_API void	MR_std_pair_std_string_float_Destroy (const MR_std_pair_std_string_float *_this)
	Destroys a heap-allocated instance of MR_std_pair_std_string_float. Does nothing if the pointer is null.
MRC_API void	MR_std_pair_std_string_float_DestroyArray (const MR_std_pair_std_string_float *_this)
	Destroys a heap-allocated array of MR_std_pair_std_string_float. Does nothing if the pointer is null.
MRC_API const MR_std_pair_std_string_float *	MR_std_pair_std_string_float_OffsetPtr (const MR_std_pair_std_string_float *ptr, ptrdiff_t i)
MRC_API MR_std_pair_std_string_float *	MR_std_pair_std_string_float_OffsetMutablePtr (MR_std_pair_std_string_float *ptr, ptrdiff_t i)
MRC_API MR_std_pair_std_string_float *	MR_std_pair_std_string_float_Construct (const char *first, const char *first_end, float second)
MRC_API const MR_std_string *	MR_std_pair_std_string_float_First (const MR_std_pair_std_string_float *_this)
MRC_API MR_std_string *	MR_std_pair_std_string_float_MutableFirst (MR_std_pair_std_string_float *_this)
MRC_API const float *	MR_std_pair_std_string_float_Second (const MR_std_pair_std_string_float *_this)
MRC_API float *	MR_std_pair_std_string_float_MutableSecond (MR_std_pair_std_string_float *_this)

Typedef Documentation

MR_std_pair_std_string_float

typedef struct MR_std_pair_std_string_float MR_std_pair_std_string_float

Stores two objects: std::string and 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_pair_std_string_float_AssignFromAnother()

MRC_API void MR_std_pair_std_string_float_AssignFromAnother	(	MR_std_pair_std_string_float *	_this,
		MR_PassBy	other_pass_by,
		MR_std_pair_std_string_float *	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_pair_std_string_float_Construct()

MRC_API MR_std_pair_std_string_float * MR_std_pair_std_string_float_Construct	(	const char *	first,
		const char *	first_end,
		float	second )

Constructs the pair elementwise. Parameter first can not be null. If first_end is null, then first is assumed to be null-terminated. The reference to the parameter first might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_std_pair_std_string_float_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_pair_std_string_float_ConstructFromAnother()

MRC_API MR_std_pair_std_string_float * MR_std_pair_std_string_float_ConstructFromAnother	(	MR_PassBy	other_pass_by,
		MR_std_pair_std_string_float *	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_pair_std_string_float_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_pair_std_string_float_DefaultConstruct()

MRC_API MR_std_pair_std_string_float * MR_std_pair_std_string_float_DefaultConstruct

(

void

)

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

MR_std_pair_std_string_float_DefaultConstructArray()

MRC_API MR_std_pair_std_string_float * MR_std_pair_std_string_float_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_pair_std_string_float_DestroyArray(). Use MR_std_pair_std_string_float_OffsetMutablePtr() and MR_std_pair_std_string_float_OffsetPtr() to access the array elements.

MR_std_pair_std_string_float_Destroy()

MRC_API void MR_std_pair_std_string_float_Destroy

(

const MR_std_pair_std_string_float *

_this

)

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

MR_std_pair_std_string_float_DestroyArray()

MRC_API void MR_std_pair_std_string_float_DestroyArray

(

const MR_std_pair_std_string_float *

_this

)

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

MR_std_pair_std_string_float_First()

MRC_API const MR_std_string * MR_std_pair_std_string_float_First

(

const MR_std_pair_std_string_float *

_this

)

The first of the two elements, read-only. 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_pair_std_string_float_MutableFirst()

MRC_API MR_std_string * MR_std_pair_std_string_float_MutableFirst

(

MR_std_pair_std_string_float *

_this

)

The first of the two elements, mutable. 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_pair_std_string_float_MutableSecond()

MRC_API float * MR_std_pair_std_string_float_MutableSecond

(

MR_std_pair_std_string_float *

_this

)

The second of the two elements, mutable. 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_pair_std_string_float_OffsetMutablePtr()

MRC_API MR_std_pair_std_string_float * MR_std_pair_std_string_float_OffsetMutablePtr	(	MR_std_pair_std_string_float *	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_pair_std_string_float_OffsetPtr()

MRC_API const MR_std_pair_std_string_float * MR_std_pair_std_string_float_OffsetPtr	(	const MR_std_pair_std_string_float *	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_pair_std_string_float_Second()

MRC_API const float * MR_std_pair_std_string_float_Second

(

const MR_std_pair_std_string_float *

_this

)

The second of the two elements, read-only. 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.