GNU Octave  6.2.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
Public Member Functions | Static Public Member Functions | Protected Attributes | Private Member Functions | Static Private Attributes | List of all members
octave::cli_application Class Reference

#include "octave.h"

Inheritance diagram for octave::cli_application:
Inheritance graph
[legend]
Collaboration diagram for octave::cli_application:
Collaboration graph
[legend]

Public Member Functions

 cli_application (const cli_application &)=delete
 
 cli_application (const cmdline_options &opts=cmdline_options())
 
 cli_application (int argc, char **argv)
 
 ~cli_application (void)=default
 
virtual interpreter & create_interpreter (void)
 
virtual void delete_interpreter (void)
 
int execute (void)
 
virtual int execute_interpreter (void)
 
void forced_interactive (bool arg)
 
virtual void gui_running (bool)
 
virtual bool gui_running (void) const
 
bool have_eval_option_code (void) const
 
bool have_script_file (void) const
 
virtual void initialize_interpreter (void)
 
void intern_argv (const string_vector &args)
 
bool interpreter_initialized (void)
 
bool is_octave_program (void) const
 
cli_application & operator= (const cli_application &)=delete
 
cmdline_options options (void) const
 
void program_invocation_name (const std::string &nm)
 
void program_name (const std::string &nm)
 
void set_program_names (const std::string &pname)
 
int sys_argc (void) const
 
char ** sys_argv (void) const
 

Static Public Member Functions

static application * app (void)
 
static string_vector argv (void)
 
static bool forced_interactive (void)
 
static bool is_gui_running (void)
 
static std::string program_invocation_name (void)
 
static std::string program_name (void)
 

Protected Attributes

string_vector m_argv
 
bool m_have_eval_option_code = false
 
bool m_have_script_file = false
 
interpreter * m_interpreter = nullptr
 
bool m_is_octave_program = false
 
cmdline_options m_options
 
std::string m_program_invocation_name
 
std::string m_program_name
 

Private Member Functions

void init (void)
 

Static Private Attributes

static application * instance = nullptr
 

Detailed Description

Definition at line 350 of file octave.h.

Constructor & Destructor Documentation

◆ cli_application() [1/3]

octave::cli_application::cli_application ( const cmdline_options &  opts = cmdline_options ())
inline

Definition at line 354 of file octave.h.

◆ cli_application() [2/3]

octave::cli_application::cli_application ( int  argc,
char **  argv 
)
inline

Definition at line 358 of file octave.h.

◆ cli_application() [3/3]

octave::cli_application::cli_application ( const cli_application &  )
delete

◆ ~cli_application()

octave::cli_application::~cli_application ( void  )
default

Member Function Documentation

◆ app()

static application* octave::application::app ( void  )
inlinestaticinherited

Definition at line 286 of file octave.h.

Referenced by octave::debugger::repl().

◆ argv()

static string_vector octave::application::argv ( void  )
inlinestaticinherited

Definition at line 298 of file octave.h.

Referenced by Fargv().

◆ create_interpreter()

interpreter & octave::application::create_interpreter ( void  )
virtualinherited

Definition at line 299 of file octave.cc.

References octave::application::m_interpreter.

Referenced by octave::interpreter_qobject::execute(), and execute().

◆ delete_interpreter()

void octave::application::delete_interpreter ( void  )
virtualinherited

Definition at line 318 of file octave.cc.

References octave::application::m_interpreter.

◆ execute()

int octave::cli_application::execute ( void  )
virtual

Implements octave::application.

Definition at line 375 of file octave.cc.

References octave::application::create_interpreter(), octave::interpreter::execute(), and octave::interpreter::shutdown().

Referenced by main().

◆ execute_interpreter()

int octave::application::execute_interpreter ( void  )
virtualinherited

Definition at line 313 of file octave.cc.

References octave::interpreter::execute(), and octave::application::m_interpreter.

◆ forced_interactive() [1/2]

void octave::application::forced_interactive ( bool  arg)
inlineinherited

Definition at line 284 of file octave.h.

Referenced by octave::debugger::repl().

◆ forced_interactive() [2/2]

bool octave::application::forced_interactive ( void  )
staticinherited

Definition at line 280 of file octave.cc.

References octave::cmdline_options::forced_interactive(), octave::application::instance, and octave::application::m_options.

Referenced by octave::base_stream::do_oscanf(), octave::base_stream::do_scanf(), Frmdir(), octave::raw_mode(), octave::debugger::repl(), octave::output_system::sync(), octave::tree_evaluator::visit_statement(), and octave::error_system::vwarning().

◆ gui_running() [1/2]

virtual void octave::application::gui_running ( bool  )
inlinevirtualinherited

Reimplemented in octave::qt_application.

Definition at line 278 of file octave.h.

◆ gui_running() [2/2]

virtual bool octave::application::gui_running ( void  ) const
inlinevirtualinherited

Reimplemented in octave::qt_application.

Definition at line 277 of file octave.h.

◆ have_eval_option_code()

bool octave::application::have_eval_option_code ( void  ) const
inlineinherited

Definition at line 259 of file octave.h.

Referenced by octave::interpreter::execute().

◆ have_script_file()

bool octave::application::have_script_file ( void  ) const
inlineinherited

Definition at line 261 of file octave.h.

Referenced by octave::interpreter::execute().

◆ init()

void octave::application::init ( void  )
privateinherited

Definition at line 325 of file octave.cc.

