#include <cerrno>
#include <cstring>
#include <fstream>
#include <limits>
#include <ostream>
#include <string>
#include "dir-ops.h"
#include "file-ops.h"
#include "file-stat.h"
#include "lo-mappers.h"
#include "lo-sysdep.h"
#include "lo-utils.h"
#include "nanosleep-wrapper.h"
#include "oct-cmplx.h"
#include "oct-env.h"
#include "oct-locbuf.h"
#include "oct-string.h"
#include "pathsearch.h"
#include "quit.h"
#include "str-vec.h"
#include "strcase-wrappers.h"
#include "vasprintf-wrapper.h"
#include "Cell.h"
#include "defun.h"
#include "error.h"
#include "errwarn.h"
#include "graphics.h"
#include "interpreter-private.h"
#include "interpreter.h"
#include "lex.h"
#include "load-path.h"
#include "oct-errno.h"
#include "oct-hist.h"
#include "ovl.h"
#include "ov-range.h"
#include "pager.h"
#include "parse.h"
#include "sysdep.h"
#include "unwind-prot.h"
#include "utils.h"
#include "variables.h"

Functions
int	almost_match (const std::string &std, const std::string &s, int min_match_len, int case_sens)

std::string	asprintf (const char *fmt,...)

void	check_dimensions (dim_vector &dim, const char *warnfor)

std::string	contents_file_in_path (const std::string &dir)

octave_idx_type	dims_to_numel (const dim_vector &dims, const octave_value_list &idx_arg)

void	display_file_lines (std::ostream &os, const std::string &file_name, int start, int end, int target_line, const std::string &marker, const std::string &who)

octave_value	do_simple_cellfun (octave_value_list(fcn)(const octave_value_list &, int), const char fcn_name, const octave_value_list &args)

octave_value_list	do_simple_cellfun (octave_value_list(fcn)(const octave_value_list &, int), const char fcn_name, const octave_value_list &args, int nargout)

std::string	do_string_escapes (const std::string &s)

octave_value_list	F__make_valid_name__ (const octave_value_list &args, int)

std::string	fcn_file_in_path (const std::string &name)

octave_value_list	Fdir_in_loadpath (octave::interpreter &interp, const octave_value_list &args, int)

octave_value_list	Fdo_string_escapes (const octave_value_list &args, int)

octave_value_list	Ferrno (const octave_value_list &args, int)

octave_value_list	Ferrno_list (const octave_value_list &args, int)

octave_value_list	Ffile_in_loadpath (octave::interpreter &interp, const octave_value_list &args, int)

octave_value_list	Ffile_in_path (const octave_value_list &args, int)

std::string	file_in_path (const std::string &name, const std::string &suffix)

std::string	find_data_file_in_load_path (const std::string &fcn, const std::string &file, bool require_regular_file)

octave_value_list	Fis_absolute_filename (const octave_value_list &args, int)

octave_value_list	Fis_rooted_relative_filename (const octave_value_list &args, int)

octave_value_list	Fis_same_file (const octave_value_list &args, int)

octave_value_list	Fisindex (octave::interpreter &interp, const octave_value_list &args, int)

octave_value_list	Fisstudent (const octave_value_list &args, int)

octave_value_list	Fisvarname (const octave_value_list &args, int)

FloatMatrix	float_identity_matrix (octave_idx_type nr, octave_idx_type nc)

octave_value_list	Fmake_absolute_filename (const octave_value_list &args, int)

std::size_t	format (std::ostream &os, const char *fmt,...)

octave_value_list	Fundo_string_escapes (const octave_value_list &args, int)

void	get_dimensions (const octave_value &a, const char *warn_for, dim_vector &dim)

void	get_dimensions (const octave_value &a, const char *warn_for, octave_idx_type &nr, octave_idx_type &nc)

void	get_dimensions (const octave_value &a, const octave_value &b, const char *warn_for, octave_idx_type &nr, octave_idx_type &nc)

Matrix	identity_matrix (octave_idx_type nr, octave_idx_type nc)

int	keyword_almost_match (const char const std, int *min_len, const std::string &s, int min_toks_to_match, int max_toks)

bool	make_valid_name (std::string &str, const make_valid_name_options &options)
	Modify `str` to be a valid variable name.

bool	same_file (const std::string &f, const std::string &g)

string_vector	search_path_for_all_files (const std::string &path, const string_vector &names)

std::string	search_path_for_file (const std::string &path, const string_vector &names)

void	sleep (double seconds, bool do_graphics_events)

const char *	undo_string_escape (char c)

std::string	undo_string_escapes (const std::string &s)

bool	valid_identifier (const char *s)

bool	valid_identifier (const std::string &s)

std::string	vasprintf (const char *fmt, va_list args)

