2008-12-18 Sebastian Huber <sebastian.huber@embedded-brains.de>

	* libmisc/serdbg/termios_printk.c, libmisc/serdbg/termios_printk.h:
	Fixed incompatible return value.

	* libmisc/cpuuse/cpuusagereport.c: Changed output format.

	* libmisc/Makefile.am, libmisc/monitor/mon-editor.c: New file.

	* libmisc/capture/capture-cli.c, libmisc/monitor/mon-command.c,
	libmisc/monitor/mon-monitor.c, libmisc/monitor/mon-object.c,
	libmisc/monitor/mon-prmisc.c, libmisc/monitor/mon-symbols.c,
	libmisc/monitor/monitor.h, libmisc/shell/cat_file.c,
	libmisc/shell/cmds.c, libmisc/shell/internal.h,
	libmisc/shell/main_help.c, libmisc/shell/shell.c,
	libmisc/shell/shell.h, libmisc/shell/shell_cmdset.c,
	libmisc/shell/shell_getchar.c, libmisc/shell/str2int.c: Various global
	data is now read only.  Added 'const' qualifier to many pointer
	parameters.  It is no longer possible to remove monitor commands.
	Moved monitor line editor into a separate file to avoid unnecessary
	dependencies.

1 files changed, 45 insertions, 565 deletions

diff --git a/cpukit/libmisc/monitor/mon-command.c b/cpukit/libmisc/monitor/mon-command.c
index 3d2732121a..e5ee6aee53 100644
--- a/cpukit/libmisc/monitor/mon-command.c
+++ b/cpukit/libmisc/monitor/mon-command.c
@@ -1,29 +1,12 @@
-/*
- * Command parsing routines for RTEMS monitor
- *
- * TODO:
+/**
+ * @file
  *
- *  $Id$
+ * @brief Command support routines for RTEMS monitor.
  */
 
-#ifdef HAVE_CONFIG_H
-#include "config.h"
-#endif
-
-#include <rtems.h>
-
-#include <rtems/monitor.h>
-
-#include <stdio.h>
-#include <string.h>
-#include <stdlib.h>
-#include <inttypes.h>
-
-#ifndef MONITOR_PROMPT
-#define MONITOR_PROMPT "rtems"          /* will have '> ' appended */
-#endif
-
 /*
+ * $Id$
+ *
  * 2001-01-30 KJO (vac4050@cae597.rsc.raytheon.com):
  *  Fixed rtems_monitor_command_lookup() to accept partial
  *  commands to uniqeness.  Added support for setting
@@ -35,554 +18,58 @@
  * covered by GPL, only the RTEMS license.
  */
 
