help.cc File Reference

#include <cstdlib>
#include <cstring>
#include <algorithm>
#include <iostream>
#include <fstream>
#include <sstream>
#include <string>
#include <sys/types.h>
#include <unistd.h>
#include "cmd-edit.h"
#include "file-ops.h"
#include "file-stat.h"
#include "oct-env.h"
#include "str-vec.h"
#include <defaults.h>
#include "defun.h"
#include "dirfns.h"
#include "error.h"
#include "gripes.h"
#include "help.h"
#include "input.h"
#include "load-path.h"
#include "oct-obj.h"
#include "ov-usr-fcn.h"
#include "pager.h"
#include "parse.h"
#include "pathsearch.h"
#include "procstream.h"
#include "pt-pr-code.h"
#include "sighandlers.h"
#include "symtab.h"
#include "syswait.h"
#include "toplev.h"
#include "unwind-prot.h"
#include "utils.h"
#include "variables.h"
#include "version.h"
#include "quit.h"
#include <map>

Include dependency graph for help.cc:

Go to the source code of this file.

Typedefs
typedef map_type::const_iterator	map_iter
typedef std::map< std::string, std::string >	map_type
typedef map_type::value_type	pair_type

Functions
static void	do_get_help_text (const std::string &name, std::string &text, std::string &format)
static void	do_get_help_text_from_file (const std::string &fname, std::string &text, std::string &format)
static std::string	do_which (const std::string &name, std::string &type)
std::string	do_which (const std::string &name)
OCTAVE_EXPORT octave_value_list	F__builtins__ (const octave_value_list &, int)
OCTAVE_EXPORT octave_value_list	F__keywords__ (const octave_value_list &, int)
OCTAVE_EXPORT octave_value_list	F__list_functions__ (const octave_value_list &args, int)
OCTAVE_EXPORT octave_value_list	F__operators__ (const octave_value_list &, int)
OCTAVE_EXPORT octave_value_list	F__which__ (const octave_value_list &args, int)
OCTAVE_EXPORT octave_value_list	Fbuilt_in_docstrings_file (const octave_value_list &args, int nargout)
OCTAVE_EXPORT octave_value_list	Fdoc_cache_file (const octave_value_list &args, int nargout)
OCTAVE_EXPORT octave_value_list	Fget_help_text (const octave_value_list &args, int)
OCTAVE_EXPORT octave_value_list	Fget_help_text_from_file (const octave_value_list &args, int)
bool	file_is_in_dir (const std::string filename, const std::string dir)
OCTAVE_EXPORT octave_value_list	Finfo_file (const octave_value_list &args, int nargout)
OCTAVE_EXPORT octave_value_list	Finfo_program (const octave_value_list &args, int nargout)
OCTAVE_EXPORT octave_value_list	Fmakeinfo_program (const octave_value_list &args, int nargout)
OCTAVE_EXPORT octave_value_list	Fsuppress_verbose_help_message (const octave_value_list &args, int nargout)
OCTAVE_EXPORT octave_value_list	Ftexi_macros_file (const octave_value_list &args, int nargout)
void	install_built_in_docstrings (void)
static const map_type	keywords_map (keywords, keywords+size(keywords))
static bool	looks_like_html (const std::string &msg)
static bool	looks_like_texinfo (const std::string &msg, size_t &p1)
string_vector	make_name_list (void)
static string_vector	names (const map_type &lst)
static const map_type	operators_map (operators, operators+size(operators))
std::string	raw_help (const std::string &nm, bool &symbol_found)
static bool	raw_help_from_file (const std::string &nm, std::string &h, std::string &file, bool &symbol_found)
static bool	raw_help_from_map (const std::string &nm, std::string &h, const map_type &map, bool &symbol_found)
static bool	raw_help_from_symbol_table (const std::string &nm, std::string &h, std::string &w, bool &symbol_found)
template<typename T , std::size_t z>
std::size_t	size (T const (&)[z])

Variables
static const string_vector	keyword_names = names (keywords_map)
static const pair_type	keywords []
static const pair_type	operators []
std::string	Vdoc_cache_file
std::string	Vinfo_file
std::string	Vinfo_program
static std::string	Vmakeinfo_program = "makeinfo"
static bool	Vsuppress_verbose_help_message = false
std::string	Vtexi_macros_file

Typedef Documentation

typedef map_type::const_iterator map_iter

Definition at line 98 of file help.cc.

typedef std::map<std::string, std::string> map_type

Definition at line 96 of file help.cc.

typedef map_type::value_type pair_type

Definition at line 97 of file help.cc.

Function Documentation

static void do_get_help_text ( const std::string &  name, std::string &  text, std::string &  format  )

static

Definition at line 1035 of file help.cc.

References looks_like_html(), looks_like_texinfo(), and raw_help().

Referenced by Fget_help_text().

static void do_get_help_text_from_file ( const std::string &  fname, std::string &  text, std::string &  format  )

static

Definition at line 1100 of file help.cc.

References f, looks_like_html(), looks_like_texinfo(), and raw_help_from_file().

