1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
|
////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 1993-2021 The Octave Project Developers
//
// See the file COPYRIGHT.md in the top-level directory of this
// distribution or <https://octave.org/copyright/>.
//
// This file is part of Octave.
//
// Octave is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Octave is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Octave; see the file COPYING. If not, see
// <https://www.gnu.org/licenses/>.
//
////////////////////////////////////////////////////////////////////////
// Born February 20, 1992.
#if defined (HAVE_CONFIG_H)
# include "config.h"
#endif
#include <iostream>
#include <string>
#include "file-ops.h"
#include "getopt-wrapper.h"
#include "lo-error.h"
#include "oct-env.h"
#include "str-vec.h"
#include "Cell.h"
#include "defun.h"
#include "display.h"
#include "error.h"
#include "input.h"
#include "interpreter.h"
#include "octave.h"
#include "oct-hist.h"
#include "oct-map.h"
#include "ovl.h"
#include "options-usage.h"
#include "ov.h"
#include "parse.h"
#include "sysdep.h"
namespace octave
{
cmdline_options::cmdline_options (void)
{
m_all_args.resize (1);
m_all_args[0] = "";
}
cmdline_options::cmdline_options (int argc, char **argv)
{
// Save raw program arguments.
m_all_args = string_vector (argv, argc);
while (true)
{
int long_idx;
int optc = octave_getopt_long_wrapper (argc, argv, short_opts,
long_opts, &long_idx);
if (optc < 0)
break;
switch (optc)
{
case '?':
// Unrecognized option. getopt_long already printed a message about
// it, so we will just print the usage string and exit.
octave_print_terse_usage_and_exit ();
break;
case 'H':
m_read_history_file = false;
break;
case 'W':
m_no_window_system = true;
break;
case 'V':
m_verbose_flag = true;
break;
case 'd':
// This is the same as yydebug in parse.y.
octave_debug++;
break;
case 'f':
m_read_init_files = false;
m_read_site_files = false;
break;
case 'h':
octave_print_verbose_usage_and_exit ();
break;
case 'i':
m_forced_interactive = true;
break;
case 'p':
if (octave_optarg_wrapper ())
m_command_line_path.push_back (octave_optarg_wrapper ());
break;
case 'q':
m_inhibit_startup_message = true;
break;
case 'x':
m_echo_commands = true;
break;
case 'v':
octave_print_version_and_exit ();
break;
case BUILT_IN_DOCSTRINGS_FILE_OPTION:
if (octave_optarg_wrapper ())
m_docstrings_file = octave_optarg_wrapper ();;
break;
case DOC_CACHE_FILE_OPTION:
if (octave_optarg_wrapper ())
m_doc_cache_file = octave_optarg_wrapper ();
break;
case EVAL_OPTION:
if (octave_optarg_wrapper ())
{
if (m_code_to_eval.empty ())
m_code_to_eval = octave_optarg_wrapper ();
else
m_code_to_eval += (std::string (" ")
+ octave_optarg_wrapper ());
}
break;
case EXEC_PATH_OPTION:
if (octave_optarg_wrapper ())
m_exec_path = octave_optarg_wrapper ();
break;
case GUI_OPTION:
m_gui = true;
break;
case IMAGE_PATH_OPTION:
if (octave_optarg_wrapper ())
m_image_path = octave_optarg_wrapper ();
break;
case INFO_FILE_OPTION:
if (octave_optarg_wrapper ())
m_info_file = octave_optarg_wrapper ();
break;
case INFO_PROG_OPTION:
if (octave_optarg_wrapper ())
m_info_program = octave_optarg_wrapper ();
break;
case DEBUG_JIT_OPTION:
m_debug_jit = true;
break;
case JIT_COMPILER_OPTION:
m_jit_compiler = true;
break;
case LINE_EDITING_OPTION:
m_forced_line_editing = m_line_editing = true;
break;
case NO_GUI_OPTION:
m_gui = false;
break;
case NO_INIT_FILE_OPTION:
m_read_init_files = false;
break;
case NO_INIT_PATH_OPTION:
m_set_initial_path = false;
break;
case NO_LINE_EDITING_OPTION:
m_line_editing = false;
break;
case NO_SITE_FILE_OPTION:
m_read_site_files = false;
break;
case PERSIST_OPTION:
m_persist = true;
break;
case TEXI_MACROS_FILE_OPTION:
if (octave_optarg_wrapper ())
m_texi_macros_file = octave_optarg_wrapper ();
break;
case TRADITIONAL_OPTION:
m_traditional = true;
m_persist = true;
break;
default:
// getopt_long should print a message about unrecognized options and
// return '?', which is handled above. If we end up here, it is
// because there was an option but we forgot to handle it.
// That should be fatal.
panic_impossible ();
break;
}
}
m_remaining_args = string_vector (argv+octave_optind_wrapper (),
argc-octave_optind_wrapper ());
}
application *application::instance = nullptr;
application::application (int argc, char **argv)
: m_options (argc, argv)
{
init ();
}
application::application (const cmdline_options& opts)
: m_options (opts)
{
init ();
}
void
application::set_program_names (const std::string& pname)
{
m_program_invocation_name = pname;
size_t pos = pname.find_last_of (sys::file_ops::dir_sep_chars ());
m_program_name = (pos != std::string::npos) ? pname.substr (pos+1) : pname;
}
void
application::intern_argv (const string_vector& args)
{
octave_idx_type nargs = args.numel ();
if (nargs > 0)
{
// Skip first argument (program name).
nargs--;
m_argv.resize (nargs);
for (octave_idx_type i = 0; i < nargs; i++)
m_argv[i] = args[i+1];
}
}
bool application::forced_interactive (void)
{
return instance ? instance->m_options.forced_interactive () : false;
}
application::~application (void)
{
// Delete interpreter if it still exists.
delete m_interpreter;
instance = nullptr;
}
bool application::interpreter_initialized (void)
{
return m_interpreter ? m_interpreter->initialized () : false;
}
interpreter& application::create_interpreter (void)
{
if (! m_interpreter)
m_interpreter = new interpreter (this);
return *m_interpreter;
}
void application::initialize_interpreter (void)
{
if (m_interpreter)
m_interpreter->initialize ();
}
int application::execute_interpreter (void)
{
return m_interpreter ? m_interpreter->execute () : -1;
}
void application::delete_interpreter (void)
{
delete m_interpreter;
m_interpreter = nullptr;
}
void application::init (void)
{
if (instance)
throw std::runtime_error
("only one Octave application object may be active");
instance = this;
string_vector all_args = m_options.all_args ();
set_program_names (all_args[0]);
string_vector remaining_args = m_options.remaining_args ();
std::string code_to_eval = m_options.code_to_eval ();
m_have_script_file = ! remaining_args.empty ();
m_have_eval_option_code = ! code_to_eval.empty ();
if (m_have_eval_option_code && m_have_script_file)
{
std::cerr << R"(error: --eval "CODE" and script file are mutually exclusive options)" << std::endl;
octave_print_terse_usage_and_exit ();
}
if (m_options.gui ())
{
if (m_options.no_window_system ())
{
std::cerr << "error: --gui and --no-window-system are mutually exclusive options" << std::endl;
octave_print_terse_usage_and_exit ();
}
if (! m_options.line_editing ())
{
std::cerr << "error: --gui and --no-line-editing are mutually exclusive options" << std::endl;
octave_print_terse_usage_and_exit ();
}
}
m_is_octave_program = ((m_have_script_file || m_have_eval_option_code)
&& ! m_options.persist ()
&& ! m_options.traditional ());
// This should probably happen early.
sysdep_init ();
}
int cli_application::execute (void)
{
interpreter& interp = create_interpreter ();
int status = interp.execute ();
interp.shutdown ();
return status;
}
}
DEFUN (isguirunning, args, ,
doc: /* -*- texinfo -*-
@deftypefn {} {} isguirunning ()
Return true if Octave is running in GUI mode and false otherwise.
@seealso{have_window_system}
@end deftypefn */)
{
if (args.length () != 0)
print_usage ();
// FIXME: This isn't quite right, it just says that we intended to
// start the GUI, not that it is actually running.
return ovl (octave::application::is_gui_running ());
}
/*
%!assert (islogical (isguirunning ()))
%!error isguirunning (1)
*/
DEFUN (argv, args, ,
doc: /* -*- texinfo -*-
@deftypefn {} {} argv ()
Return the command line arguments passed to Octave.
For example, if you invoked Octave using the command
@example
octave --no-line-editing --silent
@end example
@noindent
@code{argv} would return a cell array of strings with the elements
@option{--no-line-editing} and @option{--silent}.
If you write an executable Octave script, @code{argv} will return the list
of arguments passed to the script. @xref{Executable Octave Programs}, for
an example of how to create an executable Octave script.
@end deftypefn */)
{
if (args.length () != 0)
print_usage ();
return ovl (Cell (octave::application::argv ()));
}
/*
%!assert (iscellstr (argv ()))
%!error argv (1)
*/
DEFUN (program_invocation_name, args, ,
doc: /* -*- texinfo -*-
@deftypefn {} {} program_invocation_name ()
Return the name that was typed at the shell prompt to run Octave.
If executing a script from the command line (e.g., @code{octave foo.m})
or using an executable Octave script, the program name is set to the
name of the script. @xref{Executable Octave Programs}, for an example of
how to create an executable Octave script.
@seealso{program_name}
@end deftypefn */)
{
if (args.length () != 0)
print_usage ();
return ovl (octave::application::program_invocation_name ());
}
/*
%!assert (ischar (program_invocation_name ()))
%!error program_invocation_name (1)
*/
DEFUN (program_name, args, ,
doc: /* -*- texinfo -*-
@deftypefn {} {} program_name ()
Return the last component of the value returned by
@code{program_invocation_name}.
@seealso{program_invocation_name}
@end deftypefn */)
{
if (args.length () != 0)
print_usage ();
return ovl (octave::application::program_name ());
}
/*
%!assert (ischar (program_name ()))
%!error program_name (1)
*/
|