GNU Octave  6.2.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
octave::help_system Class Reference

#include "help.h"

Collaboration diagram for octave::help_system:
Collaboration graph
[legend]

Public Member Functions

 help_system (interpreter &interp)
 
octave_value built_in_docstrings_file (const octave_value_list &args, int nargout)
 
std::string built_in_docstrings_file (const std::string &file)
 
std::string built_in_docstrings_file (void) const
 
octave_value doc_cache_file (const octave_value_list &args, int nargout)
 
std::string doc_cache_file (const std::string &file)
 
std::string doc_cache_file (void) const
 
void get_help_text (const std::string &name, std::string &text, std::string &format) const
 
void get_help_text_from_file (const std::string &fname, std::string &text, std::string &format) const
 
octave_value info_file (const octave_value_list &args, int nargout)
 
std::string info_file (const std::string &file)
 
std::string info_file (void) const
 
octave_value info_program (const octave_value_list &args, int nargout)
 
std::string info_program (const std::string &file)
 
std::string info_program (void) const
 
string_vector make_name_list (void) const
 
octave_value makeinfo_program (const octave_value_list &args, int nargout)
 
std::string makeinfo_program (const std::string &file)
 
std::string makeinfo_program (void) const
 
std::string raw_help (const std::string &, bool &) const
 
bool suppress_verbose_help_message (bool flag)
 
octave_value suppress_verbose_help_message (const octave_value_list &args, int nargout)
 
bool suppress_verbose_help_message (void) const
 
octave_value texi_macros_file (const octave_value_list &args, int nargout)
 
std::string texi_macros_file (const std::string &file)
 
std::string texi_macros_file (void) const
 
std::string which (const std::string &name) const
 
std::string which (const std::string &name, std::string &type) const
 

Private Member Functions

string_vector local_functions (void) const
 
bool raw_help_from_docstrings_file (const std::string &nm, std::string &h, bool &symbol_found) const
 
bool raw_help_from_file (const std::string &nm, std::string &h, std::string &file, bool &symbol_found) const
 
bool raw_help_from_symbol_table (const std::string &nm, std::string &h, std::string &w, bool &symbol_found) const
 
template<typename T >
T set (T &var, const T &new_val)
 

Static Private Member Functions

static std::string init_built_in_docstrings_file (void)
 
static std::string init_doc_cache_file (void)
 
static std::string init_info_file (void)
 
static std::string init_info_program (void)
 
static std::string init_texi_macros_file (void)
 

Private Attributes

std::string m_built_in_docstrings_file
 
std::string m_doc_cache_file
 
std::string m_info_file
 
std::string m_info_program
 
interpreter & m_interpreter
 
std::string m_makeinfo_program
 
bool m_suppress_verbose_help_message
 
std::string m_texi_macros_file
 

Detailed Description

Definition at line 43 of file help.h.

Constructor & Destructor Documentation

◆ help_system()

octave::help_system::help_system ( interpreter &  interp)
inline

Definition at line 47 of file help.h.

Member Function Documentation

◆ built_in_docstrings_file() [1/3]

octave_value octave::help_system::built_in_docstrings_file ( const octave_value_list &  args,
int  nargout 
)

◆ built_in_docstrings_file() [2/3]

std::string octave::help_system::built_in_docstrings_file ( const std::string &  file)
inline

Definition at line 64 of file help.h.

References m_built_in_docstrings_file, and set().

◆ built_in_docstrings_file() [3/3]

std::string octave::help_system::built_in_docstrings_file ( void  ) const
inline

Definition at line 62 of file help.h.

References m_built_in_docstrings_file.

◆ doc_cache_file() [1/3]

octave_value octave::help_system::doc_cache_file ( const octave_value_list &  args,
int  nargout 
)

◆ doc_cache_file() [2/3]

std::string octave::help_system::doc_cache_file ( const std::string &  file)
inline

Definition at line 73 of file help.h.

References m_doc_cache_file, and set().

◆ doc_cache_file() [3/3]

std::string octave::help_system::doc_cache_file ( void  ) const
inline

Definition at line 71 of file help.h.

References m_doc_cache_file.

◆ get_help_text()

void octave::help_system::get_help_text ( const std::string &  name,
std::string &  text,
std::string &  format 
) const

◆ get_help_text_from_file()

void octave::help_system::get_help_text_from_file ( const std::string &  fname,
std::string &  text,
std::string &  format 
) const

◆ info_file() [1/3]

octave_value octave::help_system::info_file ( const octave_value_list &  args,
int  nargout 
)

◆ info_file() [2/3]

std::string octave::help_system::info_file ( const std::string &  file)
inline

Definition at line 82 of file help.h.

References m_info_file, and set().

◆ info_file() [3/3]

std::string octave::help_system::info_file ( void  ) const
inline

Definition at line 80 of file help.h.

References m_info_file.

◆ info_program() [1/3]

octave_value octave::help_system::info_program ( const octave_value_list &  args,
int  nargout 
)

◆ info_program() [2/3]

std::string octave::help_system::info_program ( const std::string &  file)
inline

Definition at line 91 of file help.h.

