EventManager.h

Go to the documentation of this file.

/*
 * EventManager.h
 * An event handling system for avr microcontrollers.
 *
 * Author: igormt@alumni.caltech.edu
 * Copyright (c) 2017 Igor Mikolic-Torreira
 *
 * Inspired by and adapted from the
 * Arduino Event System library by
 * Author: mromani@ottotecnica.com
 * Copyright (c) 2010 OTTOTECNICA Italy
 *
 * 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 St, Fifth Floor, Boston, MA 02110-1301 USA
 *
 */


#ifndef EventManager_h
#define EventManager_h


#include <stdint.h>



// Size of the listener list.  Adjust as appropriate for your application.
// Requires a total of sizeof(*f())+sizeof(int)+sizeof(bool) bytes of RAM for each unit of size
#ifndef EVENTMANAGER_DISPATCH_TABLE_SIZE
#define EVENTMANAGER_DISPATCH_TABLE_SIZE        8
#endif

#if EVENTMANAGER_DISPATCH_TABLE_SIZE > 255
#error "EVENTMANAGER_DISPATCH_TABLE_SIZE exceeds size of a uint8_t"
#endif




// Size of the event two queues.  Adjust as appropriate for your application.
// Requires a total of 4 * sizeof(int) bytes of RAM for each unit of size
#ifndef EVENTMANAGER_EVENT_QUEUE_SIZE
#define EVENTMANAGER_EVENT_QUEUE_SIZE           8
#endif

#if EVENTMANAGER_EVENT_QUEUE_SIZE > 255
#error "EVENTMANAGER_EVENT_QUEUE_SIZE exceeds size of a uint8_t"
#endif







namespace EventManager
{

    enum GenericEvents
    {
        kEventNone,
        kEventKeyPress,
        kEventKeyRelease,
        kEventChar,
        kEventTime,
        kEventTimer0,
        kEventTimer1,
        kEventTimer2,
        kEventTimer3,
        kEventAnalog0,
        kEventAnalog1,
        kEventAnalog2,
        kEventAnalog3,
        kEventAnalog4,
        kEventAnalog5,
        kEventMenu0,
        kEventMenu1,
        kEventMenu2,
        kEventMenu3,
        kEventMenu4,
        kEventMenu5,
        kEventMenu6,
        kEventMenu7,
        kEventMenu8,
        kEventMenu9,
        kEventSerial,
        kEventPaint,
        kEventUser0,
        kEventUser1,
        kEventUser2,
        kEventUser3,
        kEventUser4,
        kEventUser5,
        kEventUser6,
        kEventUser7,
        kEventUser8,
        kEventUser9,
    };



    typedef void ( *EventListener )( int eventCode, int eventParam );



    enum EventPriority
    {
        kHighPriority,
        kLowPriority
    };



    bool addListener( int eventCode, EventListener listener );



    bool removeListener( int eventCode, EventListener listener );



    int removeListener( EventListener listener );



    bool enableListener( int eventCode, EventListener listener, bool enable );



    bool isListenerEnabled( int eventCode, EventListener listener );



    bool setDefaultListener( EventListener listener );



    void removeDefaultListener();



    void enableDefaultListener( bool enable );



    bool isListenerListEmpty();



    bool isListenerListFull();



    int numListeners();



    bool isEventQueueEmpty( EventPriority pri = kLowPriority );



    bool isEventQueueFull( EventPriority pri = kLowPriority );



    int getNumEventsInQueue( EventPriority pri = kLowPriority );



    bool queueEvent( int eventCode, int eventParam, EventPriority pri = kLowPriority );



    int processEvent();



    int processAllEvents();

};




#endif