KeyMap.h

Go to the documentation of this file.

/*
 * KeyMap.h
 *
 * Part of Fly! Legacy project
 *
 * Copyright 2003 Chris Wallace
 *
 * Fly! Legacy 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; either version 2 of the License, or
 *   (at your option) any later version.
 *
 * Fly! Legacy 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 Fly! Legacy; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#ifndef KEYMAP_H
#define KEYMAP_H


#include "FlyLegacy.h"
#include <map>


//
// CKeyDefinition represents a single simulator function that can be mapped to
//   a keyboard key.
//
class CKeyDefinition : public CStreamObject {
public:
  CKeyDefinition (void);

  // CStreamObject methods
  virtual int   Read (SStream *stream, Tag tag);

  // CKeyDefinition methods
  char* GetName (void);
  int   GetCode (void);
  void  Bind (KeyCallbackPtr f);

public:
  Tag     kyid;     // Unique key definition tag
  char    name[64];   // UI name
  int     code;     // Key code and modifier
  bool    user;     // User definable
  bool    enab;     // Enabled

  KeyCallbackPtr    cb;   // Callback function
};


//
// CKeySet represents a group of key mappings that relate to a similar group
//   of simulator functions.  The default key mapping contains key sets for
//   "Menu Keys", "Global Keys", 
//
class CKeySet : public CStreamObject {
public:
  CKeySet (Tag tag);
  ~CKeySet (void);

  // CStreamObject methods
  virtual int   Read (SStream *stream, Tag tag);

  // CKeySet methods
  char*     GetName (void);
  bool      GetUserModifiableState (void);
  bool      GetEnabledState (void);
  int       GetNumKeyDefinitions (void);
  CKeyDefinition* GetKeyDefinition (int i);

public:
  Tag     kset;                         // Key set unique tag
  char    name[64];                     // Key set name
  bool    user;                         // User modifiable
  bool    enab;                         // Enabled
  std::map<Tag,CKeyDefinition*>   kkey; // Map of key ids to complete definition
};



//
// CKeyMap is the application-visible interface class to the keyboard
//   mapping system.  Typical example usage:
//
// Application init:
//   CKeyMappings *keymap = new CKeyMappings ("System\\default.key");
//   keymap->Bind ('blah', func_blah);
//   ...
//
// Application detects key press:
//   keymap->KeyPress (key, modifiers);
//
class CKeyMap : public CStreamObject {
public:
  CKeyMap (const char* keyFilename);
  ~CKeyMap (void);

  // CStreamObject methods
  virtual int   Read (SStream *stream, Tag tag);

  // CKeyMap methods
  void    Print (FILE *f);
  void    KeyPress (EKeyboardKeys key, EKeyboardModifiers mod);
  void    Bind (Tag id, KeyCallbackPtr f);
  int     GetNumKeySets (void);
  CKeySet*  GetKeySet (int i);

private:
  CKeyDefinition* FindKeyDefinitionById (Tag id);

protected:
  int                      vers; // Version, currently ignored
  std::map<Tag,CKeySet*>   kset; // Map of keyset ids
};


//
// Utility function which formats the keycode into a human-readable string
//
void formatKeyCode (char *s, int code);

#endif // KEYMAP_H

Documentation generated by