Basic signal handling. More...
|
Modules | |
| Signals | |
| Signals. | |
Typedefs | |
| typedef struct GWEN_SIGNAL | GWEN_SIGNAL |
| typedef struct GWEN_SIGNALOBJECT | GWEN_SIGNALOBJECT |
| typedef struct GWEN_SLOT | GWEN_SLOT |
| typedef int GWENHYWFAR_CB(* | GWEN_SLOT_FUNCTION) (GWEN_SLOT *slot, void *userData, void *pArg1, void *pArg2, int iArg3, int iArg4) |
Detailed Description
Basic signal handling.
This module introduces a simple signal-slot framework. Signals have a fixed list of arguments:
- a void* pointer
- 1st integer argument
- 2nd integer argument
The actual type of the void pointer is defined by the signal and corresponding slot(s): Gwen checks the type at runtime and refuses to connect signals with slots which define this pointer to be of a different type. Any signal can be connected to any number of matching slots.
The central object in this framework is GWEN_SIGNALOBJECT. It holds a list of signals and slots for a given object.
Typedef Documentation
◆ GWEN_SIGNAL
| typedef struct GWEN_SIGNAL GWEN_SIGNAL |
Definition at line 67 of file gwensignal.h.
◆ GWEN_SIGNALOBJECT
| typedef struct GWEN_SIGNALOBJECT GWEN_SIGNALOBJECT |
Definition at line 65 of file gwensignal.h.
◆ GWEN_SLOT
Definition at line 69 of file gwensignal.h.
◆ GWEN_SLOT_FUNCTION
| typedef int GWENHYWFAR_CB(* GWEN_SLOT_FUNCTION) (GWEN_SLOT *slot, void *userData, void *pArg1, void *pArg2, int iArg3, int iArg4) |
This is the prototype for the slot function. If there is a problem in the function it should return 1, otherwise 0.
Definition at line 76 of file gwensignal.h.
Function Documentation
◆ GWEN_Signal_Connect()
| GWENHYWFAR_API int GWEN_Signal_Connect | ( | GWEN_SIGNAL * | sig, |
| GWEN_SLOT * | slot | ||
| ) |
Definition at line 406 of file gwensignal.c.
References DBG_ERROR, GWEN_ERROR_INVALID, GWEN_LOGDOMAIN, GWEN_Signal_List2_HasSignal(), and GWEN_Slot_List2_HasSlot().
◆ GWEN_Signal_Disconnect()
| GWENHYWFAR_API int GWEN_Signal_Disconnect | ( | GWEN_SIGNAL * | sig, |
| GWEN_SLOT * | slot | ||
| ) |
Definition at line 446 of file gwensignal.c.
References DBG_ERROR, GWEN_ERROR_INVALID, GWEN_LOGDOMAIN, GWEN_Signal_List2_HasSignal(), and GWEN_Slot_List2_HasSlot().
◆ GWEN_Signal_Emit()
| GWENHYWFAR_API int GWEN_Signal_Emit | ( | GWEN_SIGNAL * | sig, |
| void * | pArg1, | ||
| void * | pArg2, | ||
| int | iArg3, | ||
| int | iArg4 | ||
| ) |
This function calls the slot function of all connected slots. If any of the slot functions called returns with code 1 then this function will return 1, too. Otherwise 0 is returned. This means that this function will only return 0 if every called slot function returns 0.
Definition at line 472 of file gwensignal.c.
References DBG_DEBUG, and GWEN_LOGDOMAIN.
◆ GWEN_Signal_free()
| GWENHYWFAR_API void GWEN_Signal_free | ( | GWEN_SIGNAL * | sig | ) |
Definition at line 315 of file gwensignal.c.
References DBG_ERROR, GWEN_FREE_OBJECT, and GWEN_LOGDOMAIN.
Referenced by GWEN_Signal__List2_freeAll_cb(), GWEN_Signal_new(), and GWEN_SignalObject_RemoveForDerivedType().
◆ GWEN_Signal_GetSignalObject()
| GWENHYWFAR_API GWEN_SIGNALOBJECT* GWEN_Signal_GetSignalObject | ( | const GWEN_SIGNAL * | sig | ) |
Definition at line 398 of file gwensignal.c.
◆ GWEN_Signal_new()
| GWENHYWFAR_API GWEN_SIGNAL* GWEN_Signal_new | ( | GWEN_SIGNALOBJECT * | so, |
| const char * | derivedType, | ||
| const char * | name, | ||
| const char * | typeOfArg1, | ||
| const char * | typeOfArg2 | ||
| ) |
Definition at line 284 of file gwensignal.c.
References GWEN_NEW_OBJECT, GWEN_Signal_free(), GWEN_SignalObject_AddSignal(), and GWEN_SignalObject_MkTypeId().
◆ GWEN_SignalObject_FindSignal()
| GWENHYWFAR_API GWEN_SIGNAL* GWEN_SignalObject_FindSignal | ( | const GWEN_SIGNALOBJECT * | so, |
| const char * | name, | ||
| const char * | typeOfArg1, | ||
| const char * | typeOfArg2 | ||
| ) |
Definition at line 114 of file gwensignal.c.
References GWEN_SignalObject__findSignal(), and GWEN_SignalObject_MkTypeId().
◆ GWEN_SignalObject_FindSlot()
| GWENHYWFAR_API GWEN_SLOT* GWEN_SignalObject_FindSlot | ( | const GWEN_SIGNALOBJECT * | so, |
| const char * | name, | ||
| const char * | typeOfArg1, | ||
| const char * | typeOfArg2 | ||
| ) |
Definition at line 168 of file gwensignal.c.
References GWEN_SignalObject__findSlot(), and GWEN_SignalObject_MkTypeId().
◆ GWEN_SignalObject_free()
| GWENHYWFAR_API void GWEN_SignalObject_free | ( | GWEN_SIGNALOBJECT * | so | ) |
Definition at line 59 of file gwensignal.c.
References GWEN_FREE_OBJECT, GWEN_Signal_List2_freeAll(), and GWEN_Slot_List2_freeAll().
◆ GWEN_SignalObject_new()
| GWENHYWFAR_API GWEN_SIGNALOBJECT* GWEN_SignalObject_new | ( | void | ) |
Definition at line 46 of file gwensignal.c.
References GWEN_NEW_OBJECT.
◆ GWEN_SignalObject_RemoveForDerivedType()
| GWENHYWFAR_API void GWEN_SignalObject_RemoveForDerivedType | ( | GWEN_SIGNALOBJECT * | so, |
| const char * | derivedType | ||
| ) |
This function removes all signals and slots for the given derived type. This function can be used from within the FREEDATA function of the GWEN_INHERIT framework.
Definition at line 222 of file gwensignal.c.
References GWEN_Signal_free(), GWEN_SignalObject_MkTypeId(), and GWEN_Slot_free().