References octave::cmdline_options::all_args(), octave::cmdline_options::code_to_eval(), string_vector::empty(), octave::cmdline_options::gui(), octave::application::instance, octave::cmdline_options::line_editing(), octave::application::m_have_eval_option_code, octave::application::m_have_script_file, octave::application::m_is_octave_program, octave::application::m_options, octave::cmdline_options::no_window_system(), octave_print_terse_usage_and_exit(), octave::cmdline_options::persist(), octave::cmdline_options::remaining_args(), octave::application::set_program_names(), octave::sysdep_init(), and octave::cmdline_options::traditional().

Referenced by octave::application::application().

◆ initialize_interpreter()

void octave::application::initialize_interpreter ( void  )
virtualinherited

Definition at line 307 of file octave.cc.

References octave::interpreter::initialize(), and octave::application::m_interpreter.

◆ intern_argv()

void octave::application::intern_argv ( const string_vector &  args)
inherited

Definition at line 264 of file octave.cc.

References octave::application::m_argv, string_vector::numel(), and string_vector::resize().

Referenced by octave::interpreter::interpreter(), and octave::interpreter::execute_command_line_file().

◆ interpreter_initialized()

bool octave::application::interpreter_initialized ( void  )
inherited

Definition at line 294 of file octave.cc.

References octave::interpreter::initialized(), and octave::application::m_interpreter.

◆ is_gui_running()

static bool octave::application::is_gui_running ( void  )
inlinestaticinherited

Definition at line 303 of file octave.h.

Referenced by F__event_manager_gui_preference__(), octave::event_manager::file_remove(), octave::event_manager::file_renamed(), Fisguirunning(), and octave::event_manager::update_path_dialog().

◆ is_octave_program()

bool octave::application::is_octave_program ( void  ) const
inlineinherited

Definition at line 263 of file octave.h.

Referenced by octave::interpreter::interpreter().

◆ operator=()

cli_application& octave::cli_application::operator= ( const cli_application &  )
delete

◆ options()

cmdline_options octave::application::options ( void  ) const
inlineinherited

Definition at line 257 of file octave.h.

Referenced by octave::interpreter::interpreter(), octave::interpreter::display_startup_message(), octave::interpreter::execute(), octave::interpreter::execute_command_line_file(), octave::interpreter::execute_eval_option_code(), octave::interpreter::execute_startup_files(), octave::interpreter::initialize_history(), and octave::interpreter::initialize_load_path().

◆ program_invocation_name() [1/2]

void octave::application::program_invocation_name ( const std::string &  nm)
inlineinherited

Definition at line 280 of file octave.h.

◆ program_invocation_name() [2/2]

static std::string octave::application::program_invocation_name ( void  )
inlinestaticinherited

Definition at line 288 of file octave.h.

Referenced by octave::interpreter::execute_command_line_file(), and Fprogram_invocation_name().

◆ program_name() [1/2]

void octave::application::program_name ( const std::string &  nm)
inlineinherited

Definition at line 282 of file octave.h.

◆ program_name() [2/2]

static std::string octave::application::program_name ( void  )
inlinestaticinherited

Definition at line 293 of file octave.h.

Referenced by octave::interpreter::execute_command_line_file(), and Fprogram_name().

◆ set_program_names()

void octave::application::set_program_names ( const std::string &  pname)
inherited

Definition at line 254 of file octave.cc.

References octave::sys::file_ops::dir_sep_chars(), octave::application::m_program_invocation_name, and octave::application::m_program_name.

Referenced by octave::interpreter::execute_command_line_file(), and octave::application::init().

◆ sys_argc()

int octave::application::sys_argc ( void  ) const
inlineinherited

Definition at line 250 of file octave.h.

◆ sys_argv()

char** octave::application::sys_argv ( void  ) const
inlineinherited

Definition at line 251 of file octave.h.

Member Data Documentation

◆ instance

application * octave::application::instance = nullptr
staticprivateinherited

Definition at line 315 of file octave.h.

Referenced by octave::application::~application(), octave::application::forced_interactive(), and octave::application::init().

◆ m_argv

string_vector octave::application::m_argv
protectedinherited

Definition at line 331 of file octave.h.

Referenced by octave::application::intern_argv().

◆ m_have_eval_option_code

bool octave::application::m_have_eval_option_code = false
protectedinherited

Definition at line 336 of file octave.h.

Referenced by octave::application::init().

◆ m_have_script_file

bool octave::application::m_have_script_file = false
protectedinherited

Definition at line 340 of file octave.h.

Referenced by octave::application::init().

◆ m_interpreter

interpreter* octave::application::m_interpreter = nullptr
protectedinherited

Definition at line 347 of file octave.h.

Referenced by octave::application::~application(), octave::application::create_interpreter(), octave::application::delete_interpreter(), octave::application::execute_interpreter(), octave::application::initialize_interpreter(), and octave::application::interpreter_initialized().

◆ m_is_octave_program

bool octave::application::m_is_octave_program = false
protectedinherited

Definition at line 345 of file octave.h.

Referenced by octave::application::init().

◆ m_options

cmdline_options octave::application::m_options
protectedinherited

Definition at line 333 of file octave.h.

Referenced by octave::application::forced_interactive(), octave::application::init(), and octave::qt_application::start_gui_p().

◆ m_program_invocation_name

std::string octave::application::m_program_invocation_name
protectedinherited

Definition at line 322 of file octave.h.

Referenced by octave::application::set_program_names().

◆ m_program_name

std::string octave::application::m_program_name
protectedinherited

Definition at line 325 of file octave.h.

Referenced by octave::application::set_program_names().

The documentation for this class was generated from the following files: