Renaming three keyboard functions -- 'get' is not a good name when the

routine isn't getting something from somewhere but just converting it.

git-svn-id: svn://svn.savannah.gnu.org/nano/trunk/nano@5503 35c25a1d-7b9e-4130-9fde-d3aeb78583b8

diff --git a/ChangeLog b/ChangeLog
index 408e7a526dddcfef3b85366b6984c4d9d85344be..c6b2cd5f8ddd626983d5af432ca2477102994869 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -2,6 +2,8 @@
        * src/color.c (precalc_multicolorinfo, alloc_multidata_if_needed):
        Move these two functions to the file where they belong.  And make
        the checking for an impatient user into a separate routine.
+       * src/proto.h, src/winio.c (parse_escape_sequence, convert_sequence,
+       arrow_from_abcd): Better names for these three functions.
 
 2015-12-20  Benno Schulenberg  <bensberg@justemail.net>
        * src/files.c (display_buffer), src/nano.c (main): Precalculate the

diff --git a/src/proto.h b/src/proto.h
index d9400b450aba16ad2732f47c6c6595e008c524bf..91dcff12e6706511903e7379cdb8a1029f8af5bd 100644 (file)
--- a/src/proto.h
+++ b/src/proto.h
@@ -762,7 +762,7 @@ void dump_filestruct(const filestruct *inptr);
 void dump_filestruct_reverse(void);
 #endif
 
-/* All functions in winio.c. */
+/* Most functions in winio.c. */
 void get_key_buffer(WINDOW *win);
 size_t get_key_buffer_len(void);
 void unget_input(int *input, size_t input_len);
@@ -770,9 +770,8 @@ void unget_kbinput(int kbinput, bool metakey, bool funckey);
 int *get_input(WINDOW *win, size_t input_len);
 int get_kbinput(WINDOW *win);
 int parse_kbinput(WINDOW *win);
-int get_escape_seq_kbinput(const int *seq, size_t seq_len);
-int get_escape_seq_abcd(int kbinput);
-int parse_escape_seq_kbinput(WINDOW *win, int kbinput);
+int arrow_from_abcd(int kbinput);
+int parse_escape_sequence(WINDOW *win, int kbinput);
 int get_byte_kbinput(int kbinput);
 #ifdef ENABLE_UTF8
 long add_unicode_digit(int kbinput, long factor, long *uni);

diff --git a/src/winio.c b/src/winio.c
index 75960b2ab2fef7abf2b0b8f789a810d9e4461a9b..17fd9a63706c577d00457122851af473c902f5ec 100644 (file)
--- a/src/winio.c
+++ b/src/winio.c
@@ -388,8 +388,7 @@ int parse_kbinput(WINDOW *win)
                         * there are other keystrokes waiting: escape
                         * sequence mode.  Interpret the escape
                         * sequence. */
-                       retval = parse_escape_seq_kbinput(win,
-                               *kbinput);
+                       retval = parse_escape_sequence(win, *kbinput);
                    break;
                case 2:
                    if (get_key_buffer_len() == 0) {
@@ -472,8 +471,7 @@ int parse_kbinput(WINDOW *win)
                         * interpret the escape sequence. */
                        escapes = 0;
                        meta_key = TRUE;
-                       retval = parse_escape_seq_kbinput(win,
-                               *kbinput);
+                       retval = parse_escape_sequence(win, *kbinput);
                    }
                    break;
                case 3:
@@ -492,8 +490,7 @@ int parse_kbinput(WINDOW *win)
                         * Interpret the escape sequence, and interpret
                         * the result as a control sequence. */
                        retval = get_control_kbinput(
-                               parse_escape_seq_kbinput(win,
-                               *kbinput));
+                               parse_escape_sequence(win, *kbinput));
                    break;
            }
     }
@@ -670,7 +667,7 @@ int parse_kbinput(WINDOW *win)
  * keypad values, into their corresponding key values.  These sequences
  * are generated when the keypad doesn't support the needed keys.
  * Assume that Escape has already been read in. */
