#include "ov-usr-fcn.h"

Inheritance diagram for octave_user_script:

Public Member Functions
	octave_user_script ()

	octave_user_script (const std::string &fnm, const std::string &nm, const octave::symbol_scope &scope=octave::symbol_scope::anonymous(), const std::string &ds="")

	octave_user_script (const std::string &fnm, const std::string &nm, const octave::symbol_scope &scope=octave::symbol_scope::anonymous(), octave::tree_statement_list *cmds=nullptr, const std::string &ds="")

	~octave_user_script ()=default

void	accept (octave::tree_walker &tw)

octave_value_list	call (octave::tree_evaluator &tw, int nargout=0, const octave_value_list &args=octave_value_list())

std::string	class_name () const

octave_value_list	execute (octave::tree_evaluator &tw, int nargout=0, const octave_value_list &args=octave_value_list())

octave_function *	function_value (bool=false)

bool	is_user_script () const

int	type_id () const

std::string	type_name () const

octave_user_code *	user_code_value (bool=false)

octave_user_script *	user_script_value (bool=false)

Public Member Functions inherited from octave_user_code
	~octave_user_code ()

octave::tree_statement_list *	body ()

void	cache_function_text (const std::string &text, const octave::sys::time &timestamp)

octave_value	dump () const

std::string	fcn_file_name () const

virtual octave_value	find_subfunction (const std::string &) const

std::string	get_code_line (std::size_t line)

std::deque< std::string >	get_code_lines (std::size_t line, std::size_t num_lines)

bool	is_user_code () const

void	mark_fcn_file_up_to_date (const octave::sys::time &t)

octave::symbol_scope	scope ()

std::size_t	scope_num_symbols ()

void	stash_fcn_file_name (const std::string &nm)

void	stash_fcn_file_time (const octave::sys::time &t)

virtual std::map< std::string, octave_value >	subfunctions () const

octave::sys::time	time_checked () const

octave::sys::time	time_parsed () const

Public Member Functions inherited from octave_function
	octave_function ()

	~octave_function ()=default

virtual bool	accepts_postfix_index (char type) const

virtual int	call_depth () const

std::string	canonical_name () const

octave_base_value *	clone () const

std::string	dir_name () const

std::string	dispatch_class () const

virtual std::string	doc_string (const std::string &="") const

void	document (const std::string &ds)

octave_base_value *	empty_clone () const

virtual bool	handles_dispatch_class (const std::string &) const

virtual bool	has_subfunctions () const

virtual bool	is_anonymous_function_of_class (const std::string &="") const

bool	is_class_constructor (const std::string &cname="") const

bool	is_class_method (const std::string &cname="") const

virtual bool	is_classdef_constructor (const std::string &="") const

virtual bool	is_classdef_method (const std::string &="") const

virtual bool	is_compiled () const

bool	is_defined () const

bool	is_function () const

virtual bool	is_legacy_constructor (const std::string &="") const

virtual bool	is_legacy_method (const std::string &="") const

virtual bool	is_nested_function () const

virtual bool	is_parent_function () const

bool	is_private_function () const

bool	is_private_function_of_class (const std::string &nm) const

bool	is_relative () const

virtual bool	is_subfunction () const

virtual bool	is_system_fcn_file () const

bool	islocked () const

void	lock ()

virtual void	lock_subfunctions ()

virtual void	mark_as_private_function (const std::string &cname="")

void	mark_relative ()

virtual void	maybe_relocate_end ()

std::string	name () const

std::string	package_name () const

virtual std::string	parent_fcn_name () const

virtual std::list< std::string >	parent_fcn_names () const

virtual octave::symbol_scope	parent_fcn_scope () const

virtual std::string	profiler_name () const

virtual void	push_dispatch_class (const std::string &)

virtual std::string	src_file_name () const

void	stash_dir_name (const std::string &dir)

void	stash_dispatch_class (const std::string &nm)

void	stash_package_name (const std::string &pack)

virtual void	stash_subfunction_names (const std::list< std::string > &)

virtual std::list< std::string >	subfunction_names () const

