Changeset 1e01a35 in mainline

Timestamp:

2012-07-10T12:01:07Z (12 years ago)

Author:

Vojtech Horky <vojtechhorky@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

f0d7bd9

Parents:

b4ca0a9c

git-author:

Sandeep Kumar <> (2012-07-10 12:01:07)

git-committer:

Vojtech Horky <vojtechhorky@…> (2012-07-10 12:01:07)

Message:

Symbol table completion for kernel console (#50)

Kernel console command arguments are tab-completed with words from symbol
table. Thanks Sandeep Kumar.

Location:

kernel/generic

Files:

• include/debug.h (modified) (1 diff)
• include/symtab.h (modified) (1 diff)
• include/symtab_lookup.h (added)
• src/console/kconsole.c (modified) (6 diffs)
• src/debug/symtab.c (modified) (3 diffs)

kernel/generic/include/debug.h

@@ -37 +37 @@
 
 #include <panic.h>
-#include <symtab.h>
+#include <symtab_lookup.h>
 
 #define CALLER  ((uintptr_t) __builtin_return_address(0))

kernel/generic/include/symtab.h

@@ -36 +36 @@
 #define KERN_SYMTAB_H_
 
-#include <typedefs.h>
+#define MAX_TAB_HINTS 37
 
-#define MAX_SYMBOL_NAME  64
+#include <symtab_lookup.h>
+#include <console/chardev.h>
 
-struct symtab_entry {
-        uint64_t address_le;
-        char symbol_name[MAX_SYMBOL_NAME];
-};
-
-extern int symtab_name_lookup(uintptr_t, const char **, uintptr_t *);
-extern const char *symtab_fmt_name_lookup(uintptr_t);
-extern int symtab_addr_lookup(const char *, uintptr_t *);
 extern void symtab_print_search(const char *);
-extern int symtab_compl(char *, size_t);
-
-#ifdef CONFIG_SYMTAB
-
-/** Symtable linked together by build process
- *
- */
-extern struct symtab_entry symbol_table[];
-
-#endif /* CONFIG_SYMTAB */
+extern int symtab_compl(char *, size_t, indev_t *);
 
 #endif

kernel/generic/src/console/kconsole.c

@@ -201 +201 @@
  *
  */
-NO_TRACE static int cmdtab_compl(char *input, size_t size)
+NO_TRACE static int cmdtab_compl(char *input, size_t size, indev_t * indev)
 {
         const char *name = input;
         
         size_t found = 0;
+        /* Maximum Match Length : Length of longest matching common substring in
+           case more than one match is found */
+        size_t max_match_len = size;
+        size_t max_match_len_tmp = size;
+        size_t input_len = str_length(input);
         link_t *pos = NULL;
         const char *hint;
         char *output = malloc(MAX_CMDLINE, 0);
+        char display = 'y';
+        size_t hints_to_show = MAX_TAB_HINTS - 1;
+        size_t total_hints_shown = 0;
+        char continue_showing_hints = 'y';
         
         output[0] = 0;
@@ -218 +227 @@
                 pos = pos->next;
                 found++;
+        }
+        
+        /* If possible completions are more than MAX_TAB_HINTS, ask user whether to display them or not. */
+        if (found > MAX_TAB_HINTS) {
+                printf("\nDisplay all %zu possibilities? (y or n)", found);
+                do {
+                        display = indev_pop_character(indev);
+                } while (display != 'y' && display != 'n' && display != 'Y' && display != 'N');
         }
         
@@ -225 +242 @@
                 while (cmdtab_search_one(name, &pos)) {
                         cmd_info_t *hlp = list_get_instance(pos, cmd_info_t, link);
-                        printf("%s (%s)\n", hlp->name, hlp->description);
+
+                        if (display == 'y' || display == 'Y') { /* We are still showing hints */
+                                printf("%s (%s)\n", hlp->name, hlp->description);
+                                --hints_to_show;
+                                ++total_hints_shown;
+
+                                if (hints_to_show == 0 && total_hints_shown != found) { /* Time to ask user to continue */
+                                        printf("--More--");
+                                        do {
+                                                continue_showing_hints = indev_pop_character(indev);
+                                                if (continue_showing_hints == 'y' || continue_showing_hints == 'Y'
+                                                                || continue_showing_hints == ' ') {
+                                                        hints_to_show = MAX_TAB_HINTS - 1; /* Display a full page again */
+                                                        break;
+                                                }
+
+                                                if (continue_showing_hints == 'n' || continue_showing_hints == 'N'
+                                                                || continue_showing_hints == 'q' || continue_showing_hints == 'Q') {
+                                                        display = 'n'; /* Stop displaying hints */
+                                                        break;
+                                                }
+
+                                                if (continue_showing_hints == '\n') {
+                                                        hints_to_show = 1; /* Show one more hint */
+                                                        break;
+                                                }
+                                        } while (1);
+
+                                        printf("\r         \r"); /* Delete the --More-- option */
+                                }
+                        }
+
                         pos = pos->next;
-                }
+                        for(max_match_len_tmp = 0; output[max_match_len_tmp] == hlp->name[input_len + max_match_len_tmp]
+                                        && max_match_len_tmp < max_match_len; ++max_match_len_tmp);
+                        max_match_len = max_match_len_tmp;
+                }
+                /* keep only the characters common in all completions */
+                output[max_match_len] = 0;
         }
         