-/*
- * Some key labels to define special keys.
- */
-
-#define KEYS_EXTENDED    (0x8000)
-#define KEYS_NORMAL_MASK (0x00ff)
-#define KEYS_INS         (0)
-#define KEYS_DEL         (1)
-#define KEYS_UARROW      (2)
-#define KEYS_DARROW      (3)
-#define KEYS_LARROW      (4)
-#define KEYS_RARROW      (5)
-#define KEYS_HOME        (6)
-#define KEYS_END         (7)
-#define KEYS_F1          (8)
-#define KEYS_F2          (9)
-#define KEYS_F3          (10)
-#define KEYS_F4          (11)
-#define KEYS_F5          (12)
-#define KEYS_F6          (13)
-#define KEYS_F7          (14)
-#define KEYS_F8          (15)
-#define KEYS_F9          (16)
-#define KEYS_F10         (17)
-
-#define RTEMS_COMMAND_BUFFER_SIZE (75)
-
-static char monitor_prompt[32];
-#ifndef RTEMS_UNIX
-static char buffer[RTEMS_COMMAND_BUFFER_SIZE];
-static int  pos;
-static int  logged_in;
-#endif
-/*
- * History data.
- */
-
-#define RTEMS_COMMAND_HISTORIES (20)
-
-#ifndef RTEMS_UNIX
-static char history_buffer[RTEMS_COMMAND_HISTORIES][RTEMS_COMMAND_BUFFER_SIZE];
-static int  history_pos[RTEMS_COMMAND_HISTORIES];
-static int  history;
-static int  history_next;
-#endif
-
-/*
- * Translation tables. Not sure if this is the best way to
- * handle this, how-ever I wish to avoid the overhead of
- * including a more complete and standard environment such
- * as ncurses.
- */
-
-struct translation_table
-{
-  char                     expecting;
-  struct translation_table *branch;
-  unsigned int             key;
-};
-
-#ifndef RTEMS_UNIX
-static struct translation_table trans_two[] =
-{
-  { '~', 0, KEYS_INS },
-  { 0,   0, 0 }
-};
-
-static struct translation_table trans_three[] =
-{
-  { '~', 0, KEYS_DEL },
-  { 0,   0, 0 }
-};
-
-static struct translation_table trans_tab_csi[] =
-{
-  { '2', trans_two,   0 },
-  { '3', trans_three, 0 },
-  { 'A', 0,           KEYS_UARROW },
-  { 'B', 0,           KEYS_DARROW },
-  { 'D', 0,           KEYS_LARROW },
-  { 'C', 0,           KEYS_RARROW },
-  { 'F', 0,           KEYS_END },
-  { 'H', 0,           KEYS_HOME },
-  { 0,   0,           0 }
-};
-
-static struct translation_table trans_tab_O[] =
-{
-  { '1', 0, KEYS_F1 },
-  { '2', 0, KEYS_F2 },
-  { '3', 0, KEYS_F3 },
-  { '4', 0, KEYS_F4 },
-  { '5', 0, KEYS_F5 },
-  { '6', 0, KEYS_F6 },
-  { '7', 0, KEYS_F7 },
-  { '8', 0, KEYS_F8 },
-  { '9', 0, KEYS_F9 },
-  { ':', 0, KEYS_F10 },
-  { 'P', 0, KEYS_F1 },
-  { 'Q', 0, KEYS_F2 },
-  { 'R', 0, KEYS_F3 },
-  { 'S', 0, KEYS_F4 },
-  { 'T', 0, KEYS_F5 },
-  { 'U', 0, KEYS_F6 },
-  { 'V', 0, KEYS_F7 },
-  { 'W', 0, KEYS_F8 },
-  { 'X', 0, KEYS_F9 },
-  { 'Y', 0, KEYS_F10 },
-  { 0,   0, 0 }
-};
-
-static struct translation_table trans_tab[] =
-{
-  { '[', trans_tab_csi, 0 },    /* CSI command sequences */
-  { 'O', trans_tab_O,   0 },    /* O are the fuction keys */
-  { 0,   0,             0 }
-};
-#endif
-
-/*
- * Perform a basic translation for some ANSI/VT100 key codes.
- * This code could do with a timeout on the ESC as it is
- * now lost from the input stream. It is not* used by the
- * line editor below so considiered not worth the effort.
- */
-
-#ifndef RTEMS_UNIX
-static unsigned int
-rtems_monitor_getchar (void)
-{
-  struct translation_table *translation = 0;
-  for (;;)
-  {
-    char c = getchar ();
-    if (c == 27)
-      translation = trans_tab;
-    else
-    {
-      /*
-       * If no translation happing just pass through
-       * and return the key.
-       */
-      if (translation)
-      {
-        /*
-         * Scan the current table for the key, and if found
-         * see if this key is a fork. If so follow it and
-         * wait else return the extended key.
-         */
-        int index    = 0;
-        int branched = 0;
-        while ((translation[index].expecting != '\0') ||
-               (translation[index].key != '\0'))
-        {
-          if (translation[index].expecting == c)
-          {
-            /*
-             * A branch is take if more keys are to come.
-             */
-            if (translation[index].branch == 0)
-              return KEYS_EXTENDED | translation[index].key;
-            else
-            {
-              translation = translation[index].branch;
-              branched    = 1;
-              break;
-            }
-          }
-          index++;
-        }
-        /*
-         * Who knows what these keys are, just drop them.
-         */
-        if (!branched)
-          translation = 0;
-      }
-      else
-        return c;
-    }
-  }
-}
-#endif
-
-#ifndef RTEMS_UNIX
-/*
- * The line editor with history.
- */
-
-static int
-rtems_monitor_line_editor (
-    char *command
-)
-{
-  int repeating = 0;
-
-  memset (buffer, 0, RTEMS_COMMAND_BUFFER_SIZE);
-  history = history_next;
-  pos     = 0;
-
-  if (!logged_in)
-    fprintf(stdout,"\nMonitor ready, press enter to login.\n\n");
-  else
-    fprintf(stdout,"%s $ ", monitor_prompt);
-
-  while (1)
-  {
-    unsigned int extended_key;
-    char         c;
-
-    fflush (stdout);
-
-    extended_key = rtems_monitor_getchar ();
-    c = extended_key & KEYS_NORMAL_MASK;
-    
-    /*
-     * Make the extended_key usable as a boolean.
-     */
-    extended_key &= ~KEYS_NORMAL_MASK;
-
-    if (!extended_key && !logged_in)
-    {
-      if (c == '\n')
-      {
-        logged_in = 1;
-        /*
-         * The prompt has changed from `>' to `$' to help know
-         * which version of the monitor code people are using.
-         */
-        fprintf(stdout,"%s $ ", monitor_prompt);
-      }
-    }
-    else
-    {
-      if (extended_key)
-      {
-        switch (c)
-        {
-          case KEYS_END:
-            fprintf(stdout,buffer + pos);
-            pos = (int) strlen (buffer);
-            break;
-
-          case KEYS_HOME:
-            fprintf(stdout,"\r%s $ ", monitor_prompt);
-            pos = 0;
-            break;
-
-          case KEYS_LARROW:
-            if (pos > 0)
-            {
-              pos--;
-              putchar ('\b');
-            }
-            break;
-
-          case KEYS_RARROW:
-            if ((pos < RTEMS_COMMAND_BUFFER_SIZE) && (buffer[pos] != '\0'))
-            {
-              putchar (buffer[pos]);
-              pos++;
-            }
-            break;
-
-          case KEYS_UARROW:
-            /*
-             * If we are moving up the histories then we need to save the working
-             * buffer.
-             */
-            if (history)
-            {
-              int end;
-              int bs;
-              if (history == history_next)
-              {
-                memcpy (history_buffer[history_next], buffer,
-                        RTEMS_COMMAND_BUFFER_SIZE);
-                history_pos[history_next] = pos;
-              }
-              history--;
-              memcpy (buffer, history_buffer[history],
-                      RTEMS_COMMAND_BUFFER_SIZE);
-              pos = history_pos[history];
-              fprintf(stdout,"\r%*c", RTEMS_COMMAND_BUFFER_SIZE, ' ');
-              fprintf(stdout,"\r%s $ %s", monitor_prompt, buffer);
-              end = (int) strlen (buffer);
-              for (bs = 0; bs < (end - pos); bs++)
-                putchar ('\b');
-            }
-            break;
-
-          case KEYS_DARROW:
-            if (history < history_next)
-            {
-              int end;
-              int bs;
-              history++;
-              memcpy (buffer, history_buffer[history],
-                      RTEMS_COMMAND_BUFFER_SIZE);
-              pos = history_pos[history];
-              fprintf(stdout,"\r%*c", RTEMS_COMMAND_BUFFER_SIZE, ' ');
-              fprintf(stdout,"\r%s $ %s", monitor_prompt, buffer);
-              end = (int) strlen (buffer);
-              for (bs = 0; bs < (end - pos); bs++)
-                putchar ('\b');
-            }
-            break;
-
-          case KEYS_DEL:
-            if (buffer[pos] != '\0')
-            {
-              int end;
-              int bs;
-              strcpy (&buffer[pos], &buffer[pos + 1]);
-              fprintf(stdout,"\r%s $ %s", monitor_prompt, buffer);
-              end = (int) strlen (buffer);
-              for (bs = 0; bs < (end - pos); bs++)
-                putchar ('\b');
-            }
-            break;
-        }
-      }
-      else
-      {
-        switch (c)
-        {
-          case '\b':
-          case '\x7e':
-          case '\x7f':
-            if (pos > 0)
-            {
-              int bs;
-              pos--;
-              strcpy (buffer + pos, buffer + pos + 1);
-              fprintf(stdout,"\b%s \b", buffer + pos);
-              for (bs = 0; bs < ((int) strlen (buffer) - pos); bs++)
-                putchar ('\b');
-            }
-            break;
-
-          case '\n':
-            /*
-             * Process the command.
-             */
-            fprintf(stdout,"\n");
-            repeating = 1;
-            /*
-             * Only process the history if we have a command and
-             *a history.
-             */
-            if (strlen (buffer))
-            {
-              if (history_next && (history == history_next))
-              {
-                /*
-                 * Do not place the last command into the history
-                 *if the same.
-                 */
-                if (strcmp (history_buffer[history_next - 1], buffer))
-                  repeating = 0;
-              }
-              else
-                repeating = 0;
-            }
-            if (!repeating)
-            {
-              memcpy (history_buffer[history_next], buffer,
-                      RTEMS_COMMAND_BUFFER_SIZE);
-              history_pos[history_next] = pos;
-              if (history_next < (RTEMS_COMMAND_HISTORIES - 1))
-                history_next++;
-              else
-              {
-                memmove (history_buffer[0], history_buffer[1],
-                         RTEMS_COMMAND_BUFFER_SIZE * (RTEMS_COMMAND_HISTORIES - 1));
-                memmove (&history_pos[0], &history_pos[1],
-                         sizeof (history_pos[0]) * (RTEMS_COMMAND_HISTORIES - 1));
-              }
-            }
-            else
-            {
-#ifdef ENABLE_ENTER_REPEATS
-              if (history_next)
-                memcpy (buffer, history_buffer[history_next - 1],
-                        RTEMS_COMMAND_BUFFER_SIZE);
-#endif
-            }
-            memmove (command, buffer, RTEMS_COMMAND_BUFFER_SIZE);
-            return repeating;
-            break;
-
-          default:
-            if ((pos < (RTEMS_COMMAND_BUFFER_SIZE - 1)) &&
-                (c >= ' ') && (c <= 'z'))
-            {
-              int end;
-              end = strlen (buffer);
-              if ((pos < end) && (end < RTEMS_COMMAND_BUFFER_SIZE))
-              {
-                int ch, bs;
-                for (ch = end + 1; ch > pos; ch--)
-                  buffer[ch] = buffer[ch - 1];
-                fprintf(stdout,buffer + pos);
-                for (bs = 0; bs < (end - pos + 1); bs++)
-                  putchar ('\b');
-              }
-              buffer[pos++] = c;
-              if (pos > end)
-                buffer[pos] = '\0';
-              putchar (c);
-            }
-            break;
-        }
-      }
-    }
-  }
-}
-#endif
-
-/*
- * make_argv(cp): token-count
- *  Break up the command line in 'cp' into global argv[] and argc (return
- *  value).
- */
-
-int
-rtems_monitor_make_argv(
-    char *cp,
-    int  *argc_p,
-    char **argv)
-{
-  int argc = 0;
-
-  while ((cp = strtok(cp, " \t\n\r")))
-  {
-    argv[argc++] = cp;
-    cp = (char *) NULL;
-  }
-  argv[argc] = (char *) NULL;      /* end of argv */
-
-  return *argc_p = argc;
-}
-
-
-/*
- * Read and break up a monitor command
- *
- * We have to loop on the gets call, since it will return NULL under UNIX
- *  RTEMS when we get a signal (eg: SIGALRM).
- */
-
-int
-rtems_monitor_command_read(char *command,
-                           int  *argc,
-                           char **argv)
-{
-	char *env_prompt;
-
-	env_prompt = getenv("RTEMS_MONITOR_PROMPT");
+#include <string.h>
+#include <stdio.h>
 
-  /*
-   * put node number in the prompt if we are multiprocessing
-   */
-#if defined(RTEMS_MULTIPROCESSING)
-  if (!rtems_configuration_get_user_multiprocessing_table ())
-    sprintf (monitor_prompt, "%s",
-             (env_prompt == NULL) ? MONITOR_PROMPT: env_prompt);
-  else /* .... */
-#endif
-  if (rtems_monitor_default_node != rtems_monitor_node)
-    sprintf (monitor_prompt, "%" PRId32 "-%s-%" PRId32 "", rtems_monitor_node,
-             (env_prompt == NULL) ? MONITOR_PROMPT : env_prompt,
-             rtems_monitor_default_node);
-  else
-    sprintf (monitor_prompt, "%" PRId32 "-%s", rtems_monitor_node,
-             (env_prompt == NULL) ? MONITOR_PROMPT : env_prompt);
-
-#if defined(RTEMS_UNIX)
-  /* RTEMS on unix gets so many interrupt system calls this is hosed */
-  fprintf(stdout,"%s> ", monitor_prompt);
-  fflush (stdout);
-  while (gets(command) == (char *) 0)
-    ;
-#else
-  rtems_monitor_line_editor (command);
-#endif
-
-  return rtems_monitor_make_argv (command, argc, argv);
-}
+#include <rtems.h>
+#include <rtems/monitor.h>
 
 /*
  * Look up a command in a command table
  *
  */
 
