GNU Octave
4.2.1
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
|
#include <cstdlib>
#include <cstring>
#include <algorithm>
#include <fstream>
#include <iostream>
#include <map>
#include <sstream>
#include <string>
#include "cmd-edit.h"
#include "file-ops.h"
#include "file-stat.h"
#include "oct-env.h"
#include "oct-locbuf.h"
#include "str-vec.h"
#include "call-stack.h"
#include <defaults.h>
#include "Cell.h"
#include "defun.h"
#include "dirfns.h"
#include "error.h"
#include "errwarn.h"
#include "help.h"
#include "input.h"
#include "load-path.h"
#include "ovl.h"
#include "ov-usr-fcn.h"
#include "ov-fcn-handle.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 "interpreter.h"
#include "unwind-prot.h"
#include "utils.h"
#include "variables.h"
#include "version.h"
#include "quit.h"
Go to the source code of this file.
Functions | |
OCTAVE_EXPORT octave_value_list | Fbuilt_in_docstrings_file (const octave_value_list &args, int nargout) in which ar |
static string_vector | local_functions (void) |
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) |
std::string | raw_help (const std::string &nm, bool &symbol_found) |
static bool | raw_help_from_docstrings_file (const std::string &nm, std::string &h, 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_symbol_table (const std::string &nm, std::string &h, std::string &w, bool &symbol_found) |
Variables | |
is the root directory of the Octave and | ar {version} is the Octave version number. The default value may be overridden by the environment variable {nv{OCTAVE_BUILT_IN_DOCSTRINGS_FILE}} |
is the root directory of the Octave | installation |
static const string_vector | keyword_names (keywords) |
static const char *const | keywords [] |
static const string_vector | operator_names (operators) |
static const char *const | 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 |
OCTAVE_EXPORT octave_value_list Fbuilt_in_docstrings_file | ( | const octave_value_list & | args, |
int | nargout | ||
) |
Definition at line 521 of file help.cc.
Referenced by install_help_fcns().
|
static |
Definition at line 190 of file help.cc.
References octave_call_stack::caller_user_code(), symbol_table::get_curr_fcn(), octave_function::is_subfunction(), p, octave_function::parent_fcn_scope(), string_vector::resize(), retval, octave_function::subfunction_names(), and sz.
Referenced by make_name_list().
|
static |
|
static |
string_vector make_name_list | ( | void | ) |
Definition at line 222 of file help.cc.
References autoloaded_functions(), symbol_table::built_in_function_names(), symbol_table::cmdline_function_names(), load_path::fcn_names(), keyword_names, list, local_functions(), Array< T >::numel(), and symbol_table::variable_names().
Referenced by generate_possible_completions().
std::string raw_help | ( | const std::string & | nm, |
bool & | symbol_found | ||
) |
Definition at line 475 of file help.cc.
References f, found, h, nm, raw_help_from_docstrings_file(), raw_help_from_file(), raw_help_from_symbol_table(), string, and Faddeeva::w().
|
static |
Definition at line 349 of file help.cc.
References c, error(), file, fname, max(), name, OCTAVE_LOCAL_BUFFER, string, and Vbuilt_in_docstrings_file.
Referenced by raw_help().
|
static |
Definition at line 335 of file help.cc.
References get_help_from_file(), and retval.
Referenced by raw_help().
|
static |
Definition at line 304 of file help.cc.
References octave_function::doc_string(), fcn, octave_function::fcn_file_name(), symbol_table::find_function(), octave_value::function_value(), octave_value::is_defined(), octave_base_value::is_user_function(), retval, and val.
Referenced by raw_help().
|
static |
Referenced by make_name_list().
|
static |
Definition at line 147 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().
|
static |
std::string Vdoc_cache_file |
Definition at line 73 of file help.cc.
Referenced by set_default_doc_cache_file().
std::string Vinfo_file |
Definition at line 82 of file help.cc.
Referenced by set_default_info_file(), and webinfo::webinfo().
std::string Vinfo_program |
Definition at line 86 of file help.cc.
Referenced by set_default_info_prog().
|
static |
std::string Vtexi_macros_file |
Definition at line 78 of file help.cc.
Referenced by set_default_texi_macros_file().