/*
Copyright (C) 1996-1997 Id Software, Inc.

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; either version 2
of the License, or (at your option) any later version.

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 _KEYS_H_
#define _KEYS_H_

// these are the key numbers that should be passed to Key_Event

typedef enum {
	K_TAB = 9,
	K_ENTER = 13,
	K_ESCAPE = 27,
	K_SPACE	= 32,

// normal keys should be passed as lowercased ascii

	K_BACKSPACE = 127,

	K_CAPSLOCK,
	K_PRINTSCR,
	K_SCROLLLOCK,
	K_PAUSE,

	K_UPARROW,
	K_DOWNARROW,
	K_LEFTARROW,
	K_RIGHTARROW,

	K_ALT, K_OPTION = K_ALT,
	K_LALT,     // Left Alt-Key (can be used to separate the keys for bindings)
	K_RALT,     // Right Alt-Key (can be used to separate the keys; this can NOT be used if a third level of mappings is needed)
	K_ALTGR,    // Right Alt-Key (=AltGr Key; this key must be used, if a third level of mappings is needed)
	K_CTRL,
	K_LCTRL,
	K_RCTRL,
	K_SHIFT,
	K_LSHIFT,
	K_RSHIFT,
	K_F1,
	K_F2,
	K_F3,
	K_F4,
	K_F5,
	K_F6,
	K_F7,
	K_F8,
	K_F9,
	K_F10,
	K_F11,
	K_F12,
	K_F13,
	K_F14,
	K_F15,
	K_F16,
	K_INS,
	K_DEL,
	K_PGDN,
	K_PGUP,
	K_HOME,
	K_END,

	K_WIN,
	K_COMMAND = K_WIN,
	K_LWIN,
	K_RWIN,
	K_MENU,

//
// Keypad stuff..
//
	KP_NUMLOCK,
	KP_SLASH,
	KP_STAR,

	KP_7, KP_HOME = KP_7,
	KP_8, KP_UPARROW = KP_8,
	KP_9, KP_PGUP = KP_9,
	KP_MINUS,

	KP_4, KP_LEFTARROW = KP_4,
	KP_5,
	KP_6, KP_RIGHTARROW = KP_6,
	KP_PLUS,

	KP_1, KP_END = KP_1,
	KP_2, KP_DOWNARROW = KP_2,
	KP_3, KP_PGDN = KP_3,

	KP_0, KP_INS = KP_0,
	KP_DEL,
	KP_ENTER,

	KP_EQUAL,		// Mac

//
// mouse buttons generate virtual keys
//
	K_MOUSE1 = 200,
	K_MOUSE2,
	K_MOUSE3,
	K_MOUSE4,
	K_MOUSE5,
	K_MOUSE6,
	K_MOUSE7,
	K_MOUSE8,

//
// joystick buttons
//
	K_JOY1,
	K_JOY2,
	K_JOY3,
	K_JOY4,

//
// aux keys are for multi-buttoned joysticks to generate so they can use
// the normal binding process
//
	K_AUX1,
	K_AUX2,
	K_AUX3,
	K_AUX4,
	K_AUX5,
	K_AUX6,
	K_AUX7,
	K_AUX8,
	K_AUX9,
	K_AUX10,
	K_AUX11,
	K_AUX12,
	K_AUX13,
	K_AUX14,
	K_AUX15,
	K_AUX16,
	K_AUX17,
	K_AUX18,
	K_AUX19,
	K_AUX20,
	K_AUX21,
	K_AUX22,
	K_AUX23,
	K_AUX24,
	K_AUX25,
	K_AUX26,
	K_AUX27,
	K_AUX28,
	K_AUX29,
	K_AUX30,
	K_AUX31,
	K_AUX32,

// JACK: Intellimouse(c) Mouse Wheel Support

	K_MWHEELUP,
	K_MWHEELDOWN
} keynum_t;


typedef enum {key_game, key_console, key_message, key_menu} keydest_t;

extern keydest_t	key_dest;
extern char 	*keybindings[256];
extern int		key_repeats[256];
extern qbool	keydown[256];
extern int		key_lastpress;

extern char 	chat_buffer[];
extern int 		chat_linepos;
extern qbool	chat_team;

void Key_Event (int key, qbool down);
void Key_Init (void);
void Key_WriteBindings (FILE *f);
void Key_SetBinding (int keynum, char *binding);
void Key_Unbind (int keynum);
void Key_ClearStates (void);
int Key_StringToKeynum (char *str);
char *Key_KeynumToString (int keynum, char *buffer, size_t buf_size);

#endif /* _KEYS_H_ */

