variables.h File Reference

#include "octave-config.h"
#include <limits>
#include <string>
#include "lo-ieee.h"
#include "ov-builtin.h"

Include dependency graph for variables.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
	octave

Macros
#define	SET_INTERNAL_VARIABLE(NM)    set_internal_variable (V ## NM, args, nargout, #NM)
#define	SET_INTERNAL_VARIABLE_CHOICES(NM, CHOICES)    set_internal_variable (V ## NM, args, nargout, #NM, CHOICES)
#define	SET_INTERNAL_VARIABLE_WITH_LIMITS(NM, MINVAL, MAXVAL)    set_internal_variable (V ## NM, args, nargout, #NM, MINVAL, MAXVAL)
#define	SET_NONEMPTY_INTERNAL_STRING_VARIABLE(NM)    set_internal_variable (V ## NM, args, nargout, #NM, false)

Functions
OCTINTERP_API octave_function *	extract_function (const octave_value &arg, const std::string &warn_for, const std::string &fname, const std::string &header, const std::string &trailer)
OCTINTERP_API string_vector	get_struct_elts (const std::string &text)
OCTINTERP_API octave_function *	is_valid_function (const octave_value &, const std::string &="", bool warn=false)
OCTINTERP_API octave_function *	is_valid_function (const std::string &, const std::string &="", bool warn=false)
OCTINTERP_API std::string	maybe_missing_function_hook (const std::string &name)
OCTINTERP_API octave_value	set_internal_variable (bool &var, const octave_value_list &args, int nargout, const char *nm)
OCTINTERP_API octave_value	set_internal_variable (char &var, const octave_value_list &args, int nargout, const char *nm)
OCTINTERP_API octave_value	set_internal_variable (double &var, const octave_value_list &args, int nargout, const char *nm, double minval=-octave::numeric_limits< double >::Inf(), double maxval=octave::numeric_limits< double >::Inf())
OCTINTERP_API octave_value	set_internal_variable (int &var, const octave_value_list &args, int nargout, const char *nm, const char **choices)
OCTINTERP_API octave_value	set_internal_variable (int &var, const octave_value_list &args, int nargout, const char *nm, int minval=std::numeric_limits< int >::min(), int maxval=std::numeric_limits< int >::max())
OCTINTERP_API octave_value	set_internal_variable (std::string &var, const octave_value_list &args, int nargout, const char *nm, bool empty_ok=true)
OCTINTERP_API octave_value	set_internal_variable (std::string &var, const octave_value_list &args, int nargout, const char *nm, const char **choices)
OCTINTERP_API int	symbol_exist (const std::string &name, const std::string &type="any")
OCTINTERP_API std::string	unique_symbol_name (const std::string &basename)

Macro Definition Documentation

SET_INTERNAL_VARIABLE

#define SET_INTERNAL_VARIABLE

(

NM

)

