utils.h File Reference

#include <cstdarg>
#include <iosfwd>
#include <string>
#include <list>
#include "dMatrix.h"
#include "lo-utils.h"
#include "cutils.h"

Include dependency graph for utils.h:

Go to the source code of this file.

Classes
class	octave_preserve_stream_state

Functions
OCTINTERP_API int	almost_match (const std::string &std, const std::string &s, int min_match_len=1, int case_sens=1)
OCTINTERP_API void	check_dimensions (dim_vector &dim, const char *warnfor)
OCTINTERP_API std::string	contents_file_in_path (const std::string &)
OCTINTERP_API octave_idx_type	dims_to_numel (const dim_vector &dims, const octave_value_list &idx)
OCTINTERP_API octave_value_list	do_simple_cellfun (octave_value_list(*fun)(const octave_value_list &, int), const char *fun_name, const octave_value_list &args, int nargout)
OCTINTERP_API octave_value	do_simple_cellfun (octave_value_list(*fun)(const octave_value_list &, int), const char *fun_name, const octave_value_list &args)
OCTINTERP_API std::string	do_string_escapes (const std::string &s)
OCTINTERP_API int	empty_arg (const char *name, octave_idx_type nr, octave_idx_type nc)
OCTINTERP_API std::string	fcn_file_in_path (const std::string &)
OCTINTERP_API std::string	file_in_path (const std::string &, const std::string &)
OCTINTERP_API std::string	find_data_file_in_load_path (const std::string &fcn, const std::string &file, bool require_regular_file=false)
OCTINTERP_API FloatMatrix	float_identity_matrix (octave_idx_type nr, octave_idx_type nc)
OCTINTERP_API void	get_dimensions (const octave_value &a, const char *warn_for, dim_vector &dim)
OCTINTERP_API void	get_dimensions (const octave_value &a, const octave_value &b, const char *warn_for, octave_idx_type &nr, octave_idx_type &nc)
OCTINTERP_API void	get_dimensions (const octave_value &a, const char *warn_for, octave_idx_type &nr, octave_idx_type &nc)
OCTINTERP_API Matrix	identity_matrix (octave_idx_type nr, octave_idx_type nc)
OCTINTERP_API int	keyword_almost_match (const char *const *std, int *min_len, const std::string &s, int min_toks_to_match, int max_toks)
OCTINTERP_API std::string	mex_file_in_path (const std::string &)
OCTINTERP_API std::string	oct_file_in_path (const std::string &)
OCTINTERP_API std::string	octave_asprintf (const char *fmt,...)
OCTINTERP_API size_t	octave_format (std::ostream &os, const char *fmt,...)
OCTINTERP_API void	octave_sleep (double seconds)
OCTINTERP_API std::string	octave_vasprintf (const char *fmt, va_list args)
OCTINTERP_API size_t	octave_vformat (std::ostream &os, const char *fmt, va_list args)
OCTINTERP_API bool	same_file (const std::string &f, const std::string &g)
OCTINTERP_API string_vector	search_path_for_all_files (const std::string &, const string_vector &)
OCTINTERP_API std::string	search_path_for_file (const std::string &, const string_vector &)
OCTINTERP_API const char *	undo_string_escape (char c)
OCTINTERP_API std::string	undo_string_escapes (const std::string &s)
OCTINTERP_API bool	valid_identifier (const char *s)
OCTINTERP_API bool	valid_identifier (const std::string &s)

Function Documentation

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

Definition at line 139 of file utils.cc.

References octave_strncasecmp().

Referenced by keyword_almost_match().

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

Definition at line 1121 of file utils.cc.

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

OCTINTERP_API std::string contents_file_in_path

(

const std::string &

)

Definition at line 539 of file utils.cc.

References file_ops::concat(), base_file_stat::exists(), load_path::find_dir(), and octave_env::make_absolute().

OCTINTERP_API octave_idx_type dims_to_numel	(	const dim_vector &	dims,
		const octave_value_list &	idx
	)

Definition at line 1221 of file utils.cc.

References error_state, octave_value::index_vector(), octave_value::is_magic_colon(), octave_value::is_numeric_type(), octave_value_list::length(), idx_vector::length(), dim_vector::numel(), octave_value::numel(), and dim_vector::redim().

Referenced by Fnumel(), and octave_base_value::numel().

OCTINTERP_API octave_value_list do_simple_cellfun	(	octave_value_list(*)(const octave_value_list &, int)	fun,
		const char *	fun_name,
		const octave_value_list &	args,
		int	nargout
	)

Definition at line 1437 of file utils.cc.

References arg(), octave_value::cell_value(), clear(), Array< T >::dims(), error(), error_state, octave_value::is_cell(), octave_value_list::length(), Array< T >::numel(), and OCTAVE_LOCAL_BUFFER.

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

OCTINTERP_API octave_value do_simple_cellfun	(	octave_value_list(*)(const octave_value_list &, int)	fun,
		const char *	fun_name,
		const octave_value_list &	args
	)

Definition at line 1517 of file utils.cc.

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

OCTINTERP_API std::string do_string_escapes

(

const std::string &

s

)

Definition at line 618 of file utils.cc.

References warning().

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

OCTINTERP_API int empty_arg	(	const char *	name,
		octave_idx_type	nr,
		octave_idx_type	nc
	)

Definition at line 246 of file utils.cc.

Referenced by Fdet(), Feig(), Fhess(), Finv(), Flu(), Fpinv(), Fqz(), Fsylvester(), Gchol(), and Gqr().

