2 Handle command line arguments.
4 Copyright (C) 2009, 2011
5 The Free Software Foundation, Inc.
8 Slava Zanko <slavazanko@gmail.com>, 2009.
10 This file is part of the Midnight Commander.
12 The Midnight Commander is free software: you can redistribute it
13 and/or modify it under the terms of the GNU General Public License as
14 published by the Free Software Foundation, either version 3 of the License,
15 or (at your option) any later version.
17 The Midnight Commander is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 GNU General Public License for more details.
22 You should have received a copy of the GNU General Public License
23 along with this program. If not, see <http://www.gnu.org/licenses/>.
30 #include "lib/global.h"
31 #include "lib/tty/tty.h"
32 #include "lib/strutil.h"
33 #include "lib/vfs/vfs.h"
34 #include "lib/util.h" /* x_basename() */
37 #include "src/vfs/smbfs/smbfs.h" /* smbfs_set_debugf() */
41 #include "src/textconf.h"
45 /*** external variables **************************************************************************/
47 /*** global variables ****************************************************************************/
49 /* If true, show version info and exit */
50 gboolean mc_args__show_version
= FALSE
;
52 /* If true, assume we are running on an xterm terminal */
53 gboolean mc_args__force_xterm
= FALSE
;
55 gboolean mc_args__nomouse
= FALSE
;
57 /* Force colors, only used by Slang */
58 gboolean mc_args__force_colors
= FALSE
;
60 /* Don't load keymap form file and use default one */
61 gboolean mc_args__nokeymap
= FALSE
;
63 /* Line to start the editor on */
64 int mc_args__edit_start_line
= 0;
66 char *mc_args__last_wd_file
= NULL
;
68 /* when enabled NETCODE, use folowing file as logfile */
69 char *mc_args__netfs_logfile
= NULL
;
72 char *mc_args__keymap_file
= NULL
;
75 int mc_args__debug_level
= 0;
77 /*** file scope macro definitions ****************************************************************/
79 /*** file scope type declarations ****************************************************************/
81 /*** file scope variables ************************************************************************/
83 /* forward declarations */
84 static gboolean
parse_mc_e_argument (const gchar
* option_name
, const gchar
* value
,
85 gpointer data
, GError
** error
);
86 static gboolean
parse_mc_v_argument (const gchar
* option_name
, const gchar
* value
,
87 gpointer data
, GError
** error
);
89 static GOptionContext
*context
;
91 #ifdef HAVE_SUBSHELL_SUPPORT
92 static gboolean mc_args__nouse_subshell
= FALSE
;
93 #endif /* HAVE_SUBSHELL_SUPPORT */
94 static gboolean mc_args__show_datadirs
= FALSE
;
95 static gboolean mc_args__show_datadirs_extended
= FALSE
;
96 static gboolean mc_args__show_configure_opts
= FALSE
;
98 static GOptionGroup
*main_group
;
100 static const GOptionEntry argument_main_table
[] = {
102 /* generic options */
104 "version", 'V', G_OPTION_FLAG_IN_MAIN
, G_OPTION_ARG_NONE
,
105 &mc_args__show_version
,
106 N_("Displays the current version"),
110 /* options for wrappers */
112 "datadir", 'f', G_OPTION_FLAG_IN_MAIN
, G_OPTION_ARG_NONE
,
113 &mc_args__show_datadirs
,
114 N_("Print data directory"),
118 /* show extended information about used data directories */
120 "datadir-info", 'F', G_OPTION_FLAG_IN_MAIN
, G_OPTION_ARG_NONE
,
121 &mc_args__show_datadirs_extended
,
122 N_("Print extended info about used data directories"),
126 /* show configure options */
128 "configure-options", '\0', G_OPTION_FLAG_IN_MAIN
, G_OPTION_ARG_NONE
,
129 &mc_args__show_configure_opts
,
130 N_("Print configure options"),
135 "printwd", 'P', G_OPTION_FLAG_IN_MAIN
, G_OPTION_ARG_STRING
,
136 &mc_args__last_wd_file
,
137 N_("Print last working directory to specified file"),
141 #ifdef HAVE_SUBSHELL_SUPPORT
143 "subshell", 'U', G_OPTION_FLAG_IN_MAIN
, G_OPTION_ARG_NONE
,
144 &mc_global
.tty
.use_subshell
,
145 N_("Enables subshell support (default)"),
150 "nosubshell", 'u', G_OPTION_FLAG_IN_MAIN
, G_OPTION_ARG_NONE
,
151 &mc_args__nouse_subshell
,
152 N_("Disables subshell support"),
158 #ifdef ENABLE_VFS_FTP
160 "ftplog", 'l', G_OPTION_FLAG_IN_MAIN
, G_OPTION_ARG_STRING
,
161 &mc_args__netfs_logfile
,
162 N_("Log ftp dialog to specified file"),
165 #endif /* ENABLE_VFS_FTP */
166 #ifdef ENABLE_VFS_SMB
168 "debuglevel", 'D', G_OPTION_FLAG_IN_MAIN
, G_OPTION_ARG_INT
,
169 &mc_args__debug_level
,
170 N_("Set debug level"),
173 #endif /* ENABLE_VFS_SMB */
175 /* single file operations */
177 "view", 'v', G_OPTION_FLAG_IN_MAIN
, G_OPTION_ARG_CALLBACK
,
179 N_("Launches the file viewer on a file"),
184 "edit", 'e', G_OPTION_FLAG_IN_MAIN
, G_OPTION_ARG_CALLBACK
,
186 N_("Edits one file"),
190 NULL
, '\0', 0, 0, NULL
, NULL
, NULL
/* Complete struct initialization */
195 GOptionGroup
*terminal_group
;
196 #define ARGS_TERM_OPTIONS 0
197 static const GOptionEntry argument_terminal_table
[] = {
199 /* terminal options */
201 "xterm", 'x', ARGS_TERM_OPTIONS
, G_OPTION_ARG_NONE
,
202 &mc_args__force_xterm
,
203 N_("Forces xterm features"),
208 "no-x11", 'X', ARGS_TERM_OPTIONS
, G_OPTION_ARG_NONE
,
209 &mc_global
.tty
.disable_x11
,
210 N_("Disable X11 support"),
215 "oldmouse", 'g', ARGS_TERM_OPTIONS
, G_OPTION_ARG_NONE
,
216 &mc_global
.tty
.old_mouse
,
217 N_("Tries to use an old highlight mouse tracking"),
222 "nomouse", 'd', ARGS_TERM_OPTIONS
, G_OPTION_ARG_NONE
,
224 N_("Disable mouse support in text version"),
230 "termcap", 't', ARGS_TERM_OPTIONS
, G_OPTION_ARG_NONE
,
232 N_("Tries to use termcap instead of terminfo"),
238 "slow", 's', ARGS_TERM_OPTIONS
, G_OPTION_ARG_NONE
,
239 &mc_global
.tty
.slow_terminal
,
240 N_("To run on slow terminals"),
245 "stickchars", 'a', ARGS_TERM_OPTIONS
, G_OPTION_ARG_NONE
,
246 &mc_global
.tty
.ugly_line_drawing
,
247 N_("Use stickchars to draw"),
252 "resetsoft", 'k', ARGS_TERM_OPTIONS
, G_OPTION_ARG_NONE
,
254 N_("Resets soft keys on HP terminals"),
259 "keymap", 'K', ARGS_TERM_OPTIONS
, G_OPTION_ARG_STRING
,
260 &mc_args__keymap_file
,
261 N_("Load definitions of key bindings from specified file"),
266 "nokeymap", '\0', ARGS_TERM_OPTIONS
, G_OPTION_ARG_NONE
,
268 N_("Don't load definitions of key bindings from file, use defaults"),
273 NULL
, '\0', 0, 0, NULL
, NULL
, NULL
/* Complete struct initialization */
278 #undef ARGS_TERM_OPTIONS
280 GOptionGroup
*color_group
;
281 #define ARGS_COLOR_OPTIONS 0
282 /* #define ARGS_COLOR_OPTIONS G_OPTION_FLAG_IN_MAIN */
283 static const GOptionEntry argument_color_table
[] = {
287 "nocolor", 'b', ARGS_COLOR_OPTIONS
, G_OPTION_ARG_NONE
,
288 &mc_global
.tty
.disable_colors
,
289 N_("Requests to run in black and white"),
294 "color", 'c', ARGS_COLOR_OPTIONS
, G_OPTION_ARG_NONE
,
295 &mc_args__force_colors
,
296 N_("Request to run in color mode"),
301 "colors", 'C', ARGS_COLOR_OPTIONS
, G_OPTION_ARG_STRING
,
302 &mc_global
.tty
.command_line_colors
,
303 N_("Specifies a color configuration"),
308 "skin", 'S', ARGS_COLOR_OPTIONS
, G_OPTION_ARG_STRING
,
310 N_("Show mc with specified skin"),
315 NULL
, '\0', 0, 0, NULL
, NULL
, NULL
/* Complete struct initialization */
320 #undef ARGS_COLOR_OPTIONS
322 static gchar
*mc_args__loc__colors_string
= NULL
;
323 static gchar
*mc_args__loc__footer_string
= NULL
;
324 static gchar
*mc_args__loc__header_string
= NULL
;
325 static gchar
*mc_args__loc__usage_string
= NULL
;
327 /*** file scope functions ************************************************************************/
329 /* --------------------------------------------------------------------------------------------- */
331 mc_args_clean_temp_help_strings (void)
333 g_free (mc_args__loc__colors_string
);
334 mc_args__loc__colors_string
= NULL
;
336 g_free (mc_args__loc__footer_string
);
337 mc_args__loc__footer_string
= NULL
;
339 g_free (mc_args__loc__header_string
);
340 mc_args__loc__header_string
= NULL
;
342 g_free (mc_args__loc__usage_string
);
343 mc_args__loc__usage_string
= NULL
;
346 /* --------------------------------------------------------------------------------------------- */
348 static GOptionGroup
*
349 mc_args_new_color_group (void)
352 /* FIXME: to preserve translations, lines should be split. */
353 mc_args__loc__colors_string
= g_strdup_printf ("%s\n%s",
354 /* TRANSLATORS: don't translate keywords */
355 _("--colors KEYWORD={FORE},{BACK},{ATTR}:KEYWORD2=...\n\n"
356 "{FORE}, {BACK} and {ATTR} can be omitted, and the default will be used\n"
358 " Global: errors, disabled, reverse, gauge, header\n"
359 " input, inputmark, inputunchanged, commandlinemark\n"
360 " bbarhotkey, bbarbutton, statusbar\n"
361 " File display: normal, selected, marked, markselect\n"
362 " Dialog boxes: dnormal, dfocus, dhotnormal, dhotfocus, errdhotnormal,\n"
364 " Menus: menunormal, menuhot, menusel, menuhotsel, menuinactive\n"
365 " Popup menus: pmenunormal, pmenusel, pmenutitle\n"
366 " Editor: editnormal, editbold, editmarked, editwhitespace,\n"
368 " Viewer: viewbold, viewunderline, viewselected\n"
369 " Help: helpnormal, helpitalic, helpbold, helplink, helpslink\n"),
370 /* TRANSLATORS: don't translate color names and attributes */
371 _("Standard Colors:\n"
372 " black, gray, red, brightred, green, brightgreen, brown,\n"
373 " yellow, blue, brightblue, magenta, brightmagenta, cyan,\n"
374 " brightcyan, lightgray and white\n\n"
375 "Extended colors, when 256 colors are available:\n"
376 " color16 to color255, or rgb000 to rgb555 and gray0 to gray23\n\n"
378 " bold, underline, reverse, blink; append more with '+'\n")
382 return g_option_group_new ("color", mc_args__loc__colors_string
,
383 _("Color options"), NULL
, NULL
);
387 /* --------------------------------------------------------------------------------------------- */
390 mc_args_add_usage_info (void)
392 mc_args__loc__usage_string
= g_strdup_printf ("[%s] %s\n %s - %s\n",
394 _("[this_dir] [other_panel_dir]"),
397 ("Set initial line number for the internal editor"));
398 return mc_args__loc__usage_string
;
401 /* --------------------------------------------------------------------------------------------- */
404 mc_args_add_extended_info_to_help (void)
406 mc_args__loc__footer_string
= g_strdup_printf ("%s",
409 "Please send any bug reports (including the output of `mc -V')\n"
410 "as tickets at www.midnight-commander.org\n"));
411 mc_args__loc__header_string
= g_strdup_printf (_("GNU Midnight Commander %s\n"), VERSION
);
413 g_option_context_set_description (context
, mc_args__loc__footer_string
);
414 g_option_context_set_summary (context
, mc_args__loc__header_string
);
417 /* --------------------------------------------------------------------------------------------- */
420 mc_args__convert_help_to_syscharset (const gchar
* charset
, const gchar
* error_message
,
421 const gchar
* help_str
)
425 gchar
*full_help_str
;
427 buffer
= g_string_new ("");
428 conv
= g_iconv_open (charset
, "UTF-8");
429 full_help_str
= g_strdup_printf ("%s\n\n%s\n", error_message
, help_str
);
431 str_convert (conv
, full_help_str
, buffer
);
433 g_free (full_help_str
);
434 g_iconv_close (conv
);
436 return g_string_free (buffer
, FALSE
);
439 /* --------------------------------------------------------------------------------------------- */
442 parse_mc_e_argument (const gchar
* option_name
, const gchar
* value
, gpointer data
, GError
** error
)
448 mc_global
.mc_run_mode
= MC_RUN_EDITOR
;
449 mc_run_param0
= g_strdup (value
);
454 /* --------------------------------------------------------------------------------------------- */
457 parse_mc_v_argument (const gchar
* option_name
, const gchar
* value
, gpointer data
, GError
** error
)
463 mc_global
.mc_run_mode
= MC_RUN_VIEWER
;
464 mc_run_param0
= g_strdup (value
);
469 /* --------------------------------------------------------------------------------------------- */
470 /*** public functions ****************************************************************************/
471 /* --------------------------------------------------------------------------------------------- */
474 mc_args_parse (int *argc
, char ***argv
, const char *translation_domain
, GError
** error
)
476 const gchar
*_system_codepage
;
479 _system_codepage
= str_detect_termencoding ();
482 if (!str_isutf8 (_system_codepage
))
483 bind_textdomain_codeset ("mc", "UTF-8");
486 context
= g_option_context_new (mc_args_add_usage_info ());
488 g_option_context_set_ignore_unknown_options (context
, FALSE
);
490 mc_args_add_extended_info_to_help ();
492 main_group
= g_option_group_new ("main", _("Main options"), _("Main options"), NULL
, NULL
);
494 g_option_group_add_entries (main_group
, argument_main_table
);
495 g_option_context_set_main_group (context
, main_group
);
496 g_option_group_set_translation_domain (main_group
, translation_domain
);
498 terminal_group
= g_option_group_new ("terminal", _("Terminal options"),
499 _("Terminal options"), NULL
, NULL
);
501 g_option_group_add_entries (terminal_group
, argument_terminal_table
);
502 g_option_context_add_group (context
, terminal_group
);
503 g_option_group_set_translation_domain (terminal_group
, translation_domain
);
505 color_group
= mc_args_new_color_group ();
507 g_option_group_add_entries (color_group
, argument_color_table
);
508 g_option_context_add_group (context
, color_group
);
509 g_option_group_set_translation_domain (color_group
, translation_domain
);
511 if (!g_option_context_parse (context
, argc
, argv
, error
))
513 GError
*error2
= NULL
;
516 *error
= g_error_new (MC_ERROR
, 0, "%s\n", _("Arguments parse error!"));
521 #if GLIB_CHECK_VERSION(2,14,0)
522 help_str
= g_option_context_get_help (context
, TRUE
, NULL
);
524 help_str
= g_strdup ("");
526 if (str_isutf8 (_system_codepage
))
527 error2
= g_error_new ((*error
)->domain
, (*error
)->code
, "%s\n\n%s\n",
528 (*error
)->message
, help_str
);
531 gchar
*full_help_str
;
534 mc_args__convert_help_to_syscharset (_system_codepage
, (*error
)->message
,
536 error2
= g_error_new ((*error
)->domain
, (*error
)->code
, "%s", full_help_str
);
537 g_free (full_help_str
);
541 g_error_free (*error
);
548 g_option_context_free (context
);
549 mc_args_clean_temp_help_strings ();
552 if (!str_isutf8 (_system_codepage
))
553 bind_textdomain_codeset ("mc", _system_codepage
);
559 /* --------------------------------------------------------------------------------------------- */
562 mc_args_show_info (void)
564 if (mc_args__show_version
)
570 if (mc_args__show_datadirs
)
572 printf ("%s (%s)\n", mc_global
.sysconfig_dir
, mc_global
.share_data_dir
);
576 if (mc_args__show_datadirs_extended
)
578 show_datadirs_extended ();
582 if (mc_args__show_configure_opts
)
584 show_configure_options ();
591 /* --------------------------------------------------------------------------------------------- */
594 mc_setup_by_args (int argc
, char **argv
, GError
** error
)
599 if (mc_args__force_colors
)
600 mc_global
.tty
.disable_colors
= FALSE
;
602 #ifdef HAVE_SUBSHELL_SUPPORT
603 if (mc_args__nouse_subshell
)
604 mc_global
.tty
.use_subshell
= FALSE
;
605 #endif /* HAVE_SUBSHELL_SUPPORT */
607 #ifdef ENABLE_VFS_SMB
608 if (mc_args__debug_level
!= 0)
609 smbfs_set_debug (mc_args__debug_level
);
610 #endif /* ENABLE_VFS_SMB */
612 #if defined ENABLE_VFS_FTP || defined ENABLE_VFS_FTP
613 if (mc_args__netfs_logfile
!= NULL
)
617 #ifdef ENABLE_VFS_FTP
618 vpath
= vfs_path_from_str ("ftp://");
619 mc_setctl (vpath
, VFS_SETCTL_LOGFILE
, (void *) mc_args__netfs_logfile
);
620 vfs_path_free (vpath
);
621 #endif /* ENABLE_VFS_FTP */
622 #ifdef ENABLE_VFS_SMB
623 vpath
= vfs_path_from_str ("smb://");
624 mc_setctl (vpath
, VFS_SETCTL_LOGFILE
, (void *) mc_args__netfs_logfile
);
625 vfs_path_free (vpath
);
626 #endif /* ENABLE_VFS_SMB */
628 #endif /* ENABLE_VFS_FTP || ENABLE_VFS_SMB */
630 base
= x_basename (argv
[0]);
631 tmp
= (argc
> 0) ? argv
[1] : NULL
;
633 if (strncmp (base
, "mce", 3) == 0 || strcmp (base
, "vi") == 0)
635 /* mce* or vi is link to mc */
637 mc_run_param0
= g_strdup ("");
641 * Check for filename:lineno, followed by an optional colon.
642 * This format is used by many programs (especially compilers)
643 * in error messages and warnings. It is supported so that
644 * users can quickly copy and paste file locations.
648 end
= tmp
+ strlen (tmp
);
651 if (p
> tmp
&& p
[-1] == ':')
653 while (p
> tmp
&& g_ascii_isdigit ((gchar
) p
[-1]))
655 if (tmp
< p
&& p
< end
&& p
[-1] == ':')
659 vfs_path_t
*tmp_vpath
, *fname_vpath
;
662 fname
= g_strndup (tmp
, p
- 1 - tmp
);
663 tmp_vpath
= vfs_path_from_str (tmp
);
664 fname_vpath
= vfs_path_from_str (fname
);
666 * Check that the file before the colon actually exists.
667 * If it doesn't exist, revert to the old behavior.
669 ok
= mc_stat (tmp_vpath
, &st
) == -1 && mc_stat (fname_vpath
, &st
) != -1;
670 vfs_path_free (tmp_vpath
);
671 vfs_path_free (fname_vpath
);
675 mc_run_param0
= fname
;
676 mc_args__edit_start_line
= atoi (p
);
681 goto try_plus_filename
;
687 if (*tmp
== '+' && g_ascii_isdigit ((gchar
) tmp
[1]))
691 start_line
= atoi (tmp
);
694 * If start_line is zero, position the cursor at the
695 * beginning of the file as other editors (vi, nano)
704 file
= (argc
> 1) ? argv
[2] : NULL
;
708 mc_args__edit_start_line
= start_line
;
712 mc_run_param0
= g_strdup (tmp
);
715 mc_global
.mc_run_mode
= MC_RUN_EDITOR
;
717 else if (strncmp (base
, "mcv", 3) == 0 || strcmp (base
, "view") == 0)
719 /* mcv* or view is link to mc */
722 mc_run_param0
= g_strdup (tmp
);
725 *error
= g_error_new (MC_ERROR
, 0, "%s\n", _("No arguments given to the viewer."));
728 mc_global
.mc_run_mode
= MC_RUN_VIEWER
;
731 else if (strncmp (base
, "mcd", 3) == 0 || strcmp (base
, "diff") == 0)
733 /* mcd* or diff is link to mc */
737 *error
= g_error_new (MC_ERROR
, 0, "%s\n",
738 _("Two files are required to evoke the diffviewer."));
744 mc_run_param0
= g_strdup (tmp
);
745 tmp
= (argc
> 1) ? argv
[2] : NULL
;
747 mc_run_param1
= g_strdup (tmp
);
748 mc_global
.mc_run_mode
= MC_RUN_DIFFVIEWER
;
751 #endif /* USE_DIFF_VIEW */
754 /* MC is run as mc */
756 switch (mc_global
.mc_run_mode
)
760 /* mc_run_param0 is set up in parse_mc_e_argument() and parse_mc_v_argument() */
763 case MC_RUN_DIFFVIEWER
:
764 /* not implemented yet */
769 /* sets the current dir and the other dir */
772 mc_run_param0
= g_strdup (tmp
);
773 tmp
= (argc
> 1) ? argv
[2] : NULL
;
775 mc_run_param1
= g_strdup (tmp
);
777 mc_global
.mc_run_mode
= MC_RUN_FULL
;
785 /* --------------------------------------------------------------------------------------------- */