trigger.h

Go to the documentation of this file.

/* Libmacro - A multi-platform, extendable macro and hotkey C library
  Copyright (C) 2013 Jonathan Pelletier, New Paradigm Software

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*/

#ifndef MCR_BASE_TRIGGER_H_
#define MCR_BASE_TRIGGER_H_

#include "mcr/base/itrigger.h"
#include "mcr/base/instance.h"

#ifdef __cplusplus
extern "C" {
#endif

struct mcr_Trigger {
    union {
        struct mcr_ITrigger *itrigger;
        struct mcr_Instance instance;
        struct mcr_Interface *interface;
    };
    /* Trigger specific */
    mcr_Trigger_receive_fnc trigger;
    void *actor;
};

MCR_API bool mcr_Trigger_receive(struct mcr_DispatchReceiver *dispReceiver,
                                 struct mcr_Signal *dispatchSignal, unsigned int mods);
MCR_API bool mcr_Macro_receive(struct mcr_DispatchReceiver *dispPt,
                               struct mcr_Signal *sigPt, unsigned int mods);

MCR_API void mcr_Trigger_init(struct mcr_Trigger *triggerPt);
MCR_API void mcr_Trigger_ctor(struct mcr_Trigger *triggerPt,
                              struct mcr_ITrigger *itrigPt, mcr_Trigger_receive_fnc trigger, void *actor);
MCR_API void mcr_Trigger_deinit(struct mcr_Trigger *trigPt);

MCR_API int mcr_Trigger_copy(struct mcr_Trigger *dstPt,
                             const struct mcr_Trigger *srcPt);
MCR_API int mcr_Trigger_compare(const struct mcr_Trigger *lhsTriggerPt,
                                const struct mcr_Trigger *rhsTriggerPt);

/* Dispatch utilities */
MCR_API int mcr_Trigger_add_dispatch(struct mcr_context *ctx,
                                     struct mcr_Trigger *trigPt, struct mcr_Signal *interceptPt);
MCR_API void mcr_Trigger_remove_dispatch(struct mcr_context *ctx,
        struct mcr_Trigger *trigPt, struct mcr_ISignal *isigPt);

#define mcr_Trigger_data(triggerPt) \
(triggerPt ? (triggerPt)->instance.data_member.data : NULL)

#ifdef __cplusplus
}
#endif

#endif