-int get_escape_seq_kbinput(const int *seq, size_t seq_len)
+int convert_sequence(const int *seq, size_t seq_len)
 {
     int retval = ERR;
 
@@ -695,7 +692,7 @@ int get_escape_seq_kbinput(const int *seq, size_t seq_len)
                                   * Terminal. */
                        case 'D': /* Esc O 1 ; 2 D == Shift-Left on
                                   * Terminal. */
-                           retval = get_escape_seq_abcd(seq[4]);
+                           retval = arrow_from_abcd(seq[4]);
                            break;
                        case 'P': /* Esc O 1 ; 2 P == F13 on Terminal. */
                            retval = KEY_F(13);
@@ -717,7 +714,7 @@ int get_escape_seq_kbinput(const int *seq, size_t seq_len)
                    switch (seq[4]) {
                        case 'A': /* Esc O 1 ; 5 A == Ctrl-Up on Terminal. */
                        case 'B': /* Esc O 1 ; 5 B == Ctrl-Down on Terminal. */
-                           retval = get_escape_seq_abcd(seq[4]);
+                           retval = arrow_from_abcd(seq[4]);
                            break;
                        case 'C': /* Esc O 1 ; 5 C == Ctrl-Right on Terminal. */
                            retval = CONTROL_RIGHT;
@@ -756,7 +753,7 @@ int get_escape_seq_kbinput(const int *seq, size_t seq_len)
                    case 'B': /* Esc O B == Down on VT100/VT320/xterm. */
                    case 'C': /* Esc O C == Right on VT100/VT320/xterm. */
                    case 'D': /* Esc O D == Left on VT100/VT320/xterm. */
-                       retval = get_escape_seq_abcd(seq[1]);
+                       retval = arrow_from_abcd(seq[1]);
                        break;
                    case 'E': /* Esc O E == Center (5) on numeric keypad
                               * with NumLock off on xterm. */
@@ -809,7 +806,7 @@ int get_escape_seq_kbinput(const int *seq, size_t seq_len)
                        break;
                    case 'a': /* Esc O a == Ctrl-Up on rxvt. */
                    case 'b': /* Esc O b == Ctrl-Down on rxvt. */
-                       retval = get_escape_seq_abcd(seq[1]);
+                       retval = arrow_from_abcd(seq[1]);
                        break;
                    case 'c': /* Esc O c == Ctrl-Right on rxvt. */
                        retval = CONTROL_RIGHT;
@@ -903,7 +900,7 @@ int get_escape_seq_kbinput(const int *seq, size_t seq_len)
                switch (seq[1]) {
                    case 'a': /* Esc o a == Ctrl-Up on Eterm. */
                    case 'b': /* Esc o b == Ctrl-Down on Eterm. */
-                       retval = get_escape_seq_abcd(seq[1]);
+                       retval = arrow_from_abcd(seq[1]);
                        break;
                    case 'c': /* Esc o c == Ctrl-Right on Eterm. */
                        retval = CONTROL_RIGHT;
@@ -959,7 +956,7 @@ int get_escape_seq_kbinput(const int *seq, size_t seq_len)
                        case 'B': /* Esc [ 1 ; 2 B == Shift-Down on xterm. */
                        case 'C': /* Esc [ 1 ; 2 C == Shift-Right on xterm. */
                        case 'D': /* Esc [ 1 ; 2 D == Shift-Left on xterm. */
-                           retval = get_escape_seq_abcd(seq[4]);
+                           retval = arrow_from_abcd(seq[4]);
                            break;
                    }
                }
@@ -969,7 +966,7 @@ int get_escape_seq_kbinput(const int *seq, size_t seq_len)
                    switch (seq[4]) {
                        case 'A': /* Esc [ 1 ; 5 A == Ctrl-Up on xterm. */
                        case 'B': /* Esc [ 1 ; 5 B == Ctrl-Down on xterm. */
-                           retval = get_escape_seq_abcd(seq[4]);
+                           retval = arrow_from_abcd(seq[4]);
                            break;
                        case 'C': /* Esc [ 1 ; 5 C == Ctrl-Right on xterm. */
                            retval = CONTROL_RIGHT;
@@ -1074,7 +1071,7 @@ int get_escape_seq_kbinput(const int *seq, size_t seq_len)
                    case 'D': /* Esc [ D == Left on ANSI/VT220/Linux
                               * console/FreeBSD console/Mach console/
                               * rxvt/Eterm/Terminal. */
-                       retval = get_escape_seq_abcd(seq[1]);
+                       retval = arrow_from_abcd(seq[1]);
                        break;
                    case 'E': /* Esc [ E == Center (5) on numeric keypad
                               * with NumLock off on FreeBSD console/
@@ -1160,7 +1157,7 @@ int get_escape_seq_kbinput(const int *seq, size_t seq_len)
                    case 'b': /* Esc [ b == Shift-Down on rxvt/Eterm. */
                    case 'c': /* Esc [ c == Shift-Right on rxvt/Eterm. */
                    case 'd': /* Esc [ d == Shift-Left on rxvt/Eterm. */
-                       retval = get_escape_seq_abcd(seq[1]);
+                       retval = arrow_from_abcd(seq[1]);
                        break;
                    case '[':
                        if (seq_len >= 3) {
@@ -1194,7 +1191,7 @@ int get_escape_seq_kbinput(const int *seq, size_t seq_len)
     }
 
 #ifdef DEBUG
-    fprintf(stderr, "get_escape_seq_kbinput(): retval = %d\n", retval);
+    fprintf(stderr, "convert_sequence(): retval = %d\n", retval);
 #endif
 
     return retval;
@@ -1203,7 +1200,7 @@ int get_escape_seq_kbinput(const int *seq, size_t seq_len)
 /* Return the equivalent arrow key value for the case-insensitive
  * letters A (up), B (down), C (right), and D (left).  These are common
  * to many escape sequences. */
-int get_escape_seq_abcd(int kbinput)
+int arrow_from_abcd(int kbinput)
 {
     switch (tolower(kbinput)) {
        case 'a':
@@ -1222,7 +1219,7 @@ int get_escape_seq_abcd(int kbinput)
 /* Interpret the escape sequence in the keystroke buffer, the first
  * character of which is kbinput.  Assume that the keystroke buffer
  * isn't empty, and that the initial escape has already been read in. */
-int parse_escape_seq_kbinput(WINDOW *win, int kbinput)
+int parse_escape_sequence(WINDOW *win, int kbinput)
 {
     int retval, *seq;
     size_t seq_len;
@@ -1233,11 +1230,11 @@ int parse_escape_seq_kbinput(WINDOW *win, int kbinput)
     unget_input(&kbinput, 1);
     seq_len = get_key_buffer_len();
     seq = get_input(NULL, seq_len);
-    retval = get_escape_seq_kbinput(seq, seq_len);
+    retval = convert_sequence(seq, seq_len);
 
     free(seq);
 
-    /* If we got an unrecognized escape sequence, throw it out. */
+    /* If we got an unrecognized escape sequence, notify the user. */
     if (retval == ERR) {
        if (win == edit) {
            statusbar(_("Unknown Command"));
@@ -1246,7 +1243,8 @@ int parse_escape_seq_kbinput(WINDOW *win, int kbinput)
     }
 
 #ifdef DEBUG
-    fprintf(stderr, "parse_escape_seq_kbinput(): kbinput = %d, seq_len = %lu, retval = %d\n", kbinput, (unsigned long)seq_len, retval);
+    fprintf(stderr, "parse_escape_sequence(): kbinput = %d, seq_len = %lu, retval = %d\n",
+               kbinput, (unsigned long)seq_len, retval);
 #endif
 
     return retval;