virtual bool	takes_var_return () const

virtual bool	takes_varargs () const

virtual void	unload ()

void	unlock ()

virtual void	unlock_subfunctions ()

Public Member Functions inherited from octave_base_value
	octave_base_value ()

	octave_base_value (const octave_base_value &)

virtual	~octave_base_value ()=default

virtual octave_value	all (int=0) const

virtual octave_value	any (int=0) const

virtual NDArray	array_value (bool=false) const

virtual octave_value	as_double () const

virtual octave_value	as_double_or_copy ()

virtual octave_value	as_int16 () const

virtual octave_value	as_int32 () const

virtual octave_value	as_int64 () const

virtual octave_value	as_int8 () const

virtual mxArray *	as_mxArray (bool interleaved) const

virtual octave_value	as_single () const

virtual octave_value	as_uint16 () const

virtual octave_value	as_uint32 () const

virtual octave_value	as_uint64 () const

virtual octave_value	as_uint8 () const

virtual void	assign (const std::string &, const octave_value &)

virtual boolNDArray	bool_array_value (bool=false) const

virtual boolMatrix	bool_matrix_value (bool=false) const

virtual bool	bool_value (bool=false) const

virtual void	break_closure_cycles (const std::shared_ptr< octave::stack_frame > &)

virtual builtin_type_t	builtin_type () const

virtual std::size_t	byte_size () const

virtual void	call_object_destructor ()

virtual Cell	cell_value () const

virtual Array< std::string >	cellstr_value () const

virtual charNDArray	char_array_value (bool=false) const

virtual charMatrix	char_matrix_value (bool force=false) const

virtual octave_classdef *	classdef_object_value (bool silent=false)

octave_idx_type	columns () const

virtual ComplexNDArray	complex_array_value (bool=false) const

virtual ComplexDiagMatrix	complex_diag_matrix_value (bool=false) const

virtual ComplexMatrix	complex_matrix_value (bool=false) const

virtual Complex	complex_value (bool=false) const

virtual void	convert_to_row_or_column_vector ()

virtual octave_value	convert_to_str (bool pad=false, bool force=false, char type='\'') const

virtual octave_value	convert_to_str_internal (bool pad, bool force, char type) const

virtual octave_value	diag (octave_idx_type k=0) const

virtual octave_value	diag (octave_idx_type m, octave_idx_type n) const

virtual DiagMatrix	diag_matrix_value (bool=false) const

virtual dim_vector	dims () const

virtual octave_value	do_index_op (const octave_value_list &idx, bool resize_ok=false)

virtual double	double_value (bool=false) const

virtual std::string	edit_display (const float_display_format &, octave_idx_type, octave_idx_type) const

virtual void	erase_subfunctions ()

virtual octave_value	fast_elem_extract (octave_idx_type n) const

virtual bool	fast_elem_insert (octave_idx_type n, const octave_value &x)

virtual bool	fast_elem_insert_self (void *where, builtin_type_t btyp) const

virtual octave_fcn_handle *	fcn_handle_value (bool silent=false)

virtual octave_base_value *	find_parent_class (const std::string &)

virtual FloatNDArray	float_array_value (bool=false) const

virtual FloatComplexNDArray	float_complex_array_value (bool=false) const

virtual FloatComplexDiagMatrix	float_complex_diag_matrix_value (bool=false) const

virtual FloatComplexMatrix	float_complex_matrix_value (bool=false) const

virtual FloatComplex	float_complex_value (bool=false) const

virtual FloatDiagMatrix	float_diag_matrix_value (bool=false) const

virtual FloatMatrix	float_matrix_value (bool=false) const

virtual float	float_scalar_value (bool frc_str_conv=false) const

virtual float	float_value (bool=false) const

virtual octave_value	full_value () const

virtual octave_function *	get_cached_fcn (const octave_value_list &)

virtual octave_function *	get_cached_fcn (void , void )

virtual float_display_format	get_edit_display_format () const

virtual bool	has_function_cache () const

virtual octave::idx_vector	index_vector (bool require_integers=false) const

virtual int16NDArray	int16_array_value () const

