itrigger.h File Reference

mcr_ITrigger - Interface for triggers More...

#include "mcr/base/interface.h"

Go to the source code of this file.

Classes
struct	mcr_ITrigger

Typedefs
typedef bool(*	mcr_Trigger_receive_fnc) (struct mcr_Trigger *triggerPt, struct mcr_Signal *dispatchSignal, unsigned int mods)

Functions
MCR_API void	mcr_ITrigger_init (struct mcr_ITrigger *itrigPt)
MCR_API void	mcr_ITrigger_ctor (struct mcr_ITrigger *itrigPt, struct mcr_context *context, size_t dataSize, void *(*allocate)(), void(*deallocate)(void *), mcr_data_fnc init, mcr_data_fnc deinit, mcr_compare_fnc compare, mcr_copy_fnc copy, mcr_Trigger_receive_fnc receiveFnc)
MCR_API void	mcr_ITrigger_deinit (struct mcr_ITrigger *itrigPt)
MCR_API struct mcr_IRegistry *	mcr_ITrigger_registry (struct mcr_context *ctx)
MCR_API size_t	mcr_ITrigger_id (struct mcr_ITrigger *itrigPt)
MCR_API struct mcr_ITrigger *	mcr_ITrigger_from_id (struct mcr_context *ctx, size_t id)
MCR_API const char *	mcr_ITrigger_name (struct mcr_context *ctx, struct mcr_ITrigger *itrigPt)
MCR_API struct mcr_ITrigger *	mcr_ITrigger_from_name (struct mcr_context *ctx, const char *name)

Detailed Description

mcr_ITrigger - Interface for triggers

Use mcr_DispatchReceiver_fnc to dispatch into triggers.

Definition in file itrigger.h.

Function Documentation

mcr_ITrigger_ctor()

MCR_API void mcr_ITrigger_ctor	(	struct mcr_ITrigger *	itrigPt,
		struct mcr_context *	context,
		size_t	dataSize,
		void *(*)()	allocate,
		void(*)(void *)	deallocate,
		mcr_data_fnc	init,
		mcr_data_fnc	deinit,
		mcr_compare_fnc	compare,
		mcr_copy_fnc	copy,
		mcr_Trigger_receive_fnc	receiveFnc
	)

ctor

Parameters

itrigPt	opt
context	opt mcr_Interface::context
dataSize	opt mcr_Interface::data_size
allocate	opt mcr_Interface::allocate
deallocate	opt mcr_Interface::deallocate
init	opt mcr_Interface::init
deinit	opt mcr_Interface::deinit
compare	opt mcr_Interface::compare
copy	opt mcr_Interface::copy
receiveFnc	mcr_ITrigger.receive_fnc

mcr_ITrigger_deinit()

MCR_API void mcr_ITrigger_deinit

(

struct mcr_ITrigger *

itrigPt

)

dtor

Removes self from registry, if the registry is set.

Parameters

itrigPt

opt

mcr_ITrigger_from_id()

MCR_API struct mcr_ITrigger* mcr_ITrigger_from_id	(	struct mcr_context *	ctx,
		size_t	id
	)

Get a trigger interface from its id

Parameters

id	Id of the trigger interface

Returns

Trigger interface, or null if not found

mcr_ITrigger_from_name()

MCR_API struct mcr_ITrigger* mcr_ITrigger_from_name	(	struct mcr_context *	ctx,
		const char *	name
	)

Get a trigger interface from its name

Parameters

name	opt Name of the trigger interface

Returns

Trigger interface, or null if not found

mcr_ITrigger_id()

MCR_API size_t mcr_ITrigger_id

(

struct mcr_ITrigger *

itrigPt

)

Get the id of a trigger interface.

Parameters

itrigPt

opt

Returns

retid

mcr_ITrigger_init()

MCR_API void mcr_ITrigger_init

(

struct mcr_ITrigger *

itrigPt

)

ctor

Parameters

itrigPt

opt

mcr_ITrigger_name()

MCR_API const char* mcr_ITrigger_name	(	struct mcr_context *	ctx,
		struct mcr_ITrigger *	itrigPt
	)

Get the name of a trigger interface.

Parameters

itrigPt

opt

Returns

Name of the trigger interface, or null if not found

mcr_ITrigger_registry()

MCR_API struct mcr_IRegistry* mcr_ITrigger_registry

(

struct mcr_context *

ctx

)

Get the mcr_IRegistry of mcr_ITrigger