defaults.in.h File Reference

#include <string>
#include "pathsearch.h"

Include dependency graph for defaults.in.h:

Go to the source code of this file.

Macros
#define	OCTAVE_ARCHLIBDIR   %OCTAVE_ARCHLIBDIR%
#define	OCTAVE_BINDIR   %OCTAVE_BINDIR%
#define	OCTAVE_CANONICAL_HOST_TYPE   %OCTAVE_CANONICAL_HOST_TYPE%
#define	OCTAVE_DATADIR   %OCTAVE_DATADIR%
#define	OCTAVE_DATAROOTDIR   %OCTAVE_DATAROOTDIR%
#define	OCTAVE_DEFAULT_PAGER   %OCTAVE_DEFAULT_PAGER%
#define	OCTAVE_DOC_CACHE_FILE   %OCTAVE_DOC_CACHE_FILE%
#define	OCTAVE_EXEC_PREFIX   %OCTAVE_EXEC_PREFIX%
#define	OCTAVE_FCNFILEDIR   %OCTAVE_FCNFILEDIR%
#define	OCTAVE_IMAGEDIR   %OCTAVE_IMAGEDIR%
#define	OCTAVE_INCLUDEDIR   %OCTAVE_INCLUDEDIR%
#define	OCTAVE_INFODIR   %OCTAVE_INFODIR%
#define	OCTAVE_INFOFILE   %OCTAVE_INFOFILE%
#define	OCTAVE_LIBDIR   %OCTAVE_LIBDIR%
#define	OCTAVE_LIBEXECDIR   %OCTAVE_LIBEXECDIR%
#define	OCTAVE_LOCALAPIARCHLIBDIR   %OCTAVE_LOCALAPIARCHLIBDIR%
#define	OCTAVE_LOCALAPIFCNFILEDIR   %OCTAVE_LOCALAPIFCNFILEDIR%
#define	OCTAVE_LOCALAPIOCTFILEDIR   %OCTAVE_LOCALAPIOCTFILEDIR%
#define	OCTAVE_LOCALARCHLIBDIR   %OCTAVE_LOCALARCHLIBDIR%
#define	OCTAVE_LOCALFCNFILEDIR   %OCTAVE_LOCALFCNFILEDIR%
#define	OCTAVE_LOCALOCTFILEDIR   %OCTAVE_LOCALOCTFILEDIR%
#define	OCTAVE_LOCALSTARTUPFILEDIR   %OCTAVE_LOCALSTARTUPFILEDIR%
#define	OCTAVE_LOCALVERARCHLIBDIR   %OCTAVE_LOCALVERARCHLIBDIR%
#define	OCTAVE_LOCALVERFCNFILEDIR   %OCTAVE_LOCALVERFCNFILEDIR%
#define	OCTAVE_LOCALVEROCTFILEDIR   %OCTAVE_LOCALVEROCTFILEDIR%
#define	OCTAVE_MAN1DIR   %OCTAVE_MAN1DIR%
#define	OCTAVE_MAN1EXT   %OCTAVE_MAN1EXT%
#define	OCTAVE_MANDIR   %OCTAVE_MANDIR%
#define	OCTAVE_OCTDATADIR   %OCTAVE_OCTDATADIR%
#define	OCTAVE_OCTETCDIR   %OCTAVE_OCTETCDIR%
#define	OCTAVE_OCTFILEDIR   %OCTAVE_OCTFILEDIR%
#define	OCTAVE_OCTINCLUDEDIR   %OCTAVE_OCTINCLUDEDIR%
#define	OCTAVE_OCTLIBDIR   %OCTAVE_OCTLIBDIR%
#define	OCTAVE_OCTLOCALEDIR   %OCTAVE_OCTLOCALEDIR%
#define	OCTAVE_OCTTESTSDIR   %OCTAVE_OCTTESTSDIR%
#define	OCTAVE_PREFIX   %OCTAVE_PREFIX%
#define	OCTAVE_RELEASE   %OCTAVE_RELEASE%
#define	OCTAVE_STARTUPFILEDIR   %OCTAVE_STARTUPFILEDIR%
#define	OCTAVE_TEXI_MACROS_FILE   %OCTAVE_TEXI_MACROS_FILE%

