src/learn.c

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