Audit and eliminate redundant helper #include directives.
[fw/openocd] / src / helper / options.c
1 /***************************************************************************
2  *   Copyright (C) 2004, 2005 by Dominic Rath                              *
3  *   Dominic.Rath@gmx.de                                                   *
4  *                                                                         *
5  *   Copyright (C) 2007,2008 Ã˜yvind Harboe                                 *
6  *   oyvind.harboe@zylin.com                                               *
7  *                                                                         *
8  *   This program is free software; you can redistribute it and/or modify  *
9  *   it under the terms of the GNU General Public License as published by  *
10  *   the Free Software Foundation; either version 2 of the License, or     *
11  *   (at your option) any later version.                                   *
12  *                                                                         *
13  *   This program is distributed in the hope that it will be useful,       *
14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
16  *   GNU General Public License for more details.                          *
17  *                                                                         *
18  *   You should have received a copy of the GNU General Public License     *
19  *   along with this program; if not, write to the                         *
20  *   Free Software Foundation, Inc.,                                       *
21  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
22  ***************************************************************************/
23 #ifdef HAVE_CONFIG_H
24 #include "config.h"
25 #endif
26
27 #include "configuration.h"
28 #include "log.h"
29 #include "server.h"
30
31 #include <getopt.h>
32
33 static int help_flag, version_flag;
34
35 static struct option long_options[] =
36 {
37         {"help",        no_argument,            &help_flag,     1},
38         {"version",     no_argument,            &version_flag,  1},
39         {"debug",       optional_argument,      0,              'd'},
40         {"file",        required_argument,      0,              'f'},
41         {"search",      required_argument,      0,              's'},
42         {"log_output",  required_argument,      0,      'l'},
43         {"command",     required_argument,      0,              'c'},
44         {"pipe",        no_argument,            0,              'p'},
45         {0, 0, 0, 0}
46 };
47
48 int configuration_output_handler(struct command_context_s *context, const char* line)
49 {
50         LOG_USER_N("%s", line);
51
52         return ERROR_OK;
53 }
54
55 int add_default_dirs(void)
56 {
57 #ifdef _WIN32
58         /* Add the parent of the directory where openocd.exe resides to the
59          * config script search path.
60          * Directory layout: 
61          * bin\openocd.exe
62          * lib\openocd
63          * event\at91eb40a_reset.cfg
64          * target\at91eb40a.cfg
65          */
66         {
67                 char strExePath [MAX_PATH];
68                 GetModuleFileName (NULL, strExePath, MAX_PATH);
69                 /* Either this code will *always* work or it will SEGFAULT giving
70                  * excellent information on the culprit. 
71                  */
72                 *strrchr(strExePath, '\\')=0;
73                 strcat(strExePath, "\\..");
74                 add_script_search_dir(strExePath);
75         }
76         /*
77          * Add support for the default (as of 20080121) layout when
78          * using autotools and cygwin to build native MinGW binary.
79          * Path separator is converted to UNIX style so that MinGW is
80          * pleased.
81          *
82          * bin/openocd.exe
83          * lib/openocd/event/at91eb40a_reset.cfg
84          * lib/openocd/target/at91eb40a.cfg
85          */
86         {
87                 char strExePath [MAX_PATH];
88                 char *p;
89                 GetModuleFileName (NULL, strExePath, MAX_PATH);
90                 *strrchr(strExePath, '\\')=0;
91                 strcat(strExePath, "/../lib/"PACKAGE);
92                 for(p=strExePath; *p; p++) {
93                         if(*p == '\\')
94                                 *p = '/';
95                 }
96                 add_script_search_dir(strExePath);
97         }
98 #else
99         /* Add dir for openocd supplied scripts last so that user can over
100            ride those scripts if desired. */
101         add_script_search_dir(PKGDATADIR);
102         add_script_search_dir(PKGLIBDIR);
103 #endif
104         return ERROR_OK;
105 }
106
107 int parse_cmdline_args(struct command_context_s *cmd_ctx, int argc, char *argv[])
108 {
109         int c;
110         char command_buffer[128];
111
112         while (1)
113         {       
114                 /* getopt_long stores the option index here. */
115                 int option_index = 0;
116                 
117                 c = getopt_long(argc, argv, "hvd::l:f:s:c:p", long_options, &option_index);
118                 
119                 /* Detect the end of the options. */
120                 if (c == -1)
121                         break;
122                 
123                 switch (c)
124                 {
125                         case 0:
126                                 break;
127                         case 'h':       /* --help | -h */
128                                 help_flag = 1;
129                                 break;
130                         case 'v':       /* --version | -v */
131                                 version_flag = 1;
132                                 break;
133                         case 'f':       /* --file | -f */
134                         {
135                                 snprintf(command_buffer, 128, "script {%s}", optarg);
136                                 add_config_command(command_buffer);
137                                 break;
138                         }
139                         case 's':       /* --search | -s */
140                                 add_script_search_dir(optarg);
141                                 break;
142                         case 'd':       /* --debug | -d */
143                                 if (optarg)
144                                         snprintf(command_buffer, 128, "debug_level %s", optarg);
145                                 else
146                                         snprintf(command_buffer, 128, "debug_level 3");
147                                 command_run_line(cmd_ctx, command_buffer);
148                                 break;
149                         case 'l':       /* --log_output | -l */
150                                 if (optarg)
151                                 {
152                                         snprintf(command_buffer, 128, "log_output %s", optarg);
153                                         command_run_line(cmd_ctx, command_buffer);
154                                 }       
155                                 break;
156                         case 'c':       /* --command | -c */
157                                 if (optarg)
158                                 {
159                                         add_config_command(optarg);
160                                 }       
161                                 break;
162                         case 'p':       /* --pipe | -p */
163 #if BUILD_ECOSBOARD == 1
164                                 /* pipes unsupported on hosted platforms */
165                                 LOG_WARNING("pipes not supported on this platform");
166 #else
167                                 server_use_pipes = 1;
168 #endif
169                                 break;
170                 }
171         }
172
173         if (help_flag)
174         {
175                 LOG_OUTPUT("Open On-Chip Debugger\n(c) 2005-2008 by Dominic Rath\n\n");
176                 LOG_OUTPUT("--help       | -h\tdisplay this help\n");
177                 LOG_OUTPUT("--version    | -v\tdisplay OpenOCD version\n");
178                 LOG_OUTPUT("--file       | -f\tuse configuration file <name>\n");
179                 LOG_OUTPUT("--search     | -s\tdir to search for config files and scripts\n");
180                 LOG_OUTPUT("--debug      | -d\tset debug level <0-3>\n");
181                 LOG_OUTPUT("--log_output | -l\tredirect log output to file <name>\n");
182                 LOG_OUTPUT("--command    | -c\trun <command>\n");
183                 LOG_OUTPUT("--pipe       | -p\tuse pipes for gdb communication\n");
184                 exit(-1);
185         }       
186
187         if (version_flag)
188         {
189                 /* Nothing to do, version gets printed automatically. */
190                 // It is not an error to request the VERSION number.
191                 exit(0);
192         }
193         
194         return ERROR_OK;
195 }