pipes: add documentation for pipes

[openocd.git] / src / server / tcl_server.c

diff --git a/src/server/tcl_server.c b/src/server/tcl_server.c
index 082476861b5e3999f3216570fa9dfc1a942f3075..16710860614c708f21ddb24121aa9686cd90ef91 100644 (file)
--- a/src/server/tcl_server.c
+++ b/src/server/tcl_server.c
@@ -1,5 +1,6 @@
 /***************************************************************************
- *   Copyright (C) 2008                                                    *
+ *   Copyright (C) 2010 Øyvind Harboe                                      *
+ *   oyvind.harboe@zylin.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  *
@@ -34,7 +35,7 @@ struct tcl_connection {
        int tc_outerror; /* flag an output error */
 };
 
-static unsigned short tcl_port = 6666;
+static const char *tcl_port;
 
 /* handlers */
 static int tcl_new_connection(struct connection *connection);
@@ -56,7 +57,8 @@ int tcl_output(struct connection *connection, const void *data, ssize_t len)
        if (tclc->tc_outerror)
                return ERROR_SERVER_REMOTE_CLOSED;
 
-       wlen = write_socket(connection->fd, data, len);
+       wlen = connection_write(connection, data, len);
+
        if (wlen == len)
                return ERROR_OK;
 
@@ -81,16 +83,16 @@ static int tcl_new_connection(struct connection *connection)
 
 static int tcl_input(struct connection *connection)
 {
-       Jim_Interp *interp = (Jim_Interp *)connection->priv;
+       Jim_Interp *interp = (Jim_Interp *)connection->cmd_ctx->interp;
        int retval;
        int i;
        ssize_t rlen;
        const char *result;
        int reslen;
        struct tcl_connection *tclc;
-       char in[256];
+       unsigned char in[256];
 
-       rlen = read_socket(connection->fd, &in, sizeof(in));
+       rlen = connection_read(connection, &in, sizeof(in));
        if (rlen <= 0) {
                if (rlen < 0)
                        LOG_ERROR("error during read: %s", strerror(errno));
@@ -104,13 +106,6 @@ static int tcl_input(struct connection *connection)
        /* push as much data into the line as possible */
        for (i = 0; i < rlen; i++)
        {
-               if (!isprint(in[i]) && !isspace(in[i]))
-               {
-                       /* drop this line */
-                       tclc->tc_linedrop = 1;
-                       continue;
-               }
-
                /* buffer the data */
                tclc->tc_line[tclc->tc_lineoffset] = in[i];
                if (tclc->tc_lineoffset < TCL_MAX_LINE)
@@ -118,7 +113,11 @@ static int tcl_input(struct connection *connection)
                else
                        tclc->tc_linedrop = 1;
 
-               if (in[i] != '\n')
+               /* ctrl-z is end of command. When testing from telnet, just
+                * press ctrl-z a couple of times first to put telnet into the
+                * mode where it will send 0x1a in response to pressing ctrl-z
+                */
+               if (in[i] != '\x1a')
                        continue;
 
                /* process the line */
@@ -131,13 +130,15 @@ static int tcl_input(struct connection *connection)
                }
                else {
                        tclc->tc_line[tclc->tc_lineoffset-1] = '\0';
+                       LOG_DEBUG("Executing script:\n %s", tclc->tc_line);
                        retval = Jim_Eval_Named(interp, tclc->tc_line, "remote:connection",1);
+                       LOG_DEBUG("Result: %d\n %s", retval, Jim_GetString(Jim_GetResult(interp), &reslen));
                        result = Jim_GetString(Jim_GetResult(interp), &reslen);
                        retval = tcl_output(connection, result, reslen);
                        if (retval != ERROR_OK)
                                return retval;
-                       if (memchr(result, '\n', reslen) == NULL)
-                               tcl_output(connection, "\n", 1);
+                       /* Always output ctrl-d as end of line to allow multiline results */
+                       tcl_output(connection, "\x1a", 1);
                }
 
                tclc->tc_lineoffset = 0;
@@ -157,40 +158,39 @@ static int tcl_closed(struct connection *connection)
        return ERROR_OK;
 }
 
-int tcl_init(struct command_context *cmd_ctx)
+int tcl_init(void)
 {
-       int retval;
-
-       if (tcl_port == 0)
+       if (strcmp(tcl_port, "disabled") == 0)
        {
-               LOG_INFO("tcl port disabled");
+               LOG_INFO("tcl server disabled");
                return ERROR_OK;
        }
 
-       retval = add_service("tcl", CONNECTION_TCP, tcl_port, 1,
+       return add_service("tcl", tcl_port, 1,
                        &tcl_new_connection, &tcl_input,
-                       &tcl_closed, cmd_ctx->interp);
-       return retval;
+                       &tcl_closed, NULL);
 }
 
 COMMAND_HANDLER(handle_tcl_port_command)
 {
-       return CALL_COMMAND_HANDLER(server_port_command, &tcl_port);
+       return CALL_COMMAND_HANDLER(server_pipe_command, &tcl_port);
 }
 
 static const struct command_registration tcl_command_handlers[] = {
        {
                .name = "tcl_port",
-               .handler = &handle_tcl_port_command,
+               .handler = handle_tcl_port_command,
                .mode = COMMAND_CONFIG,
-               .help = "port on which to listen "
-                       "for incoming TCL syntax",
-               .usage = "<port>",
+               .help = "Specify port on which to listen "
+                       "for incoming Tcl syntax.  "
+                       "Read help on 'gdb_port'.",
+               .usage = "[port_num]",
        },
        COMMAND_REGISTRATION_DONE
 };
 
 int tcl_register_commands(struct command_context *cmd_ctx)
 {
+       tcl_port = strdup("6666");
        return register_commands(cmd_ctx, NULL, tcl_command_handlers);
 }