octave-nkf: libinterp/octave.cc comparison

comparison libinterp/octave.cc @ 19559:18377fc879d0

Make cmd-line options for --eval, script file, '< script' mutually exclusive (bug #35318). * octave.cc (octave_process_command_line): Check for invalid pairs of mutually exclusive command line options. Re-format various comments to use up to 80 columns.

author	Rik <rik@octave.org>
date	Fri, 02 Jan 2015 18:05:24 -0800
parents	b39cbe9f3bb0
children	65f4d9e1206c

comparison

equal deleted inserted replaced

-:ffc339cea115
+:18377fc879d0
 // The command-line options.
 static string_vector octave_argv;
 // The name used to invoke Octave.
-static std::string
+static std::string octave_program_invocation_name;
-octave_program_invocation_name;
 // The last component of octave_program_invocation_name.
 static std::string octave_program_name;
 // TRUE means we are using readline.
 // If TRUE, ignore the window system even if it is available.
 // (--no-window-system, -W)
 static bool no_window_system = false;
-// The code to evaluate at startup (--eval CODE)
+// The code to evaluate at startup
+// (--eval CODE)
 static std::string code_to_eval;
 // If TRUE, don't exit after evaluating code given by --eval option.
+// (--persist)
 static bool persist = false;
 // If TRUE, the GUI should be started.
 static bool start_gui = false;
-// If TRUE use traditional settings (--traditional)
+// If TRUE use traditional (maximally MATLAB compatible) settings
+// (--traditional)
 static bool traditional = false;
 // Store the command-line options for later use.
 static void
 << "error: execution of " << file << " failed\n"
 << "error: trying to make my way to a command prompt"
 << std::endl;
 }
-// Execute commands from a file and catch potential exceptions in a
+// Execute commands from a file and catch potential exceptions in a consistent
-// consistent way.  This function should be called anywhere we might
+// way.  This function should be called anywhere we might parse and execute
-// parse and execute commands from a file before before we have entered
+// commands from a file before before we have entered the main loop in
-// the main loop in toplev.cc.
+// toplev.cc.
 static void
 safe_source_file (const std::string& file_name,
 const std::string& context = std::string (),
 bool verbose = false, bool require_file = true,
 }
 if (read_init_files)
 {
 // Try to execute commands from $HOME/$OCTAVE_INITFILE and
-// $OCTAVE_INITFILE.  If $OCTAVE_INITFILE is not set, .octaverc
+// $OCTAVE_INITFILE.  If $OCTAVE_INITFILE is not set,
-// is assumed.
+// .octaverc is assumed.
 bool home_rc_already_executed = false;
 std::string initfile = octave_env::getenv ("OCTAVE_INITFILE");
 set_liboctave_error_with_id_handler (lo_error_with_id_handler);
 set_liboctave_warning_handler (warning);
 set_liboctave_warning_with_id_handler (warning_with_id);
 }
-// What happens on --traditional.
+// What internal options get configured by --traditional.
 static void
 maximum_braindamage (void)
 {
 persist = true;
 break;
 switch (optc)
 {
 case '?':
-// Unrecognized option.  getopt_long already printed a
+// Unrecognized option.  getopt_long already printed a message about
-// message about that, so we will just print the usage string
+// it, so we will just print the usage string and exit.
-// and exit.
 octave_print_terse_usage_and_exit ();
 break;
 case 'H':
 Fhistory_save (octave_value (false));
 case TRADITIONAL_OPTION:
 traditional = true;
 break;
 default:
-// getopt_long should print a message about unrecognized
+// getopt_long should print a message about unrecognized options and
-// options and return '?', which is handled above.  So if we
+// return '?', which is handled above.  If we end up here, it is
-// end up here, it is because there was an option but we
+// because there was an option but we forgot to handle it.
-// forgot to handle it.  That should be fatal.
+// That should be fatal.
 panic_impossible ();
 break;
 }
 }
+// Check for various incompatible argument pairs
 if (force_gui_option && no_gui_option)
 {
-error ("error: only one of --force-gui and --no-gui may be used");
+error ("only one of --force-gui and --no-gui may be used");
 octave_print_terse_usage_and_exit ();
 }
+bool script_file = (argc - optind) > 0;
+if (! code_to_eval.empty () && script_file)
+{
+error ("--eval \"CODE\" and script file are mutually exclusive options");
+octave_print_terse_usage_and_exit ();
+}
+bool redir_input = ! gnulib::isatty (fileno (stdin));
+if (! code_to_eval.empty () && redir_input)
+{
+error ("--eval \"CODE\" and '< script' are mutually exclusive options");
+octave_print_terse_usage_and_exit ();
+}
+if (script_file && redir_input)
+{
+error ("script file and '< script' are mutually exclusive options");
+octave_print_terse_usage_and_exit ();
+}
 }
 // EMBEDDED is declared int instead of bool because this function is
 // declared extern "C".
 octave_thread::init ();
 set_default_prompts ();
-// Initialize default warning state before --traditional option may
+// Initialize default warning state before --traditional option
-// reset them.
+// that may reset them.
 initialize_default_warning_state ();
 if (traditional)
 maximum_braindamage ();
 init_signals ();
 octave_ieee_init ();
-// The idea here is to force xerbla to be referenced so that we will
+// The idea here is to force xerbla to be referenced so that we will link to
-// link to our own version instead of the one provided by the BLAS
+// our own version instead of the one provided by the BLAS library.  But
-// library.  But octave_NaN should never be -1, so we should never
+// octave_NaN should never be -1, so we should never actually call xerbla.
-// actually call xerbla.
 if (octave_NaN == -1)
 F77_FUNC (xerbla, XERBLA) ("octave", 13 F77_CHAR_ARG_LEN (6));
 initialize_error_handlers ();
 set_image_path (image_path);
 if (no_window_system)
 display_info::no_window_system ();
