pscharcontrol.h

Go to the documentation of this file.

/*
 * Copyright (C) 2006 Atomic Blue (info@planeshift.it, http://www.atomicblue.org)
 *
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation (version 2 of the License)
 * This program 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */

#ifndef __PSCHARCONTROL_H__
#define __PSCHARCONTROL_H__
//=============================================================================
// Crystal Space Includes
//=============================================================================
#include <csutil/hash.h>
#include <csutil/csstring.h>
#include <iutil/eventnames.h>

//=============================================================================
// Project Includes
//=============================================================================

//=============================================================================
// Local Includes
//=============================================================================
#include "psmovement.h"

class psTriggerHandler;
class psCharController;


struct psControl
{
    typedef void (psTriggerHandler::*TriggerFunction)(const psControl*, bool);

    typedef const void* DataPtr;

    enum PressType
    {
        NORMAL,  
        TOGGLE   
    };

    enum Device
    {
        NONE,      
        KEYBOARD,  
        MOUSE      
    };

    psControl(const char* n, PressType t, TriggerFunction f)
        : name(n), state(false), device(NONE), button(0), mods(0), type(t), function(f), data(NULL) {}

    csString name;             
    bool state;                
    Device device;             
    uint button;               
    uint32 mods;               
    PressType type;            
    TriggerFunction function;  
    DataPtr data;              

    void Execute() const;      
    csString ToString() const; 

    static psTriggerHandler* handler;  
};


csString ComboToString(psControl::Device device, uint button, uint32 mods);

csString GetDisplayName(const char* name);

// CS strangeness requires different methods for mouse and key modifiers
uint32 GetPSKeyMods(const iEvent* event);
uint32 GetPSMouseMods(const iEvent* event);

#define PS_MODS_MASK CSMASK_ALLSHIFTS


class psControlManager
{
public:
    psControlManager(iEventNameRegistry* eventname_reg, psTriggerHandler* handler);

    bool HandleEvent(iEvent &event);

    void NewTrigger(const char* name, psControl::PressType type, psControl::TriggerFunction function);

    bool MapTrigger(const char* name, psControl::Device device, uint button, uint32 mods);

    void ResetTrigger(psControl* trigger);    
    void ResetAllTriggers();                  

    psControl* GetTrigger(const char* name);

    psControl* GetMappedTrigger(psControl::Device device, uint button, uint32 mods);

    csArray<psControl*>* GetMappedTriggers(psControl::Device device, uint button);

    const csPDelArray<psControl> &GetAllTriggers()
    {
        return triggers;
    }

    bool SetTriggerData(const char* name, const void* ptr);

protected:
    typedef csHash<psControl*,uint> psControlMap;  

    psControlMap keyboard;   
    psControlMap mouse;      

    csPDelArray<psControl> triggers;  

    // Event ID cache
    csEventID event_key_down;
    csEventID event_key_up;
    csEventID event_mouse_down;
    csEventID event_mouse_up;

    static psControl* GetFromMap(const psControlMap &ctrlmap, uint button, uint32 mods);

    csArray<psControl*>* GetArrayFromMap(const psControlMap &ctrlmap, uint button);

    void HandleButton(psControl::Device device, uint button, uint32 mods, bool newState);


};


class psTriggerHandler
{
public:
    psTriggerHandler(psCharController* controler);
    ~psTriggerHandler();

    // Functions called by triggers  (psControl stores pointers to these)
    void HandleBrightnessUp(const psControl* trigger, bool value);
    void HandleBrightnessDown(const psControl* trigger, bool value);
    void HandleBrightnessReset(const psControl* trigger, bool value);
    void HandleMovement(const psControl* trigger, bool value);
    void HandleMovementJump(const psControl* trigger, bool value);
    void HandleMode(const psControl* trigger, bool value);
    void HandleAutoMove(const psControl* trigger, bool value);
    void HandleLook(const psControl* trigger, bool value);
    void HandleZoom(const psControl* trigger, bool value);
    void HandleMouseLook(const psControl* trigger, bool value);
    void HandleMouseLookToggle(const psControl* trigger, bool value);
    void HandleMouseZoom(const psControl* trigger, bool value);
    void HandleMouseMove(const psControl* trigger, bool value);
    void HandleCameraMode(const psControl* trigger, bool value);
    void HandleCenterCamera(const psControl* trigger, bool value);
    void HandleMovementAction(const psControl* trigger, bool value);
    void HandleShortcut(const psControl* trigger, bool value);
    void HandleWindow(const psControl* trigger, bool value);
    void HandleModeRun(const psControl* trigger, bool value);
    void HandleModeSneak(const psControl* trigger, bool value);

protected:
    psCharController* charcontrol;
    psMovementManager* movement;
};


class psCharController
{
public:
    psCharController(iEventNameRegistry* eventname_reg);
    ~psCharController();

    bool Initialize();
    bool IsReady();

    bool HandleEvent(iEvent &event);

    psMovementManager* GetMovementManager()
    {
        return &movement;
    }

    const psControl* GetTrigger(const char* name);

    const psControl* GetMappedTrigger(psControl::Device device, uint button, uint32 mods);

    bool RemapTrigger(const char* name, psControl::Device device, uint button, uint32 mods);

    bool MatchTrigger(const char* name, psControl::Device device, uint button, uint32 mods);

    void LoadKeyFile();

    void LoadDefaultKeys();

    void CenterMouse(bool value);
    void CancelMouseLook();

protected:
    psTriggerHandler handler;    
    psControlManager controls;   
    psMovementManager movement;  

    void CreateKeys();                
    bool LoadKeys(const char* file);  
    void SaveKeys();                  

    bool ready;  

    csEventID event_mouseclick;
};

#endif