Functions
OCTINTERP_API void	install_defaults (void)
OCTINTERP_API void	set_exec_path (const std::string &path=std::string())
OCTINTERP_API void	set_image_path (const std::string &path=std::string())
OCTINTERP_API std::string	subst_octave_home (const std::string &)

Variables
OCTINTERP_API std::string	Varch_lib_dir
OCTINTERP_API std::string	Vbin_dir
OCTINTERP_API std::string	Vbuilt_in_docstrings_file
OCTINTERP_API std::string	Vdata_dir
OCTINTERP_API std::string	VEDITOR
OCTINTERP_API std::string	Vfcn_file_dir
OCTINTERP_API std::string	Vfftw_wisdom_program
OCTINTERP_API std::string	Vimage_dir
OCTINTERP_API std::string	Vinfo_dir
OCTINTERP_API std::string	Vlibexec_dir
OCTINTERP_API std::string	Vlocal_api_fcn_file_dir
OCTINTERP_API std::string	Vlocal_api_oct_file_dir
OCTINTERP_API std::string	Vlocal_arch_lib_dir
OCTINTERP_API std::string	Vlocal_fcn_file_dir
OCTINTERP_API std::string	Vlocal_oct_file_dir
OCTINTERP_API std::string	Vlocal_site_defaults_file
OCTINTERP_API std::string	Vlocal_ver_arch_lib_dir
OCTINTERP_API std::string	Vlocal_ver_fcn_file_dir
OCTINTERP_API std::string	Vlocal_ver_oct_file_dir
OCTINTERP_API std::string	Voct_data_dir
OCTINTERP_API std::string	Voct_etc_dir
OCTINTERP_API std::string	Voct_file_dir
OCTINTERP_API std::string	Voct_locale_dir
OCTINTERP_API std::string	Voctave_home
OCTINTERP_API std::string	Vsite_defaults_file

Macro Definition Documentation

#define OCTAVE_ARCHLIBDIR   %OCTAVE_ARCHLIBDIR%

Definition at line 40 of file defaults.in.h.

#define OCTAVE_BINDIR   %OCTAVE_BINDIR%

Definition at line 44 of file defaults.in.h.

#define OCTAVE_CANONICAL_HOST_TYPE   %OCTAVE_CANONICAL_HOST_TYPE%

Definition at line 32 of file defaults.in.h.

#define OCTAVE_DATADIR   %OCTAVE_DATADIR%

Definition at line 48 of file defaults.in.h.

#define OCTAVE_DATAROOTDIR   %OCTAVE_DATAROOTDIR%

Definition at line 52 of file defaults.in.h.

#define OCTAVE_DEFAULT_PAGER   %OCTAVE_DEFAULT_PAGER%

Definition at line 36 of file defaults.in.h.

#define OCTAVE_DOC_CACHE_FILE   %OCTAVE_DOC_CACHE_FILE%

Definition at line 56 of file defaults.in.h.

#define OCTAVE_EXEC_PREFIX   %OCTAVE_EXEC_PREFIX%

Definition at line 64 of file defaults.in.h.

#define OCTAVE_FCNFILEDIR   %OCTAVE_FCNFILEDIR%

Definition at line 68 of file defaults.in.h.

#define OCTAVE_IMAGEDIR   %OCTAVE_IMAGEDIR%

Definition at line 72 of file defaults.in.h.

#define OCTAVE_INCLUDEDIR   %OCTAVE_INCLUDEDIR%

Definition at line 76 of file defaults.in.h.

#define OCTAVE_INFODIR   %OCTAVE_INFODIR%

Definition at line 80 of file defaults.in.h.

