hooks to enable experimentation with scripting language support. Reduces patch size...

[openocd.git] / src / helper / command.c

/***************************************************************************
 *   Copyright (C) 2005 by Dominic Rath                                    *
 *   Dominic.Rath@gmx.de                                                   *
 *                                                                         *
 *   part of this file is taken from libcli (libcli.sourceforge.net)       *
 *   Copyright (C) David Parrish (david@dparrish.com)                      *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "replacements.h"

#include "command.h"

#include "log.h"
#include "time_support.h"

#include <stdlib.h>
#include <string.h>
#include <ctype.h>
#include <stdarg.h>
#include <stdio.h>
#include <unistd.h>

int fast_and_dangerous = 0;

void command_print_help_line(command_context_t* context, struct command_s *command, int indent);

int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
int handle_time_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);

int build_unique_lengths(command_context_t *context, command_t *commands)
{
        command_t *c, *p;

        /* iterate through all commands */
        for (c = commands; c; c = c->next)
        {
                /* find out how many characters are required to uniquely identify a command */
                for (c->unique_len = 1; c->unique_len <= strlen(c->name); c->unique_len++)
                {
                        int foundmatch = 0;
                        
                        /* for every command, see if the current length is enough */
                        for (p = commands; p; p = p->next)
                        {
                                /* ignore the command itself */
                                if (c == p)
                                        continue;
                                
                                /* compare commands up to the current length */
                                if (strncmp(p->name, c->name, c->unique_len) == 0)
                                        foundmatch++;
                        }
                        
                        /* when none of the commands matched, we've found the minimum length required */
                        if (!foundmatch)
                                break;
                }
                
                /* if the current command has children, build the unique lengths for them */
                if (c->children)
                        build_unique_lengths(context, c->children);
        }
        
        return ERROR_OK;
}

/* Avoid evaluating this each time we add a command. Reduces overhead from O(n^2) to O(n). 
 * Makes a difference on ARM7 types machines and is not observable on GHz machines.
 */
static int unique_length_dirty = 1; 

command_t* register_command(command_context_t *context, command_t *parent, char *name, int (*handler)(struct command_context_s *context, char* name, char** args, int argc), enum command_mode mode, char *help)
{
        command_t *c, *p;
        unique_length_dirty = 1;
        
        if (!context || !name)
                return NULL;
                                
        c = malloc(sizeof(command_t));
        
        c->name = strdup(name);
        c->parent = parent;
        c->children = NULL;
        c->handler = handler;
        c->mode = mode;
        if (help)
                c->help = strdup(help);
        else
                c->help = NULL;
        c->unique_len = 0;
        c->next = NULL;
        
        /* place command in tree */
        if (parent)
        {
                if (parent->children)
                {
                        /* find last child */
                        for (p = parent->children; p && p->next; p = p->next);
                        if (p)
                                p->next = c;
                }
                else
                {
                        parent->children = c;
                }
        }
        else
        {
                if (context->commands)
                {
                        /* find last command */
                        for (p = context->commands; p && p->next; p = p->next);
                        if (p)
                                p->next = c;
                }
                else
                {
                        context->commands = c;
                }
        }
        
        return c;
}

int unregister_all_commands(command_context_t *context)
{
        command_t *c, *c2;
        
        unique_length_dirty = 1;
        
        if (context == NULL)
                return ERROR_OK;
        
        
        while(NULL != context->commands)
        {
                c = context->commands;
                
                while(NULL != c->children)
                {
                        c2 = c->children;
                        c->children = c->children->next;
                        free(c2->name);
                        c2->name = NULL;
                        free(c2->help);
                        c2->help = NULL;
                        free(c2);
                        c2 = NULL;
                }
                
                context->commands = context->commands->next;
                
                free(c->name);
                c->name = NULL;
                free(c->help);
                c->help = NULL;
                free(c);
                c = NULL;               
        }
        
        return ERROR_OK;
}

