src/learn.c

   1 /* Learn keys
   2    Copyright (C) 1995, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
   3    2007, 2009 Free Software Foundation, Inc.
   4
   5    Written by: 1995 Jakub Jelinek
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20  */
  21
  22 /** \file learn.c
  23  *  \brief Source: learn keys module
  24  */
  25
  26 #include <config.h>
  27
  28 #include <ctype.h>
  29 #include <stdio.h>
  30 #include <stdlib.h>
  31 #include <string.h>
  32
  33 #include <sys/types.h>
  34 #include <sys/stat.h>
  35 #include <unistd.h>
  36
  37 #include "global.h"
  38
  39 #include "../src/tty/tty.h"
  40 #include "../src/tty/key.h"
  41
  42 #include "dialog.h"
  43 #include "widget.h"
  44 #include "../src/mcconfig/mcconfig.h"   /* Save profile */
  45 #include "setup.h"
  46 #include "layout.h"                     /* repaint_screen() */
  47 #include "learn.h"
  48 #include "wtools.h"
  49 #include "strutil.h"
  50
  51 #define UX              4
  52 #define UY              3
  53
  54 #define BY              UY + 17
  55
  56 #define ROWS            13
  57 #define COLSHIFT        23
  58
  59 #define BUTTONS         2
  60
  61 static struct {
  62     int ret_cmd, flags, y, x;
  63     const char *text;
  64 } learn_but[BUTTONS] = {
  65     { B_CANCEL, NORMAL_BUTTON, 0, 39, N_("&Cancel") },
  66     { B_ENTER, DEFPUSH_BUTTON, 0, 25, N_("&Save") }
  67 };
  68
  69 static Dlg_head *learn_dlg;
  70 typedef struct {
  71     Widget *button;
  72     Widget *label;
  73     int ok;
  74     char *sequence;
  75 } learnkey;
  76 static learnkey *learnkeys = NULL;
  77 static int learn_total;
  78 static int learnok;
  79 static int learnchanged;
  80 static const char* learn_title = N_("Learn keys");
  81
  82
  83 static int learn_button (int action)
  84 {
  85     char *seq;
  86     Dlg_head *d = create_message (D_ERROR, _(" Teach me a key "),
  87 _("Please press the %s\n"
  88 "and then wait until this message disappears.\n\n"
  89 "Then, press it again to see if OK appears\n"
  90 "next to its button.\n\n"
  91 "If you want to escape, press a single Escape key\n"
  92 "and wait as well."),
  93         _(key_name_conv_tab [action - B_USER].longname));
  94     mc_refresh ();
  95     if (learnkeys [action - B_USER].sequence != NULL) {
  96         g_free (learnkeys [action - B_USER].sequence);
  97         learnkeys [action - B_USER].sequence = NULL;
  98     }
  99     seq = learn_key ();
 100
 101     if (seq){
 102         /* Esc hides the dialog and do not allow definitions of
 103          * regular characters
 104          */
 105         gboolean seq_ok = FALSE;
 106
 107         if (*seq && strcmp (seq, "\\e") && strcmp (seq, "\\e\\e")
 108             && strcmp (seq, "^m" ) && strcmp (seq, "^i" )
 109             && (seq [1] || (*seq < ' ' || *seq > '~'))){
 110
 111             learnchanged = 1;
 112             learnkeys [action - B_USER].sequence = seq;
 113             seq = convert_controls (seq);
 114             seq_ok = define_sequence (key_name_conv_tab [action - B_USER].code,
 115                                       seq, MCKEY_NOACTION);
 116         }
 117
 118         if (!seq_ok)
 119             message (D_NORMAL, _(" Cannot accept this key "),
 120                 _(" You have entered \"%s\""), seq);
 121
 122         g_free (seq);
 123     }
 124
 125     dlg_run_done (d);
 126     destroy_dlg (d);
 127     dlg_select_widget (learnkeys [action - B_USER].button);
 128     return 0; /* Do not kill learn_dlg */
 129 }
 130
 131 static int learn_move (int right)
 132 {
 133     int i, totalcols;
 134
 135     totalcols = (learn_total - 1) / ROWS + 1;
 136     for (i = 0; i < learn_total; i++)
 137         if (learnkeys [i].button == learn_dlg->current) {
 138             if (right) {
 139                 if (i < learn_total - ROWS)
 140                     i += ROWS;
 141                 else
 142                     i %= ROWS;
 143             } else {
 144                 if (i / ROWS)
 145                     i -= ROWS;
 146                 else if (i + (totalcols - 1) * ROWS >= learn_total)
 147                     i += (totalcols - 2) * ROWS;
 148                 else
 149                     i += (totalcols - 1) * ROWS;
 150             }
 151             dlg_select_widget (learnkeys [i].button);
 152             return 1;
 153         }
 154     return 0;
 155 }
 156
 157 static int
 158 learn_check_key (int c)
 159 {
 160     int i;
 161
 162     for (i = 0; i < learn_total; i++) {
 163         if (key_name_conv_tab[i].code != c || learnkeys[i].ok)
 164             continue;
 165
 166         dlg_select_widget (learnkeys[i].button);
 167         /* TRANSLATORS: This label appears near learned keys.  Keep it short.  */
 168         label_set_text ((WLabel *) learnkeys[i].label, _("OK"));
 169         learnkeys[i].ok = 1;
 170         learnok++;
 171         if (learnok >= learn_total) {
 172             learn_dlg->ret_value = B_CANCEL;
 173             if (learnchanged) {
 174                 if (query_dialog (learn_title,
 175                                   _
 176                                   ("It seems that all your keys already\n"
 177                                    "work fine. That's great."), D_ERROR, 2,
 178                                   _("&Save"), _("&Discard")) == 0)
 179                     learn_dlg->ret_value = B_ENTER;
 180             } else {
 181                 message (D_ERROR, learn_title,
 182                          _
 183                          ("Great! You have a complete terminal database!\n"
 184                           "All your keys work well."));
 185             }
 186             dlg_stop (learn_dlg);
 187         }
 188         return 1;
 189     }
 190     switch (c) {
 191     case KEY_LEFT:
 192     case 'h':
 193         return learn_move (0);
 194     case KEY_RIGHT:
 195     case 'l':
 196         return learn_move (1);
 197     case 'j':
 198         dlg_one_down (learn_dlg);
 199         return 1;
 200     case 'k':
 201         dlg_one_up (learn_dlg);
 202         return 1;
 203     }
 204
 205     /* Prevent from disappearing if a non-defined sequence is pressed
 206        and contains a button hotkey.  Only recognize hotkeys with ALT.  */
 207     if (c < 255 && g_ascii_isalnum (c))
 208                 return 1;
 209
 210     return 0;
 211 }
 212
 213 static cb_ret_t
 214 learn_callback (Dlg_head *h, dlg_msg_t msg, int parm)
 215 {
 216     switch (msg) {
 217     case DLG_DRAW:
 218         common_dialog_repaint (h);
 219         return MSG_HANDLED;
 220
 221     case DLG_KEY:
 222         return learn_check_key (parm);
 223
 224     default:
 225         return default_dlg_callback (h, msg, parm);
 226     }
 227 }
 228
 229 static void
 230 init_learn (void)
 231 {
 232     int x, y, i, j;
 233     key_code_name_t *key;
 234     char buffer[BUF_TINY];
 235
 236 #ifdef ENABLE_NLS
 237     static int i18n_flag = 0;
 238     if (!i18n_flag) {
 239         learn_but[0].text = _(learn_but[0].text);
 240         learn_but[0].x = 78 / 2 + 4;
 241
 242         learn_but[1].text = _(learn_but[1].text);
 243         learn_but[1].x = 78 / 2 - (str_term_width1 (learn_but[1].text) + 9);
 244
 245         learn_title = _(learn_title);
 246         i18n_flag = 1;
 247     }
 248 #endif                          /* ENABLE_NLS */
 249
 250     do_refresh ();
 251
 252     learn_dlg =
 253         create_dlg (0, 0, 23, 78, dialog_colors, learn_callback,
 254                     "[Learn keys]", learn_title, DLG_CENTER | DLG_REVERSE);
 255
 256     for (i = 0; i < BUTTONS; i++)
 257         add_widget (learn_dlg,
 258                     button_new (BY + learn_but[i].y, learn_but[i].x,
 259                                 learn_but[i].ret_cmd, learn_but[i].flags,
 260                                 _(learn_but[i].text), 0));
 261
 262     x = UX;
 263     y = UY;
 264     for (key = key_name_conv_tab, j = 0;
 265          key->name != NULL && strcmp (key->name, "kpleft"); key++, j++);
 266     learnkeys = g_new (learnkey, j);
 267     x += ((j - 1) / ROWS) * COLSHIFT;
 268     y += (j - 1) % ROWS;
 269     learn_total = j;
 270     learnok = 0;
 271     learnchanged = 0;
 272     for (i = j - 1, key = key_name_conv_tab + j - 1; i >= 0; i--, key--) {
 273         learnkeys[i].ok = 0;
 274         learnkeys[i].sequence = NULL;
 275         g_snprintf (buffer, sizeof (buffer), "%-16s", _(key->longname));
 276         add_widget (learn_dlg, learnkeys[i].button = (Widget *)
 277                     button_new (y, x, B_USER + i, NARROW_BUTTON, buffer,
 278                                 learn_button));
 279         add_widget (learn_dlg, learnkeys[i].label = (Widget *)
 280                     label_new (y, x + 19, ""));
 281         if (i % 13)
 282             y--;
 283         else {
 284             x -= COLSHIFT;
 285             y = UY + ROWS - 1;
 286         }
 287     }
 288     add_widget (learn_dlg,
 289                 label_new (UY + 14, 5,
 290                            _
 291                            ("Press all the keys mentioned here. After you have done it, check")));
 292     add_widget (learn_dlg,
 293                 label_new (UY + 15, 5,
 294                            _
 295                            ("which keys are not marked with OK.  Press space on the missing")));
 296     add_widget (learn_dlg,
 297                 label_new (UY + 16, 5,
 298                            _
 299                            ("key, or click with the mouse to define it. Move around with Tab.")));
 300 }
 301
 302 static void learn_done (void)
 303 {
 304     destroy_dlg (learn_dlg);
 305     repaint_screen ();
 306 }
 307
 308 static void
 309 learn_save (void)
 310 {
 311     int i;
 312     int profile_changed = 0;
 313     char *section = g_strconcat ("terminal:", getenv ("TERM"), (char *) NULL);
 314
 315     for (i = 0; i < learn_total; i++) {
 316         if (learnkeys [i].sequence != NULL) {
 317             profile_changed = 1;
 318             mc_config_set_string(mc_main_config, section,
 319                 key_name_conv_tab [i].name, learnkeys [i].sequence);
 320         }
 321     }
 322
 323     /* On the one hand no good idea to save the complete setup but
 324      * without 'Auto save setup' the new key-definitions will not be
 325      * saved unless the user does an 'Options/Save Setup'.
 326      * On the other hand a save-button that does not save anything to
 327      * disk is much worse.
 328      */
 329     if (profile_changed)
 330         mc_config_save_file (mc_main_config);
 331
 332     g_free (section);
 333 }
 334
 335 void learn_keys (void)
 336 {
 337     int save_old_esc_mode = old_esc_mode;
 338     int save_alternate_plus_minus = alternate_plus_minus;
 339
 340     old_esc_mode = 0; /* old_esc_mode cannot work in learn keys dialog */
 341     alternate_plus_minus = 1; /* don't translate KP_ADD, KP_SUBTRACT and
 342                                  KP_MULTIPLY to '+', '-' and '*' in
 343                                  correct_key_code */
 344     application_keypad_mode ();
 345     init_learn ();
 346
 347     run_dlg (learn_dlg);
 348
 349     old_esc_mode = save_old_esc_mode;
 350     alternate_plus_minus = save_alternate_plus_minus;
 351
 352     if (!alternate_plus_minus)
 353         numeric_keypad_mode ();
 354
 355     switch (learn_dlg->ret_value) {
 356     case B_ENTER:
 357         learn_save ();
 358         break;
 359     }
 360
 361     learn_done ();
 362 }
 363