#define OCTAVE_INFOFILE   %OCTAVE_INFOFILE%

Definition at line 84 of file defaults.in.h.

#define OCTAVE_LIBDIR   %OCTAVE_LIBDIR%

Definition at line 88 of file defaults.in.h.

#define OCTAVE_LIBEXECDIR   %OCTAVE_LIBEXECDIR%

Definition at line 92 of file defaults.in.h.

#define OCTAVE_LOCALAPIARCHLIBDIR   %OCTAVE_LOCALAPIARCHLIBDIR%

Definition at line 124 of file defaults.in.h.

#define OCTAVE_LOCALAPIFCNFILEDIR   %OCTAVE_LOCALAPIFCNFILEDIR%

Definition at line 100 of file defaults.in.h.

#define OCTAVE_LOCALAPIOCTFILEDIR   %OCTAVE_LOCALAPIOCTFILEDIR%

Definition at line 104 of file defaults.in.h.

#define OCTAVE_LOCALARCHLIBDIR   %OCTAVE_LOCALARCHLIBDIR%

Definition at line 108 of file defaults.in.h.

#define OCTAVE_LOCALFCNFILEDIR   %OCTAVE_LOCALFCNFILEDIR%

Definition at line 112 of file defaults.in.h.

#define OCTAVE_LOCALOCTFILEDIR   %OCTAVE_LOCALOCTFILEDIR%

Definition at line 116 of file defaults.in.h.

#define OCTAVE_LOCALSTARTUPFILEDIR   %OCTAVE_LOCALSTARTUPFILEDIR%

Definition at line 120 of file defaults.in.h.

#define OCTAVE_LOCALVERARCHLIBDIR   %OCTAVE_LOCALVERARCHLIBDIR%

Definition at line 128 of file defaults.in.h.

#define OCTAVE_LOCALVERFCNFILEDIR   %OCTAVE_LOCALVERFCNFILEDIR%

Definition at line 132 of file defaults.in.h.

#define OCTAVE_LOCALVEROCTFILEDIR   %OCTAVE_LOCALVEROCTFILEDIR%

Definition at line 136 of file defaults.in.h.

#define OCTAVE_MAN1DIR   %OCTAVE_MAN1DIR%

Definition at line 140 of file defaults.in.h.

#define OCTAVE_MAN1EXT   %OCTAVE_MAN1EXT%

Definition at line 144 of file defaults.in.h.

#define OCTAVE_MANDIR   %OCTAVE_MANDIR%

Definition at line 148 of file defaults.in.h.

#define OCTAVE_OCTDATADIR   %OCTAVE_OCTDATADIR%

Definition at line 152 of file defaults.in.h.

#define OCTAVE_OCTETCDIR   %OCTAVE_OCTETCDIR%

Definition at line 160 of file defaults.in.h.

#define OCTAVE_OCTFILEDIR   %OCTAVE_OCTFILEDIR%

Definition at line 156 of file defaults.in.h.

#define OCTAVE_OCTINCLUDEDIR   %OCTAVE_OCTINCLUDEDIR%

Definition at line 168 of file defaults.in.h.

#define OCTAVE_OCTLIBDIR   %OCTAVE_OCTLIBDIR%

Definition at line 172 of file defaults.in.h.

#define OCTAVE_OCTLOCALEDIR   %OCTAVE_OCTLOCALEDIR%

Definition at line 164 of file defaults.in.h.

#define OCTAVE_OCTTESTSDIR   %OCTAVE_OCTTESTSDIR%

Definition at line 176 of file defaults.in.h.

#define OCTAVE_PREFIX   %OCTAVE_PREFIX%

Definition at line 180 of file defaults.in.h.

#define OCTAVE_RELEASE   %OCTAVE_RELEASE%

Definition at line 188 of file defaults.in.h.

#define OCTAVE_STARTUPFILEDIR   %OCTAVE_STARTUPFILEDIR%

Definition at line 184 of file defaults.in.h.