@@ -294 +347 @@
                         if (beg == 0) {
                                 /* Command completion */
-                                found = cmdtab_compl(tmp, STR_BOUNDS(MAX_CMDLINE));
+                                found = cmdtab_compl(tmp, STR_BOUNDS(MAX_CMDLINE), indev);
                         } else {
                                 /* Symbol completion */
-                                found = symtab_compl(tmp, STR_BOUNDS(MAX_CMDLINE));
+                                found = symtab_compl(tmp, STR_BOUNDS(MAX_CMDLINE), indev);
                         }
                         
                         if (found == 0)
                                 continue;
-                        
-                        if (found > 1) {
-                                /* No unique hint, list was printed */
-                                printf("%s> ", prompt);
-                                printf("%ls", current);
-                                print_cc('\b', wstr_length(current) - position);
-                                continue;
-                        }
-                        
-                        /* We have a hint */
-                        
+
+                        /* We have hints, may be many. In case of more than one hint,
+                           tmp will contain the common prefix. */
                         size_t off = 0;
                         size_t i = 0;
@@ -320 +365 @@
                                 i++;
                         }
+                        
+                        if (found > 1) {
+                                /* No unique hint, list was printed */
+                                printf("%s> ", prompt);
+                                printf("%ls", current);
+                                position += str_length(tmp);
+                                print_cc('\b', wstr_length(current) - position);
+                                continue;
+                        }
+                        
+                        /* We have a hint */
                         
                         printf("%ls", current + position);
@@ -540 +596 @@
 /** Parse command line.
  *
- * @param cmdline Command line as read from input device. 
+ * @param cmdline Command line as read from input device.
  * @param size    Size (in bytes) of the string.
  *

kernel/generic/src/debug/symtab.c

@@ -209 +209 @@
  *
  */
-int symtab_compl(char *input, size_t size)
+int symtab_compl(char *input, size_t size, indev_t * indev)
 {
 #ifdef CONFIG_SYMTAB
@@ -226 +226 @@
         const char *hint;
         char output[MAX_SYMBOL_NAME];
+        /* Maximum Match Length : Length of longest matching common substring in
+           case more than one match is found */
+        size_t max_match_len = size;
+        size_t max_match_len_tmp = size;
+        size_t input_len = str_length(input);
+        char *sym_name;
+        char display = 'y';
+        size_t hints_to_show = MAX_TAB_HINTS - 1;
+        size_t total_hints_shown = 0;
+        char continue_showing_hints = 'y';
         
         output[0] = 0;
+
+        while ((hint = symtab_search_one(name, &pos))) {
+                ++pos;
+        }
+
+        pos = 0;
         
         while ((hint = symtab_search_one(name, &pos))) {
@@ -237 +253 @@
         }
         
+        /* If possible completions are more than MAX_TAB_HINTS, ask user whether to display them or not. */
+        if (found > MAX_TAB_HINTS) {
+                printf("\nDisplay all %zu possibilities? (y or n)", found);
+                do {
+                        display = indev_pop_character(indev);
+                } while (display != 'y' && display != 'n' && display != 'Y' && display != 'N');
+        }
+        
         if ((found > 1) && (str_length(output) != 0)) {
                 printf("\n");
                 pos = 0;
                 while (symtab_search_one(name, &pos)) {
-                        printf("%s\n", symbol_table[pos].symbol_name);
+                        sym_name = symbol_table[pos].symbol_name;
                         pos++;
+
+                        if (display == 'y' || display == 'Y') { /* We are still showing hints */
+                                printf("%s\n", sym_name);
+                                --hints_to_show;
+                                ++total_hints_shown;
+
+                                if (hints_to_show == 0 && total_hints_shown != found) { /* Time to ask user to continue */
+                                        printf("--More--");
+                                        do {
+                                                continue_showing_hints = indev_pop_character(indev);
+                                                if (continue_showing_hints == 'y' || continue_showing_hints == 'Y'
+                                                                || continue_showing_hints == ' ') {
+                                                        hints_to_show = MAX_TAB_HINTS - 1; /* Display a full page again */
+                                                        break;
+                                                }
+
+                                                if (continue_showing_hints == 'n' || continue_showing_hints == 'N'
+                                                                || continue_showing_hints == 'q' || continue_showing_hints == 'Q') {
+                                                        display = 'n'; /* Stop displaying hints */
+                                                        break;
+                                                }
+
+                                                if (continue_showing_hints == '\n') {
+                                                        hints_to_show = 1; /* Show one more hint */
+                                                        break;
+                                                }
+                                        } while (1);
+
+                                        printf("\r         \r"); /* Delete the --More-- option */
+                                }
+                        }
+
+                        for(max_match_len_tmp = 0; output[max_match_len_tmp] == sym_name[input_len + max_match_len_tmp]
+                                        && max_match_len_tmp < max_match_len; ++max_match_len_tmp);
+                        max_match_len = max_match_len_tmp;
                 }
+                /* keep only the characters common in all completions */
+                output[max_match_len] = 0;
         }