ref: b64487305ba2741a247e8d3b6ef265b7ee67af90
dir: /src/setup/keyboard.c/
// // Copyright(C) 2005-2014 Simon Howard // // 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. // #include "textscreen.h" #include "doomtype.h" #include "m_config.h" #include "m_controls.h" #include "m_misc.h" #include "execute.h" #include "txt_keyinput.h" #include "mode.h" #include "joystick.h" #include "keyboard.h" #define WINDOW_HELP_URL "https://www.chocolate-doom.org/setup-keyboard" int vanilla_keyboard_mapping = 1; static int always_run = 0; // Keys within these groups cannot have the same value. static int *controls[] = { &key_left, &key_right, &key_up, &key_down, &key_strafeleft, &key_straferight, &key_fire, &key_use, &key_strafe, &key_speed, &key_jump, &key_flyup, &key_flydown, &key_flycenter, &key_lookup, &key_lookdown, &key_lookcenter, &key_invleft, &key_invright, &key_invquery, &key_invuse, &key_invpop, &key_mission, &key_invkey, &key_invhome, &key_invend, &key_invdrop, &key_useartifact, &key_pause, &key_usehealth, &key_weapon1, &key_weapon2, &key_weapon3, &key_weapon4, &key_weapon5, &key_weapon6, &key_weapon7, &key_weapon8, &key_arti_all, &key_arti_health, &key_arti_poisonbag, &key_arti_blastradius, &key_arti_teleport, &key_arti_teleportother, &key_arti_egg, &key_arti_invulnerability, &key_prevweapon, &key_nextweapon, NULL }; static int *menu_nav[] = { &key_menu_activate, &key_menu_up, &key_menu_down, &key_menu_left, &key_menu_right, &key_menu_back, &key_menu_forward, NULL }; static int *shortcuts[] = { &key_menu_help, &key_menu_save, &key_menu_load, &key_menu_volume, &key_menu_detail, &key_menu_qsave, &key_menu_endgame, &key_menu_messages, &key_spy, &key_menu_qload, &key_menu_quit, &key_menu_gamma, &key_menu_incscreen, &key_menu_decscreen, &key_menu_screenshot, &key_message_refresh, &key_multi_msg, &key_multi_msgplayer[0], &key_multi_msgplayer[1], &key_multi_msgplayer[2], &key_multi_msgplayer[3] }; static int *map_keys[] = { &key_map_north, &key_map_south, &key_map_east, &key_map_west, &key_map_zoomin, &key_map_zoomout, &key_map_toggle, &key_map_maxzoom, &key_map_follow, &key_map_grid, &key_map_mark, &key_map_clearmark, NULL }; static void UpdateJoybSpeed(TXT_UNCAST_ARG(widget), TXT_UNCAST_ARG(var)) { if (always_run) { /* <Janizdreg> if you want to pick one for chocolate doom to use, pick 29, since that is the most universal one that also works with heretic, hexen and strife =P NB. This choice also works with original, ultimate and final exes. */ joybspeed = 29; } else { joybspeed = 0; } } static int VarInGroup(int *variable, int **group) { unsigned int i; for (i=0; group[i] != NULL; ++i) { if (group[i] == variable) { return 1; } } return 0; } static void CheckKeyGroup(int *variable, int **group) { unsigned int i; // Don't check unless the variable is in this group. if (!VarInGroup(variable, group)) { return; } // If another variable has the same value as the new value, reset it. for (i=0; group[i] != NULL; ++i) { if (*variable == *group[i] && group[i] != variable) { // A different key has the same value. Clear the existing // value. This ensures that no two keys can have the same // value. *group[i] = 0; } } } // Callback invoked when a key control is set static void KeySetCallback(TXT_UNCAST_ARG(widget), TXT_UNCAST_ARG(variable)) { TXT_CAST_ARG(int, variable); CheckKeyGroup(variable, controls); CheckKeyGroup(variable, menu_nav); CheckKeyGroup(variable, shortcuts); CheckKeyGroup(variable, map_keys); } // Add a label and keyboard input to the specified table. static void AddKeyControl(TXT_UNCAST_ARG(table), char *name, int *var) { TXT_CAST_ARG(txt_table_t, table); txt_key_input_t *key_input; TXT_AddWidget(table, TXT_NewLabel(name)); key_input = TXT_NewKeyInput(var); TXT_AddWidget(table, key_input); TXT_SignalConnect(key_input, "set", KeySetCallback, var); } static void AddSectionLabel(TXT_UNCAST_ARG(table), char *title, boolean add_space) { TXT_CAST_ARG(txt_table_t, table); char buf[64]; if (add_space) { TXT_AddWidgets(table, TXT_NewStrut(0, 1), TXT_TABLE_EOL, NULL); } M_snprintf(buf, sizeof(buf), " - %s - ", title); TXT_AddWidgets(table, TXT_NewLabel(buf), TXT_TABLE_EOL, NULL); } static void ConfigExtraKeys(TXT_UNCAST_ARG(widget), TXT_UNCAST_ARG(unused)) { txt_window_t *window; txt_scrollpane_t *scrollpane; txt_table_t *table; boolean extra_keys = gamemission == heretic || gamemission == hexen || gamemission == strife; window = TXT_NewWindow("Extra keyboard controls"); TXT_SetWindowHelpURL(window, WINDOW_HELP_URL); table = TXT_NewTable(2); TXT_SetColumnWidths(table, 21, 9); if (extra_keys) { // When we have extra controls, a scrollable pane must be used. scrollpane = TXT_NewScrollPane(0, 13, table); TXT_AddWidget(window, scrollpane); AddSectionLabel(table, "View", false); AddKeyControl(table, "Look up", &key_lookup); AddKeyControl(table, "Look down", &key_lookdown); AddKeyControl(table, "Center view", &key_lookcenter); if (gamemission == heretic || gamemission == hexen) { AddSectionLabel(table, "Flying", true); AddKeyControl(table, "Fly up", &key_flyup); AddKeyControl(table, "Fly down", &key_flydown); AddKeyControl(table, "Fly center", &key_flycenter); } AddSectionLabel(table, "Inventory", true); AddKeyControl(table, "Inventory left", &key_invleft); AddKeyControl(table, "Inventory right", &key_invright); if (gamemission == strife) { AddKeyControl(table, "Home", &key_invhome); AddKeyControl(table, "End", &key_invend); AddKeyControl(table, "Query", &key_invquery); AddKeyControl(table, "Drop", &key_invdrop); AddKeyControl(table, "Show weapons", &key_invpop); AddKeyControl(table, "Show mission", &key_mission); AddKeyControl(table, "Show keys", &key_invkey); AddKeyControl(table, "Use", &key_invuse); AddKeyControl(table, "Use health", &key_usehealth); } else { AddKeyControl(table, "Use artifact", &key_useartifact); } if (gamemission == hexen) { AddSectionLabel(table, "Artifacts", true); AddKeyControl(table, "One of each", &key_arti_all); AddKeyControl(table, "Quartz Flask", &key_arti_health); AddKeyControl(table, "Flechette", &key_arti_poisonbag); AddKeyControl(table, "Disc of Repulsion", &key_arti_blastradius); AddKeyControl(table, "Chaos Device", &key_arti_teleport); AddKeyControl(table, "Banishment Device", &key_arti_teleportother); AddKeyControl(table, "Porkalator", &key_arti_egg); AddKeyControl(table, "Icon of the Defender", &key_arti_invulnerability); } } else { TXT_AddWidget(window, table); } AddSectionLabel(table, "Weapons", extra_keys); AddKeyControl(table, "Weapon 1", &key_weapon1); AddKeyControl(table, "Weapon 2", &key_weapon2); AddKeyControl(table, "Weapon 3", &key_weapon3); AddKeyControl(table, "Weapon 4", &key_weapon4); AddKeyControl(table, "Weapon 5", &key_weapon5); AddKeyControl(table, "Weapon 6", &key_weapon6); AddKeyControl(table, "Weapon 7", &key_weapon7); AddKeyControl(table, "Weapon 8", &key_weapon8); AddKeyControl(table, "Previous weapon", &key_prevweapon); AddKeyControl(table, "Next weapon", &key_nextweapon); } static void OtherKeysDialog(TXT_UNCAST_ARG(widget), TXT_UNCAST_ARG(unused)) { txt_window_t *window; txt_table_t *table; txt_scrollpane_t *scrollpane; window = TXT_NewWindow("Other keys"); TXT_SetWindowHelpURL(window, WINDOW_HELP_URL); table = TXT_NewTable(2); TXT_SetColumnWidths(table, 25, 9); AddSectionLabel(table, "Menu navigation", false); AddKeyControl(table, "Activate menu", &key_menu_activate); AddKeyControl(table, "Move cursor up", &key_menu_up); AddKeyControl(table, "Move cursor down", &key_menu_down); AddKeyControl(table, "Move slider left", &key_menu_left); AddKeyControl(table, "Move slider right", &key_menu_right); AddKeyControl(table, "Go to previous menu", &key_menu_back); AddKeyControl(table, "Activate menu item", &key_menu_forward); AddKeyControl(table, "Confirm action", &key_menu_confirm); AddKeyControl(table, "Cancel action", &key_menu_abort); AddSectionLabel(table, "Shortcut keys", true); AddKeyControl(table, "Pause game", &key_pause); AddKeyControl(table, "Help screen", &key_menu_help); AddKeyControl(table, "Save game", &key_menu_save); AddKeyControl(table, "Load game", &key_menu_load); AddKeyControl(table, "Sound volume", &key_menu_volume); AddKeyControl(table, "Toggle detail", &key_menu_detail); AddKeyControl(table, "Quick save", &key_menu_qsave); AddKeyControl(table, "End game", &key_menu_endgame); AddKeyControl(table, "Toggle messages", &key_menu_messages); AddKeyControl(table, "Quick load", &key_menu_qload); AddKeyControl(table, "Quit game", &key_menu_quit); AddKeyControl(table, "Toggle gamma", &key_menu_gamma); AddKeyControl(table, "Multiplayer spy", &key_spy); AddKeyControl(table, "Increase screen size", &key_menu_incscreen); AddKeyControl(table, "Decrease screen size", &key_menu_decscreen); AddKeyControl(table, "Save a screenshot", &key_menu_screenshot); AddKeyControl(table, "Display last message", &key_message_refresh); AddKeyControl(table, "Finish recording demo", &key_demo_quit); AddSectionLabel(table, "Map", true); AddKeyControl(table, "Toggle map", &key_map_toggle); AddKeyControl(table, "Zoom in", &key_map_zoomin); AddKeyControl(table, "Zoom out", &key_map_zoomout); AddKeyControl(table, "Maximum zoom out", &key_map_maxzoom); AddKeyControl(table, "Follow mode", &key_map_follow); AddKeyControl(table, "Pan north", &key_map_north); AddKeyControl(table, "Pan south", &key_map_south); AddKeyControl(table, "Pan east", &key_map_east); AddKeyControl(table, "Pan west", &key_map_west); AddKeyControl(table, "Toggle grid", &key_map_grid); AddKeyControl(table, "Mark location", &key_map_mark); AddKeyControl(table, "Clear all marks", &key_map_clearmark); AddSectionLabel(table, "Multiplayer", true); AddKeyControl(table, "Send message", &key_multi_msg); AddKeyControl(table, "- to player 1", &key_multi_msgplayer[0]); AddKeyControl(table, "- to player 2", &key_multi_msgplayer[1]); AddKeyControl(table, "- to player 3", &key_multi_msgplayer[2]); AddKeyControl(table, "- to player 4", &key_multi_msgplayer[3]); if (gamemission == hexen || gamemission == strife) { AddKeyControl(table, "- to player 5", &key_multi_msgplayer[4]); AddKeyControl(table, "- to player 6", &key_multi_msgplayer[5]); AddKeyControl(table, "- to player 7", &key_multi_msgplayer[6]); AddKeyControl(table, "- to player 8", &key_multi_msgplayer[7]); } scrollpane = TXT_NewScrollPane(0, 13, table); TXT_AddWidget(window, scrollpane); } void ConfigKeyboard(void) { txt_window_t *window; txt_checkbox_t *run_control; always_run = joybspeed >= 20; window = TXT_NewWindow("Keyboard configuration"); TXT_SetWindowHelpURL(window, WINDOW_HELP_URL); // The window is on a 5-column grid layout that looks like: // Label | Control | | Label | Control // There is a small gap between the two conceptual "columns" of // controls, just for spacing. TXT_SetTableColumns(window, 5); TXT_SetColumnWidths(window, 15, 8, 2, 15, 8); TXT_AddWidget(window, TXT_NewSeparator("Movement")); AddKeyControl(window, "Move Forward", &key_up); TXT_AddWidget(window, TXT_TABLE_EMPTY); AddKeyControl(window, "Strafe Left", &key_strafeleft); AddKeyControl(window, "Move Backward", &key_down); TXT_AddWidget(window, TXT_TABLE_EMPTY); AddKeyControl(window, "Strafe Right", &key_straferight); AddKeyControl(window, "Turn Left", &key_left); TXT_AddWidget(window, TXT_TABLE_EMPTY); AddKeyControl(window, "Speed On", &key_speed); AddKeyControl(window, "Turn Right", &key_right); TXT_AddWidget(window, TXT_TABLE_EMPTY); AddKeyControl(window, "Strafe On", &key_strafe); if (gamemission == hexen || gamemission == strife) { AddKeyControl(window, "Jump", &key_jump); } TXT_AddWidget(window, TXT_NewSeparator("Action")); AddKeyControl(window, "Fire/Attack", &key_fire); TXT_AddWidget(window, TXT_TABLE_EMPTY); AddKeyControl(window, "Use", &key_use); TXT_AddWidgets(window, TXT_NewButton2("More controls...", ConfigExtraKeys, NULL), TXT_TABLE_OVERFLOW_RIGHT, TXT_TABLE_EMPTY, TXT_NewButton2("Other keys...", OtherKeysDialog, NULL), TXT_TABLE_OVERFLOW_RIGHT, TXT_NewSeparator("Misc."), run_control = TXT_NewCheckBox("Always run", &always_run), TXT_TABLE_EOL, TXT_NewInvertedCheckBox("Use native keyboard mapping", &vanilla_keyboard_mapping), TXT_TABLE_EOL, NULL); TXT_SignalConnect(run_control, "changed", UpdateJoybSpeed, NULL); TXT_SetWindowAction(window, TXT_HORIZ_CENTER, TestConfigAction()); } void BindKeyboardVariables(void) { M_BindIntVariable("vanilla_keyboard_mapping", &vanilla_keyboard_mapping); }