extfs helpers: Replace all 'gawk' occurences with @AWK@ meta variable.
[midnight-commander.git] / src / args.c
bloba1addb984839f317b72d028173282dcaa26f67e6
1 /*
2 Handle command line arguments.
4 Copyright (C) 2009 The Free Software Foundation, Inc.
6 Written by:
7 Slava Zanko <slavazanko@gmail.com>, 2009.
9 This file is part of the Midnight Commander.
11 The Midnight Commander is free software; you can redistribute it
12 and/or modify it under the terms of the GNU General Public License as
13 published by the Free Software Foundation; either version 2 of the
14 License, or (at your option) any later version.
16 The Midnight Commander is distributed in the hope that it will be
17 useful, but WITHOUT ANY WARRANTY; without even the implied warranty
18 of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program; if not, write to the Free Software
23 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
24 MA 02110-1301, USA.
27 #include <config.h>
28 #include <stdlib.h>
29 #include <stdio.h>
31 #include "lib/global.h"
32 #include "lib/tty/tty.h"
33 #include "lib/tty/color.h" /* command_line_colors */
34 #include "lib/tty/mouse.h"
35 #include "lib/strutil.h"
36 #include "lib/vfs/mc-vfs/vfs.h"
37 #ifdef ENABLE_VFS_SMB
38 #include "lib/vfs/mc-vfs/smbfs.h" /* smbfs_set_debugf() */
39 #endif
40 #include "lib/util.h" /* x_basename() */
42 #include "src/main.h"
43 #include "src/textconf.h"
44 #include "src/subshell.h" /* use_subshell */
46 #include "src/args.h"
48 /*** external variables **************************************************************************/
50 /*** global variables ****************************************************************************/
52 /* If true, show version info and exit */
53 gboolean mc_args__show_version = FALSE;
55 /* If true, assume we are running on an xterm terminal */
56 gboolean mc_args__force_xterm = FALSE;
58 gboolean mc_args__nomouse = FALSE;
60 /* For slow terminals */
61 gboolean mc_args__slow_terminal = FALSE;
63 /* If true use +, -, | for line drawing */
64 gboolean mc_args__ugly_line_drawing = FALSE;
66 /* Set to force black and white display at program startup */
67 gboolean mc_args__disable_colors = FALSE;
69 /* Force colors, only used by Slang */
70 gboolean mc_args__force_colors = FALSE;
72 /* Line to start the editor on */
73 int mc_args__edit_start_line = 0;
75 /* Show in specified skin */
76 char *mc_args__skin = NULL;
78 char *mc_args__last_wd_file = NULL;
80 /* when enabled NETCODE, use folowing file as logfile */
81 char *mc_args__netfs_logfile = NULL;
83 /* keymap file */
84 char *mc_args__keymap_file = NULL;
86 /* Debug level */
87 int mc_args__debug_level = 0;
89 /*** file scope macro definitions ****************************************************************/
91 /*** file scope type declarations ****************************************************************/
93 /*** file scope variables ************************************************************************/
95 /* forward declarations */
96 static gboolean parse_mc_e_argument (const gchar * option_name, const gchar * value,
97 gpointer data, GError ** error);
98 static gboolean parse_mc_v_argument (const gchar * option_name, const gchar * value,
99 gpointer data, GError ** error);
101 static GOptionContext *context;
103 static gboolean mc_args__nouse_subshell = FALSE;
104 static gboolean mc_args__show_datadirs = FALSE;
106 static GOptionGroup *main_group;
108 static const GOptionEntry argument_main_table[] = {
109 /* *INDENT-OFF* */
110 /* generic options */
112 "version", 'V', G_OPTION_FLAG_IN_MAIN, G_OPTION_ARG_NONE,
113 &mc_args__show_version,
114 N_("Displays the current version"),
115 NULL
118 /* options for wrappers */
120 "datadir", 'f', G_OPTION_FLAG_IN_MAIN, G_OPTION_ARG_NONE,
121 &mc_args__show_datadirs,
122 N_("Print data directory"),
123 NULL
127 "printwd", 'P', G_OPTION_FLAG_IN_MAIN, G_OPTION_ARG_STRING,
128 &mc_args__last_wd_file,
129 N_("Print last working directory to specified file"),
130 "<file>"
133 #ifdef HAVE_SUBSHELL_SUPPORT
135 "subshell", 'U', G_OPTION_FLAG_IN_MAIN, G_OPTION_ARG_NONE,
136 &use_subshell,
137 N_("Enables subshell support (default)"),
138 NULL
142 "nosubshell", 'u', G_OPTION_FLAG_IN_MAIN, G_OPTION_ARG_NONE,
143 &mc_args__nouse_subshell,
144 N_("Disables subshell support"),
145 NULL
147 #endif
149 /* debug options */
150 #ifdef ENABLE_VFS_FTP
152 "ftplog", 'l', G_OPTION_FLAG_IN_MAIN, G_OPTION_ARG_STRING,
153 &mc_args__netfs_logfile,
154 N_("Log ftp dialog to specified file"),
155 "<file>"
157 #endif /* ENABLE_VFS_FTP */
158 #ifdef ENABLE_VFS_SMB
160 "debuglevel", 'D', G_OPTION_FLAG_IN_MAIN, G_OPTION_ARG_INT,
161 &mc_args__debug_level,
162 N_("Set debug level"),
163 "<integer>"
165 #endif /* ENABLE_VFS_SMB */
167 /* single file operations */
169 "view", 'v', G_OPTION_FLAG_IN_MAIN, G_OPTION_ARG_CALLBACK,
170 parse_mc_v_argument,
171 N_("Launches the file viewer on a file"),
172 "<file>"
176 "edit", 'e', G_OPTION_FLAG_IN_MAIN, G_OPTION_ARG_CALLBACK,
177 parse_mc_e_argument,
178 N_("Edits one file"),
179 "<file>"},
182 NULL, '\0', 0, 0, NULL, NULL, NULL /* Complete struct initialization */
184 /* *INDENT-ON* */
187 GOptionGroup *terminal_group;
188 #define ARGS_TERM_OPTIONS 0
189 static const GOptionEntry argument_terminal_table[] = {
190 /* *INDENT-OFF* */
191 /* terminal options */
193 "xterm", 'x', ARGS_TERM_OPTIONS, G_OPTION_ARG_NONE,
194 &mc_args__force_xterm,
195 N_("Forces xterm features"),
196 NULL
200 "nomouse", 'd', ARGS_TERM_OPTIONS, G_OPTION_ARG_NONE,
201 &mc_args__nomouse,
202 N_("Disable mouse support in text version"),
203 NULL
206 #ifdef HAVE_SLANG
208 "termcap", 't', ARGS_TERM_OPTIONS, G_OPTION_ARG_NONE,
209 &SLtt_Try_Termcap,
210 N_("Tries to use termcap instead of terminfo"),
211 NULL
213 #endif
216 "slow", 's', ARGS_TERM_OPTIONS, G_OPTION_ARG_NONE,
217 &mc_args__slow_terminal,
218 N_("To run on slow terminals"),
219 NULL
223 "stickchars", 'a', ARGS_TERM_OPTIONS, G_OPTION_ARG_NONE,
224 &mc_args__ugly_line_drawing,
225 N_("Use stickchars to draw"),
226 NULL
230 "resetsoft", 'k', ARGS_TERM_OPTIONS, G_OPTION_ARG_NONE,
231 &reset_hp_softkeys,
232 N_("Resets soft keys on HP terminals"),
233 NULL
237 "keymap", 'K', ARGS_TERM_OPTIONS, G_OPTION_ARG_STRING,
238 &mc_args__keymap_file,
239 N_("Load definitions of key bindings from specified file"),
240 "<file>"
244 NULL, '\0', 0, 0, NULL, NULL, NULL /* Complete struct initialization */
246 /* *INDENT-ON* */
249 #undef ARGS_TERM_OPTIONS
251 GOptionGroup *color_group;
252 #define ARGS_COLOR_OPTIONS 0
253 // #define ARGS_COLOR_OPTIONS G_OPTION_FLAG_IN_MAIN
254 static const GOptionEntry argument_color_table[] = {
255 /* *INDENT-OFF* */
256 /* color options */
258 "nocolor", 'b', ARGS_COLOR_OPTIONS, G_OPTION_ARG_NONE,
259 &mc_args__disable_colors,
260 N_("Requests to run in black and white"),
261 NULL
265 "color", 'c', ARGS_COLOR_OPTIONS, G_OPTION_ARG_NONE,
266 &mc_args__force_colors,
267 N_("Request to run in color mode"),
268 NULL
272 "colors", 'C', ARGS_COLOR_OPTIONS, G_OPTION_ARG_STRING,
273 &command_line_colors,
274 N_("Specifies a color configuration"),
275 "<string>"
279 "skin", 'S', ARGS_COLOR_OPTIONS, G_OPTION_ARG_STRING,
280 &mc_args__skin,
281 N_("Show mc with specified skin"),
282 "<string>"
286 NULL, '\0', 0, 0, NULL, NULL, NULL /* Complete struct initialization */
288 /* *INDENT-ON* */
291 #undef ARGS_COLOR_OPTIONS
293 static gchar *mc_args__loc__colors_string = NULL;
294 static gchar *mc_args__loc__footer_string = NULL;
295 static gchar *mc_args__loc__header_string = NULL;
296 static gchar *mc_args__loc__usage_string = NULL;
298 /*** file scope functions ************************************************************************/
300 /* --------------------------------------------------------------------------------------------- */
301 static void
302 mc_args_clean_temp_help_strings (void)
304 g_free (mc_args__loc__colors_string);
305 mc_args__loc__colors_string = NULL;
307 g_free (mc_args__loc__footer_string);
308 mc_args__loc__footer_string = NULL;
310 g_free (mc_args__loc__header_string);
311 mc_args__loc__header_string = NULL;
313 g_free (mc_args__loc__usage_string);
314 mc_args__loc__usage_string = NULL;
317 /* --------------------------------------------------------------------------------------------- */
319 static GOptionGroup *
320 mc_args_new_color_group (void)
322 /* FIXME: to preserve translations, lines should be split. */
323 mc_args__loc__colors_string = g_strdup_printf ("%s\n%s",
324 /* TRANSLATORS: don't translate keywords */
325 _("--colors KEYWORD={FORE},{BACK}\n\n"
326 "{FORE} and {BACK} can be omitted, and the default will be used\n"
327 "\n Keywords:\n"
328 " Global: errors, disabled, reverse, gauge, header\n"
329 " input, inputmark, inputunchanged, commandlinemark\n"
330 " bbarhotkey, bbarbutton, statusbar\n"
331 " File display: normal, selected, marked, markselect\n"
332 " Dialog boxes: dnormal, dfocus, dhotnormal, dhotfocus, errdhotnormal,\n"
333 " errdhotfocus\n"
334 " Menus: menunormal, menuhot, menusel, menuhotsel, menuinactive\n"
335 " Popup menus: pmenunormal, pmenusel, pmenutitle\n"
336 " Editor: editnormal, editbold, editmarked, editwhitespace,\n"
337 " editlinestate\n"
338 " Viewer: viewbold, viewunderline, viewselected\n"
339 " Help: helpnormal, helpitalic, helpbold, helplink, helpslink\n"),
340 /* TRANSLATORS: don't translate color names */
341 _("Colors:\n"
342 " black, gray, red, brightred, green, brightgreen, brown,\n"
343 " yellow, blue, brightblue, magenta, brightmagenta, cyan,\n"
344 " brightcyan, lightgray and white\n\n"));
346 return g_option_group_new ("color", mc_args__loc__colors_string,
347 _("Color options"), NULL, NULL);
351 /* --------------------------------------------------------------------------------------------- */
353 static gchar *
354 mc_args_add_usage_info (void)
356 mc_args__loc__usage_string = g_strdup_printf ("[%s] %s\n %s - %s\n",
357 _("+number"),
358 _("[this_dir] [other_panel_dir]"),
359 _("+number"),
361 ("Set initial line number for the internal editor"));
362 return mc_args__loc__usage_string;
365 /* --------------------------------------------------------------------------------------------- */
367 static void
368 mc_args_add_extended_info_to_help (void)
370 mc_args__loc__footer_string = g_strdup_printf ("%s",
372 ("\n"
373 "Please send any bug reports (including the output of `mc -V')\n"
374 "as tickets at www.midnight-commander.org\n"));
375 mc_args__loc__header_string = g_strdup_printf (_("GNU Midnight Commander %s\n"), VERSION);
377 #if GLIB_CHECK_VERSION(2,12,0)
378 g_option_context_set_description (context, mc_args__loc__footer_string);
379 g_option_context_set_summary (context, mc_args__loc__header_string);
380 #endif
383 /* --------------------------------------------------------------------------------------------- */
385 static void
386 mc_setup_by_args (int argc, char *argv[])
388 const char *base;
389 char *tmp;
391 if (mc_args__nomouse)
392 use_mouse_p = MOUSE_DISABLED;
394 if (mc_args__netfs_logfile != NULL)
396 #ifdef ENABLE_VFS_FTP
397 mc_setctl ("/#ftp:", VFS_SETCTL_LOGFILE, (void *) mc_args__netfs_logfile);
398 #endif /* ENABLE_VFS_FTP */
399 #ifdef ENABLE_VFS_SMB
400 smbfs_set_debugf (mc_args__netfs_logfile);
401 #endif /* ENABLE_VFS_SMB */
404 #ifdef ENABLE_VFS_SMB
405 if (mc_args__debug_level != 0)
406 smbfs_set_debug (mc_args__debug_level);
407 #endif /* ENABLE_VFS_SMB */
409 base = x_basename (argv[0]);
410 tmp = (argc > 0) ? argv[1] : NULL;
412 if (strncmp (base, "mce", 3) == 0 || strcmp (base, "vi") == 0)
414 /* mce* or vi is link to mc */
416 mc_run_param0 = g_strdup ("");
417 if (tmp != NULL)
420 * Check for filename:lineno, followed by an optional colon.
421 * This format is used by many programs (especially compilers)
422 * in error messages and warnings. It is supported so that
423 * users can quickly copy and paste file locations.
425 char *end, *p;
427 end = tmp + strlen (tmp);
428 p = end;
430 if (p > tmp && p[-1] == ':')
431 p--;
432 while (p > tmp && g_ascii_isdigit ((gchar) p[-1]))
433 p--;
434 if (tmp < p && p < end && p[-1] == ':')
436 char *fname;
437 struct stat st;
439 fname = g_strndup (tmp, p - 1 - tmp);
441 * Check that the file before the colon actually exists.
442 * If it doesn't exist, revert to the old behavior.
444 if (mc_stat (tmp, &st) == -1 && mc_stat (fname, &st) != -1)
446 mc_run_param0 = fname;
447 mc_args__edit_start_line = atoi (p);
449 else
451 g_free (fname);
452 goto try_plus_filename;
455 else
457 try_plus_filename:
458 if (*tmp == '+' && g_ascii_isdigit ((gchar) tmp[1]))
460 int start_line;
462 start_line = atoi (tmp);
465 * If start_line is zero, position the cursor at the
466 * beginning of the file as other editors (vi, nano)
468 if (start_line == 0)
469 start_line++;
471 if (start_line > 0)
473 char *file;
475 file = (argc > 1) ? argv[2] : NULL;
476 if (file != NULL)
478 tmp = file;
479 mc_args__edit_start_line = start_line;
483 mc_run_param0 = g_strdup (tmp);
486 mc_run_mode = MC_RUN_EDITOR;
488 else if (strncmp (base, "mcv", 3) == 0 || strcmp (base, "view") == 0)
490 /* mcv* or view is link to mc */
492 if (tmp != NULL)
493 mc_run_param0 = g_strdup (tmp);
494 else
496 fprintf (stderr, "%s\n", _("No arguments given to the viewer."));
497 exit (EXIT_FAILURE);
499 mc_run_mode = MC_RUN_VIEWER;
501 #ifdef USE_DIFF_VIEW
502 else if (strncmp (base, "mcd", 3) == 0 || strcmp (base, "diff") == 0)
504 /* mcd* or diff is link to mc */
506 if (argc < 3)
508 fprintf (stderr, "%s\n", _("Two files are required to evoke the diffviewer."));
509 exit (EXIT_FAILURE);
512 if (tmp != NULL)
514 mc_run_param0 = g_strdup (tmp);
515 tmp = (argc > 1) ? argv[2] : NULL;
516 if (tmp != NULL)
517 mc_run_param1 = g_strdup (tmp);
518 mc_run_mode = MC_RUN_DIFFVIEWER;
521 #endif /* USE_DIFF_VIEW */
522 else
524 /* MC is run as mc */
526 switch (mc_run_mode)
528 case MC_RUN_EDITOR:
529 case MC_RUN_VIEWER:
530 /* mc_run_param0 is set up in parse_mc_e_argument() and parse_mc_v_argument() */
531 break;
533 case MC_RUN_DIFFVIEWER:
534 /* not implemented yet */
535 break;
537 case MC_RUN_FULL:
538 default:
539 /* sets the current dir and the other dir */
540 if (tmp != NULL)
542 mc_run_param0 = g_strdup (tmp);
543 tmp = (argc > 1) ? argv[2] : NULL;
544 if (tmp != NULL)
545 mc_run_param1 = g_strdup (tmp);
547 mc_run_mode = MC_RUN_FULL;
548 break;
553 /* --------------------------------------------------------------------------------------------- */
555 static gboolean
556 mc_args_process (int argc, char *argv[])
558 if (mc_args__show_version)
560 show_version ();
561 return FALSE;
563 if (mc_args__show_datadirs)
565 printf ("%s (%s)\n", mc_home, mc_home_alt);
566 return FALSE;
569 if (mc_args__force_colors)
570 mc_args__disable_colors = FALSE;
572 #ifdef HAVE_SUBSHELL_SUPPORT
573 if (mc_args__nouse_subshell)
574 use_subshell = 0;
575 #endif /* HAVE_SUBSHELL_SUPPORT */
577 mc_setup_by_args (argc, argv);
579 return TRUE;
582 /* --------------------------------------------------------------------------------------------- */
584 static gchar *
585 mc_args__convert_help_to_syscharset (const gchar * charset, const gchar * error_message,
586 const gchar * help_str)
588 GString *buffer = g_string_new ("");
589 GIConv conv = g_iconv_open (charset, "UTF-8");
590 gchar *full_help_str = g_strdup_printf ("%s\n\n%s\n", error_message, help_str);
592 str_convert (conv, full_help_str, buffer);
594 g_free (full_help_str);
595 g_iconv_close (conv);
597 return g_string_free (buffer, FALSE);
600 /* --------------------------------------------------------------------------------------------- */
602 static gboolean
603 parse_mc_e_argument (const gchar * option_name, const gchar * value, gpointer data, GError ** error)
605 (void) option_name;
606 (void) data;
607 (void) error;
609 mc_run_mode = MC_RUN_EDITOR;
610 mc_run_param0 = g_strdup (value);
612 return TRUE;
615 /* --------------------------------------------------------------------------------------------- */
617 static gboolean
618 parse_mc_v_argument (const gchar * option_name, const gchar * value, gpointer data, GError ** error)
620 (void) option_name;
621 (void) data;
622 (void) error;
624 mc_run_mode = MC_RUN_VIEWER;
625 mc_run_param0 = g_strdup (value);
627 return TRUE;
630 /* --------------------------------------------------------------------------------------------- */
632 /*** public functions ****************************************************************************/
634 /* --------------------------------------------------------------------------------------------- */
636 gboolean
637 mc_args_handle (int argc, char **argv, const char *translation_domain)
639 GError *error = NULL;
640 const gchar *_system_codepage = str_detect_termencoding ();
642 #ifdef ENABLE_NLS
643 if (!str_isutf8 (_system_codepage))
644 bind_textdomain_codeset ("mc", "UTF-8");
645 #endif
647 context = g_option_context_new (mc_args_add_usage_info ());
649 g_option_context_set_ignore_unknown_options (context, FALSE);
651 mc_args_add_extended_info_to_help ();
653 main_group = g_option_group_new ("main", _("Main options"), _("Main options"), NULL, NULL);
655 g_option_group_add_entries (main_group, argument_main_table);
656 g_option_context_set_main_group (context, main_group);
657 g_option_group_set_translation_domain (main_group, translation_domain);
659 terminal_group = g_option_group_new ("terminal", _("Terminal options"),
660 _("Terminal options"), NULL, NULL);
662 g_option_group_add_entries (terminal_group, argument_terminal_table);
663 g_option_context_add_group (context, terminal_group);
664 g_option_group_set_translation_domain (terminal_group, translation_domain);
666 color_group = mc_args_new_color_group ();
668 g_option_group_add_entries (color_group, argument_color_table);
669 g_option_context_add_group (context, color_group);
670 g_option_group_set_translation_domain (color_group, translation_domain);
672 if (!g_option_context_parse (context, &argc, &argv, &error))
674 if (error != NULL)
676 gchar *full_help_str;
677 gchar *help_str;
679 #if GLIB_CHECK_VERSION(2,14,0)
680 help_str = g_option_context_get_help (context, TRUE, NULL);
681 #else
682 help_str = g_strdup ("");
683 #endif
684 if (!str_isutf8 (_system_codepage))
685 full_help_str =
686 mc_args__convert_help_to_syscharset (_system_codepage, error->message,
687 help_str);
688 else
689 full_help_str = g_strdup_printf ("%s\n\n%s\n", error->message, help_str);
691 fprintf (stderr, "%s", full_help_str);
693 g_free (help_str);
694 g_free (full_help_str);
695 g_error_free (error);
697 g_option_context_free (context);
698 mc_args_clean_temp_help_strings ();
699 return FALSE;
702 g_option_context_free (context);
703 mc_args_clean_temp_help_strings ();
705 #ifdef ENABLE_NLS
706 if (!str_isutf8 (_system_codepage))
707 bind_textdomain_codeset ("mc", _system_codepage);
708 #endif
710 return mc_args_process (argc, argv);
713 /* --------------------------------------------------------------------------------------------- */