gimbal_event.h

Go to the documentation of this file.

/*! \file
 *  \brief GblEvent base type and basic API
 *  \ingroup meta
 *
 *  \todo
 *      - maybe give them timestamps?
 *      - maybe give them virtuals for onAccept/onReject/onReset?
 *      - maybe give them source objects?
 *      - extra extended creation args + default values
 *
 *  \author 2023 Falco Girgis
 *  \copyright MIT License
 */
 
#ifndef GIMBAL_EVENT_H
#define GIMBAL_EVENT_H
 
#include "gimbal_box.h"
 
/*! \name Type System
 *  \brief Type UUID and cast operators
 *  @{
 */
#define GBL_EVENT_TYPE          (GBL_TYPEID(GblEvent))            //!< Returns the GblType for GblEvent
#define GBL_EVENT(self)         (GBL_CAST(GblEvent, self))        //!< Casts a GblInstance to GblEvent
#define GBL_EVENT_CLASS(klass)  (GBL_CLASS_CAST(GblEvent, klass)) //!< Casts a GblClass to GblEventClass
#define GBL_EVENT_CLASSOF(self) (GBL_CLASSOF(GblEvent, self))     //!< Gets a GblEventClass from GblInstance
//! @}
 
#define GBL_SELF_TYPE GblEvent
 
GBL_DECLS_BEGIN
 
GBL_DECLARE_ENUM(GBL_EVENT_STATE) {
    GBL_EVENT_STATE_PENDING,
    GBL_EVENT_STATE_ACCEPTED,
    GBL_EVENT_STATE_IGNORED
};
 
/*! \struct GblEventClass
 *  \extends GblBoxClass
 *  \brief GblClass VTable structure for GblEvent
 *
 *  No public virtual methods
 *
 *  \sa GblEvent
 */
GBL_CLASS_DERIVE_EMPTY(GblEvent, GblBox)
 
/*! \struct  GblEvent
 *  \extends GblBox
 *  \ingroup meta
 *  \brief   Event base class for use with the event system
 *
 *  \sa GblIEventHandler, GblIEventFilter
 */
GBL_INSTANCE_DERIVE(GblEvent, GblBox)
    GBL_PRIVATE_BEGIN
        GBL_EVENT_STATE state;
    GBL_PRIVATE_END
GBL_INSTANCE_END
 
GBL_EXPORT GblType         GblEvent_type      (void)                   GBL_NOEXCEPT;
GBL_EXPORT GblEvent*       GblEvent_create    (GblType type)           GBL_NOEXCEPT;
GBL_EXPORT GBL_RESULT      GblEvent_construct (GBL_SELF, GblType type) GBL_NOEXCEPT;
GBL_EXPORT GBL_EVENT_STATE GblEvent_state     (GBL_CSELF)              GBL_NOEXCEPT;
GBL_EXPORT GBL_RESULT      GblEvent_accept    (GBL_SELF)               GBL_NOEXCEPT;
GBL_EXPORT void            GblEvent_reset     (GBL_SELF)               GBL_NOEXCEPT;
 
GBL_DECLS_END
 
#undef GBL_SELF_TYPE
 
 
#endif // GIMBAL_EVENT_H