virtual octave_int16	int16_scalar_value () const

virtual int32NDArray	int32_array_value () const

virtual octave_int32	int32_scalar_value () const

virtual int64NDArray	int64_array_value () const

virtual octave_int64	int64_scalar_value () const

virtual int64_t	int64_value (bool=false, bool=false) const

virtual int8NDArray	int8_array_value () const

virtual octave_int8	int8_scalar_value () const

virtual int	int_value (bool=false, bool=false) const

virtual bool	is_all_va_args () const

virtual bool	is_anonymous_function () const

virtual bool	is_bool_matrix () const

virtual bool	is_bool_scalar () const

virtual bool	is_builtin_function () const

virtual bool	is_char_matrix () const

virtual bool	is_classdef_meta () const

virtual bool	is_classdef_object () const

virtual bool	is_classdef_superclass_ref () const

virtual bool	is_complex_matrix () const

virtual bool	is_complex_scalar () const

virtual bool	is_constant () const

virtual bool	is_cs_list () const

virtual bool	is_diag_matrix () const

virtual bool	is_dld_function () const

virtual bool	is_double_type () const

virtual bool	is_full_num_matrix () const

virtual bool	is_function_cache () const

virtual bool	is_function_handle () const

virtual bool	is_inline_function () const

virtual bool	is_instance_of (const std::string &) const

virtual bool	is_int16_type () const

virtual bool	is_int32_type () const

virtual bool	is_int64_type () const

virtual bool	is_int8_type () const

virtual bool	is_legacy_object () const

virtual bool	is_magic_colon () const

virtual bool	is_magic_int () const

virtual bool	is_matrix_type () const

virtual bool	is_maybe_function () const

virtual bool	is_mex_function () const

virtual bool	is_package () const

virtual bool	is_perm_matrix () const

virtual bool	is_range () const

virtual bool	is_real_matrix () const

virtual bool	is_real_scalar () const

virtual bool	is_scalar_type () const

virtual bool	is_single_type () const

virtual sortmode	is_sorted_rows (sortmode mode=UNSORTED) const

virtual bool	is_sq_string () const

virtual bool	is_storable () const

virtual bool	is_string () const

virtual bool	is_true () const

virtual bool	is_uint16_type () const

virtual bool	is_uint32_type () const

virtual bool	is_uint64_type () const

virtual bool	is_uint8_type () const

virtual bool	is_user_function () const

bool	is_zero_by_zero () const

virtual bool	iscell () const

virtual bool	iscellstr () const

virtual bool	iscomplex () const

bool	isempty () const

virtual bool	isfield (const std::string &) const

virtual bool	isfloat () const

virtual bool	isinteger () const

virtual bool	isjava () const

virtual bool	islogical () const

virtual bool	isnull () const

virtual bool	isnumeric () const

virtual bool	isobject () const

virtual bool	isreal () const

virtual sortmode	issorted (sortmode mode=UNSORTED) const

virtual bool	issparse () const

virtual bool	isstruct () const

virtual octave_value_list	list_value () const

virtual bool	load_ascii (std::istream &is)

virtual bool	load_binary (std::istream &is, bool swap, octave::mach_info::float_format fmt)

virtual bool	load_hdf5 (octave_hdf5_id loc_id, const char *name)

virtual long int	long_value (bool=false, bool=false) const

virtual octave_base_value *	make_storable_value ()

virtual octave_value	map (unary_mapper_t) const

virtual string_vector	map_keys () const

virtual octave_map	map_value () const

virtual MatrixType	matrix_type () const

virtual MatrixType	matrix_type (const MatrixType &typ) const

virtual Matrix	matrix_value (bool=false) const

virtual void	maybe_call_dtor ()

virtual void	maybe_economize ()

virtual const void *	mex_get_data () const

virtual const octave_idx_type *	mex_get_ir () const

virtual const octave_idx_type *	mex_get_jc () const

virtual int	ndims () const

virtual octave_idx_type	nfields () const

virtual int	nint_value (bool=false) const

virtual octave_idx_type	nnz () const

virtual std::size_t	nparents () const

