UT_Intercept.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        UT_Intercept.h ( UT Library, C++)
 *
 * COMMENTS:
 *
 *      This class is used to intercept and reroute
 *      input events to interested listeners.
 *      
 */

#ifndef __UT_Intercept__
#define __UT_Intercept__

#include "UT_API.h"
#include "UT_ValArray.h"


class UT_InterceptEvent;

typedef int (*UT_InterceptCallback)(int handle_idx, void *data, 
                                    UT_InterceptEvent *event,
                                    int poll, short xres, short yres);


enum UT_Key : int
{
    UT_KEY_INVALID = 0,
    // Values of 0x00000001 through 0x0010FFFF represent unicode code points.
    //
    // We provide enumerators for a very small subset of these here.  Which
    // values in this range are actually used will depend on the keyboard
    // layout.  We generally use the upper-case code point for any code point
    // that is considered lower-case.
    //
    // Some of the keys representing control characters have special values
    // that differ from their unicode code point.

    UT_KEY_ZERO  = 0x30,
    UT_KEY_ONE   = 0x31,
    UT_KEY_TWO   = 0x32,
    UT_KEY_THREE = 0x33,
    UT_KEY_FOUR  = 0x34,
    UT_KEY_FIVE  = 0x35,
    UT_KEY_SIX   = 0x36,
    UT_KEY_SEVEN = 0x37,
    UT_KEY_EIGHT = 0x38,
    UT_KEY_NINE  = 0x39,
    UT_KEY_A     = 0x41,
    UT_KEY_B     = 0x42,
    UT_KEY_C     = 0x43,
    UT_KEY_D     = 0x44,
    UT_KEY_E     = 0x45,
    UT_KEY_F     = 0x46,
    UT_KEY_G     = 0x47,
    UT_KEY_H     = 0x48,
    UT_KEY_I     = 0x49,
    UT_KEY_J     = 0x4A,
    UT_KEY_K     = 0x4B,
    UT_KEY_L     = 0x4C,
    UT_KEY_M     = 0x4D,
    UT_KEY_N     = 0x4E,
    UT_KEY_O     = 0x4F,
    UT_KEY_P     = 0x50,
    UT_KEY_Q     = 0x51,
    UT_KEY_R     = 0x52,
    UT_KEY_S     = 0x53,
    UT_KEY_T     = 0x54,
    UT_KEY_U     = 0x55,
    UT_KEY_V     = 0x56,
    UT_KEY_W     = 0x57,
    UT_KEY_X     = 0x58,
    UT_KEY_Y     = 0x59,
    UT_KEY_Z     = 0x5A,

    UT_KEY_SEMICOLON    = 0x3B,
    UT_KEY_COMMA        = 0x2C,
    UT_KEY_PERIOD       = 0x2E,
    UT_KEY_QUOTE        = 0x27,
    UT_KEY_LEFTBRACKET  = 0x5B,
    UT_KEY_RIGHTBRACKET = 0x5D,
    UT_KEY_MINUS        = 0x2D,
    UT_KEY_EQUAL        = 0x3D,
    UT_KEY_SLASH        = 0x2F,
    UT_KEY_BACKSLASH    = 0x5C,

    // Values for special keys not represented by a unicode code point start
    // at 0x00110000.

    UT_KEY_PAD0  = 0x00110000,
    UT_KEY_PAD1  = 0x00110001,
    UT_KEY_PAD2  = 0x00110002,
    UT_KEY_PAD3  = 0x00110003,
    UT_KEY_PAD4  = 0x00110004,
    UT_KEY_PAD5  = 0x00110005,
    UT_KEY_PAD6  = 0x00110006,
    UT_KEY_PAD7  = 0x00110007,
    UT_KEY_PAD8  = 0x00110008,
    UT_KEY_PAD9  = 0x00110009,
    UT_KEY_ESC   = 0x0011000A,
    UT_KEY_SPACE = 0x0011000B,

};

// The following sentinel should only be used for validity checks, not for
// allocating fixed size arrays.
#define UT_KEY_MAX      UT_KEY_SPACE;

class UT_API UT_InterceptEvent {

public:

    UT_Key      key;
    short       mx;
    short       my;


    unsigned    alt_state : 1,
                ctl_state : 1,
                key_state : 1;
};

class UT_API UT_Intercept
{
public:

     UT_Intercept();

    int          numListeners() const
                 { return myListeners.entries(); }

    int          addListener(UT_InterceptCallback func, void *data);
    void         removeListener(int idx);

    int          distributeEvent(UT_InterceptEvent *event);

    void         setPollMode(int mode)
                 { myPollMode = mode; }

    int          getPollMode() const
                 { return myPollMode; }

    void         setModeNotifier(void *data)
                 { myModeNotifier = data; }

    void        *getModeNotifier() const
                 { return myModeNotifier; }

    void         setResolution(short x, short y)
                 { myResolutionX = x; myResolutionY = y;}

private:

    UT_ValArray<UT_InterceptCallback>            myListeners;
    UT_ValArray<void *>                          myData;
    int                                          myPollMode;
    short                                        myResolutionX;
    short                                        myResolutionY;
    void                                        *myModeNotifier;
};

UT_API extern UT_Intercept *UTgetIntercept(); // Get the app intercept ptr

#endif