Mercurial > octave
annotate libinterp/corefcn/environment.cc @ 29961:7d6709900da7
eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
Files affected: __betainc__.cc, __contourc__.cc, __eigs__.cc,
__expint__.cc, __ftp__.cc, __gammainc__.cc, __ichol__.cc, __ilu__.cc,
__magick_read__.cc, __pchip_deriv__.cc, __qp__.cc, amd.cc, balance.cc,
besselj.cc, bsxfun.cc, call-stack.cc, ccolamd.cc, cellfun.cc, chol.cc,
colamd.cc, colloc.cc, conv2.cc, daspk.cc, dasrt.cc, dassl.cc, data.cc,
defaults.cc, dirfns.cc, display.cc, dlmread.cc, dmperm.cc, dot.cc,
eig.cc, ellipj.cc, environment.cc, error.cc, event-manager.cc, fft.cc,
fft2.cc, fftn.cc, file-io.cc, find.cc, gcd.cc, getgrent.cc,
getpwent.cc, getrusage.cc, gsvd.cc, hash.cc, help.cc, hess.cc,
hex2num.cc, input.cc, inv.cc, jsondecode.cc, jsonencode.cc,
load-path.cc, load-save.cc, lookup.cc, lsode.cc, lu.cc, max.cc,
mgorth.cc, oct-hist.cc, ordqz.cc, ordschur.cc, pager.cc, pr-output.cc,
psi.cc, qr.cc, quad.cc, quadcc.cc, qz.cc, rand.cc, regexp.cc,
schur.cc, settings.cc, sighandlers.cc, sparse.cc, spparms.cc,
sqrtm.cc, stream-euler.cc, strfind.cc, strfns.cc, sub2ind.cc, svd.cc,
symbfact.cc, symtab.cc, syscalls.cc, sysdep.cc, time.cc, toplev.cc,
tril.cc, typecast.cc, urlwrite.cc, utils.cc, variables.cc,
__delaunayn__.cc, __fltk_uigetfile__.cc, __glpk__.cc,
__init_gnuplot__.cc, __ode15__.cc, __voronoi__.cc, audiodevinfo.cc,
audioread.cc, convhulln.cc, fftw.cc, gzip.cc, ov-cell.cc, ov-class.cc,
ov-classdef.cc, ov-fcn-handle.cc, ov-struct.cc, ov-typeinfo.cc,
ov-usr-fcn.cc, octave.cc, lex.ll, oct-parse.yy, profiler.cc,
andpt-eval.cc.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Sat, 14 Aug 2021 22:48:52 -0400 |
parents | 939bef0b66e0 |
children | 796f54d4ddbf |
rev | line source |
---|---|
27923
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
1 //////////////////////////////////////////////////////////////////////// |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
2 // |
29358
0a5b15007766
update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents:
27923
diff
changeset
|
3 // Copyright (C) 2017-2021 The Octave Project Developers |
27923
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
4 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
5 // See the file COPYRIGHT.md in the top-level directory of this |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
6 // distribution or <https://octave.org/copyright/>. |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
7 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
8 // This file is part of Octave. |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
9 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
10 // Octave is free software: you can redistribute it and/or modify it |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
11 // under the terms of the GNU General Public License as published by |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
12 // the Free Software Foundation, either version 3 of the License, or |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
13 // (at your option) any later version. |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
14 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
15 // Octave is distributed in the hope that it will be useful, but |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
16 // WITHOUT ANY WARRANTY; without even the implied warranty of |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
18 // GNU General Public License for more details. |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
19 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
20 // You should have received a copy of the GNU General Public License |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
21 // along with Octave; see the file COPYING. If not, see |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
22 // <https://www.gnu.org/licenses/>. |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
23 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
24 //////////////////////////////////////////////////////////////////////// |
23719 | 25 |
26 #if defined (HAVE_CONFIG_H) | |
27 # include "config.h" | |
28 #endif | |
29 | |
30 #include <string> | |
31 | |
32 #include "dir-ops.h" | |
33 #include "oct-env.h" | |
34 #include "file-stat.h" | |
35 #include "pathsearch.h" | |
36 #include "str-vec.h" | |
37 | |
25460
627d6bde9b8d
solve installation info initialization problem differently
John W. Eaton <jwe@octave.org>
parents:
25440
diff
changeset
|
38 #include "defaults.h" |
23719 | 39 #include "defun.h" |
40 #include "environment.h" | |
41 #include "interpreter.h" | |
42 #include "variables.h" | |
43 | |
29960
939bef0b66e0
merge "namespace octave" and OCTAVE_NAMESPACE_BEGIN/END blocks
John W. Eaton <jwe@octave.org>
parents:
29958
diff
changeset
|
44 OCTAVE_NAMESPACE_BEGIN |
939bef0b66e0
merge "namespace octave" and OCTAVE_NAMESPACE_BEGIN/END blocks
John W. Eaton <jwe@octave.org>
parents:
29958
diff
changeset
|
45 |
27101
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
46 static void append_to_shell_path (const std::string& exec_path) |
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
47 { |
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
48 // FIXME: should there be a way to remove a previous setting from |
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
49 // PATH? |
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
50 |
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
51 if (exec_path.empty ()) |
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
52 return; |
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
53 |
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
54 // FIXME: should we really be modifying PATH in the environment? |
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
55 |
27102
84ff9953faa1
where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
27101
diff
changeset
|
56 std::string shell_path = sys::env::getenv ("PATH"); |
27101
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
57 |
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
58 if (shell_path.empty ()) |
27102
84ff9953faa1
where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
27101
diff
changeset
|
59 sys::env::putenv ("PATH", exec_path); |
27101
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
60 else |
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
61 { |
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
62 // If PATH doesn't already have exec_path, append it. |
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
63 // FIXME: should we search for the elements individually, and |
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
64 // only append those that are missing? |
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
65 |
27102
84ff9953faa1
where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
27101
diff
changeset
|
66 std::string path_sep = directory_path::path_sep_str (); |
27101
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
67 |
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
68 if (shell_path.find (exec_path) == std::string::npos) |
27102
84ff9953faa1
where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
27101
diff
changeset
|
69 sys::env::putenv ("PATH", shell_path + path_sep + exec_path); |
27101
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
70 } |
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
71 } |
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
72 |
23719 | 73 octave_value |
74 environment::editor (const octave_value_list& args, int nargout) | |
75 { | |
76 return set_internal_variable (m_editor, args, nargout, "EDITOR", false); | |
77 } | |
78 | |
79 | |
80 octave_value | |
81 environment::exec_path (const octave_value_list& args, int nargout) | |
82 { | |
83 octave_value retval | |
84 = set_internal_variable (m_exec_path, args, nargout, "EXEC_PATH", false); | |
85 | |
86 append_to_shell_path (m_exec_path); | |
87 | |
88 return retval; | |
89 } | |
90 | |
91 std::string environment::exec_path (const std::string& path) | |
92 { | |
93 std::string old_val = set (m_exec_path, path); | |
94 | |
95 append_to_shell_path (m_exec_path); | |
96 | |
97 return old_val; | |
98 } | |
99 | |
100 octave_value | |
101 environment::image_path (const octave_value_list& args, int nargout) | |
102 { | |
103 return set_internal_variable (m_image_path, args, nargout, "IMAGE_PATH", | |
104 false); | |
105 } | |
106 | |
107 std::string environment::init_editor (void) | |
108 { | |
109 std::string retval = "emacs"; | |
110 | |
25336
389757b7b6af
eliminate redundant octave:: namespace tags
John W. Eaton <jwe@octave.org>
parents:
25103
diff
changeset
|
111 std::string env_editor = sys::env::getenv ("EDITOR"); |
23719 | 112 |
113 if (! env_editor.empty ()) | |
114 retval = env_editor; | |
115 | |
116 return retval; | |
117 } | |
118 | |
25460
627d6bde9b8d
solve installation info initialization problem differently
John W. Eaton <jwe@octave.org>
parents:
25440
diff
changeset
|
119 std::string environment::init_exec_path (void) |
23719 | 120 { |
25336
389757b7b6af
eliminate redundant octave:: namespace tags
John W. Eaton <jwe@octave.org>
parents:
25103
diff
changeset
|
121 std::string exec_path = sys::env::getenv ("OCTAVE_EXEC_PATH"); |
23719 | 122 |
25336
389757b7b6af
eliminate redundant octave:: namespace tags
John W. Eaton <jwe@octave.org>
parents:
25103
diff
changeset
|
123 std::string path_sep = directory_path::path_sep_str (); |
23719 | 124 |
125 if (exec_path.empty ()) | |
25460
627d6bde9b8d
solve installation info initialization problem differently
John W. Eaton <jwe@octave.org>
parents:
25440
diff
changeset
|
126 exec_path = (config::local_ver_arch_lib_dir () + path_sep |
627d6bde9b8d
solve installation info initialization problem differently
John W. Eaton <jwe@octave.org>
parents:
25440
diff
changeset
|
127 + config::local_api_arch_lib_dir () + path_sep |
627d6bde9b8d
solve installation info initialization problem differently
John W. Eaton <jwe@octave.org>
parents:
25440
diff
changeset
|
128 + config::local_arch_lib_dir () + path_sep |
627d6bde9b8d
solve installation info initialization problem differently
John W. Eaton <jwe@octave.org>
parents:
25440
diff
changeset
|
129 + config::arch_lib_dir () + path_sep |
627d6bde9b8d
solve installation info initialization problem differently
John W. Eaton <jwe@octave.org>
parents:
25440
diff
changeset
|
130 + config::bin_dir ()); |
23719 | 131 |
132 append_to_shell_path (exec_path); | |
133 | |
134 return exec_path; | |
135 } | |
136 | |
25460
627d6bde9b8d
solve installation info initialization problem differently
John W. Eaton <jwe@octave.org>
parents:
25440
diff
changeset
|
137 std::string environment::init_image_path (void) |
23719 | 138 { |
139 std::string image_path = "."; | |
140 | |
25336
389757b7b6af
eliminate redundant octave:: namespace tags
John W. Eaton <jwe@octave.org>
parents:
25103
diff
changeset
|
141 std::string path_sep = directory_path::path_sep_str (); |
23719 | 142 |
25336
389757b7b6af
eliminate redundant octave:: namespace tags
John W. Eaton <jwe@octave.org>
parents:
25103
diff
changeset
|
143 std::string env_path = sys::env::getenv ("OCTAVE_IMAGE_PATH"); |
23719 | 144 |
145 if (! env_path.empty ()) | |
146 image_path += path_sep + env_path; | |
147 | |
25460
627d6bde9b8d
solve installation info initialization problem differently
John W. Eaton <jwe@octave.org>
parents:
25440
diff
changeset
|
148 std::string gen_path = genpath (config::image_dir (), ""); |
23719 | 149 |
150 if (! gen_path.empty ()) | |
151 image_path += path_sep + gen_path; | |
152 | |
153 return image_path; | |
154 } | |
29958
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29359
diff
changeset
|
155 |
23719 | 156 DEFMETHOD (EDITOR, interp, args, nargout, |
157 doc: /* -*- texinfo -*- | |
158 @deftypefn {} {@var{val} =} EDITOR () | |
159 @deftypefnx {} {@var{old_val} =} EDITOR (@var{new_val}) | |
160 @deftypefnx {} {} EDITOR (@var{new_val}, "local") | |
161 Query or set the internal variable that specifies the default text editor. | |
162 | |
163 The default value is taken from the environment variable @w{@env{EDITOR}} | |
164 when Octave starts. If the environment variable is not initialized, | |
165 @w{@env{EDITOR}} will be set to @qcode{"emacs"}. | |
166 | |
167 When called from inside a function with the @qcode{"local"} option, the | |
168 variable is changed locally for the function and any subroutines it calls. | |
169 The original variable value is restored when exiting the function. | |
170 | |
171 @seealso{edit, edit_history} | |
172 @end deftypefn */) | |
173 { | |
29961
7d6709900da7
eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents:
29960
diff
changeset
|
174 environment& env = interp.get_environment (); |
23719 | 175 |
176 return env.editor (args, nargout); | |
177 } | |
178 | |
179 /* | |
180 %!test | |
181 %! orig_val = EDITOR (); | |
182 %! old_val = EDITOR ("X"); | |
183 %! assert (orig_val, old_val); | |
184 %! assert (EDITOR (), "X"); | |
185 %! EDITOR (orig_val); | |
186 %! assert (EDITOR (), orig_val); | |
187 | |
28930
2883b3d08b7e
maint: Remove unnecessary parentheses bracketing %!error BIST tests.
Rik <rik@octave.org>
parents:
27923
diff
changeset
|
188 %!error EDITOR (1, 2) |
23719 | 189 */ |
190 | |
191 DEFMETHOD (EXEC_PATH, interp, args, nargout, | |
192 doc: /* -*- texinfo -*- | |
193 @deftypefn {} {@var{val} =} EXEC_PATH () | |
194 @deftypefnx {} {@var{old_val} =} EXEC_PATH (@var{new_val}) | |
195 @deftypefnx {} {} EXEC_PATH (@var{new_val}, "local") | |
196 Query or set the internal variable that specifies a colon separated | |
197 list of directories to append to the shell PATH when executing external | |
198 programs. | |
199 | |
200 The initial value of is taken from the environment variable | |
201 @w{@env{OCTAVE_EXEC_PATH}}, but that value can be overridden by the command | |
202 line argument @option{--exec-path PATH}. | |
203 | |
204 When called from inside a function with the @qcode{"local"} option, the | |
205 variable is changed locally for the function and any subroutines it calls. | |
206 The original variable value is restored when exiting the function. | |
207 | |
208 @seealso{IMAGE_PATH, OCTAVE_HOME, OCTAVE_EXEC_HOME} | |
209 @end deftypefn */) | |
210 { | |
29961
7d6709900da7
eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents:
29960
diff
changeset
|
211 environment& env = interp.get_environment (); |
23719 | 212 |
213 return env.exec_path (args, nargout); | |
214 } | |
215 | |
216 /* | |
217 %!test | |
218 %! orig_val = EXEC_PATH (); | |
219 %! old_val = EXEC_PATH ("X"); | |
220 %! assert (orig_val, old_val); | |
221 %! assert (EXEC_PATH (), "X"); | |
222 %! EXEC_PATH (orig_val); | |
223 %! assert (EXEC_PATH (), orig_val); | |
224 | |
28930
2883b3d08b7e
maint: Remove unnecessary parentheses bracketing %!error BIST tests.
Rik <rik@octave.org>
parents:
27923
diff
changeset
|
225 %!error EXEC_PATH (1, 2) |
23719 | 226 */ |
227 | |
228 DEFMETHOD (IMAGE_PATH, interp, args, nargout, | |
229 doc: /* -*- texinfo -*- | |
230 @deftypefn {} {@var{val} =} IMAGE_PATH () | |
231 @deftypefnx {} {@var{old_val} =} IMAGE_PATH (@var{new_val}) | |
232 @deftypefnx {} {} IMAGE_PATH (@var{new_val}, "local") | |
233 Query or set the internal variable that specifies a colon separated | |
234 list of directories in which to search for image files. | |
235 | |
236 When called from inside a function with the @qcode{"local"} option, the | |
237 variable is changed locally for the function and any subroutines it calls. | |
238 The original variable value is restored when exiting the function. | |
239 | |
240 @seealso{EXEC_PATH, OCTAVE_HOME, OCTAVE_EXEC_HOME} | |
241 @end deftypefn */) | |
242 { | |
29961
7d6709900da7
eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents:
29960
diff
changeset
|
243 environment& env = interp.get_environment (); |
23719 | 244 |
245 return env.image_path (args, nargout); | |
246 } | |
247 | |
248 /* | |
249 %!test | |
250 %! orig_val = IMAGE_PATH (); | |
251 %! old_val = IMAGE_PATH ("X"); | |
252 %! assert (orig_val, old_val); | |
253 %! assert (IMAGE_PATH (), "X"); | |
254 %! IMAGE_PATH (orig_val); | |
255 %! assert (IMAGE_PATH (), orig_val); | |
256 | |
28930
2883b3d08b7e
maint: Remove unnecessary parentheses bracketing %!error BIST tests.
Rik <rik@octave.org>
parents:
27923
diff
changeset
|
257 %!error IMAGE_PATH (1, 2) |
23719 | 258 */ |
29958
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29359
diff
changeset
|
259 |
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29359
diff
changeset
|
260 OCTAVE_NAMESPACE_END |