src/args.c

   1 /*
   2    Handle command line arguments.
   3
   4    Copyright (C) 2009 The Free Software Foundation, Inc.
   5
   6    Written by:
   7    Slava Zanko <slavazanko@gmail.com>, 2009.
   8
   9    This file is part of the Midnight Commander.
  10
  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.
  15
  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.
  20
  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.
  25  */
  26
  27 #include <config.h>
  28 #include <stdio.h>
  29
  30
  31 #include "lib/global.h"
  32 #include "lib/tty/tty.h"
  33 #include "lib/strutil.h"
  34
  35 #include "src/args.h"
  36 #include "src/textconf.h"
  37
  38 /*** external variables **************************************************************************/
  39
  40 extern int reset_hp_softkeys;
  41 extern int use_subshell;
  42
  43 extern char *mc_home;
  44 extern char *mc_home_alt;
  45
  46 /* colors specified on the command line: they override any other setting */
  47 extern char *command_line_colors;
  48
  49 extern const char *edit_one_file;
  50 extern const char *view_one_file;
  51 /*** global variables ****************************************************************************/
  52
  53 /* If true, show version info and exit */
  54 gboolean mc_args__version = FALSE;
  55
  56 /* If true, assume we are running on an xterm terminal */
  57 gboolean mc_args__force_xterm = FALSE;
  58
  59 gboolean mc_args__nomouse = FALSE;
  60
  61 /* For slow terminals */
  62 gboolean mc_args__slow_terminal = FALSE;
  63
  64 /* If true use +, -, | for line drawing */
  65 gboolean mc_args__ugly_line_drawing = FALSE;
  66
  67 /* Set to force black and white display at program startup */
  68 gboolean mc_args__disable_colors = FALSE;
  69
  70 /* Force colors, only used by Slang */
  71 gboolean mc_args__force_colors = FALSE;
  72
  73 /* Show in specified skin */
  74 char *mc_args__skin = NULL;
  75
  76 char *mc_args__last_wd_file = NULL;
  77
  78 /* when enabled NETCODE, use folowing file as logfile */
  79 char *mc_args__netfs_logfile = NULL;
  80
  81 /* keymap file */
  82 char *mc_args__keymap_file = NULL;
  83
  84 /* Debug level*/
  85 int mc_args__debug_level = 0;
  86
  87
  88 /*** file scope macro definitions ****************************************************************/
  89
  90 /*** file scope type declarations ****************************************************************/
  91
  92 /*** file scope variables ************************************************************************/
  93
  94 static GOptionContext *context;
  95
  96
  97 static gboolean mc_args__nouse_subshell = FALSE;
  98 static gboolean mc_args__show_datadirs = FALSE;
  99
 100 GOptionGroup *main_group;
 101 static const GOptionEntry argument_main_table[] = {
 102     /* generic options */
 103     {
 104      "version", 'V', G_OPTION_FLAG_IN_MAIN, G_OPTION_ARG_NONE,
 105      &mc_args__version,
 106      N_("Displays the current version"),
 107      NULL
 108     },
 109
 110     /* options for wrappers */
 111     {
 112      "datadir", 'f', G_OPTION_FLAG_IN_MAIN, G_OPTION_ARG_NONE,
 113      &mc_args__show_datadirs,
 114      N_("Print data directory"),
 115      NULL
 116     },
 117
 118     {
 119      "printwd", 'P', G_OPTION_FLAG_IN_MAIN, G_OPTION_ARG_STRING,
 120      &mc_args__last_wd_file,
 121      N_("Print last working directory to specified file"),
 122      "<file>"
 123     },
 124
 125 #ifdef HAVE_SUBSHELL_SUPPORT
 126     {
 127      "subshell", 'U', G_OPTION_FLAG_IN_MAIN, G_OPTION_ARG_NONE,
 128      &use_subshell,
 129      N_("Enables subshell support (default)"),
 130      NULL
 131     },
 132
 133     {
 134      "nosubshell", 'u', G_OPTION_FLAG_IN_MAIN, G_OPTION_ARG_NONE,
 135      &mc_args__nouse_subshell,
 136      N_("Disables subshell support"),
 137      NULL
 138     },
 139 #endif
 140
 141     /* debug options */
 142 #ifdef USE_NETCODE
 143     {
 144      "ftplog", 'l', G_OPTION_FLAG_IN_MAIN, G_OPTION_ARG_STRING,
 145      &mc_args__netfs_logfile,
 146      N_("Log ftp dialog to specified file"),
 147      "<file>"
 148     },
 149 #ifdef ENABLE_VFS_SMB
 150     {
 151      "debuglevel", 'D', G_OPTION_FLAG_IN_MAIN, G_OPTION_ARG_INT,
 152      &mc_args__debug_level,
 153      N_("Set debug level"),
 154      "<integer>"
 155     },
 156 #endif /* ENABLE_VFS_SMB */
 157 #endif
 158
 159     /* single file operations */
 160     {
 161      "view", 'v', G_OPTION_FLAG_IN_MAIN, G_OPTION_ARG_STRING,
 162      &view_one_file,
 163      N_("Launches the file viewer on a file"),
 164      "<file>"
 165     },
 166
 167     {
 168      "edit", 'e', G_OPTION_FLAG_IN_MAIN, G_OPTION_ARG_STRING,
 169      &edit_one_file,
 170      N_("Edits one file"),
 171      "<file>"
 172     },
 173
 174     {NULL}
 175 };
 176
 177 GOptionGroup *terminal_group;
 178 #define ARGS_TERM_OPTIONS 0
 179 static const GOptionEntry argument_terminal_table[] = {
 180
 181     /* terminal options */
 182     {
 183      "xterm", 'x', ARGS_TERM_OPTIONS, G_OPTION_ARG_NONE,
 184      &mc_args__force_xterm,
 185      N_("Forces xterm features"),
 186      NULL
 187     },
 188
 189     {
 190      "nomouse", 'd', ARGS_TERM_OPTIONS, G_OPTION_ARG_NONE,
 191      &mc_args__nomouse,
 192      N_("Disable mouse support in text version"),
 193      NULL
 194     },
 195
 196 #ifdef HAVE_SLANG
 197     {
 198      "termcap", 't', ARGS_TERM_OPTIONS, G_OPTION_ARG_NONE,
 199      &SLtt_Try_Termcap,
 200      N_("Tries to use termcap instead of terminfo"),
 201      NULL
 202     },
 203 #endif
 204
 205     {
 206      "slow", 's', ARGS_TERM_OPTIONS, G_OPTION_ARG_NONE,
 207      &mc_args__slow_terminal,
 208      N_("To run on slow terminals"),
 209      NULL
 210     },
 211
 212     {
 213      "stickchars", 'a', ARGS_TERM_OPTIONS, G_OPTION_ARG_NONE,
 214      &mc_args__ugly_line_drawing,
 215      N_("Use stickchars to draw"),
 216      NULL
 217     },
 218
 219     {
 220      "resetsoft", 'k', ARGS_TERM_OPTIONS, G_OPTION_ARG_NONE,
 221      &reset_hp_softkeys,
 222      N_("Resets soft keys on HP terminals"),
 223      NULL
 224     },
 225
 226     {
 227      "keymap", 'K', ARGS_TERM_OPTIONS, G_OPTION_ARG_STRING,
 228      &mc_args__keymap_file,
 229      N_("Load definitions of key bindings from specified file"),
 230      "<file>"
 231     },
 232
 233     {NULL}
 234 };
 235 #undef ARGS_TERM_OPTIONS
 236
 237 GOptionGroup *color_group;
 238 #define ARGS_COLOR_OPTIONS 0
 239 // #define ARGS_COLOR_OPTIONS G_OPTION_FLAG_IN_MAIN
 240 static const GOptionEntry argument_color_table[] = {
 241     /* color options */
 242     {
 243      "nocolor", 'b', ARGS_COLOR_OPTIONS, G_OPTION_ARG_NONE,
 244      &mc_args__disable_colors,
 245      N_("Requests to run in black and white"),
 246      NULL
 247     },
 248
 249     {
 250      "color", 'c', ARGS_COLOR_OPTIONS, G_OPTION_ARG_NONE,
 251      &mc_args__force_colors,
 252      N_("Request to run in color mode"),
 253      NULL
 254     },
 255
 256     {
 257      "colors", 'C', ARGS_COLOR_OPTIONS, G_OPTION_ARG_STRING,
 258      &command_line_colors,
 259      N_("Specifies a color configuration"),
 260      "<string>"
 261     },
 262
 263     {
 264      "skin", 'S', ARGS_COLOR_OPTIONS, G_OPTION_ARG_STRING,
 265      &mc_args__skin,
 266      N_("Show mc with specified skin"),
 267      "<string>"
 268     },
 269
 270     {NULL}
 271 };
 272 #undef ARGS_COLOR_OPTIONS
 273
 274 static gchar *mc_args__loc__colors_string = NULL;
 275 static gchar *mc_args__loc__footer_string = NULL;
 276 static gchar *mc_args__loc__header_string = NULL;
 277 static gchar *mc_args__loc__usage_string = NULL;
 278
 279 /*** file scope functions ************************************************************************/
 280
 281 /* --------------------------------------------------------------------------------------------- */
 282 static void
 283 mc_args_clean_temp_help_strings(void)
 284 {
 285     g_free(mc_args__loc__colors_string);
 286     mc_args__loc__colors_string = NULL;
 287
 288     g_free(mc_args__loc__footer_string);
 289     mc_args__loc__footer_string = NULL;
 290
 291     g_free(mc_args__loc__header_string);
 292     mc_args__loc__header_string = NULL;
 293
 294     g_free(mc_args__loc__usage_string);
 295     mc_args__loc__usage_string = NULL;
 296 }
 297
 298 /* --------------------------------------------------------------------------------------------- */
 299
 300 static GOptionGroup *
 301 mc_args_new_color_group(void)
 302 {
 303     /*
 304      * FIXME: undocumented keywords: viewunderline, editnormal, editbold,
 305      * and editmarked.  To preserve translations, lines should be split.
 306      */
 307
 308     mc_args__loc__colors_string = g_strdup_printf("%s%s",
 309         /* TRANSLATORS: don't translate keywords and names of colors */
 310         _(  "--colors KEYWORD={FORE},{BACK}\n\n"
 311             "{FORE} and {BACK} can be omitted, and the default will be used\n"
 312             "\n" "Keywords:\n"
 313             "   Global:       errors, reverse, gauge, input, viewunderline\n"
 314             "   File display: normal, selected, marked, markselect\n"
 315             "   Dialog boxes: dnormal, dfocus, dhotnormal, dhotfocus, errdhotnormal,\n"
 316             "                 errdhotfocus\n"
 317             "   Menus:        menu, menuhot, menusel, menuhotsel\n"
 318             "   Editor:       editnormal, editbold, editmarked, editwhitespace,\n"
 319             "                 editlinestate\n"),
 320         /* TRANSLATORS: don't translate keywords and names of colors */
 321         _(  "   Help:         helpnormal, helpitalic, helpbold, helplink, helpslink\n"
 322             "\n" "Colors:\n"
 323             "   black, gray, red, brightred, green, brightgreen, brown,\n"
 324             "   yellow, blue, brightblue, magenta, brightmagenta, cyan,\n"
 325             "   brightcyan, lightgray and white\n\n")
 326     );
 327
 328     return g_option_group_new ("color", mc_args__loc__colors_string,
 329                         _("Color options"),NULL, NULL);
 330
 331 }
 332
 333 /* --------------------------------------------------------------------------------------------- */
 334
 335 static gchar *
 336 mc_args_add_usage_info(void)
 337 {
 338     mc_args__loc__usage_string = g_strdup_printf("[%s] %s\n %s - %s\n",
 339         _("+number"),
 340         _("[this_dir] [other_panel_dir]"),
 341         _("+number"),
 342         _("Set initial line number for the internal editor")
 343     );
 344     return mc_args__loc__usage_string;
 345 }
 346
 347 /* --------------------------------------------------------------------------------------------- */
 348
 349 static void
 350 mc_args_add_extended_info_to_help(void)
 351 {
 352     mc_args__loc__footer_string = g_strdup_printf("%s",
 353         _
 354            ("\n"
 355             "Please send any bug reports (including the output of `mc -V')\n"
 356             "to mc-devel@gnome.org\n")
 357     );
 358     mc_args__loc__header_string = g_strdup_printf (_("GNU Midnight Commander %s\n"), VERSION);
 359
 360 #if GLIB_CHECK_VERSION(2,12,0)
 361     g_option_context_set_description (context, mc_args__loc__footer_string);
 362     g_option_context_set_summary (context, mc_args__loc__header_string);
 363 #endif
 364
 365 }
 366
 367 /* --------------------------------------------------------------------------------------------- */
 368
 369 static gboolean
 370 mc_args_process(void)
 371 {
 372     if (mc_args__version){
 373         show_version ();
 374         return FALSE;
 375     }
 376     if (mc_args__show_datadirs){
 377         printf ("%s (%s)\n", mc_home, mc_home_alt);
 378         return FALSE;
 379     }
 380
 381     if (mc_args__force_colors)
 382         mc_args__disable_colors = FALSE;
 383
 384 #ifdef HAVE_SUBSHELL_SUPPORT
 385     if (mc_args__nouse_subshell)
 386         use_subshell = 0;
 387
 388     if (mc_args__nouse_subshell)
 389         use_subshell = 0;
 390 #endif                          /* HAVE_SUBSHELL_SUPPORT */
 391
 392     return TRUE;
 393 }
 394
 395 /* --------------------------------------------------------------------------------------------- */
 396
 397 static gchar *
 398 mc_args__convert_help_to_syscharset(const gchar *charset, const gchar *error_message, const gchar *help_str)
 399 {
 400     GString *buffer = g_string_new("");
 401     GIConv conv = g_iconv_open ( charset, "UTF-8");
 402     gchar *full_help_str = g_strdup_printf("%s\n\n%s\n",error_message,help_str);
 403
 404     str_convert (conv, full_help_str, buffer);
 405
 406     g_free(full_help_str);
 407     g_iconv_close (conv);
 408
 409     return g_string_free(buffer, FALSE);
 410 }
 411
 412 /* --------------------------------------------------------------------------------------------- */
 413
 414 /*** public functions ****************************************************************************/
 415
 416 /* --------------------------------------------------------------------------------------------- */
 417
 418 gboolean
 419 mc_args_handle(int *argc, char ***argv, const gchar *translation_domain)
 420 {
 421     GError *error = NULL;
 422     const gchar *_system_codepage = str_detect_termencoding();
 423
 424 #ifdef ENABLE_NLS
 425     if (!str_isutf8 (_system_codepage))
 426         bind_textdomain_codeset ("mc", "UTF-8");
 427 #endif
 428
 429     context = g_option_context_new (mc_args_add_usage_info());
 430
 431     g_option_context_set_ignore_unknown_options (context, FALSE);
 432
 433     mc_args_add_extended_info_to_help();
 434
 435     main_group = g_option_group_new ("main", _("Main options"),
 436                         _("Main options"),NULL, NULL);
 437
 438     g_option_group_add_entries (main_group, argument_main_table);
 439     g_option_context_set_main_group (context, main_group);
 440     g_option_group_set_translation_domain(main_group, translation_domain);
 441
 442
 443     terminal_group = g_option_group_new ("terminal", _("Terminal options"),
 444                         _("Terminal options"),NULL, NULL);
 445
 446     g_option_group_add_entries (terminal_group, argument_terminal_table);
 447     g_option_context_add_group (context, terminal_group);
 448     g_option_group_set_translation_domain(terminal_group, translation_domain);
 449
 450
 451     color_group = mc_args_new_color_group();
 452
 453     g_option_group_add_entries (color_group, argument_color_table);
 454     g_option_context_add_group (context, color_group);
 455     g_option_group_set_translation_domain(color_group, translation_domain);
 456
 457     if (! g_option_context_parse (context, argc, argv, &error)) {
 458         if (error != NULL)
 459         {
 460             gchar *full_help_str;
 461             gchar *help_str;
 462
 463 #if GLIB_CHECK_VERSION(2,14,0)
 464             help_str = g_option_context_get_help  (context, TRUE, NULL);
 465 #else
 466             help_str = g_strdup("");
 467 #endif
 468             if ( !str_isutf8 (_system_codepage))
 469                 full_help_str = mc_args__convert_help_to_syscharset(_system_codepage,error->message, help_str);
 470             else
 471                 full_help_str = g_strdup_printf("%s\n\n%s\n",error->message,help_str);
 472
 473             fprintf(stderr, "%s",full_help_str);
 474
 475             g_free(help_str);
 476             g_free(full_help_str);
 477             g_error_free (error);
 478         }
 479         g_option_context_free (context);
 480         mc_args_clean_temp_help_strings();
 481         return FALSE;
 482     }
 483
 484     g_option_context_free (context);
 485     mc_args_clean_temp_help_strings();
 486
 487 #ifdef ENABLE_NLS
 488     if (!str_isutf8 (_system_codepage))
 489         bind_textdomain_codeset ("mc", _system_codepage);
 490 #endif
 491
 492     return mc_args_process();
 493 }
 494
 495 /* --------------------------------------------------------------------------------------------- */