GNU Octave  9.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
defaults.h
Go to the documentation of this file.
1 ////////////////////////////////////////////////////////////////////////
2 //
3 // Copyright (C) 1993-2024 The Octave Project Developers
4 //
5 // See the file COPYRIGHT.md in the top-level directory of this
6 // distribution or <https://octave.org/copyright/>.
7 //
8 // This file is part of Octave.
9 //
10 // Octave is free software: you can redistribute it and/or modify it
11 // under the terms of the GNU General Public License as published by
12 // the Free Software Foundation, either version 3 of the License, or
13 // (at your option) any later version.
14 //
15 // Octave is distributed in the hope that it will be useful, but
16 // WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 // GNU General Public License for more details.
19 //
20 // You should have received a copy of the GNU General Public License
21 // along with Octave; see the file COPYING. If not, see
22 // <https://www.gnu.org/licenses/>.
23 //
24 ////////////////////////////////////////////////////////////////////////
25 
26 #if ! defined (octave_defaults_h)
27 #define octave_defaults_h 1
28 
29 #include "octave-config.h"
30 
31 #include <string>
32 
33 #include "pathsearch.h"
34 
35 OCTAVE_BEGIN_NAMESPACE(octave)
36 
37 OCTAVE_BEGIN_NAMESPACE(config)
38 
39 extern OCTINTERP_API std::string
40 prepend_octave_home (const std::string& s);
41 
42 extern OCTINTERP_API std::string
43 prepend_octave_exec_home (const std::string& s);
44 
45 // These could be defined as pure constants, but we'll use
46 // functions to be consistent with the values that require
47 // initialization.
48 
49 extern OCTINTERP_API std::string canonical_host_type ();
50 extern OCTINTERP_API std::string release ();
51 extern OCTINTERP_API std::string default_pager ();
52 
53 // These require initialization, so can't be defined as pure
54 // constants. We use functions to access these values so that
55 // they can't be modified by users.
56 
57 extern OCTINTERP_API std::string octave_home ();
58 extern OCTINTERP_API std::string octave_exec_home ();
59 
60 extern OCTINTERP_API std::string bin_dir ();
61 extern OCTINTERP_API std::string data_dir ();
62 extern OCTINTERP_API std::string dataroot_dir ();
63 extern OCTINTERP_API std::string include_dir ();
64 extern OCTINTERP_API std::string lib_dir ();
65 extern OCTINTERP_API std::string libexec_dir ();
66 
67 extern OCTINTERP_API std::string local_ver_arch_lib_dir ();
68 extern OCTINTERP_API std::string local_api_arch_lib_dir ();
69 extern OCTINTERP_API std::string local_arch_lib_dir ();
70 extern OCTINTERP_API std::string arch_lib_dir ();
71 
72 extern OCTINTERP_API std::string local_ver_oct_file_dir ();
73 extern OCTINTERP_API std::string local_api_oct_file_dir ();
74 extern OCTINTERP_API std::string local_oct_file_dir ();
75 extern OCTINTERP_API std::string oct_file_dir ();
76 
77 extern OCTINTERP_API std::string local_ver_fcn_file_dir ();
78 extern OCTINTERP_API std::string local_api_fcn_file_dir ();
79 extern OCTINTERP_API std::string local_fcn_file_dir ();
80 extern OCTINTERP_API std::string fcn_file_dir ();
81 
82 extern OCTINTERP_API std::string oct_data_dir ();
83 extern OCTINTERP_API std::string oct_doc_dir ();
84 extern OCTINTERP_API std::string oct_etc_dir ();
85 extern OCTINTERP_API std::string oct_fonts_dir ();
86 extern OCTINTERP_API std::string oct_include_dir ();
87 extern OCTINTERP_API std::string oct_lib_dir ();
88 extern OCTINTERP_API std::string oct_locale_dir ();
89 extern OCTINTERP_API std::string oct_tests_dir ();
90 
91 extern OCTINTERP_API std::string info_dir ();
92 
93 extern OCTINTERP_API std::string man_dir ();
94 extern OCTINTERP_API std::string man1_dir ();
95 extern OCTINTERP_API std::string man1_ext ();
96 
97 extern OCTINTERP_API std::string image_dir ();
98 
99 extern OCTINTERP_API std::string local_startupfile_dir ();
100 extern OCTINTERP_API std::string startupfile_dir ();
101 
102 extern OCTINTERP_API std::string local_site_defaults_file ();
103 extern OCTINTERP_API std::string site_defaults_file ();
104 
105 OCTAVE_END_NAMESPACE(config)
106 
107 OCTAVE_END_NAMESPACE(octave)
108 
109 #endif
OCTAVE_BEGIN_NAMESPACE
OCTAVE_BEGIN_NAMESPACE(octave) static octave_value daspk_fcn
startupfile_dir
std::string startupfile_dir()
man_dir
std::string man_dir()
dataroot_dir
std::string dataroot_dir()
oct_doc_dir
std::string oct_doc_dir()
default_pager
std::string default_pager()
local_ver_arch_lib_dir
std::string local_ver_arch_lib_dir()
local_oct_file_dir
std::string local_oct_file_dir()
prepend_octave_home
std::string prepend_octave_home(const std::string &s)
local_startupfile_dir
std::string local_startupfile_dir()
octave_exec_home
std::string octave_exec_home()
canonical_host_type
std::string canonical_host_type()
oct_fonts_dir
std::string oct_fonts_dir()
lib_dir
std::string lib_dir()
local_fcn_file_dir
std::string local_fcn_file_dir()
include_dir
std::string include_dir()
local_api_oct_file_dir
std::string local_api_oct_file_dir()
local_arch_lib_dir
std::string local_arch_lib_dir()
info_dir
std::string info_dir()
oct_tests_dir
std::string oct_tests_dir()
fcn_file_dir
std::string fcn_file_dir()
site_defaults_file
std::string site_defaults_file()
bin_dir
std::string bin_dir()
local_api_fcn_file_dir
std::string local_api_fcn_file_dir()
local_ver_fcn_file_dir
std::string local_ver_fcn_file_dir()
man1_dir
std::string man1_dir()
octave_home
std::string octave_home()
oct_etc_dir
std::string oct_etc_dir()
prepend_octave_exec_home
std::string prepend_octave_exec_home(const std::string &s)
local_ver_oct_file_dir
std::string local_ver_oct_file_dir()
local_api_arch_lib_dir
std::string local_api_arch_lib_dir()
man1_ext
std::string man1_ext()
libexec_dir
std::string libexec_dir()
image_dir
std::string image_dir()
local_site_defaults_file
std::string local_site_defaults_file()
oct_locale_dir
std::string oct_locale_dir()
oct_file_dir
std::string oct_file_dir()
oct_data_dir
std::string oct_data_dir()
release
std::string release()
oct_include_dir
std::string oct_include_dir()
oct_lib_dir
std::string oct_lib_dir()
data_dir
std::string data_dir()
arch_lib_dir
std::string arch_lib_dir()