virtual octave_idx_type	numel () const

virtual type_conv_info	numeric_conversion_function () const

virtual type_conv_info	numeric_demotion_function () const

virtual octave_idx_type	nzmax () const

virtual std::list< std::string >	parent_class_name_list () const

virtual string_vector	parent_class_names () const

virtual PermMatrix	perm_matrix_value () const

virtual octave_value	permute (const Array< int > &vec, bool=false) const

virtual void	print (std::ostream &os, bool pr_as_read_syntax=false)

virtual bool	print_as_scalar () const

virtual void	print_info (std::ostream &os, const std::string &prefix) const

virtual bool	print_name_tag (std::ostream &os, const std::string &name) const

virtual void	print_raw (std::ostream &os, bool pr_as_read_syntax=false) const

virtual void	print_with_name (std::ostream &output_buf, const std::string &name, bool print_padding=true)

virtual octave::range< double >	range_value () const

virtual octave_value	reshape (const dim_vector &) const

virtual octave_value	resize (const dim_vector &, bool fill=false) const

octave_idx_type	rows () const

virtual bool	save_ascii (std::ostream &os)

virtual bool	save_binary (std::ostream &os, bool save_as_floats)

virtual bool	save_hdf5 (octave_hdf5_id loc_id, const char *name, bool save_as_floats)

virtual octave_scalar_map	scalar_map_value () const

virtual double	scalar_value (bool frc_str_conv=false) const

virtual void	short_disp (std::ostream &os) const

virtual short int	short_value (bool=false, bool=false) const

virtual octave_value	simple_subsasgn (char type, octave_value_list &idx, const octave_value &rhs)

virtual octave_value_list	simple_subsref (char type, octave_value_list &idx, int nargout)

virtual Matrix	size ()

virtual octave_value	sort (Array< octave_idx_type > &sidx, octave_idx_type dim=0, sortmode mode=ASCENDING) const

virtual octave_value	sort (octave_idx_type dim=0, sortmode mode=ASCENDING) const

virtual Array< octave_idx_type >	sort_rows_idx (sortmode mode=ASCENDING) const

virtual SparseBoolMatrix	sparse_bool_matrix_value (bool=false) const

virtual SparseComplexMatrix	sparse_complex_matrix_value (bool=false) const

virtual SparseMatrix	sparse_matrix_value (bool=false) const

virtual octave_value	squeeze () const

virtual octave_value	storable_value ()

virtual std::string	string_value (bool force=false) const

virtual string_vector	string_vector_value (bool pad=false) const

virtual octave_value	subsasgn (const std::string &type, const std::list< octave_value_list > &idx, const octave_value &rhs)

virtual octave_value	subsref (const std::string &type, const std::list< octave_value_list > &idx)

virtual octave_value	subsref (const std::string &type, const std::list< octave_value_list > &idx, bool auto_add)

virtual octave_value_list	subsref (const std::string &type, const std::list< octave_value_list > &idx, int nargout)

virtual octave_base_value *	try_narrowing_conversion ()

virtual uint16NDArray	uint16_array_value () const

virtual octave_uint16	uint16_scalar_value () const

virtual uint32NDArray	uint32_array_value () const

virtual octave_uint32	uint32_scalar_value () const

virtual uint64NDArray	uint64_array_value () const

virtual octave_uint64	uint64_scalar_value () const

virtual uint64_t	uint64_value (bool=false, bool=false) const

virtual uint8NDArray	uint8_array_value () const

virtual octave_uint8	uint8_scalar_value () const

virtual unsigned int	uint_value (bool=false, bool=false) const

virtual unsigned long int	ulong_value (bool=false, bool=false) const

virtual octave_value	undef_subsasgn (const std::string &type, const std::list< octave_value_list > &idx, const octave_value &rhs)

virtual octave_base_value *	unique_clone ()

virtual octave_base_value *	unique_parent_class (const std::string &)

virtual octave_user_function *	user_function_value (bool silent=false)

virtual unsigned short int	ushort_value (bool=false, bool=false) const