References m_info_program, and set().

◆ info_program() [3/3]

std::string octave::help_system::info_program ( void  ) const
inline

Definition at line 89 of file help.h.

References m_info_program.

◆ init_built_in_docstrings_file()

static std::string octave::help_system::init_built_in_docstrings_file ( void  )
staticprivate

◆ init_doc_cache_file()

static std::string octave::help_system::init_doc_cache_file ( void  )
staticprivate

◆ init_info_file()

static std::string octave::help_system::init_info_file ( void  )
staticprivate

◆ init_info_program()

static std::string octave::help_system::init_info_program ( void  )
staticprivate

◆ init_texi_macros_file()

static std::string octave::help_system::init_texi_macros_file ( void  )
staticprivate

◆ local_functions()

string_vector octave::help_system::local_functions ( void  ) const
private

◆ make_name_list()

string_vector octave::help_system::make_name_list ( void  ) const

◆ makeinfo_program() [1/3]

octave_value octave::help_system::makeinfo_program ( const octave_value_list &  args,
int  nargout 
)

◆ makeinfo_program() [2/3]

std::string octave::help_system::makeinfo_program ( const std::string &  file)
inline

Definition at line 100 of file help.h.

References m_makeinfo_program, and set().

◆ makeinfo_program() [3/3]

std::string octave::help_system::makeinfo_program ( void  ) const
inline

Definition at line 98 of file help.h.

References m_makeinfo_program.

◆ raw_help()

std::string octave::help_system::raw_help ( const std::string &  ,
bool &   
) const

◆ raw_help_from_docstrings_file()

bool octave::help_system::raw_help_from_docstrings_file ( const std::string &  nm,
std::string &  h,
bool &  symbol_found 
) const
private

◆ raw_help_from_file()

bool octave::help_system::raw_help_from_file ( const std::string &  nm,
std::string &  h,
std::string &  file,
bool &  symbol_found 
) const
private

◆ raw_help_from_symbol_table()

bool octave::help_system::raw_help_from_symbol_table ( const std::string &  nm,
std::string &  h,
std::string &  w,
bool &  symbol_found 
) const
private

◆ set()

template<typename T >
T octave::help_system::set ( T &  var,
const T &  new_val 
)
inlineprivate

Definition at line 183 of file help.h.

Referenced by built_in_docstrings_file(), doc_cache_file(), info_file(), info_program(), makeinfo_program(), suppress_verbose_help_message(), and texi_macros_file().

◆ suppress_verbose_help_message() [1/3]

bool octave::help_system::suppress_verbose_help_message ( bool  flag)
inline

Definition at line 113 of file help.h.

References m_suppress_verbose_help_message, and set().

◆ suppress_verbose_help_message() [2/3]

octave_value octave::help_system::suppress_verbose_help_message ( const octave_value_list &  args,
int  nargout 
)

◆ suppress_verbose_help_message() [3/3]

bool octave::help_system::suppress_verbose_help_message ( void  ) const
inline

Definition at line 108 of file help.h.

References m_suppress_verbose_help_message.

◆ texi_macros_file() [1/3]

octave_value octave::help_system::texi_macros_file ( const octave_value_list &  args,
int  nargout 
)

◆ texi_macros_file() [2/3]

std::string octave::help_system::texi_macros_file ( const std::string &  file)
inline

Definition at line 122 of file help.h.

References m_texi_macros_file, and set().

◆ texi_macros_file() [3/3]

std::string octave::help_system::texi_macros_file ( void  ) const
inline

Definition at line 120 of file help.h.

References m_texi_macros_file.

◆ which() [1/2]

std::string octave::help_system::which ( const std::string &  name) const

Referenced by Fdbstatus().

◆ which() [2/2]

std::string octave::help_system::which ( const std::string &  name,
std::string &  type 
) const

Member Data Documentation

◆ m_built_in_docstrings_file

std::string octave::help_system::m_built_in_docstrings_file
private

Definition at line 146 of file help.h.

Referenced by built_in_docstrings_file().

◆ m_doc_cache_file

std::string octave::help_system::m_doc_cache_file
private

Definition at line 150 of file help.h.

Referenced by doc_cache_file().

◆ m_info_file

std::string octave::help_system::m_info_file
private

Definition at line 154 of file help.h.

Referenced by info_file().

◆ m_info_program

std::string octave::help_system::m_info_program
private

Definition at line 158 of file help.h.

Referenced by info_program().

◆ m_interpreter

interpreter& octave::help_system::m_interpreter
private

Definition at line 142 of file help.h.

◆ m_makeinfo_program

std::string octave::help_system::m_makeinfo_program
private

Definition at line 161 of file help.h.

Referenced by makeinfo_program().

◆ m_suppress_verbose_help_message

bool octave::help_system::m_suppress_verbose_help_message
private

Definition at line 165 of file help.h.

Referenced by suppress_verbose_help_message().

◆ m_texi_macros_file

std::string octave::help_system::m_texi_macros_file
private

Definition at line 170 of file help.h.

Referenced by texi_macros_file().

The documentation for this class was generated from the following file: