More standard --help output.
[ardour.git] / gtk2_ardour / opts.cc
1 /*
2     Copyright (C) 2001 Paul Davis
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 #include <getopt.h>
21 #include <string.h>
22 #include <iostream>
23 #include <cstdlib>
24
25 #include "ardour/debug.h"
26 #include "ardour/session.h"
27
28 #include "opts.h"
29
30 #include "i18n.h"
31
32 using namespace std;
33
34 string ARDOUR_COMMAND_LINE::session_name = "";
35 string ARDOUR_COMMAND_LINE::jack_client_name = "ardour";
36 bool  ARDOUR_COMMAND_LINE::show_key_actions = false;
37 bool ARDOUR_COMMAND_LINE::no_splash = true;
38 bool ARDOUR_COMMAND_LINE::just_version = false;
39 bool ARDOUR_COMMAND_LINE::use_vst = true;
40 bool ARDOUR_COMMAND_LINE::new_session = false;
41 char* ARDOUR_COMMAND_LINE::curvetest_file = 0;
42 bool ARDOUR_COMMAND_LINE::try_hw_optimization = true;
43 string ARDOUR_COMMAND_LINE::keybindings_path = ""; /* empty means use builtin default */
44 Glib::ustring ARDOUR_COMMAND_LINE::menus_file = "ardour.menus";
45 bool ARDOUR_COMMAND_LINE::finder_invoked_ardour = false;
46 string ARDOUR_COMMAND_LINE::immediate_save;
47
48 using namespace ARDOUR_COMMAND_LINE;
49
50 int
51 print_help (const char *execname)
52 {
53         cout << _("Usage: ") << execname << " [OPTION]... [SESSION_NAME]\n\n"
54              << _("  [SESSION_NAME]              Name of session to load\n")
55              << _("  -v, --version               Show version information\n")
56              << _("  -h, --help                  Print this message\n")
57              << _("  -b, --bindings              Print all possible keyboard binding names\n")
58              << _("  -c, --name <name>           Use a specific jack client name, default is ardour\n")
59              << _("  -d, --disable-plugins       Disable all plugins in an existing session\n")
60              << _("  -D, --debug <options>       Set debug flags. Use \"-D list\" to see available options\n")
61              << _("  -n, --show-splash           Show splash screen\n")
62              << _("  -m, --menus file            Use \"file\" for Ardour menus\n")
63              << _("  -N, --new session-name      Create a new session from the command line\n")
64              << _("  -O, --no-hw-optimizations   Disable h/w specific optimizations\n")
65              << _("  -S, --sync                  Draw the gui synchronously \n")
66 #ifdef VST_SUPPORT
67              << _("  -V, --novst                 Do not use VST support\n")
68 #endif
69              << _("  -E, --save <file>           Load the specified session, save it to <file> and then quit\n")
70              << _("  -C, --curvetest filename    Curve algorithm debugger\n")
71              << _("  -k, --keybindings filename  Name of key bindings to load (default is ~/.ardour3/ardour.bindings)\n")
72                 ;
73         return 1;
74
75 }
76
77 static void
78 list_debug_options ()
79 {
80         cerr << _("The following debug options are available. Their use is case-insensitive.") << "\n\n";
81         cerr << "\tMidiSourceIO\n";
82         cerr << "\tMidiPlaylistIO\n";
83 }
84
85 static int
86 parse_debug_options (const char* str)
87 {
88         char* p;
89         char* sp;
90         uint64_t bits = 0;
91         char* copy = strdup (str);
92
93         p = strtok_r (copy, ",", &sp);
94
95         while (p) {
96                 if (strcasecmp (p, "list") == 0) {
97                         list_debug_options ();
98                         free (copy);
99                         return 1;
100                 }
101
102                 if (strcasecmp (p, "midisourceio") == 0) {
103                         bits |= ARDOUR::DEBUG::MidiSourceIO;
104                 }
105                 if (strcasecmp (p, "midiplaylistio") == 0) {
106                         bits |= ARDOUR::DEBUG::MidiPlaylistIO;
107                 }
108
109                 p = strtok_r (0, ",", &sp);
110         }
111         
112         free (copy);
113         ARDOUR::set_debug_bits (bits);
114         return 0;
115 }
116
117
118 int
119 ARDOUR_COMMAND_LINE::parse_opts (int argc, char *argv[])
120 {
121         const char *optstring = "bc:C:dD:hk:E:m:N:nOp:SU:vV";
122         const char *execname = strrchr (argv[0], '/');
123
124         if (getenv ("ARDOUR_SAE")) {
125                 menus_file = "ardour-sae.menus";
126                 keybindings_path = "SAE";
127         }
128
129         if (execname == 0) {
130                 execname = argv[0];
131         } else {
132                 execname++;
133         }
134
135         const struct option longopts[] = {
136                 { "version", 0, 0, 'v' },
137                 { "help", 0, 0, 'h' },
138                 { "bindings", 0, 0, 'b' },
139                 { "debug", 1, 0, 'D' },
140                 { "show-splash", 0, 0, 'n' },
141                 { "menus", 1, 0, 'm' },
142                 { "name", 1, 0, 'c' },
143                 { "novst", 0, 0, 'V' },
144                 { "new", 1, 0, 'N' },
145                 { "no-hw-optimizations", 0, 0, 'O' },
146                 { "sync", 0, 0, 'S' },
147                 { "curvetest", 1, 0, 'C' },
148                 { "save", 1, 0, 'E' },
149                 { 0, 0, 0, 0 }
150         };
151
152         int option_index = 0;
153         int c = 0;
154
155         while (1) {
156                 c = getopt_long (argc, argv, optstring, longopts, &option_index);
157
158                 if (c == -1) {
159                         break;
160                 }
161
162                 switch (c) {
163                 case 0:
164                         break;
165
166                 case 'v':
167                         just_version = true;
168                         break;
169
170                 case 'h':
171                         print_help (execname);
172                         exit (0);
173                         break;
174                 case 'b':
175                         show_key_actions = true;
176                         break;
177
178                 case 'd':
179                         ARDOUR::Session::set_disable_all_loaded_plugins (true);
180                         break;
181
182                 case 'D':
183                         if (parse_debug_options (optarg)) {
184                                 exit (0);
185                         }
186                         break;
187                         
188                 case 'm':
189                         menus_file = optarg;
190                         break;
191
192                 case 'n':
193                         no_splash = false;
194                         break;
195
196                 case 'p':
197                         //undocumented OS X finder -psn_XXXXX argument
198                         finder_invoked_ardour = true;
199                         break;
200
201                 case 'S':
202                 //      ; just pass this through to gtk it will figure it out
203                         break;
204
205                 case 'N':
206                         new_session = true;
207                         session_name = optarg;
208                         break;
209
210                 case 'O':
211                         try_hw_optimization = false;
212                         break;
213
214                 case 'V':
215 #ifdef VST_SUPPORT
216                         use_vst = false;
217 #endif /* VST_SUPPORT */
218                         break;
219
220                 case 'c':
221                         jack_client_name = optarg;
222                         break;
223
224                 case 'C':
225                         curvetest_file = optarg;
226                         break;
227
228                 case 'k':
229                         keybindings_path = optarg;
230                         break;
231
232                 case 'E':
233                         immediate_save = optarg;
234                         break;
235
236                 default:
237                         return print_help(execname);
238                 }
239         }
240
241         if (optind < argc) {
242                 if (new_session) {
243                         cerr << "Illogical combination: you can either create a new session, or a load an existing session but not both!" << endl;
244                         return print_help(execname);
245                 }
246                 session_name = argv[optind++];
247         }
248
249         return 0;
250 }
251