set_internal_variable (V ## NM, args, nargout, #NM)

Definition at line 103 of file variables.h.

SET_INTERNAL_VARIABLE_CHOICES

#define SET_INTERNAL_VARIABLE_CHOICES	(		NM,
			CHOICES
	)		set_internal_variable (V ## NM, args, nargout, #NM, CHOICES)

Definition at line 113 of file variables.h.

SET_INTERNAL_VARIABLE_WITH_LIMITS

#define SET_INTERNAL_VARIABLE_WITH_LIMITS	(		NM,
			MINVAL,
			MAXVAL
	)		set_internal_variable (V ## NM, args, nargout, #NM, MINVAL, MAXVAL)

Definition at line 109 of file variables.h.

SET_NONEMPTY_INTERNAL_STRING_VARIABLE

#define SET_NONEMPTY_INTERNAL_STRING_VARIABLE

(

NM

)

set_internal_variable (V ## NM, args, nargout, #NM, false)

Definition at line 106 of file variables.h.

Function Documentation

extract_function()

OCTINTERP_API octave_function* extract_function	(	const octave_value &	arg,
		const std::string &	warn_for,
		const std::string &	fname,
		const std::string &	header,
		const std::string &	trailer
	)

Definition at line 124 of file variables.cc.

References octave::__get_interpreter__(), error(), octave::interpreter::eval_string(), is_valid_function(), retval, warning(), and octave_value::xstring_value().

get_struct_elts()

OCTINTERP_API string_vector get_struct_elts

(

const std::string &

text

)

Definition at line 1527 of file variables.cc.

References len, n, and retval.

is_valid_function() [1/2]

OCTINTERP_API octave_function* is_valid_function	(	const octave_value &	arg,
		const std::string &	warn_for = "",
		bool	warn = false
	)

Definition at line 102 of file variables.cc.

References error(), octave_value::is_string(), is_valid_function(), and octave_value::string_value().

is_valid_function() [2/2]

OCTINTERP_API octave_function* is_valid_function	(	const std::string &	fcn_name,
		const std::string &	warn_for = "",
		bool	warn = false
	)

Definition at line 77 of file variables.cc.

References octave::__get_symbol_table__(), error(), octave::symbol_table::find_function(), octave_value::function_value(), and octave_value::is_defined().

Referenced by extract_function(), named_hook_function::is_valid(), and is_valid_function().

maybe_missing_function_hook()

OCTINTERP_API std::string maybe_missing_function_hook

(

const std::string &

name

)

Definition at line 1433 of file variables.cc.

References octave::__get_interpreter__(), octave::feval(), octave::symbol_table::find_function(), octave::interpreter::get_symbol_table(), octave_value::is_defined(), octave_value_list::length(), name, octave::action_container::protect_var(), and Vmissing_function_hook.

Referenced by octave::tree_identifier::eval_undefined_error().

set_internal_variable() [1/7]

OCTINTERP_API octave_value set_internal_variable	(	bool &	var,
		const octave_value_list &	args,
		int	nargout,
		const char *	nm
	)

Definition at line 608 of file variables.cc.

References octave_value_list::length(), print_usage(), retval, try_local_protect(), wants_local_change(), and warning().

Referenced by octave::error_system::backtrace_on_warning(), octave::error_system::beep_on_error(), octave::load_save_system::crash_dumps_octave_core(), octave::error_system::debug_on_caught(), octave::error_system::debug_on_error(), octave::error_system::debug_on_warning(), octave::error_system::discard_warning_messages(), octave::settings::display_tokens(), octave::environment::editor(), octave::environment::exec_path(), F__parser_debug_flag__(), Fdebug_on_interrupt(), Fhistory_control(), Fhistory_file(), Fhistory_save(), Fhistory_size(), Fsighup_dumps_octave_core(), Fsigquit_dumps_octave_core(), Fsigterm_dumps_octave_core(), octave::environment::image_path(), octave::history_system::input_from_tmp_file(), octave::error_system::last_error_id(), octave::error_system::last_error_message(), octave::error_system::last_warning_id(), octave::error_system::last_warning_message(), octave::settings::lexer_debug_flag(), octave::tree_evaluator::max_recursion_depth(), octave::call_stack::max_stack_depth(), octave::load_save_system::octave_core_file_limit(), octave::load_save_system::octave_core_file_name(), octave::load_save_system::octave_core_file_options(), octave::output_system::page_output_immediately(), octave::output_system::page_screen_output(), octave::output_system::PAGER(), octave::output_system::PAGER_FLAGS(), octave::tree_evaluator::PS4(), octave::error_system::quiet_warning(), octave::load_save_system::save_default_options(), octave::load_save_system::save_header_format_string(), octave::tree_evaluator::silent_functions(), octave::tree_evaluator::string_fill_char(), octave::history_system::timestamp_format_string(), octave::error_system::verbose_warning(), and octave::tree_evaluator::whos_line_format().

set_internal_variable() [2/7]

OCTINTERP_API octave_value set_internal_variable	(	char &	var,
		const octave_value_list &	args,
		int	nargout,
		const char *	nm
	)

Definition at line 638 of file variables.cc.

References error(), octave_value_list::length(), print_usage(), retval, try_local_protect(), wants_local_change(), and warning().

set_internal_variable() [3/7]

OCTINTERP_API octave_value set_internal_variable	(	double &	var,
		const octave_value_list &	args,
		int	nargout,
		const char *	nm,
		double	minval = -octave::numeric_limits< double >::Inf(),
		double	maxval = octave::numeric_limits< double >::Inf()
	)

Definition at line 717 of file variables.cc.

References error(), octave_value_list::length(), print_usage(), retval, try_local_protect(), wants_local_change(), and warning().

set_internal_variable() [4/7]

OCTINTERP_API octave_value set_internal_variable	(	int &	var,
		const octave_value_list &	args,
		int	nargout,
		const char *	nm,
		const char **	choices
	)

Definition at line 786 of file variables.cc.

References error(), octave_value_list::length(), print_usage(), retval, try_local_protect(), wants_local_change(), and warning().

set_internal_variable() [5/7]

OCTINTERP_API octave_value set_internal_variable	(	int &	var,
		const octave_value_list &	args,
		int	nargout,
		const char *	nm,
		int	minval = std::numeric_limits< int >::min(),
		int	maxval = std::numeric_limits< int >::max()
	)

Definition at line 681 of file variables.cc.

References error(), octave_value_list::length(), print_usage(), retval, try_local_protect(), wants_local_change(), and warning().

set_internal_variable() [6/7]

OCTINTERP_API octave_value set_internal_variable	(	std::string &	var,
		const octave_value_list &	args,
		int	nargout,
		const char *	nm,
		bool	empty_ok = true
	)

Definition at line 753 of file variables.cc.

References error(), octave_value_list::length(), print_usage(), retval, try_local_protect(), wants_local_change(), and warning().

set_internal_variable() [7/7]

OCTINTERP_API octave_value set_internal_variable	(	std::string &	var,
		const octave_value_list &	args,
		int	nargout,
		const char *	nm,
		const char **	choices
	)

Definition at line 831 of file variables.cc.

References error(), octave_value_list::length(), print_usage(), retval, try_local_protect(), wants_local_change(), and warning().

symbol_exist()

OCTINTERP_API int symbol_exist	(	const std::string &	name,
		const std::string &	type = "any"
	)

Definition at line 358 of file variables.cc.

References octave::__get_interpreter__(), name, and symbol_exist().

unique_symbol_name()

OCTINTERP_API std::string unique_symbol_name

(

const std::string &

basename

)

Definition at line 370 of file variables.cc.

References octave::__get_interpreter__(), basename(), GET_IDX, len, and symbol_exist().