-rtems_monitor_command_entry_t *
-rtems_monitor_command_lookup(
-    rtems_monitor_command_entry_t *table,
-    int                            argc,
-    char                          **argv
+const rtems_monitor_command_entry_t *rtems_monitor_command_lookup(
+  const rtems_monitor_command_entry_t *table,
+  const char *command_name
 )
 {
-  int command_length;
-  rtems_monitor_command_entry_t *found_it = NULL;
-
-  command_length = strlen (argv[0]);
+  const rtems_monitor_command_entry_t *found_it = NULL;
+  size_t command_length = 0;
 
-  if ((table == 0) || (argv[0] == 0))
-    return 0;
-
-  while (table)
-  {
-    if (table->command)
-    {
+  if (command_name == NULL) {
+    return NULL;
+  }
 
-      /*
-       * Check for ambiguity
-       */
-      if (!strncmp (table->command, argv[0], command_length))
-      {
-        if (found_it)
-        {
-          return 0;
-        }
+  command_length = strlen(command_name);
 
-        else
+  while (table != NULL) {
+    if (table->command != NULL) {
+      /* Check for ambiguity */
+      if (!strncmp(table->command, command_name, command_length)) {
+        if (found_it == NULL) {
           found_it = table;
+        } else {
+          return NULL;
+        }
       }
     }
     table = table->next;
   }
 
-  /*
-   * No ambiguity (the possible partial command was unique after all)
-   */
-  if (found_it)
-  {
-    if (found_it->command_function == 0)
-      return 0;
+  /* No ambiguity (the possible partial command was unique after all) */
 
-    return found_it;
+  /* Ignore empty commands */
+  if (found_it == NULL || found_it->command_function == NULL) {
+    return NULL;
   }
 
-  return 0;
+  return found_it;
 }
 
 static void
 rtems_monitor_show_help (
-  rtems_monitor_command_entry_t *help_cmd,
+  const rtems_monitor_command_entry_t *help_cmd,
   int                           max_cmd_len
 )
 {
@@ -675,26 +162,21 @@ rtems_monitor_show_help (
 
 void
 rtems_monitor_command_usage(
-  rtems_monitor_command_entry_t *table,
-  char                          *command_string
+  const rtems_monitor_command_entry_t *table,
+  const char                          *command_name
 )
 {
-  rtems_monitor_command_entry_t *command = table;
+  const rtems_monitor_command_entry_t *command = table;
   int                           max_cmd_len = 0;
 
   /* if first entry in table is a usage, then print it out */
 
-  if (command_string && (*command_string != '\0'))
+  if (command_name && (*command_name != '\0'))
   {
-    char *argv[2];
-
-    argv[0] = command_string;
-    argv[1] = 0;
-
-    command = rtems_monitor_command_lookup (table, 1, argv);
+    command = rtems_monitor_command_lookup (table, command_name);
 
     if (command)
-      rtems_monitor_show_help (command, strlen (command_string));
+      rtems_monitor_show_help (command, strlen (command_name));
     else
       fprintf(stdout,"Unrecognised command; try just 'help'\n");
     return;
@@ -730,18 +212,16 @@ rtems_monitor_command_usage(
 }
 
 
-void
-rtems_monitor_help_cmd(
-    int          argc,
-    char       **argv,
-    rtems_monitor_command_arg_t *command_arg,
-    bool         verbose
+void rtems_monitor_help_cmd(
+  int                                argc,
+  char                             **argv,
+  const rtems_monitor_command_arg_t *command_arg,
+  bool                               verbose
 )
 {
   int arg;
-  rtems_monitor_command_entry_t *command;
-
-  command = command_arg->monitor_command_entry;
+  const rtems_monitor_command_entry_t *command =
+    command_arg->monitor_command_entry;
 
   if (argc == 1)
     rtems_monitor_command_usage(command, 0);