#define OCTAVE_TEXI_MACROS_FILE   %OCTAVE_TEXI_MACROS_FILE%

Definition at line 60 of file defaults.in.h.

Function Documentation

OCTINTERP_API void install_defaults

(

void

)

Definition at line 419 of file defaults.cc.

References set_built_in_docstrings_file(), set_default_arch_lib_dir(), set_default_bin_dir(), set_default_data_dir(), set_default_doc_cache_file(), set_default_editor(), set_default_fcn_file_dir(), set_default_image_dir(), set_default_info_dir(), set_default_info_file(), set_default_info_prog(), set_default_libexec_dir(), set_default_local_api_arch_lib_dir(), set_default_local_api_fcn_file_dir(), set_default_local_api_oct_file_dir(), set_default_local_arch_lib_dir(), set_default_local_fcn_file_dir(), set_default_local_oct_file_dir(), set_default_local_ver_arch_lib_dir(), set_default_local_ver_fcn_file_dir(), set_default_local_ver_oct_file_dir(), set_default_oct_data_dir(), set_default_oct_etc_dir(), set_default_oct_file_dir(), set_default_oct_locale_dir(), set_default_texi_macros_file(), set_exec_path(), set_image_path(), set_local_site_defaults_file(), set_octave_home(), and set_site_defaults_file().

Referenced by main(), and octave_main().

OCTINTERP_API void set_exec_path

(

const std::string &

path = std::string()

)

Definition at line 253 of file defaults.cc.

References octave_env::getenv(), dir_path::path_sep_str(), octave_env::putenv(), Varch_lib_dir, Vbin_dir, VEXEC_PATH, Vlocal_api_arch_lib_dir, Vlocal_arch_lib_dir, and Vlocal_ver_arch_lib_dir.

Referenced by FEXEC_PATH(), install_defaults(), and octave_initialize_interpreter().

OCTINTERP_API void set_image_path

(

const std::string &

path = std::string()

)

Definition at line 292 of file defaults.cc.

References genpath(), octave_env::getenv(), dir_path::path_sep_str(), Vimage_dir, and VIMAGE_PATH.

Referenced by install_defaults(), and octave_initialize_interpreter().

OCTINTERP_API std::string subst_octave_home

(

const std::string &

)

Definition at line 101 of file defaults.cc.

References file_ops::dir_sep_char(), OCTAVE_PREFIX, replace(), and Voctave_home.

Referenced by set_default_arch_lib_dir(), set_default_bin_dir(), set_default_data_dir(), set_default_doc_cache_file(), set_default_fcn_file_dir(), set_default_image_dir(), set_default_info_dir(), set_default_info_file(), set_default_libexec_dir(), set_default_local_api_arch_lib_dir(), set_default_local_api_fcn_file_dir(), set_default_local_api_oct_file_dir(), set_default_local_arch_lib_dir(), set_default_local_fcn_file_dir(), set_default_local_oct_file_dir(), set_default_local_ver_arch_lib_dir(), set_default_local_ver_fcn_file_dir(), set_default_local_ver_oct_file_dir(), set_default_oct_data_dir(), set_default_oct_etc_dir(), set_default_oct_file_dir(), set_default_oct_locale_dir(), set_default_texi_macros_file(), set_local_site_defaults_file(), and set_site_defaults_file().

Variable Documentation

OCTINTERP_API std::string Varch_lib_dir

Definition at line 64 of file defaults.cc.

Referenced by set_default_arch_lib_dir(), and set_exec_path().

OCTINTERP_API std::string Vbin_dir

Definition at line 60 of file defaults.cc.

Referenced by set_default_bin_dir(), and set_exec_path().

OCTINTERP_API std::string Vbuilt_in_docstrings_file

Definition at line 98 of file defaults.cc.

Referenced by install_built_in_docstrings(), and set_built_in_docstrings_file().

OCTINTERP_API std::string Vdata_dir

Definition at line 62 of file defaults.cc.

Referenced by set_default_data_dir().

OCTINTERP_API std::string VEDITOR

Definition at line 91 of file defaults.cc.

Referenced by do_edit_history(), and set_default_editor().

OCTINTERP_API std::string Vfcn_file_dir

Definition at line 82 of file defaults.cc.

Referenced by load_path::do_initialize(), octave_user_function::mark_as_system_fcn_file(), and set_default_fcn_file_dir().

OCTINTERP_API std::string Vfftw_wisdom_program

OCTINTERP_API std::string Vimage_dir

Definition at line 84 of file defaults.cc.

Referenced by set_default_image_dir(), and set_image_path().

OCTINTERP_API std::string Vinfo_dir

Definition at line 61 of file defaults.cc.

Referenced by set_default_info_dir().

OCTINTERP_API std::string Vlibexec_dir

Definition at line 63 of file defaults.cc.

Referenced by set_default_libexec_dir().

OCTINTERP_API std::string Vlocal_api_fcn_file_dir

Definition at line 74 of file defaults.cc.

Referenced by load_path::do_initialize(), and set_default_local_api_fcn_file_dir().

OCTINTERP_API std::string Vlocal_api_oct_file_dir

Definition at line 70 of file defaults.cc.

Referenced by load_path::do_initialize(), and set_default_local_api_oct_file_dir().

OCTINTERP_API std::string Vlocal_arch_lib_dir

Definition at line 65 of file defaults.cc.

Referenced by set_default_local_arch_lib_dir(), and set_exec_path().

OCTINTERP_API std::string Vlocal_fcn_file_dir

Definition at line 75 of file defaults.cc.

Referenced by load_path::do_initialize(), and set_default_local_fcn_file_dir().

OCTINTERP_API std::string Vlocal_oct_file_dir

Definition at line 71 of file defaults.cc.

Referenced by load_path::do_initialize(), and set_default_local_oct_file_dir().

OCTINTERP_API std::string Vlocal_site_defaults_file

Definition at line 95 of file defaults.cc.

Referenced by execute_startup_files(), and set_local_site_defaults_file().

OCTINTERP_API std::string Vlocal_ver_arch_lib_dir

Definition at line 67 of file defaults.cc.

Referenced by set_default_local_ver_arch_lib_dir(), and set_exec_path().

OCTINTERP_API std::string Vlocal_ver_fcn_file_dir

Definition at line 73 of file defaults.cc.

Referenced by load_path::do_initialize(), and set_default_local_ver_fcn_file_dir().

OCTINTERP_API std::string Vlocal_ver_oct_file_dir

Definition at line 69 of file defaults.cc.

Referenced by load_path::do_initialize(), and set_default_local_ver_oct_file_dir().

OCTINTERP_API std::string Voct_data_dir

Definition at line 77 of file defaults.cc.

Referenced by load_path::do_initialize(), and set_default_oct_data_dir().

OCTINTERP_API std::string Voct_etc_dir

Definition at line 78 of file defaults.cc.

Referenced by default_qt_settings_file(), main_window::display_release_notes(), set_built_in_docstrings_file(), and set_default_oct_etc_dir().

OCTINTERP_API std::string Voct_file_dir

Definition at line 81 of file defaults.cc.

Referenced by load_path::do_initialize(), octave_dld_function::octave_dld_function(), octave_mex_function::octave_mex_function(), and set_default_oct_file_dir().

OCTINTERP_API std::string Voct_locale_dir

Definition at line 79 of file defaults.cc.

Referenced by resource_manager::get_gui_translation_dir(), and set_default_oct_locale_dir().

OCTINTERP_API std::string Voctave_home

Definition at line 58 of file defaults.cc.

Referenced by FOCTAVE_HOME(), set_octave_home(), and subst_octave_home().

OCTINTERP_API std::string Vsite_defaults_file

Definition at line 96 of file defaults.cc.

Referenced by execute_startup_files(), and set_site_defaults_file().