GNU Octave  4.2.1
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Functions | Variables
help.cc File Reference
#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"
Include dependency graph for help.cc:

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
 

Function Documentation

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 string_vector local_functions ( void  )
static
static bool looks_like_html ( const std::string msg)
static

Definition at line 278 of file help.cc.

References string, and t.

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

Definition at line 289 of file help.cc.

References string, and t.

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

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 bool raw_help_from_file ( const std::string nm,
std::string h,
std::string file,
bool symbol_found 
)
static

Definition at line 335 of file help.cc.

References get_help_from_file(), and retval.

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

Variable Documentation

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}}

Definition at line 521 of file help.cc.

is the root directory of the Octave installation

Definition at line 521 of file help.cc.

const string_vector keyword_names(keywords)
static

Referenced by make_name_list().

const char* const keywords[]
static
const string_vector operator_names(operators)
static
const char* const operators[]
static

Definition at line 95 of file help.cc.

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().

std::string Vmakeinfo_program = "makeinfo"
static

Definition at line 89 of file help.cc.

bool Vsuppress_verbose_help_message = false
static

Definition at line 93 of file help.cc.

std::string Vtexi_macros_file

Definition at line 78 of file help.cc.

Referenced by set_default_texi_macros_file().