std::size_t	vformat (std::ostream &os, const char *fmt, va_list args)

Function Documentation

◆ almost_match()

int almost_match	(	const std::string &	std,
		const std::string &	s,
		int	min_match_len,
		int	case_sens
	)

Definition at line 412 of file utils.cc.

References octave_strncasecmp(), and strncmp().

Referenced by keyword_almost_match().

◆ asprintf()

std::string asprintf	(	const char *	fmt,
			...
	)

Definition at line 1557 of file utils.cc.

References vasprintf().

◆ check_dimensions()

void check_dimensions	(	dim_vector &	dim,
		const char *	warnfor
	)

Definition at line 1358 of file utils.cc.

References dim_vector::ndims(), and warning_with_id().

Referenced by Fcell().

◆ contents_file_in_path()

std::string contents_file_in_path ( const std::string & dir )

Definition at line 788 of file utils.cc.

References __get_load_path__(), and load_path::find_dir().

◆ dims_to_numel()

octave_idx_type dims_to_numel	(	const dim_vector &	dims,
		const octave_value_list &	idx_arg
	)

Definition at line 1442 of file utils.cc.

References error(), octave_value::index_vector(), octave_value::is_magic_colon(), octave_value::isnumeric(), len, octave_value_list::length(), idx_vector::length(), octave_value::numel(), dim_vector::numel(), and dim_vector::redim().

Referenced by Fnumel().

◆ display_file_lines()

void display_file_lines	(	std::ostream &	os,
		const std::string &	file_name,
		int	start,
		int	end,
		int	target_line,
		const std::string &	marker,
		const std::string &	who
	)

Definition at line 807 of file utils.cc.

Referenced by stack_frame::debug_list(), and stack_frame::debug_type().

◆ do_simple_cellfun() [1/2]

octave_value do_simple_cellfun	(	octave_value_list(*)(const octave_value_list &, int)	fcn,
		const char *	fcn_name,
		const octave_value_list &	args
	)

Definition at line 1776 of file utils.cc.

References do_simple_cellfun(), and octave_value_list::length().

◆ do_simple_cellfun() [2/2]

octave_value_list do_simple_cellfun	(	octave_value_list(*)(const octave_value_list &, int)	fcn,
		const char *	fcn_name,
		const octave_value_list &	args,
		int	nargout
	)

Definition at line 1708 of file utils.cc.

References octave_value::cell_value(), Array< T, Alloc >::dims(), error(), octave_value::iscell(), octave_value_list::length(), Array< T, Alloc >::numel(), numel(), OCTAVE_LOCAL_BUFFER, and octave_value_list::resize().

Referenced by do_simple_cellfun(), Fstrfind(), and Fstrrep().

◆ do_string_escapes()

std::string do_string_escapes ( const std::string & s )

Definition at line 838 of file utils.cc.

References len, and warning().

Referenced by Fdlmread(), Fdo_string_escapes(), stream::oscanf(), stream::printf(), and stream::scanf().

◆ F__make_valid_name__()

octave_value_list F__make_valid_name__	(	const octave_value_list &	args,
		int
	)

Definition at line 268 of file utils.cc.

References Array< T, Alloc >::dims(), error(), make_valid_name(), Array< T, Alloc >::numel(), ovl(), and print_usage().

◆ fcn_file_in_path()

std::string fcn_file_in_path ( const std::string & name )

Definition at line 749 of file utils.cc.

References __get_load_path__(), load_path::find_fcn_file(), and len.

Referenced by tree_evaluator::echo(), and get_help_from_file().

◆ Fdir_in_loadpath()

octave_value_list Fdir_in_loadpath	(	octave::interpreter &	interp,
		const octave_value_list &	args,
		int
	)

Definition at line 1225 of file utils.cc.

References load_path::find_dir(), load_path::find_matching_dirs(), ovl(), and print_usage().

◆ Fdo_string_escapes()

octave_value_list Fdo_string_escapes	(	const octave_value_list &	args,
		int
	)

Definition at line 972 of file utils.cc.

References do_string_escapes(), ovl(), and print_usage().

◆ Ferrno()

octave_value_list Ferrno	(	const octave_value_list &	args,
		int
	)

Definition at line 1279 of file utils.cc.

References octave_errno::get(), octave_errno::lookup(), print_usage(), octave_errno::set(), and octave_value::string_value().

◆ Ferrno_list()

octave_value_list Ferrno_list	(	const octave_value_list &	args,
		int
	)

Definition at line 1329 of file utils.cc.

References octave_errno::list(), ovl(), and print_usage().

◆ Ffile_in_loadpath()

octave_value_list Ffile_in_loadpath	(	octave::interpreter &	interp,
		const octave_value_list &	args,
		int
	)

Definition at line 577 of file utils.cc.

References string_vector::empty(), error(), load_path::find_all_first_of(), load_path::find_first_of(), ovl(), and print_usage().

◆ Ffile_in_path()

octave_value_list Ffile_in_path	(	const octave_value_list &	args,
		int
	)

Definition at line 648 of file utils.cc.

References string_vector::empty(), error(), ovl(), print_usage(), search_path_for_all_files(), and search_path_for_file().

◆ file_in_path()

std::string file_in_path	(	const std::string &	name,
		const std::string &	suffix
	)

Definition at line 698 of file utils.cc.

References __get_load_path__(), and load_path::find_file().

◆ find_data_file_in_load_path()

std::string find_data_file_in_load_path	(	const std::string &	fcn,
		const std::string &	file,
		bool	require_regular_file
	)

Definition at line 711 of file utils.cc.

References __get_load_path__(), load_path::find_file(), and warn_data_file_in_path().

Referenced by Fdlmread().

◆ Fis_absolute_filename()

octave_value_list Fis_absolute_filename	(	const octave_value_list &	args,
		int
	)

Definition at line 1141 of file utils.cc.

References ovl(), and print_usage().

◆ Fis_rooted_relative_filename()

octave_value_list Fis_rooted_relative_filename	(	const octave_value_list &	args,
		int
	)

Definition at line 1162 of file utils.cc.

References ovl(), and print_usage().

◆ Fis_same_file()

octave_value_list Fis_same_file	(	const octave_value_list &	args,
		int
	)

Definition at line 325 of file utils.cc.

References octave_value::cellstr_value(), Array< T, Alloc >::dims(), error(), octave_value::is_string(), Array< T, Alloc >::numel(), print_usage(), and octave_value::string_value().

◆ Fisindex()

octave_value_list Fisindex	(	octave::interpreter &	interp,
		const octave_value_list &	args,
		int
	)

Definition at line 1665 of file utils.cc.

References idx_vector::extent(), and print_usage().

◆ Fisstudent()

octave_value_list Fisstudent	(	const octave_value_list &	args,
		int
	)

Definition at line 1796 of file utils.cc.

References ovl(), and print_usage().

◆ Fisvarname()

octave_value_list Fisvarname	(	const octave_value_list &	args,
		int
	)

Definition at line 105 of file utils.cc.

References iskeyword(), print_usage(), octave_value::string_value(), and valid_identifier().

◆ float_identity_matrix()

FloatMatrix float_identity_matrix	(	octave_idx_type	nr,
		octave_idx_type	nc
	)

Definition at line 1498 of file utils.cc.

◆ Fmake_absolute_filename()

octave_value_list Fmake_absolute_filename	(	const octave_value_list &	args,
		int
	)

Definition at line 1187 of file utils.cc.

References ovl(), and print_usage().

◆ format()

std::size_t format	(	std::ostream &	os,
		const char *	fmt,
			...
	)

Definition at line 1514 of file utils.cc.

References vformat().

Referenced by symbol_info_list::display(), F__magick_finfo__(), Faudiodevinfo(), opengl_functions::glDrawPixels(), opengl_functions::glReadPixels(), opengl_functions::glTexImage2D(), load_save_system::load(), symbol_info_list::parse_whos_line_format(), load_save_system::save(), and load_save_system::save_header_format_string().

◆ Fundo_string_escapes()

octave_value_list Fundo_string_escapes	(	const octave_value_list &	args,
		int
	)

Definition at line 1104 of file utils.cc.

References ovl(), print_usage(), and undo_string_escapes().

◆ get_dimensions() [1/3]

void get_dimensions	(	const octave_value &	a,
		const char *	warn_for,
		dim_vector &	dim
	)

Definition at line 1377 of file utils.cc.

References octave_value::dims(), error(), dim_vector::isvector(), Array< T, Alloc >::numel(), dim_vector::numel(), octave_value::octave_idx_type_vector_value(), and dim_vector::resize().

Referenced by Fcell(), and Feye().

◆ get_dimensions() [2/3]

void get_dimensions	(	const octave_value &	a,
		const char *	warn_for,
		octave_idx_type &	nr,
		octave_idx_type &	nc
	)

Definition at line 1407 of file utils.cc.

References octave_value::columns(), error(), octave_value::idx_type_value(), octave_value::is_scalar_type(), octave_value::octave_idx_type_vector_value(), and octave_value::rows().

◆ get_dimensions() [3/3]

void get_dimensions	(	const octave_value &	a,
		const octave_value &	b,
		const char *	warn_for,
		octave_idx_type &	nr,
		octave_idx_type &	nc
	)

Definition at line 1431 of file utils.cc.

References octave_value::idx_type_value(), and octave_value::isempty().

◆ identity_matrix()

Matrix identity_matrix	(	octave_idx_type	nr,
		octave_idx_type	nc
	)

Definition at line 1482 of file utils.cc.

◆ keyword_almost_match()

int keyword_almost_match	(	const char const	std,
		int *	min_len,
		const std::string &	s,
		int	min_toks_to_match,
		int	max_toks
	)

Definition at line 428 of file utils.cc.

References almost_match(), and strsave().

◆ make_valid_name()

bool make_valid_name	(	std::string &	str,
		const make_valid_name_options &	options
	)

Modify str to be a valid variable name.

Parameters

str	input string
options	see also `help matlab.lang.makeValidName`.

Returns: true, if str was modified.

Definition at line 137 of file utils.cc.

References make_valid_name_options::get_prefix(), make_valid_name_options::get_replacement_style(), iskeyword(), valid_identifier(), and x.

Referenced by F__make_valid_name__().

◆ same_file()

bool same_file	(	const std::string &	f,
		const std::string &	g
	)

Definition at line 297 of file utils.cc.

References f.

◆ search_path_for_all_files()

string_vector search_path_for_all_files	(	const std::string &	path,
		const string_vector &	names
	)

Definition at line 528 of file utils.cc.

References directory_path::find_all_first_of(), len, string_vector::numel(), and string_vector::std_list().

Referenced by Ffile_in_path().

◆ search_path_for_file()

std::string search_path_for_file	(	const std::string &	path,
		const string_vector &	names
	)

Definition at line 517 of file utils.cc.

References directory_path::find_first_of(), and string_vector::std_list().

Referenced by Ffile_in_path().

◆ sleep()

void sleep	(	double	seconds,
		bool	do_graphics_events
	)

Definition at line 1577 of file utils.cc.

References __get_gh_manager__(), flush_stdout(), kbhit(), octave_nanosleep_wrapper(), gh_manager::process_events(), and gh_manager::unlock().

Referenced by Fpause(), and tree_evaluator::server_loop().

◆ undo_string_escape()

const char * undo_string_escape ( char c )

Definition at line 1020 of file utils.cc.

Referenced by undo_string_escapes().

◆ undo_string_escapes()

std::string undo_string_escapes ( const std::string & s )

Definition at line 1065 of file utils.cc.

References undo_string_escape().

Referenced by Fundo_string_escapes(), and base_parser::make_constant().

◆ valid_identifier() [1/2]

bool valid_identifier ( const char * s )

Definition at line 79 of file utils.cc.

Referenced by make_valid_name_options::make_valid_name_options(), tree_evaluator::assignin(), Farrayfun(), Fcellfun(), Fdisplay(), Fisvarname(), make_valid_name(), and valid_identifier().

◆ valid_identifier() [2/2]

bool valid_identifier ( const std::string & s )

Definition at line 92 of file utils.cc.

References valid_identifier().

◆ vasprintf()

std::string vasprintf	(	const char *	fmt,
		va_list	args
	)

Definition at line 1539 of file utils.cc.

References free(), and octave_vasprintf_wrapper().

Referenced by asprintf(), octave_vasprintf_wrapper(), and vformat().

◆ vformat()

std::size_t vformat	(	std::ostream &	os,
		const char *	fmt,
		va_list	args
	)

Definition at line 1529 of file utils.cc.

References vasprintf().

Referenced by format().

Functions

Function Documentation

◆ almost_match()

◆ asprintf()

◆ check_dimensions()

◆ contents_file_in_path()

◆ dims_to_numel()

◆ display_file_lines()

◆ do_simple_cellfun() [1/2]

◆ do_simple_cellfun() [2/2]

◆ do_string_escapes()

◆ F__make_valid_name__()

◆ fcn_file_in_path()

◆ Fdir_in_loadpath()

◆ Fdo_string_escapes()

◆ Ferrno()

◆ Ferrno_list()

◆ Ffile_in_loadpath()

◆ Ffile_in_path()

◆ file_in_path()

◆ find_data_file_in_load_path()

◆ Fis_absolute_filename()

◆ Fis_rooted_relative_filename()

◆ Fis_same_file()

◆ Fisindex()

◆ Fisstudent()

◆ Fisvarname()

◆ float_identity_matrix()

◆ Fmake_absolute_filename()

◆ format()

◆ Fundo_string_escapes()

◆ get_dimensions() [1/3]

◆ get_dimensions() [2/3]

◆ get_dimensions() [3/3]

◆ identity_matrix()

◆ keyword_almost_match()

◆ make_valid_name()

◆ same_file()

◆ search_path_for_all_files()

◆ search_path_for_file()

◆ sleep()

◆ undo_string_escape()

◆ undo_string_escapes()

◆ valid_identifier() [1/2]

◆ valid_identifier() [2/2]

◆ vasprintf()

◆ vformat()