int unregister_command(command_context_t *context, char *name)
{
        command_t *c, *p = NULL, *c2;
        
        unique_length_dirty = 1;
        
        if ((!context) || (!name))
                return ERROR_INVALID_ARGUMENTS;
        
        /* find command */
        for (c = context->commands; c; c = c->next)
        {
                if (strcmp(name, c->name) == 0)
                {
                        /* unlink command */
                        if (p)
                        {
                                p->next = c->next;
                        }
                        else
                        {
                                context->commands = c->next;
                        }
                        
                        /* unregister children */
                        if (c->children)
                        {
                                for (c2 = c->children; c2; c2 = c2->next)
                                {
                                        free(c2->name);
                                        if (c2->help)
                                                free(c2->help);
                                        free(c2);
                                }
                        }
                        
                        /* delete command */
                        free(c->name);
                        if (c->help)
                                free(c->help);
                        free(c);
                }
                
                /* remember the last command for unlinking */
                p = c;
        }
        
        return ERROR_OK;
}

int parse_line(char *line, char *words[], int max_words)
{
        int nwords = 0;
        char *p = line;
        char *word_start = line;
        int inquote = 0;

        while (nwords < max_words - 1)
        {
                /* check if we reached
                 * a terminating NUL
                 * a matching closing quote character " or '
                 * we're inside a word but not a quote, and the current character is whitespace
                 */
                if (!*p || *p == inquote || (word_start && !inquote && isspace(*p)))
                {
                        /* we're inside a word or quote, and reached its end*/
                        if (word_start)
                        {
                                int len;
                                char *word_end=p;
                                
                                /* This will handle extra whitespace within quotes */
                                while (isspace(*word_start)&&(word_start<word_end))
                                        word_start++;
                                while (isspace(*(word_end-1))&&(word_start<word_end))
                                        word_end--;
                                len = word_end - word_start;
                                
                                if (len>0)
                                {
                                        /* copy the word */
                                        memcpy(words[nwords] = malloc(len + 1), word_start, len);
                                        /* add terminating NUL */
                                        words[nwords++][len] = 0;
                                }
                        }
                        /* we're done parsing the line */
                        if (!*p)
                                break;

                        /* skip over trailing quote or whitespace*/
                        if (inquote || isspace(*p))
                                p++;
                        while (isspace(*p))
                                p++;
                        
                        inquote = 0;
                        word_start = 0;
                }
                else if (*p == '"' || *p == '\'')
                {
                        /* we've reached the beginning of a quote */
                        inquote = *p++;
                        word_start = p;
                }
                else
                {
                        /* we've reached the beginning of a new word */
                        if (!word_start)
                                word_start = p;
                        
                        /* normal character, skip */
                        p++;
                }
        }
        
        return nwords;
}

void command_print_n(command_context_t *context, char *format, ...)
{
        char *string;
        
        va_list ap;
        va_start(ap, format);

        string = alloc_vprintf(format, ap);
        if (string != NULL)
        {
                context->output_handler(context, string);
                free(string);
        }

        va_end(ap);
}

void command_print(command_context_t *context, char *format, ...)
{
        char *string;

        va_list ap;
        va_start(ap, format);

        string = alloc_vprintf(format, ap);
        if (string != NULL)
        {
                strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
                context->output_handler(context, string);
                free(string);
        }

        va_end(ap);
}

command_t *find_command(command_context_t *context, command_t *commands, char *words[], int num_words, int start_word, int *new_start_word)
{
        command_t *c;
        
        if (unique_length_dirty)
        {
                unique_length_dirty = 0;
                /* update unique lengths */
                build_unique_lengths(context, context->commands);
        }
        
        for (c = commands; c; c = c->next)
        {
                if (strncasecmp(c->name, words[start_word], c->unique_len))
                        continue;

                if (strncasecmp(c->name, words[start_word], strlen(words[start_word])))
                        continue;
                
                if ((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode) )
                {
                        if (!c->children)
                        {
                                if (!c->handler)
                                {
                                        return NULL;
                                }
                                else
                                {
                                        *new_start_word=start_word;
                                        return c;
                                }
                        }
                        else
                        {
                                if (start_word == num_words - 1)
                                {
                                        return NULL;
                                }
                                return find_command(context, c->children, words, num_words, start_word + 1, new_start_word);
                        }
                }
        }
        return NULL;
}