Referenced by Fget_help_text_from_file().

static std::string do_which ( const std::string &  name, std::string &  type  )

static

Definition at line 1207 of file help.cc.

References octave_function::fcn_file_name(), load_path::find_fcn_file(), load_path::find_file(), symbol_table::find_function(), octave_value::function_value(), octave_value::is_defined(), octave_base_value::is_user_function(), octave_value::is_user_script(), octave_env::make_absolute(), and octave_function::src_file_name().

Referenced by do_which(), F__which__(), and Fdbstatus().

std::string do_which

(

const std::string &

name

)

Definition at line 1265 of file help.cc.

References do_which().

OCTAVE_EXPORT octave_value_list F__builtins__	(	const octave_value_list &	,
		int
	)

Definition at line 1199 of file help.cc.

References symbol_table::built_in_function_names(), and octave_value().

OCTAVE_EXPORT octave_value_list F__keywords__	(	const octave_value_list &	,
		int
	)

Definition at line 1187 of file help.cc.

References keywords_map(), names(), and octave_value().

OCTAVE_EXPORT octave_value_list F__list_functions__	(	const octave_value_list &	args,
		int
	)

Definition at line 1355 of file help.cc.

References string_vector::append(), autoloaded_functions(), error(), error_state, load_path::fcn_names(), load_path::files(), and string_vector::sort().

OCTAVE_EXPORT octave_value_list F__operators__	(	const octave_value_list &	,
		int
	)

Definition at line 1175 of file help.cc.

References names(), octave_value(), and operators_map().

OCTAVE_EXPORT octave_value_list F__which__	(	const octave_value_list &	args,
		int
	)

Definition at line 1280 of file help.cc.

References octave_map::assign(), do_which(), error_state, Array< T >::length(), names(), and print_usage().

OCTAVE_EXPORT octave_value_list Fbuilt_in_docstrings_file	(	const octave_value_list &	args,
		int	nargout
	)

Definition at line 956 of file help.cc.

References SET_NONEMPTY_INTERNAL_STRING_VARIABLE.

Referenced by octave_process_command_line().

OCTAVE_EXPORT octave_value_list Fdoc_cache_file	(	const octave_value_list &	args,
		int	nargout
	)

Definition at line 1409 of file help.cc.

References SET_NONEMPTY_INTERNAL_STRING_VARIABLE.

Referenced by octave_process_command_line().

OCTAVE_EXPORT octave_value_list Fget_help_text	(	const octave_value_list &	args,
		int
	)

Definition at line 1072 of file help.cc.

References do_get_help_text(), error(), error_state, and print_usage().

OCTAVE_EXPORT octave_value_list Fget_help_text_from_file	(	const octave_value_list &	args,
		int
	)

Definition at line 1141 of file help.cc.

References do_get_help_text_from_file(), error(), error_state, and print_usage().

bool file_is_in_dir ( const std::string  filename, const std::string  dir  )

inline

Definition at line 1326 of file help.cc.

References file_ops::is_dir_sep().

OCTAVE_EXPORT octave_value_list Finfo_file	(	const octave_value_list &	args,
		int	nargout
	)

Definition at line 1455 of file help.cc.

References SET_NONEMPTY_INTERNAL_STRING_VARIABLE.

Referenced by octave_process_command_line().

OCTAVE_EXPORT octave_value_list Finfo_program	(	const octave_value_list &	args,
		int	nargout
	)

Definition at line 1479 of file help.cc.

References SET_NONEMPTY_INTERNAL_STRING_VARIABLE.

Referenced by octave_process_command_line().

OCTAVE_EXPORT octave_value_list Fmakeinfo_program	(	const octave_value_list &	args,
		int	nargout
	)

Definition at line 1497 of file help.cc.

References SET_NONEMPTY_INTERNAL_STRING_VARIABLE.

OCTAVE_EXPORT octave_value_list Fsuppress_verbose_help_message	(	const octave_value_list &	args,
		int	nargout
	)

Definition at line 1514 of file help.cc.

References SET_INTERNAL_VARIABLE.

OCTAVE_EXPORT octave_value_list Ftexi_macros_file	(	const octave_value_list &	args,
		int	nargout
	)

Definition at line 1433 of file help.cc.

References SET_NONEMPTY_INTERNAL_STRING_VARIABLE.

Referenced by octave_process_command_line().

void install_built_in_docstrings

(

void

)

Definition at line 962 of file help.cc.

References octave_function::document(), symbol_table::find_built_in_function(), octave_value::function_value(), octave_value::is_defined(), OCTAVE_LOCAL_BUFFER, and Vbuilt_in_docstrings_file.

Referenced by install_builtins().

static const map_type keywords_map ( keywords  , keywords+  sizekeywords  )

static

Referenced by F__keywords__(), and raw_help().

static bool looks_like_html ( const std::string &  msg )

static

Definition at line 844 of file help.cc.

Referenced by do_get_help_text(), and do_get_help_text_from_file().

static bool looks_like_texinfo ( const std::string &  msg, size_t &  p1  )