virtual int	write (octave::stream &os, int block_size, oct_data_conv::data_type output_type, int skip, octave::mach_info::float_format flt_fmt) const

virtual octave_idx_type	xnumel (const octave_value_list &)

virtual std::string	xstring_value () const

Static Public Member Functions
static void	register_type ()

static void	register_type (octave::type_info &)

static std::string	static_class_name ()

static int	static_type_id ()

static std::string	static_type_name ()

Static Public Member Functions inherited from octave_base_value
static void	register_type ()

static void	register_type (octave::type_info &)

static std::string	static_class_name ()

static int	static_type_id ()

static std::string	static_type_name ()

Additional Inherited Members
Public Types inherited from octave_base_value
typedef octave_base_value (	type_conv_fcn) (const octave_base_value &)

enum	unary_mapper_t { umap_abs , umap_acos , umap_acosh , umap_angle , umap_arg , umap_asin , umap_asinh , umap_atan , umap_atanh , umap_cbrt , umap_ceil , umap_conj , umap_cos , umap_cosh , umap_erf , umap_erfinv , umap_erfcinv , umap_erfc , umap_erfcx , umap_erfi , umap_dawson , umap_exp , umap_expm1 , umap_isfinite , umap_fix , umap_floor , umap_gamma , umap_imag , umap_isinf , umap_isna , umap_isnan , umap_lgamma , umap_log , umap_log2 , umap_log10 , umap_log1p , umap_real , umap_round , umap_roundb , umap_signum , umap_sin , umap_sinh , umap_sqrt , umap_tan , umap_tanh , umap_xisalnum , umap_xisalpha , umap_xisascii , umap_xiscntrl , umap_xisdigit , umap_xisgraph , umap_xislower , umap_xisprint , umap_xispunct , umap_xisspace , umap_xisupper , umap_xisxdigit , umap_xsignbit , umap_xtolower , umap_xtoupper , umap_unknown , num_unary_mappers = umap_unknown }

Protected Member Functions inherited from octave_user_code
	octave_user_code (const std::string &fnm="", const std::string &nm="", const octave::symbol_scope &scope=octave::symbol_scope::anonymous(), octave::tree_statement_list *cmds=nullptr, const std::string &ds="")

void	get_file_info ()

Protected Member Functions inherited from octave_function
	octave_function (const std::string &nm, const std::string &ds="")

Protected Member Functions inherited from octave_base_value
int	current_print_indent_level () const

void	decrement_indent_level () const

void	increment_indent_level () const

void	indent (std::ostream &os) const

void	newline (std::ostream &os) const

octave_value	numeric_assign (const std::string &type, const std::list< octave_value_list > &idx, const octave_value &rhs)

void	reset () const

void	reset_indent_level () const

void	warn_load (const char *type) const

void	warn_save (const char *type) const

Static Protected Member Functions inherited from octave_base_value
static const char *	get_umap_name (unary_mapper_t)

Protected Attributes inherited from octave_user_code
octave::tree_statement_list *	m_cmd_list

octave::file_info *	m_file_info

std::string	m_file_name

octave::symbol_scope	m_scope

octave::sys::time	m_t_checked

octave::sys::time	m_t_parsed

Protected Attributes inherited from octave_function
std::string	m_dir_name

std::string	m_dispatch_class

std::string	m_doc

bool	m_locked

std::string	m_name

std::string	m_package_name

bool	m_private

bool	m_relative

Protected Attributes inherited from octave_base_value
octave::refcount< octave_idx_type > &	count

octave::refcount< octave_idx_type >	m_count

Detailed Description

Definition at line 149 of file ov-usr-fcn.h.

Constructor & Destructor Documentation

◆ octave_user_script() [1/3]

octave_user_script::octave_user_script ( )

Definition at line 155 of file ov-usr-fcn.cc.

◆ octave_user_script() [2/3]

octave_user_script::octave_user_script	(	const std::string &	fnm,
		const std::string &	nm,
		const octave::symbol_scope &	scope = `octave::symbol_scope::anonymous ()`,
		octave::tree_statement_list *	cmds = `nullptr`,
		const std::string &	ds = `""`
	)