int find_and_run_command(command_context_t *context, command_t *commands, char *words[], int num_words)
{
        int start_word=0;
        command_t *c;
        c=find_command(context, commands, words, num_words, start_word, &start_word);
        if (c==NULL)
        {
                command_print(context, "Command %s not found", words[start_word]);
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
        
        int retval = c->handler(context, c->name, words + start_word + 1, num_words - start_word - 1);
        if (retval == ERROR_COMMAND_SYNTAX_ERROR)
        {
                command_print(context, "Syntax error:");
                command_print_help_line(context, c, 0);
        }
        else if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
        {
                /* just fall through for a shutdown request */
        }
        else if (retval != ERROR_OK)
        {
                /* we do not print out an error message because the command *should*
                 * have printed out an error
                 */
                LOG_DEBUG("Command failed with error code %d", retval); 
        }
        return retval; 
}

int command_run_line_internal_op(command_context_t *context, char *line, int run)
{
        LOG_USER_N("%s", ""); /* Keep GDB connection alive*/ 
        
        int nwords;
        char *words[128] = {0};
        int retval;
        int i;

        /* skip preceding whitespace */
        while (isspace(*line))
                line++;
        
        /* empty line, ignore */
        if (!*line)
                return ERROR_OK;
        
        /* ignore comments */
        if (*line && (line[0] == '#'))
                return ERROR_OK;
        
        LOG_DEBUG("%s", line);

        nwords = parse_line(line, words, sizeof(words) / sizeof(words[0]));
        
        if (nwords > 0)
                if (run)
                {
                        retval = find_and_run_command(context, context->commands, words, nwords);
                } else
                {
                        int t;
                        return (find_command(context, context->commands, words, nwords, 0, &t)!=NULL)?ERROR_OK:ERROR_FAIL;
                }
        else
                return ERROR_INVALID_ARGUMENTS;
        
        for (i = 0; i < nwords; i++)
                free(words[i]);
        
        return retval;
}

int command_run_line_internal(command_context_t *context, char *line)
{
        return command_run_line_internal_op(context, line, 1);
}

int command_run_line(command_context_t *context, char *line)
{
        int retval;
        if ((!context) || (!line))
                return ERROR_INVALID_ARGUMENTS;

        if (command_run_line_internal_op(context, line, 0)!=ERROR_OK)
        {
                /* If we can't find a command, then try the interpreter. 
                 * If there is no interpreter implemented, then this will
                 * simply print a syntax error.
                 * 
                 * These hooks were left in to reduce patch size for 
                 * wip to add scripting language.
                 */
                return jim_command(context, line);
        }

        return command_run_line_internal(context, line);
}

int command_run_file(command_context_t *context, FILE *file, enum command_mode mode)
{
        int retval = ERROR_OK;
        int old_command_mode;
        char *buffer=malloc(4096);
        if (buffer==NULL)
        {
                return ERROR_INVALID_ARGUMENTS;
        }
        
        old_command_mode = context->mode;
        context->mode = mode;
        
        while (fgets(buffer, 4096, file))
        {
                char *p;
                char *cmd, *end;
                
                /* stop processing line after a comment (#, !) or a LF, CR were encountered */
                if ((p = strpbrk(buffer, "#!\r\n")))
                        *p = 0;

                /* skip over leading whitespace */
                cmd = buffer;
                while (isspace(*cmd))
                        cmd++;

                /* empty (all whitespace) line? */
                if (!*cmd)
                        continue;
                
                /* search the end of the current line, ignore trailing whitespace */
                for (p = end = cmd; *p; p++)
                        if (!isspace(*p))
                                end = p;
                
                /* terminate end */
                *++end = 0;
                if (strcasecmp(cmd, "quit") == 0)
                        break;

                /* run line */
                if ((retval = command_run_line(context, cmd)) == ERROR_COMMAND_CLOSE_CONNECTION)
                        break;
        }
        
        context->mode = old_command_mode;

        
        free(buffer);
        
        return retval;
}

void command_print_help_line(command_context_t* context, struct command_s *command, int indent)
{
        command_t *c;
        char *indent_text=malloc(indent + 2);
        
        char *help = "no help available";
        char name_buf[64];
        
        if (indent)
        {
            indent_text[0] = ' ';
            memset(indent_text + 1, '-', indent);
            indent_text[indent + 1] = 0;
        }
        
        if (command->help)
                help = command->help;
                
        snprintf(name_buf, 64, command->name);

        if (indent)
            strncat(name_buf, indent_text, 64);

        command_print(context, "%20s\t%s", name_buf, help, indent);
        
        if (command->children)
        {
                for (c = command->children; c; c = c->next)
                {
                        command_print_help_line(context, c, indent + 1);
                }
        }
        free(indent_text);
}

int command_print_help_match(command_context_t* context, command_t* c_first, char* name, char** args, int argc)
{
        command_t * c;

        for (c = c_first; c; c = c->next)
        {
                if (argc > 0)
                {
                        if (strncasecmp(c->name, args[0], c->unique_len))
                                continue;

                        if (strncasecmp(c->name, args[0], strlen(args[0])))
                                continue;

                        if (argc > 1)
                        {
                                command_print_help_match(context, c->children, name, args + 1, argc - 1);
                                continue;
                        }
                }

                command_print_help_line(context, c, 0);
        }
        
        return ERROR_OK;
}

int command_print_help(command_context_t* context, char* name, char** args, int argc)
{
    return command_print_help_match(context, context->commands, name, args, argc);
}

void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, char* line), void *priv)
{
        context->output_handler = output_handler;
        context->output_handler_priv = priv;
}

command_context_t* copy_command_context(command_context_t* context)
{
        command_context_t* copy_context = malloc(sizeof(command_context_t));

        *copy_context = *context;
        
        return copy_context;
}

int command_done(command_context_t *context)
{
        free(context);
        context = NULL;
        
        return ERROR_OK;
}

command_context_t* command_init()
{
        command_context_t* context = malloc(sizeof(command_context_t));
        
        context->mode = COMMAND_EXEC;
        context->commands = NULL;
        context->current_target = 0;
        context->output_handler = NULL;
        context->output_handler_priv = NULL;
        
        register_command(context, NULL, "help", command_print_help,
                                         COMMAND_EXEC, "display this help");
        
        register_command(context, NULL, "sleep", handle_sleep_command,
                                         COMMAND_ANY, "sleep for <n> milliseconds");
        
        register_command(context, NULL, "time", handle_time_command,
                                         COMMAND_ANY, "time <cmd + args> - execute <cmd + args> and print time it took");
        
        register_command(context, NULL, "fast", handle_fast_command,
                                         COMMAND_ANY, "fast <enable/disable> - place at beginning of config files. Sets defaults to fast and dangerous.");
        
        return context;
}

/* sleep command sleeps for <n> miliseconds
 * this is useful in target startup scripts
 */
int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
{
        unsigned long duration = 0;
        
        if (argc == 1)
        {
                duration = strtoul(args[0], NULL, 0);
                usleep(duration * 1000);
        }

        return ERROR_OK;
}

int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
{
        if (argc!=1)
                return ERROR_COMMAND_SYNTAX_ERROR;
        
        fast_and_dangerous = strcmp("enable", args[0])==0;
        
        return ERROR_OK;
}


int handle_time_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
{
        duration_t duration;
        char *duration_text;
        int retval;
        float t;
        
        if (argc<1)
                return ERROR_COMMAND_SYNTAX_ERROR;
        
        duration_start_measure(&duration);
        
        retval = find_and_run_command(cmd_ctx, cmd_ctx->commands, args, argc);
        
        duration_stop_measure(&duration, &duration_text);
        
        t=duration.duration.tv_sec;
        t+=((float)duration.duration.tv_usec / 1000000.0);
        command_print(cmd_ctx, "%s took %fs", args[0], t);
        
        free(duration_text);

        return retval;
}