2 Handle command line arguments.
4 Copyright (C) 2009-2017
5 Free Software Foundation, Inc.
8 Slava Zanko <slavazanko@gmail.com>, 2009.
9 Andrew Borodin <aborodin@vmail.ru>, 2011, 2012.
11 This file is part of the Midnight Commander.
13 The Midnight Commander is free software: you can redistribute it
14 and/or modify it under the terms of the GNU General Public License as
15 published by the Free Software Foundation, either version 3 of the License,
16 or (at your option) any later version.
18 The Midnight Commander is distributed in the hope that it will be useful,
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 GNU General Public License for more details.
23 You should have received a copy of the GNU General Public License
24 along with this program. If not, see <http://www.gnu.org/licenses/>.
31 #include "lib/global.h"
32 #include "lib/tty/tty.h"
33 #include "lib/strutil.h"
34 #include "lib/vfs/vfs.h"
35 #include "lib/util.h" /* x_basename() */
38 #include "src/vfs/smbfs/smbfs.h" /* smbfs_set_debugf() */
41 #include "src/textconf.h"
45 /*** external variables **************************************************************************/
47 /*** global variables ****************************************************************************/
49 /* If true, assume we are running on an xterm terminal */
50 gboolean mc_args__force_xterm
= FALSE
;
52 gboolean mc_args__nomouse
= FALSE
;
54 /* Force colors, only used by Slang */
55 gboolean mc_args__force_colors
= FALSE
;
57 /* Don't load keymap from file and use default one */
58 gboolean mc_args__nokeymap
= FALSE
;
60 char *mc_args__last_wd_file
= NULL
;
62 /* when enabled NETCODE, use folowing file as logfile */
63 char *mc_args__netfs_logfile
= NULL
;
66 char *mc_args__keymap_file
= NULL
;
70 int mc_args__debug_level
= 0;
73 void *mc_run_param0
= NULL
;
74 char *mc_run_param1
= NULL
;
76 /*** file scope macro definitions ****************************************************************/
78 /*** file scope type declarations ****************************************************************/
80 /*** file scope variables ************************************************************************/
82 /* If true, show version info and exit */
83 static gboolean mc_args__show_version
= FALSE
;
85 /* forward declarations */
86 static gboolean
parse_mc_e_argument (const gchar
* option_name
, const gchar
* value
,
87 gpointer data
, GError
** mcerror
);
88 static gboolean
parse_mc_v_argument (const gchar
* option_name
, const gchar
* value
,
89 gpointer data
, GError
** mcerror
);
91 static GOptionContext
*context
;
93 #ifdef ENABLE_SUBSHELL
94 static gboolean mc_args__nouse_subshell
= FALSE
;
95 #endif /* ENABLE_SUBSHELL */
96 static gboolean mc_args__show_datadirs
= FALSE
;
97 static gboolean mc_args__show_datadirs_extended
= FALSE
;
98 static gboolean mc_args__show_configure_opts
= FALSE
;
100 static GOptionGroup
*main_group
;
102 static const GOptionEntry argument_main_table
[] = {
104 /* generic options */
106 "version", 'V', G_OPTION_FLAG_IN_MAIN
, G_OPTION_ARG_NONE
,
107 &mc_args__show_version
,
108 N_("Displays the current version"),
112 /* options for wrappers */
114 "datadir", 'f', G_OPTION_FLAG_IN_MAIN
, G_OPTION_ARG_NONE
,
115 &mc_args__show_datadirs
,
116 N_("Print data directory"),
120 /* show extended information about used data directories */
122 "datadir-info", 'F', G_OPTION_FLAG_IN_MAIN
, G_OPTION_ARG_NONE
,
123 &mc_args__show_datadirs_extended
,
124 N_("Print extended info about used data directories"),
128 /* show configure options */
130 "configure-options", '\0', G_OPTION_FLAG_IN_MAIN
, G_OPTION_ARG_NONE
,
131 &mc_args__show_configure_opts
,
132 N_("Print configure options"),
137 "printwd", 'P', G_OPTION_FLAG_IN_MAIN
, G_OPTION_ARG_STRING
,
138 &mc_args__last_wd_file
,
139 N_("Print last working directory to specified file"),
143 #ifdef ENABLE_SUBSHELL
145 "subshell", 'U', G_OPTION_FLAG_IN_MAIN
, G_OPTION_ARG_NONE
,
146 &mc_global
.tty
.use_subshell
,
147 N_("Enables subshell support (default)"),
152 "nosubshell", 'u', G_OPTION_FLAG_IN_MAIN
, G_OPTION_ARG_NONE
,
153 &mc_args__nouse_subshell
,
154 N_("Disables subshell support"),
160 #ifdef ENABLE_VFS_FTP
162 "ftplog", 'l', G_OPTION_FLAG_IN_MAIN
, G_OPTION_ARG_STRING
,
163 &mc_args__netfs_logfile
,
164 N_("Log ftp dialog to specified file"),
167 #endif /* ENABLE_VFS_FTP */
168 #ifdef ENABLE_VFS_SMB
170 "debuglevel", 'D', G_OPTION_FLAG_IN_MAIN
, G_OPTION_ARG_INT
,
171 &mc_args__debug_level
,
172 N_("Set debug level"),
175 #endif /* ENABLE_VFS_SMB */
178 /* handle arguments manually */
179 "view", 'v', G_OPTION_FLAG_IN_MAIN
| G_OPTION_FLAG_NO_ARG
, G_OPTION_ARG_CALLBACK
,
180 (gpointer
) parse_mc_v_argument
,
181 N_("Launches the file viewer on a file"),
186 /* handle arguments manually */
187 "edit", 'e', G_OPTION_FLAG_IN_MAIN
| G_OPTION_FLAG_NO_ARG
, G_OPTION_ARG_CALLBACK
,
188 (gpointer
) parse_mc_e_argument
,
193 NULL
, '\0', 0, 0, NULL
, NULL
, NULL
/* Complete struct initialization */
198 static GOptionGroup
*terminal_group
;
199 #define ARGS_TERM_OPTIONS 0
200 static const GOptionEntry argument_terminal_table
[] = {
202 /* terminal options */
204 "xterm", 'x', ARGS_TERM_OPTIONS
, G_OPTION_ARG_NONE
,
205 &mc_args__force_xterm
,
206 N_("Forces xterm features"),
211 "no-x11", 'X', ARGS_TERM_OPTIONS
, G_OPTION_ARG_NONE
,
212 &mc_global
.tty
.disable_x11
,
213 N_("Disable X11 support"),
218 "oldmouse", 'g', ARGS_TERM_OPTIONS
, G_OPTION_ARG_NONE
,
219 &mc_global
.tty
.old_mouse
,
220 N_("Tries to use an old highlight mouse tracking"),
225 "nomouse", 'd', ARGS_TERM_OPTIONS
, G_OPTION_ARG_NONE
,
227 N_("Disable mouse support in text version"),
233 "termcap", 't', ARGS_TERM_OPTIONS
, G_OPTION_ARG_NONE
,
235 N_("Tries to use termcap instead of terminfo"),
241 "slow", 's', ARGS_TERM_OPTIONS
, G_OPTION_ARG_NONE
,
242 &mc_global
.tty
.slow_terminal
,
243 N_("To run on slow terminals"),
248 "stickchars", 'a', ARGS_TERM_OPTIONS
, G_OPTION_ARG_NONE
,
249 &mc_global
.tty
.ugly_line_drawing
,
250 N_("Use stickchars to draw"),
256 "resetsoft", 'k', ARGS_TERM_OPTIONS
, G_OPTION_ARG_NONE
,
258 N_("Resets soft keys on HP terminals"),
264 "keymap", 'K', ARGS_TERM_OPTIONS
, G_OPTION_ARG_STRING
,
265 &mc_args__keymap_file
,
266 N_("Load definitions of key bindings from specified file"),
271 "nokeymap", '\0', ARGS_TERM_OPTIONS
, G_OPTION_ARG_NONE
,
273 N_("Don't load definitions of key bindings from file, use defaults"),
278 NULL
, '\0', 0, 0, NULL
, NULL
, NULL
/* Complete struct initialization */
283 #undef ARGS_TERM_OPTIONS
285 static GOptionGroup
*color_group
;
286 #define ARGS_COLOR_OPTIONS 0
287 /* #define ARGS_COLOR_OPTIONS G_OPTION_FLAG_IN_MAIN */
288 static const GOptionEntry argument_color_table
[] = {
292 "nocolor", 'b', ARGS_COLOR_OPTIONS
, G_OPTION_ARG_NONE
,
293 &mc_global
.tty
.disable_colors
,
294 N_("Requests to run in black and white"),
299 "color", 'c', ARGS_COLOR_OPTIONS
, G_OPTION_ARG_NONE
,
300 &mc_args__force_colors
,
301 N_("Request to run in color mode"),
306 "colors", 'C', ARGS_COLOR_OPTIONS
, G_OPTION_ARG_STRING
,
307 &mc_global
.tty
.command_line_colors
,
308 N_("Specifies a color configuration"),
313 "skin", 'S', ARGS_COLOR_OPTIONS
, G_OPTION_ARG_STRING
,
315 N_("Show mc with specified skin"),
320 NULL
, '\0', 0, 0, NULL
, NULL
, NULL
/* Complete struct initialization */
325 #undef ARGS_COLOR_OPTIONS
327 static gchar
*mc_args__loc__colors_string
= NULL
;
328 static gchar
*mc_args__loc__footer_string
= NULL
;
329 static gchar
*mc_args__loc__header_string
= NULL
;
330 static gchar
*mc_args__loc__usage_string
= NULL
;
332 /*** file scope functions ************************************************************************/
334 /* --------------------------------------------------------------------------------------------- */
336 mc_args_clean_temp_help_strings (void)
338 MC_PTR_FREE (mc_args__loc__colors_string
);
339 MC_PTR_FREE (mc_args__loc__footer_string
);
340 MC_PTR_FREE (mc_args__loc__header_string
);
341 MC_PTR_FREE (mc_args__loc__usage_string
);
344 /* --------------------------------------------------------------------------------------------- */
346 static GOptionGroup
*
347 mc_args_new_color_group (void)
350 /* FIXME: to preserve translations, lines should be split. */
351 mc_args__loc__colors_string
= g_strdup_printf ("%s\n%s",
352 /* TRANSLATORS: don't translate keywords */
353 _("--colors KEYWORD={FORE},{BACK},{ATTR}:KEYWORD2=...\n\n"
354 "{FORE}, {BACK} and {ATTR} can be omitted, and the default will be used\n"
356 " Global: errors, disabled, reverse, gauge, header\n"
357 " input, inputmark, inputunchanged, commandlinemark\n"
358 " bbarhotkey, bbarbutton, statusbar\n"
359 " File display: normal, selected, marked, markselect\n"
360 " Dialog boxes: dnormal, dfocus, dhotnormal, dhotfocus, errdhotnormal,\n"
362 " Menus: menunormal, menuhot, menusel, menuhotsel, menuinactive\n"
363 " Popup menus: pmenunormal, pmenusel, pmenutitle\n"
364 " Editor: editnormal, editbold, editmarked, editwhitespace,\n"
365 " editlinestate, editbg, editframe, editframeactive\n"
367 " Viewer: viewnormal,viewbold, viewunderline, viewselected\n"
368 " Help: helpnormal, helpitalic, helpbold, helplink, helpslink\n"),
369 /* TRANSLATORS: don't translate color names and attributes */
370 _("Standard Colors:\n"
371 " black, gray, red, brightred, green, brightgreen, brown,\n"
372 " yellow, blue, brightblue, magenta, brightmagenta, cyan,\n"
373 " brightcyan, lightgray and white\n\n"
374 "Extended colors, when 256 colors are available:\n"
375 " color16 to color255, or rgb000 to rgb555 and gray0 to gray23\n\n"
377 " bold, italic, underline, reverse, blink; append more with '+'\n")
381 return g_option_group_new ("color", mc_args__loc__colors_string
,
382 _("Color options"), NULL
, NULL
);
386 /* --------------------------------------------------------------------------------------------- */
389 mc_args_add_usage_info (void)
393 switch (mc_global
.mc_run_mode
)
396 s
= g_strdup_printf ("%s\n", _("[+lineno] file1[:lineno] [file2[:lineno]...]"));
399 s
= g_strdup_printf ("%s\n", _("file"));
402 case MC_RUN_DIFFVIEWER
:
403 s
= g_strdup_printf ("%s\n", _("file1 file2"));
405 #endif /* USE_DIFF_VIEW */
408 s
= g_strdup_printf ("%s\n", _("[this_dir] [other_panel_dir]"));
411 mc_args__loc__usage_string
= s
;
413 return mc_args__loc__usage_string
;
416 /* --------------------------------------------------------------------------------------------- */
419 mc_args_add_extended_info_to_help (void)
421 mc_args__loc__footer_string
= g_strdup_printf ("%s",
424 "Please send any bug reports (including the output of 'mc -V')\n"
425 "as tickets at www.midnight-commander.org\n"));
426 mc_args__loc__header_string
= g_strdup_printf (_("GNU Midnight Commander %s\n"), VERSION
);
428 g_option_context_set_description (context
, mc_args__loc__footer_string
);
429 g_option_context_set_summary (context
, mc_args__loc__header_string
);
432 /* --------------------------------------------------------------------------------------------- */
435 mc_args__convert_help_to_syscharset (const gchar
* charset
, const gchar
* error_message_str
,
436 const gchar
* help_str
)
440 gchar
*full_help_str
;
442 buffer
= g_string_new ("");
443 conv
= g_iconv_open (charset
, "UTF-8");
444 full_help_str
= g_strdup_printf ("%s\n\n%s\n", error_message_str
, help_str
);
446 str_convert (conv
, full_help_str
, buffer
);
448 g_free (full_help_str
);
449 g_iconv_close (conv
);
451 return g_string_free (buffer
, FALSE
);
454 /* --------------------------------------------------------------------------------------------- */
457 parse_mc_e_argument (const gchar
* option_name
, const gchar
* value
, gpointer data
,
464 mc_return_val_if_error (mcerror
, FALSE
);
466 mc_global
.mc_run_mode
= MC_RUN_EDITOR
;
471 /* --------------------------------------------------------------------------------------------- */
474 parse_mc_v_argument (const gchar
* option_name
, const gchar
* value
, gpointer data
,
481 mc_return_val_if_error (mcerror
, FALSE
);
483 mc_global
.mc_run_mode
= MC_RUN_VIEWER
;
488 /* --------------------------------------------------------------------------------------------- */
490 * Create mcedit_arg_t object from vfs_path_t object and the line number.
492 * @param file_vpath file path object
493 * @param line_number line number. If value is 0, try to restore saved position.
494 * @return mcedit_arg_t object
497 static mcedit_arg_t
*
498 mcedit_arg_vpath_new (vfs_path_t
* file_vpath
, long line_number
)
502 arg
= g_new (mcedit_arg_t
, 1);
503 arg
->file_vpath
= file_vpath
;
504 arg
->line_number
= line_number
;
509 /* --------------------------------------------------------------------------------------------- */
511 * Create mcedit_arg_t object from file name and the line number.
513 * @param file_name file name
514 * @param line_number line number. If value is 0, try to restore saved position.
515 * @return mcedit_arg_t object
518 static mcedit_arg_t
*
519 mcedit_arg_new (const char *file_name
, long line_number
)
521 return mcedit_arg_vpath_new (vfs_path_from_str (file_name
), line_number
);
524 /* --------------------------------------------------------------------------------------------- */
526 * Get list of filenames (and line numbers) from command line, when mc called as editor
528 * @param argc count of all arguments
529 * @param argv array of strings, contains arguments
530 * @return list of mcedit_arg_t objects
534 parse_mcedit_arguments (int argc
, char **argv
)
538 long first_line_number
= -1;
540 for (i
= 0; i
< argc
; i
++)
549 * First, try to get line number as +lineno.
556 lineno
= strtol (tmp
+ 1, &error
, 10);
560 /* this is line number */
561 first_line_number
= lineno
;
564 /* this is file name */
568 * Check for filename:lineno, followed by an optional colon.
569 * This format is used by many programs (especially compilers)
570 * in error messages and warnings. It is supported so that
571 * users can quickly copy and paste file locations.
573 end
= tmp
+ strlen (tmp
);
576 if (p
> tmp
&& p
[-1] == ':')
578 while (p
> tmp
&& g_ascii_isdigit ((gchar
) p
[-1]))
581 if (tmp
< p
&& p
< end
&& p
[-1] == ':')
584 vfs_path_t
*tmp_vpath
, *fname_vpath
;
587 fname
= g_strndup (tmp
, p
- 1 - tmp
);
588 tmp_vpath
= vfs_path_from_str (tmp
);
589 fname_vpath
= vfs_path_from_str (fname
);
592 * Check that the file before the colon actually exists.
593 * If it doesn't exist, create new file.
595 if (mc_stat (tmp_vpath
, &st
) == -1 && mc_stat (fname_vpath
, &st
) != -1)
597 arg
= mcedit_arg_vpath_new (fname_vpath
, atoi (p
));
598 vfs_path_free (tmp_vpath
);
602 arg
= mcedit_arg_vpath_new (tmp_vpath
, 0);
603 vfs_path_free (fname_vpath
);
609 arg
= mcedit_arg_new (tmp
, 0);
611 flist
= g_list_prepend (flist
, arg
);
615 flist
= g_list_prepend (flist
, mcedit_arg_new (NULL
, 0));
616 else if (first_line_number
!= -1)
618 /* overwrite line number for first file */
621 l
= g_list_last (flist
);
622 ((mcedit_arg_t
*) l
->data
)->line_number
= first_line_number
;
628 /* --------------------------------------------------------------------------------------------- */
629 /*** public functions ****************************************************************************/
630 /* --------------------------------------------------------------------------------------------- */
633 mc_setup_run_mode (char **argv
)
637 base
= x_basename (argv
[0]);
639 if (strncmp (base
, "mce", 3) == 0 || strcmp (base
, "vi") == 0)
641 /* mce* or vi is link to mc */
642 mc_global
.mc_run_mode
= MC_RUN_EDITOR
;
644 else if (strncmp (base
, "mcv", 3) == 0 || strcmp (base
, "view") == 0)
646 /* mcv* or view is link to mc */
647 mc_global
.mc_run_mode
= MC_RUN_VIEWER
;
650 else if (strncmp (base
, "mcd", 3) == 0 || strcmp (base
, "diff") == 0)
652 /* mcd* or diff is link to mc */
653 mc_global
.mc_run_mode
= MC_RUN_DIFFVIEWER
;
655 #endif /* USE_DIFF_VIEW */
659 mc_args_parse (int *argc
, char ***argv
, const char *translation_domain
, GError
** mcerror
)
661 const gchar
*_system_codepage
;
664 mc_return_val_if_error (mcerror
, FALSE
);
666 _system_codepage
= str_detect_termencoding ();
669 if (!str_isutf8 (_system_codepage
))
670 bind_textdomain_codeset ("mc", "UTF-8");
673 context
= g_option_context_new (mc_args_add_usage_info ());
675 g_option_context_set_ignore_unknown_options (context
, FALSE
);
677 mc_args_add_extended_info_to_help ();
679 main_group
= g_option_group_new ("main", _("Main options"), _("Main options"), NULL
, NULL
);
681 g_option_group_add_entries (main_group
, argument_main_table
);
682 g_option_context_set_main_group (context
, main_group
);
683 g_option_group_set_translation_domain (main_group
, translation_domain
);
685 terminal_group
= g_option_group_new ("terminal", _("Terminal options"),
686 _("Terminal options"), NULL
, NULL
);
688 g_option_group_add_entries (terminal_group
, argument_terminal_table
);
689 g_option_context_add_group (context
, terminal_group
);
690 g_option_group_set_translation_domain (terminal_group
, translation_domain
);
692 color_group
= mc_args_new_color_group ();
694 g_option_group_add_entries (color_group
, argument_color_table
);
695 g_option_context_add_group (context
, color_group
);
696 g_option_group_set_translation_domain (color_group
, translation_domain
);
698 if (!g_option_context_parse (context
, argc
, argv
, mcerror
))
700 if (*mcerror
== NULL
)
701 mc_propagate_error (mcerror
, 0, "%s\n", _("Arguments parse error!"));
706 help_str
= g_option_context_get_help (context
, TRUE
, NULL
);
708 if (str_isutf8 (_system_codepage
))
709 mc_replace_error (mcerror
, (*mcerror
)->code
, "%s\n\n%s\n", (*mcerror
)->message
,
713 gchar
*full_help_str
;
716 mc_args__convert_help_to_syscharset (_system_codepage
, (*mcerror
)->message
,
718 mc_replace_error (mcerror
, (*mcerror
)->code
, "%s", full_help_str
);
719 g_free (full_help_str
);
727 g_option_context_free (context
);
728 mc_args_clean_temp_help_strings ();
731 if (!str_isutf8 (_system_codepage
))
732 bind_textdomain_codeset ("mc", _system_codepage
);
738 /* --------------------------------------------------------------------------------------------- */
741 mc_args_show_info (void)
743 if (mc_args__show_version
)
749 if (mc_args__show_datadirs
)
751 printf ("%s (%s)\n", mc_global
.sysconfig_dir
, mc_global
.share_data_dir
);
755 if (mc_args__show_datadirs_extended
)
757 show_datadirs_extended ();
761 if (mc_args__show_configure_opts
)
763 show_configure_options ();
770 /* --------------------------------------------------------------------------------------------- */
773 mc_setup_by_args (int argc
, char **argv
, GError
** mcerror
)
777 mc_return_val_if_error (mcerror
, FALSE
);
779 if (mc_args__force_colors
)
780 mc_global
.tty
.disable_colors
= FALSE
;
782 #ifdef ENABLE_SUBSHELL
783 if (mc_args__nouse_subshell
)
784 mc_global
.tty
.use_subshell
= FALSE
;
785 #endif /* ENABLE_SUBSHELL */
787 #ifdef ENABLE_VFS_SMB
788 if (mc_args__debug_level
!= 0)
789 smbfs_set_debug (mc_args__debug_level
);
790 #endif /* ENABLE_VFS_SMB */
792 if (mc_args__netfs_logfile
!= NULL
)
795 #ifdef ENABLE_VFS_FTP
796 vpath
= vfs_path_from_str ("ftp://");
797 mc_setctl (vpath
, VFS_SETCTL_LOGFILE
, (void *) mc_args__netfs_logfile
);
798 vfs_path_free (vpath
);
799 #endif /* ENABLE_VFS_FTP */
800 #ifdef ENABLE_VFS_SMB
801 vpath
= vfs_path_from_str ("smb://");
802 mc_setctl (vpath
, VFS_SETCTL_LOGFILE
, (void *) mc_args__netfs_logfile
);
803 vfs_path_free (vpath
);
804 #endif /* ENABLE_VFS_SMB */
808 tmp
= (argc
> 0) ? argv
[1] : NULL
;
810 switch (mc_global
.mc_run_mode
)
813 mc_run_param0
= parse_mcedit_arguments (argc
- 1, &argv
[1]);
819 mc_propagate_error (mcerror
, 0, "%s\n", _("No arguments given to the viewer."));
823 mc_run_param0
= g_strdup (tmp
);
827 case MC_RUN_DIFFVIEWER
:
830 mc_propagate_error (mcerror
, 0, "%s\n",
831 _("Two files are required to envoke the diffviewer."));
835 #endif /* USE_DIFF_VIEW */
839 /* set the current dir and the other dir for filemanager,
840 or two files for diff viewer */
843 mc_run_param0
= g_strdup (tmp
);
844 tmp
= (argc
> 1) ? argv
[2] : NULL
;
846 mc_run_param1
= g_strdup (tmp
);
854 /* --------------------------------------------------------------------------------------------- */
856 * Free the mcedit_arg_t object.
858 * @param arg mcedit_arg_t object
862 mcedit_arg_free (mcedit_arg_t
* arg
)
864 vfs_path_free (arg
->file_vpath
);
868 /* --------------------------------------------------------------------------------------------- */