std_function_float_from_MR_EdgeId.h File Reference

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

Go to the source code of this file.

Functions
MRC_API MR_std_function_float_from_MR_EdgeId *	MR_std_function_float_from_MR_EdgeId_DefaultConstruct (void)
MRC_API MR_std_function_float_from_MR_EdgeId *	MR_std_function_float_from_MR_EdgeId_DefaultConstructArray (size_t num_elems)
MRC_API MR_std_function_float_from_MR_EdgeId *	MR_std_function_float_from_MR_EdgeId_ConstructFromAnother (MR_PassBy other_pass_by, MR_std_function_float_from_MR_EdgeId *other)
MRC_API void	MR_std_function_float_from_MR_EdgeId_AssignFromAnother (MR_std_function_float_from_MR_EdgeId *_this, MR_PassBy other_pass_by, MR_std_function_float_from_MR_EdgeId *other)
MRC_API void	MR_std_function_float_from_MR_EdgeId_Destroy (const MR_std_function_float_from_MR_EdgeId *_this)
	Destroys a heap-allocated instance of MR_std_function_float_from_MR_EdgeId. Does nothing if the pointer is null.
MRC_API void	MR_std_function_float_from_MR_EdgeId_DestroyArray (const MR_std_function_float_from_MR_EdgeId *_this)
	Destroys a heap-allocated array of MR_std_function_float_from_MR_EdgeId. Does nothing if the pointer is null.
MRC_API const MR_std_function_float_from_MR_EdgeId *	MR_std_function_float_from_MR_EdgeId_OffsetPtr (const MR_std_function_float_from_MR_EdgeId *ptr, ptrdiff_t i)
MRC_API MR_std_function_float_from_MR_EdgeId *	MR_std_function_float_from_MR_EdgeId_OffsetMutablePtr (MR_std_function_float_from_MR_EdgeId *ptr, ptrdiff_t i)
MRC_API bool	MR_std_function_float_from_MR_EdgeId_has_value (const MR_std_function_float_from_MR_EdgeId *_this)
MRC_API void	MR_std_function_float_from_MR_EdgeId_reset (MR_std_function_float_from_MR_EdgeId *_this)
MRC_API float	MR_std_function_float_from_MR_EdgeId_call (const MR_std_function_float_from_MR_EdgeId *_this, MR_EdgeId _1)
MRC_API MR_std_function_float_from_MR_EdgeId *	MR_std_function_float_from_MR_EdgeId_ConstructStateless (float(*func)(MR_EdgeId *_1))
MRC_API void	MR_std_function_float_from_MR_EdgeId_Assign (MR_std_function_float_from_MR_EdgeId *_this, float(*func)(MR_EdgeId *_1))
MRC_API MR_std_function_float_from_MR_EdgeId *	MR_std_function_float_from_MR_EdgeId_ConstructEx (float(*func)(MR_EdgeId *_1, void *_userdata, void **_cleanup_value), void *userdata, void(*postcall_callback)(void *_userdata, void *_cleanup_value), void(*userdata_callback)(void **_this_userdata, void *_other_userdata))
MRC_API void	MR_std_function_float_from_MR_EdgeId_AssignEx (MR_std_function_float_from_MR_EdgeId *_this, float(*func)(MR_EdgeId *_1, void *_userdata, void **_cleanup_value), void *userdata, void(*postcall_callback)(void *_userdata, void *_cleanup_value), void(*userdata_callback)(void **_this_userdata, void *_other_userdata))

Function Documentation

MR_std_function_float_from_MR_EdgeId_Assign()

MRC_API void MR_std_function_float_from_MR_EdgeId_Assign	(	MR_std_function_float_from_MR_EdgeId *	_this,
		float(*	func )(MR_EdgeId *_1) )

Assign a stateless function. Parameter _this can not be null. It is a single object. Callback parameter _1 will never be null. It is non-owning, do NOT destroy it. In C++ that parameter is an rvalue reference.

MR_std_function_float_from_MR_EdgeId_AssignEx()

MRC_API void MR_std_function_float_from_MR_EdgeId_AssignEx	(	MR_std_function_float_from_MR_EdgeId *	_this,
		float(*	func )(MR_EdgeId *_1, void *_userdata, void **_cleanup_value),
		void *	userdata,
		void(*	postcall_callback )(void *_userdata, void *_cleanup_value),
		void(*	userdata_callback )(void **_this_userdata, void *_other_userdata) )

Assign a function with additional state. Parameter _this can not be null. It is a single object. The reference to the parameter userdata might be preserved in this object. When this function is called, this object will drop any object references it held previously. Callback parameter _1 will never be null. It is non-owning, do NOT destroy it. In C++ that parameter is an rvalue reference. Parameter userdata is propagated to func. Parameter postcall_callback can be null. If specified, it will always be called right after func, after constructing the underlying C++ return value. If null, then func will always receive null _cleanup_value. If specified, then _cleanup_value will not be null. func can write to *_cleanup_value, and that value will be forwarded to the postcall_callback call. Writing null has no special effect, postcall_callback will be called regardless. *_cleanup_value is null by default. The intent is to handle cases where in C++ the callback returns by value, but the corresponding C callback returns a pointer, which makes implementing the callback difficult, as you would need to either leak the pointer, or it would dangle. With this callback, you can leak the pointer from func, and then clean it up in postcall_callback. Another way to handle this is by using MR_PassBy_MoveAndDestroy,but it is less flexible than the callback, since it forces an extra move in some cases. This might make no sense to C users, but it helps when wrapping C bindings in another language. If you're using MR_PassBy_Copy or MR_PassBy_Move, then in C you'd expect your pointer to outlive the callback, so all is good. But when wrapping C in a managed language where objects are shared references, you might not know if the object you're returning is the last reference or not, so you'd have to either copy/move it into a temporary, which you would then MR_PassBy_MoveAndDestroy (which adds an extra move), or introduce a null state to your objects to MR_PassBy_MoveAndDestroy the original pointer (having the null state might be undesirable). And attempting to use MR_PassBy_Copy or MR_PassBy_Move could dangle your pointer, if the returned object in your language is a local or temporary, and is the last reference to the underlying C/C++ object. What postcall_callback allows you to do is to preserve a reference to the returned object in your language, so that it lives long enough for the contents to be copied into the returned C++ object. Parameter userdata_callback can be null. Pass null if you don't need custom behavior when destroying and/or copying the functor. The _this_userdata parameter will never be null. If *_this_userdata is non-null and _other_userdata is null, the functor is being destroyed. Perform any cleanup if needed. If *_this_userdata is null and _other_userdata is non-null, a copy of the functor is being constructed. Perform copying if needed and write the new userdata to *_this_userdata. If *_this_userdata is non-null and _other_userdata is non-null, the functor is being assigned. The simplest option is to destroy *_this_userdata first, and then behave as if it was null. Both *_this_userdata and _other_userdata will never be null at the same time.

MR_std_function_float_from_MR_EdgeId_AssignFromAnother()