Definition at line 159 of file ov-usr-fcn.cc.

References octave_user_code::m_cmd_list.

◆ octave_user_script() [3/3]

octave_user_script::octave_user_script	(	const std::string &	fnm,
		const std::string &	nm,
		const octave::symbol_scope &	scope = `octave::symbol_scope::anonymous ()`,
		const std::string &	ds = `""`
	)

Definition at line 169 of file ov-usr-fcn.cc.

◆ ~octave_user_script()

octave_user_script::~octave_user_script ( )

default

Member Function Documentation

◆ accept()

void octave_user_script::accept ( octave::tree_walker & tw )

virtual

Reimplemented from octave_function.

Definition at line 199 of file ov-usr-fcn.cc.

◆ call()

octave_value_list octave_user_script::call	(	octave::tree_evaluator &	tw,
		int	nargout = `0`,
		const octave_value_list &	args = `octave_value_list ()`
	)

virtual

Reimplemented from octave_function.

Definition at line 181 of file ov-usr-fcn.cc.

References execute().

◆ class_name()

std::string octave_user_script::class_name ( ) const

inlinevirtual

Reimplemented from octave_base_value.

Definition at line 197 of file ov-usr-fcn.h.

◆ execute()

octave_value_list octave_user_script::execute	(	octave::tree_evaluator &	tw,
		int	nargout = `0`,
		const octave_value_list &	args = `octave_value_list ()`
	)

virtual

Implements octave_function.

Definition at line 192 of file ov-usr-fcn.cc.

Referenced by call().

◆ function_value()

octave_function* octave_user_script::function_value ( bool = false )

inlinevirtual

Reimplemented from octave_base_value.

Definition at line 169 of file ov-usr-fcn.h.

◆ is_user_script()

bool octave_user_script::is_user_script ( ) const

inlinevirtual

Reimplemented from octave_base_value.

Definition at line 178 of file ov-usr-fcn.h.

◆ register_type() [1/2]

void octave_user_script::register_type ( )

static

Definition at line 153 of file ov-usr-fcn.cc.

◆ register_type() [2/2]

void octave_user_script::register_type ( octave::type_info & ti )

static

Definition at line 153 of file ov-usr-fcn.cc.

◆ static_class_name()

static std::string octave_user_script::static_class_name ( )

inlinestatic

Definition at line 197 of file ov-usr-fcn.h.

◆ static_type_id()

static int octave_user_script::static_type_id ( )

inlinestatic

Definition at line 197 of file ov-usr-fcn.h.

◆ static_type_name()

static std::string octave_user_script::static_type_name ( )

inlinestatic

Definition at line 197 of file ov-usr-fcn.h.

◆ type_id()

int octave_user_script::type_id ( ) const

inlinevirtual

Reimplemented from octave_base_value.

Definition at line 197 of file ov-usr-fcn.h.

◆ type_name()

std::string octave_user_script::type_name ( ) const

inlinevirtual

Reimplemented from octave_base_value.

Definition at line 197 of file ov-usr-fcn.h.

◆ user_code_value()

octave_user_code* octave_user_script::user_code_value ( bool = false )

inlinevirtual

Reimplemented from octave_base_value.

Definition at line 173 of file ov-usr-fcn.h.

◆ user_script_value()

octave_user_script* octave_user_script::user_script_value ( bool = false )

inlinevirtual

Reimplemented from octave_base_value.

Definition at line 171 of file ov-usr-fcn.h.

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

libinterp/octave-value/ov-usr-fcn.h
libinterp/octave-value/ov-usr-fcn.cc

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ octave_user_script() [1/3]

◆ octave_user_script() [2/3]

◆ octave_user_script() [3/3]

◆ ~octave_user_script()

Member Function Documentation

◆ accept()

◆ call()

◆ class_name()

◆ execute()

◆ function_value()

◆ is_user_script()

◆ register_type() [1/2]

◆ register_type() [2/2]

◆ static_class_name()

◆ static_type_id()

◆ static_type_name()

◆ type_id()

◆ type_name()

◆ user_code_value()

◆ user_script_value()