static

Definition at line 855 of file help.cc.

Referenced by do_get_help_text(), and do_get_help_text_from_file().

string_vector make_name_list

(

void

)

Definition at line 794 of file help.cc.

References autoloaded_functions(), symbol_table::built_in_function_names(), symbol_table::cmdline_function_names(), load_path::fcn_names(), Array< T >::length(), and symbol_table::variable_names().

Referenced by generate_possible_completions().

static string_vector names ( const map_type &  lst )

static

Definition at line 778 of file help.cc.

Referenced by QTerminal::color_names(), do_dbstack(), do_load(), do_who(), F__keywords__(), F__operators__(), F__which__(), Fdbstatus(), Ffile_in_loadpath(), Ffile_in_path(), generate_possible_completions(), generate_struct_completions(), octave_base_value::get_umap_name(), main_window::handle_rename_variable_request(), octave_value_list::name_tags(), octave_value_list::operator=(), pr_where(), read_mat5_binary_element(), graphics_object::set(), octave_fcn_handle::set_fcn(), octave_value_list::slice(), octave_value_list::stash_name_tags(), octave_user_function::stash_subfunction_names(), and workspace_model::storage_class_names().

static const map_type operators_map ( operators  , operators+  sizeoperators  )

static

Referenced by F__operators__(), and raw_help().

std::string raw_help	(	const std::string &	nm,
		bool &	symbol_found
	)

Definition at line 925 of file help.cc.

References f, keywords_map(), operators_map(), raw_help_from_file(), raw_help_from_map(), raw_help_from_symbol_table(), and Faddeeva::w().

Referenced by do_get_help_text().

static bool raw_help_from_file ( const std::string &  nm, std::string &  h, std::string &  file, bool &  symbol_found  )

static

Definition at line 901 of file help.cc.

References get_help_from_file().

Referenced by do_get_help_text_from_file(), and raw_help().

static bool raw_help_from_map ( const std::string &  nm, std::string &  h, const map_type &  map, bool &  symbol_found  )

static

Definition at line 915 of file help.cc.

Referenced by raw_help().

static bool raw_help_from_symbol_table ( const std::string &  nm, std::string &  h, std::string &  w, bool &  symbol_found  )

static

Definition at line 870 of file help.cc.

References octave_function::doc_string(), octave_function::fcn_file_name(), symbol_table::find_function(), octave_value::function_value(), octave_value::is_defined(), and octave_base_value::is_user_function().

Referenced by raw_help().

template<typename T , std::size_t z>

std::size_t size

(

T const

(&)[z]

)

Definition at line 102 of file help.cc.

Referenced by octave_allocator::alloc(), Screen::BackSpace(), caseless_str::compare(), default_history_size(), action_container::discard(), dlsode(), do_fread(), ft_manager::do_get_font(), action_container::empty(), Fbase64_decode(), Ffread(), Ffscanf(), Fsscanf(), Fterminal_size(), ft_render::ft_font::get_face(), text_element_fontsize::get_fontsize(), get_size(), ft_render::ft_font::get_size(), ScreenWindow::getImage(), Screen::insertChars(), install_data_fcns(), octave_base_list< tree_index_expression * >::length(), lin_interpn(), octave__create_buffer(), octave_chunk_buffer::octave_chunk_buffer(), octave_local_buffer< T >::octave_local_buffer(), octave_tex__create_buffer(), ft_render::ft_font::operator=(), QUnixTerminalImpl::resizeEvent(), action_container::run(), safe_size_comp(), save_mat5_array_length(), HistoryTypeFile::scroll(), HistoryTypeBuffer::scroll(), TerminalView::setSize(), Screen::ShowCharacter(), slsode(), write_mat5_array(), and write_mat5_integer_data().

Variable Documentation

const string_vector keyword_names = names (keywords_map)

static

Definition at line 789 of file help.cc.

const pair_type keywords[]

static

Definition at line 444 of file help.cc.

Referenced by octave_struct::load_ascii(), octave_float_complex_matrix::load_ascii(), octave_char_matrix_str::load_ascii(), octave_complex_matrix::load_ascii(), octave_cell::load_ascii(), octave_float_matrix::load_ascii(), octave_bool_matrix::load_ascii(), and octave_matrix::load_ascii().

const pair_type operators[]

static

Definition at line 107 of file help.cc.

std::string Vdoc_cache_file

Definition at line 72 of file help.cc.

Referenced by set_default_doc_cache_file().

std::string Vinfo_file

Definition at line 81 of file help.cc.

Referenced by set_default_info_file(), and webinfo::webinfo().

std::string Vinfo_program

Definition at line 85 of file help.cc.

Referenced by set_default_info_prog().

std::string Vmakeinfo_program = "makeinfo"

static

Definition at line 88 of file help.cc.

bool Vsuppress_verbose_help_message = false

static

Definition at line 92 of file help.cc.

std::string Vtexi_macros_file

Definition at line 77 of file help.cc.

Referenced by set_default_texi_macros_file().