-// Is input coming from a terminal?  If so, we are probably
+// Is input coming from a terminal?  If so, we are probably interactive.
-// interactive.
 // If stdin is not a tty, then we are reading commands from a pipe or
 // a redirected file.
 bool stdin_is_tty = gnulib::isatty (fileno (stdin));
 execute_startup_files ();
 if (! inhibit_startup_message && reading_startup_message_printed)
 std::cout << std::endl;
-// If there is an extra argument, see if it names a file to read.
+// Execute any code specified with --eval 'CODE'
-// Additional arguments are taken as command line options for the
-// script.
-int last_arg_idx = optind;
-int remaining_args = octave_cmdline_argc - last_arg_idx;
 if (! code_to_eval.empty ())
 {
 int parse_status = execute_eval_option_code (code_to_eval);
-if (! (persist || remaining_args > 0))
-{
-quitting_gracefully = true;
-clean_up_and_exit (parse_status || error_state ? 1 : 0);
-}
-}
-if (remaining_args > 0)
-{
-// If we are running an executable script (#! /bin/octave) then
-// we should only see the args passed to the script.
-intern_argv (remaining_args, octave_cmdline_argv+last_arg_idx);
-execute_command_line_file (octave_cmdline_argv[last_arg_idx]);
 if (! persist)
 {
 quitting_gracefully = true;
+clean_up_and_exit (parse_status || error_state ? 1 : 0);
+}
+}
+// If there is an extra argument, see if it names a file to read.
+// Additional arguments are taken as command line options for the script.
+int last_arg_idx = optind;
+int remaining_args = octave_cmdline_argc - last_arg_idx;
+if (remaining_args > 0)
+{
+// If we are running an executable script (#! /bin/octave) then
+// we should only see the args passed to the script.
+intern_argv (remaining_args, octave_cmdline_argv+last_arg_idx);
+execute_command_line_file (octave_cmdline_argv[last_arg_idx]);
+if (! persist)
+{
+quitting_gracefully = true;
 clean_up_and_exit (error_state ? 1 : 0);
 }
 }
 // Avoid counting commands executed from startup files.
 command_editor::reset_current_command_number (1);
 // Now argv should have the full set of args.
 intern_argv (octave_cmdline_argc, octave_cmdline_argv);
-// Force input to be echoed if not really interactive, but the user
+// Force input to be echoed if not really interactive,
-// has forced interactive behavior.
+// but the user has forced interactive behavior.
 if (! interactive && forced_interactive)
 {
 command_editor::blink_matching_paren (false);
 // FIXME: is this the right thing to do?
 Fecho_executing_commands (octave_value (ECHO_CMD_LINE));
 }
 if (octave_embedded)
 {
-// FIXME: do we need to do any cleanup here before
+// FIXME: Do we need to do any cleanup here before returning?
-// returning?  If we don't, what will happen to Octave functions
+// If we don't, what will happen to Octave functions that have been
-// that have been registered to execute with atexit, for example?
+// registered to execute with atexit, for example?
 return 1;
 }
 int retval = main_loop ();
 return false;
 if (persist)
 return true;
-// If stdin is not a tty, then assume we are reading commands from a
+// If stdin is not a tty, then assume we are reading commands from a pipe or
-// pipe or a redirected file and the GUI should not start.  If this is
+// a redirected file and the GUI should not start.  If this is not the case
-// not the case (for example, starting from a desktop "launcher" with
+// (for example, starting from a desktop "launcher" with no terminal) and you
-// no terminal) and you want to start the GUI, you may use the
+// want to start the GUI, you may use the --force-gui option to start the GUI.
-// --force-gui option to start the GUI.
 if (! gnulib::isatty (fileno (stdin)))
 return false;
-// If we have code to eval or execute from a file, and we are going to
+// If we have code to eval or execute from a file, and we are going to exit
-// exit immediately after executing it, don't start the gui.
+// immediately after executing it, don't start the gui.
 int last_arg_idx = optind;
 int remaining_args = octave_cmdline_argc - last_arg_idx;
 if (! code_to_eval.empty () || remaining_args > 0)
 return false;
 return true;
 }
-// Return int instead of bool because this function is declared
+// Return int instead of bool because this function is declared extern "C".
-// extern "C".
 int
 octave_starting_gui (void)
 {
 start_gui = check_starting_gui ();
 */
 DEFUN (argv, args, ,
 "-*- texinfo -*-\n\
 @deftypefn {Built-in Function} {} argv ()\n\
-Return the command line arguments passed to Octave.  For example,\n\
+Return the command line arguments passed to Octave.\n\
-if you invoked Octave using the command\n\
+\n\
+For example, if you invoked Octave using the command\n\
 \n\
 @example\n\
 octave --no-line-editing --silent\n\
 @end example\n\
 \n\
 @noindent\n\
 @code{argv} would return a cell array of strings with the elements\n\
 @option{--no-line-editing} and @option{--silent}.\n\
 \n\
-If you write an executable Octave script, @code{argv} will return the\n\
+If you write an executable Octave script, @code{argv} will return the list\n\
-list of arguments passed to the script.  @xref{Executable Octave Programs},\n\
+of arguments passed to the script.  @xref{Executable Octave Programs}, for\n\
-for an example of how to create an executable Octave script.\n\
+an example of how to create an executable Octave script.\n\
 @end deftypefn")
 {
 octave_value retval;
 if (args.length () == 0)

Mercurial > octave-nkf

comparison libinterp/octave.cc @ 19559:18377fc879d0