MRC_API void MR_std_function_float_from_MR_EdgeId_AssignFromAnother	(	MR_std_function_float_from_MR_EdgeId *	_this,
		MR_PassBy	other_pass_by,
		MR_std_function_float_from_MR_EdgeId *	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 held previously.

MR_std_function_float_from_MR_EdgeId_call()

MRC_API float MR_std_function_float_from_MR_EdgeId_call	(	const MR_std_function_float_from_MR_EdgeId *	_this,
		MR_EdgeId	_1 )

Calls the stored callable. Parameter _this can not be null. It is a single object.

MR_std_function_float_from_MR_EdgeId_ConstructEx()

MRC_API MR_std_function_float_from_MR_EdgeId * MR_std_function_float_from_MR_EdgeId_ConstructEx	(	float(*	func )(MR_EdgeId *_1, void *_userdata, void **_cleanup_value),
		void *	userdata,
		void(*	postcall_callback )(void *_userdata, void *_cleanup_value),
		void(*	userdata_callback )(void **_this_userdata, void *_other_userdata) )

Construct a function with additional state. The reference to the parameter userdata might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_std_function_float_from_MR_EdgeId_Destroy() to free it when you're done using it. When this function is called, this object will drop any object references it held previously. Callback parameter _1 will never be null. It is non-owning, do NOT destroy it. In C++ that parameter is an rvalue reference. Parameter userdata is propagated to func. Parameter postcall_callback can be null. If specified, it will always be called right after func, after constructing the underlying C++ return value. If null, then func will always receive null _cleanup_value. If specified, then _cleanup_value will not be null. func can write to *_cleanup_value, and that value will be forwarded to the postcall_callback call. Writing null has no special effect, postcall_callback will be called regardless. *_cleanup_value is null by default. The intent is to handle cases where in C++ the callback returns by value, but the corresponding C callback returns a pointer, which makes implementing the callback difficult, as you would need to either leak the pointer, or it would dangle. With this callback, you can leak the pointer from func, and then clean it up in postcall_callback. Another way to handle this is by using MR_PassBy_MoveAndDestroy,but it is less flexible than the callback, since it forces an extra move in some cases. This might make no sense to C users, but it helps when wrapping C bindings in another language. If you're using MR_PassBy_Copy or MR_PassBy_Move, then in C you'd expect your pointer to outlive the callback, so all is good. But when wrapping C in a managed language where objects are shared references, you might not know if the object you're returning is the last reference or not, so you'd have to either copy/move it into a temporary, which you would then MR_PassBy_MoveAndDestroy (which adds an extra move), or introduce a null state to your objects to MR_PassBy_MoveAndDestroy the original pointer (having the null state might be undesirable). And attempting to use MR_PassBy_Copy or MR_PassBy_Move could dangle your pointer, if the returned object in your language is a local or temporary, and is the last reference to the underlying C/C++ object. What postcall_callback allows you to do is to preserve a reference to the returned object in your language, so that it lives long enough for the contents to be copied into the returned C++ object. Parameter userdata_callback can be null. Pass null if you don't need custom behavior when destroying and/or copying the functor. The _this_userdata parameter will never be null. If *_this_userdata is non-null and _other_userdata is null, the functor is being destroyed. Perform any cleanup if needed. If *_this_userdata is null and _other_userdata is non-null, a copy of the functor is being constructed. Perform copying if needed and write the new userdata to *_this_userdata. If *_this_userdata is non-null and _other_userdata is non-null, the functor is being assigned. The simplest option is to destroy *_this_userdata first, and then behave as if it was null. Both *_this_userdata and _other_userdata will never be null at the same time.

MR_std_function_float_from_MR_EdgeId_ConstructFromAnother()

MRC_API MR_std_function_float_from_MR_EdgeId * MR_std_function_float_from_MR_EdgeId_ConstructFromAnother	(	MR_PassBy	other_pass_by,
		MR_std_function_float_from_MR_EdgeId *	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_function_float_from_MR_EdgeId_Destroy() to free it when you're done using it. When this function is called, this object will drop any object references it held previously.

MR_std_function_float_from_MR_EdgeId_ConstructStateless()

MRC_API MR_std_function_float_from_MR_EdgeId * MR_std_function_float_from_MR_EdgeId_ConstructStateless

(

float(*

func )(MR_EdgeId *_1)

)

Construct a stateless function. Never returns null. Returns an instance allocated on the heap! Must call MR_std_function_float_from_MR_EdgeId_Destroy() to free it when you're done using it. Callback parameter _1 will never be null. It is non-owning, do NOT destroy it. In C++ that parameter is an rvalue reference.

MR_std_function_float_from_MR_EdgeId_DefaultConstruct()

MRC_API MR_std_function_float_from_MR_EdgeId * MR_std_function_float_from_MR_EdgeId_DefaultConstruct

(

void

)

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

MR_std_function_float_from_MR_EdgeId_DefaultConstructArray()

MRC_API MR_std_function_float_from_MR_EdgeId * MR_std_function_float_from_MR_EdgeId_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_function_float_from_MR_EdgeId_DestroyArray(). Use MR_std_function_float_from_MR_EdgeId_OffsetMutablePtr() and MR_std_function_float_from_MR_EdgeId_OffsetPtr() to access the array elements.

MR_std_function_float_from_MR_EdgeId_Destroy()

MRC_API void MR_std_function_float_from_MR_EdgeId_Destroy

(

const MR_std_function_float_from_MR_EdgeId *

_this

)

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

MR_std_function_float_from_MR_EdgeId_DestroyArray()

MRC_API void MR_std_function_float_from_MR_EdgeId_DestroyArray

(

const MR_std_function_float_from_MR_EdgeId *

_this

)

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

MR_std_function_float_from_MR_EdgeId_has_value()

MRC_API bool MR_std_function_float_from_MR_EdgeId_has_value

(

const MR_std_function_float_from_MR_EdgeId *

_this

)

Returns true if this instance stores a callable, as opposed to being null. Parameter _this can not be null. It is a single object.

MR_std_function_float_from_MR_EdgeId_OffsetMutablePtr()

MRC_API MR_std_function_float_from_MR_EdgeId * MR_std_function_float_from_MR_EdgeId_OffsetMutablePtr	(	MR_std_function_float_from_MR_EdgeId *	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_function_float_from_MR_EdgeId_OffsetPtr()

MRC_API const MR_std_function_float_from_MR_EdgeId * MR_std_function_float_from_MR_EdgeId_OffsetPtr	(	const MR_std_function_float_from_MR_EdgeId *	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_function_float_from_MR_EdgeId_reset()

MRC_API void MR_std_function_float_from_MR_EdgeId_reset

(

MR_std_function_float_from_MR_EdgeId *

_this

)

Destroys the stored callable, making this instance null. Parameter _this can not be null. It is a single object.