OCTINTERP_API std::string fcn_file_in_path

(

const std::string &

)

Definition at line 504 of file utils.cc.

References octave_env::absolute_pathname(), base_file_stat::exists(), load_path::find_fcn_file(), base_file_stat::is_dir(), and Vfilemarker.

Referenced by do_dbtype(), get_help_from_file(), and octave_user_function::mark_as_system_fcn_file().

OCTINTERP_API std::string file_in_path	(	const std::string &	,
		const std::string &
	)

Definition at line 452 of file utils.cc.

References load_path::find_file(), and octave_env::make_absolute().

Referenced by install_utils_fcns(), and symbol_exist().

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

Definition at line 463 of file utils.cc.

References octave_env::absolute_pathname(), base_file_stat::exists(), load_path::find_file(), gripe_data_file_in_path(), base_file_stat::is_reg(), octave_env::make_absolute(), and octave_env::rooted_relative_pathname().

Referenced by do_stream_open(), find_file_to_load(), and Fmd5sum().

OCTINTERP_API FloatMatrix float_identity_matrix	(	octave_idx_type	nr,
		octave_idx_type	nc
	)

Definition at line 1270 of file utils.cc.

References min().

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

Definition at line 1141 of file utils.cc.

References check_dimensions(), octave_value::columns(), error(), error_state, fix(), octave_value::int_value(), octave_value::is_scalar_type(), Array< T >::length(), dim_vector::resize(), octave_value::rows(), and octave_value::vector_value().

Referenced by Fcell(), Feye(), fill_matrix(), and Fsparse().

OCTINTERP_API 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 1208 of file utils.cc.

References check_dimensions(), error(), error_state, octave_value::int_value(), and octave_value::is_empty().

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

Definition at line 1177 of file utils.cc.

References check_dimensions(), octave_value::columns(), error(), error_state, fix(), octave_value::int_value(), octave_value::is_scalar_type(), octave_value::rows(), and octave_value::vector_value().

OCTINTERP_API Matrix identity_matrix	(	octave_idx_type	nr,
		octave_idx_type	nc
	)

Definition at line 1254 of file utils.cc.

References min().

OCTINTERP_API 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 155 of file utils.cc.

References almost_match(), and strsave().

Referenced by set_DASPK_options(), set_DASRT_options(), set_DASSL_options(), set_LSODE_options(), set_Quad_options(), show_DASPK_options(), show_DASRT_options(), show_DASSL_options(), show_LSODE_options(), and show_Quad_options().

OCTINTERP_API std::string mex_file_in_path

(

const std::string &

)

Definition at line 590 of file utils.cc.

References octave_env::absolute_pathname(), base_file_stat::exists(), and load_path::find_mex_file().

OCTINTERP_API std::string oct_file_in_path

(

const std::string &

)

Definition at line 561 of file utils.cc.

References octave_env::absolute_pathname(), base_file_stat::exists(), and load_path::find_oct_file().

OCTINTERP_API std::string octave_asprintf	(	const char *	fmt,
			...
	)

Definition at line 1329 of file utils.cc.

References octave_vasprintf().

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

Definition at line 1286 of file utils.cc.

References octave_vformat().

Referenced by do_printf_conv().

OCTINTERP_API void octave_sleep

(

double

seconds

)

Definition at line 1344 of file utils.cc.

References max(), octave_sleep(), and octave_usleep().

Referenced by octave_sleep().

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

Definition at line 1311 of file utils.cc.

References free().

Referenced by octave_asprintf(), and octave_vformat().

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

Definition at line 1301 of file utils.cc.

References octave_vasprintf().

Referenced by mexPrintf(), octave_format(), verror(), and vwarning().

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

Definition at line 133 of file utils.cc.

References same_file_internal().

Referenced by load_path::do_contains_canonical(), execute_startup_files(), octave_qt_link::file_in_path(), and out_of_date_check().

OCTINTERP_API string_vector search_path_for_all_files	(	const std::string &	,
		const string_vector &
	)

Definition at line 264 of file utils.cc.

References dir_path::find_all_first_of(), Array< T >::length(), and octave_env::make_absolute().

Referenced by Ffile_in_path().

OCTINTERP_API std::string search_path_for_file	(	const std::string &	,
		const string_vector &
	)

Definition at line 254 of file utils.cc.

References dir_path::find_first_of(), and octave_env::make_absolute().

Referenced by Ffile_in_path(), and have_gnuplot_binary().

OCTINTERP_API const char* undo_string_escape

(

char

c

)

Definition at line 754 of file utils.cc.

Referenced by octave_lex(), and undo_string_escapes().

OCTINTERP_API std::string undo_string_escapes

(

const std::string &

s

)

Definition at line 802 of file utils.cc.

References undo_string_escape().

Referenced by Fundo_string_escapes(), install_utils_fcns(), octave_base_parser::make_constant(), octave_print_internal(), scanf_format_list::printme(), and printf_format_list::printme().

OCTINTERP_API bool valid_identifier

(

const char *

s

)

Definition at line 77 of file utils.cc.

Referenced by octave_cmd_eval::execute(), Farrayfun(), Fassignin(), Fcellfun(), Fisvarname(), get_fcn_files(), load_path::dir_info::get_file_list(), hdf5_read_next_data(), maybe_warn_invalid_field_name(), read_ascii_data(), read_mat_ascii_data(), workspace_model::setData(), and valid_identifier().

OCTINTERP_API bool valid_identifier

(

const std::string &

s

)

Definition at line 90 of file utils.cc.

References valid_identifier().