IEventQueue.h

/*
 * synergy -- mouse and keyboard sharing utility
 * Copyright (C) 2012 Bolton Software Ltd.
 * Copyright (C) 2004 Chris Schoeneman
 * 
 * This package is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * found in the file COPYING that should have accompanied this file.
 * 
 * This package 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef IEVENTQUEUE_H
#define IEVENTQUEUE_H

#include "IInterface.h"
#include "CEvent.h"
#include "CString.h"

#define EVENTQUEUE IEventQueue::getInstance()

class IEventJob;
class IEventQueueBuffer;

// Opaque type for timer info.  This is defined by subclasses of
// IEventQueueBuffer.
class CEventQueueTimer;


class IEventQueue : public IInterface {
public:
    class CTimerEvent {
    public:
        CEventQueueTimer*   m_timer;    
        UInt32              m_count;    
    };




    virtual void        loop() = 0;


    virtual void        adoptBuffer(IEventQueueBuffer*) = 0;


    virtual bool        getEvent(CEvent& event, double timeout = -1.0) = 0;


    virtual bool        dispatchEvent(const CEvent& event) = 0;


    virtual void        addEvent(const CEvent& event) = 0;


    virtual CEventQueueTimer*
                        newTimer(double duration, void* target) = 0;


    virtual CEventQueueTimer*
                        newOneShotTimer(double duration,
                            void* target) = 0;


    virtual void        deleteTimer(CEventQueueTimer*) = 0;


    virtual void        adoptHandler(CEvent::Type type,
                            void* target, IEventJob* handler) = 0;


    virtual void        removeHandler(CEvent::Type type, void* target) = 0;


    virtual void        removeHandlers(void* target) = 0;


    virtual CEvent::Type
                        registerType(const char* name) = 0;


    virtual CEvent::Type
                        registerTypeOnce(CEvent::Type& type,
                            const char* name) = 0;





    virtual bool        isEmpty() const = 0;


    virtual IEventJob*  getHandler(CEvent::Type type, void* target) const = 0;


    virtual const char* getTypeName(CEvent::Type type) = 0;


    virtual CEvent::Type getRegisteredType(const CString& name) const = 0;


    static void*        getSystemTarget();


    static IEventQueue* getInstance();


protected:



    static void         setInstance(IEventQueue*);


private:
    static IEventQueue* s_instance;
};

#endif