oops... backup file snuck in, remove it.
[fw/openocd] / src / helper / options.c
index 04419569f461eeb96c60e41cc34cdc94edf88160..3a95df46d0799923f12af0f3b7c165eaf0c24f4b 100644 (file)
@@ -2,7 +2,7 @@
  *   Copyright (C) 2004, 2005 by Dominic Rath                              *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
- *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
+ *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
  *   oyvind.harboe@zylin.com                                               *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
 #include "config.h"
 #endif
 
-#include "types.h"
-#include "command.h"
 #include "configuration.h"
-#include "log.h"
+// @todo the inclusion of server.h here is a layering violation
+#include <server/server.h>
 
-#include <stdio.h>
-#include <stdlib.h>
 #include <getopt.h>
-#include <string.h>
 
 static int help_flag, version_flag;
 
-static struct option long_options[] =
+static const struct option long_options[] =
 {
        {"help",        no_argument,            &help_flag,     1},
        {"version",     no_argument,            &version_flag,  1},
        {"debug",       optional_argument,      0,              'd'},
-       {"file",        required_argument,      0,              'f'},
+       {"file",        required_argument,      0,              'f'},
        {"search",      required_argument,      0,              's'},
-       {"log_output",  required_argument,      0,              'l'},
+       {"log_output",  required_argument,      0,      'l'},
        {"command",     required_argument,      0,              'c'},
+       {"pipe",        no_argument,            0,              'p'},
        {0, 0, 0, 0}
 };
 
-int configuration_output_handler(struct command_context_s *context, const char* line)
+int configuration_output_handler(struct command_context *context, const char* line)
 {
-       LOG_USER_N(line);
+       LOG_USER_N("%s", line);
 
        return ERROR_OK;
 }
 
-int add_default_dirs(void)
+static void add_default_dirs(void)
 {
 #ifdef _WIN32
        /* Add the parent of the directory where openocd.exe resides to the
         * config script search path.
-        * Directory layout: 
+        * Directory layout:
         * bin\openocd.exe
         * lib\openocd
         * event\at91eb40a_reset.cfg
@@ -70,37 +67,77 @@ int add_default_dirs(void)
                char strExePath [MAX_PATH];
                GetModuleFileName (NULL, strExePath, MAX_PATH);
                /* Either this code will *always* work or it will SEGFAULT giving
-                * excellent information on the culprit. 
+                * excellent information on the culprit.
                 */
-               *strrchr(strExePath, '\\')=0;
+               *strrchr(strExePath, '\\') = 0;
                strcat(strExePath, "\\..");
                add_script_search_dir(strExePath);
        }
+       /*
+        * Add support for the default (as of 20091118) layout when
+        * using autotools and cygwin/MinGW to build native binary.
+        * Path separator is converted to UNIX style so that MinGW is
+        * pleased.
+        *
+        * bin/openocd.exe
+        * share/openocd/scripts/interface/dummy.cfg
+        * share/openocd/scripts/target/at91eb40a.cfg
+        */
+       {
+               char strExePath [MAX_PATH];
+               char *p;
+               GetModuleFileName (NULL, strExePath, MAX_PATH);
+               *strrchr(strExePath, '\\') = 0;
+               strcat(strExePath, "/../share/"PACKAGE"/scripts");
+               for (p = strExePath; *p; p++) {
+                       if (*p == '\\')
+                               *p = '/';
+               }
+               add_script_search_dir(strExePath);
+       }
 #else
-       /* Add dir for openocd supplied scripts last so that user can over
-          ride those scripts if desired. */
-       add_script_search_dir(PKGDATADIR);
-       add_script_search_dir(PKGLIBDIR);
+       /*
+        * The directory containing OpenOCD-supplied scripts should be
+        * listed last in the built-in search order, so the user can
+        * override these scripts with site-specific customizations.
+        */
+
+       const char *home = getenv("HOME");
+
+       if (home) 
+       {
+               char *path;
+
+               path = alloc_printf("%s/.openocd", home);
+
+               if (path) 
+               {
+                       add_script_search_dir(path);
+                       free(path);
+               }
+       }
+
+       add_script_search_dir(PKGDATADIR "/site");
+       add_script_search_dir(PKGDATADIR "/scripts");
 #endif
-       return ERROR_OK;
 }
 
-int parse_cmdline_args(struct command_context_s *cmd_ctx, int argc, char *argv[])
+int parse_cmdline_args(struct command_context *cmd_ctx, int argc, char *argv[])
 {
        int c;
        char command_buffer[128];
 
        while (1)
-       {       
+       {
                /* getopt_long stores the option index here. */
                int option_index = 0;
-               
-               c = getopt_long(argc, argv, "hvd::l:f:s:c:", long_options, &option_index);
-               
+
+               c = getopt_long(argc, argv, "hvd::l:f:s:c:p", long_options, &option_index);
+
                /* Detect the end of the options. */
                if (c == -1)
                        break;
-               
+
                switch (c)
                {
                        case 0:
@@ -132,21 +169,28 @@ int parse_cmdline_args(struct command_context_s *cmd_ctx, int argc, char *argv[]
                                {
                                        snprintf(command_buffer, 128, "log_output %s", optarg);
                                        command_run_line(cmd_ctx, command_buffer);
-                               }       
+                               }
                                break;
                        case 'c':       /* --command | -c */
                                if (optarg)
                                {
                                        add_config_command(optarg);
-                               }       
+                               }
+                               break;
+                       case 'p':       /* --pipe | -p */
+#if BUILD_ECOSBOARD == 1
+                               /* pipes unsupported on hosted platforms */
+                               LOG_WARNING("pipes not supported on this platform");
+#else
+                               server_use_pipes = 1;
+#endif
                                break;
-                               
                }
        }
 
        if (help_flag)
        {
-               LOG_OUTPUT("Open On-Chip Debugger\n(c) 2005-2008 by Dominic Rath\n\n");
+               LOG_OUTPUT("Open On-Chip Debugger\nLicensed under GNU GPL v2\n");
                LOG_OUTPUT("--help       | -h\tdisplay this help\n");
                LOG_OUTPUT("--version    | -v\tdisplay OpenOCD version\n");
                LOG_OUTPUT("--file       | -f\tuse configuration file <name>\n");
@@ -154,15 +198,21 @@ int parse_cmdline_args(struct command_context_s *cmd_ctx, int argc, char *argv[]
                LOG_OUTPUT("--debug      | -d\tset debug level <0-3>\n");
                LOG_OUTPUT("--log_output | -l\tredirect log output to file <name>\n");
                LOG_OUTPUT("--command    | -c\trun <command>\n");
+               LOG_OUTPUT("--pipe       | -p\tuse pipes for gdb communication\n");
                exit(-1);
-       }       
+       }
 
        if (version_flag)
        {
                /* Nothing to do, version gets printed automatically. */
-               exit(-1);
-       }       
+               // It is not an error to request the VERSION number.
+               exit(0);
+       }
 
+       /* paths specified on the command line take precedence over these
+        * built-in paths
+        */
+       add_default_dirs();
 
        return ERROR_OK;
 }