Mercurial > octave
annotate libinterp/corefcn/environment.cc @ 27102:84ff9953faa1
where possible, eliminate octave:: namespace qualifier inside octave namespace
Affected files:
file-editor-tab.cc, file-editor.cc, main-window.cc, octave-cmd.h,
octave-qt-link.cc, settings-dialog.cc, call-stack.cc, environment.cc,
ft-text-renderer.cc, gl2ps-print.cc, help.cc, input.cc,
interpreter-private.cc, interpreter-private.h, interpreter.cc,
load-path.cc, oct-hist.cc, oct-process.cc, oct-stream.cc, pager.cc,
syminfo.cc, symtab.h, sysdep.cc, text-renderer.cc, utils.cc, gzip.cc,
cdef-manager.cc, ov-fcn-handle.cc, ov-java.cc, jit-typeinfo.cc,
oct-parse.yy, pt-eval.cc, pt-tm-const.cc, chol.cc, gsvd.cc,
oct-rand.cc, oct-rand.h, randmtzig.cc, randpoisson.cc, file-ops.cc,
lo-sysdep.cc, file-info.cc, oct-glob.cc, oct-sparse.cc, and
url-transfer.cc.
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Wed, 22 May 2019 13:57:30 +0000 |
| parents | 097774bed4ed |
| children | b442ec6dda5c |
| rev | line source |
|---|---|
| 23719 | 1 /* |
| 2 | |
|
26376
00f796120a6d
maint: Update copyright dates in all source files.
John W. Eaton <jwe@octave.org>
parents:
25460
diff
changeset
|
3 Copyright (C) 2017-2019 John W. Eaton |
| 23719 | 4 |
| 5 This file is part of Octave. | |
| 6 | |
|
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23719
diff
changeset
|
7 Octave is free software: you can redistribute it and/or modify it |
| 23719 | 8 under the terms of the GNU General Public License as published by |
|
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23719
diff
changeset
|
9 the Free Software Foundation, either version 3 of the License, or |
| 23719 | 10 (at your option) any later version. |
| 11 | |
| 12 Octave is distributed in the hope that it will be useful, but | |
| 13 WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 15 GNU General Public License for more details. | |
| 16 | |
| 17 You should have received a copy of the GNU General Public License | |
| 18 along with Octave; see the file COPYING. If not, see | |
|
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23719
diff
changeset
|
19 <https://www.gnu.org/licenses/>. |
| 23719 | 20 |
| 21 */ | |
| 22 | |
| 23 #if defined (HAVE_CONFIG_H) | |
| 24 # include "config.h" | |
| 25 #endif | |
| 26 | |
| 27 #include <string> | |
| 28 | |
| 29 #include "dir-ops.h" | |
| 30 #include "oct-env.h" | |
| 31 #include "file-stat.h" | |
| 32 #include "pathsearch.h" | |
| 33 #include "str-vec.h" | |
| 34 | |
|
25460
627d6bde9b8d
solve installation info initialization problem differently
John W. Eaton <jwe@octave.org>
parents:
25440
diff
changeset
|
35 #include "defaults.h" |
| 23719 | 36 #include "defun.h" |
| 37 #include "environment.h" | |
| 38 #include "interpreter.h" | |
| 39 #include "variables.h" | |
| 40 | |
| 41 namespace octave | |
| 42 { | |
|
27101
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
43 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
|
44 { |
|
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
45 // 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
|
46 // 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 if (exec_path.empty ()) |
|
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
49 return; |
|
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 // 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
|
52 |
|
27102
84ff9953faa1
where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
27101
diff
changeset
|
53 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
|
54 |
|
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
55 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
|
56 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
|
57 else |
|
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
58 { |
|
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
59 // 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
|
60 // 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
|
61 // only append those that are missing? |
|
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
62 |
|
27102
84ff9953faa1
where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
27101
diff
changeset
|
63 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
|
64 |
|
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
65 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
|
66 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
|
67 } |
|
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
68 } |
|
097774bed4ed
move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
69 |
| 23719 | 70 octave_value |
| 71 environment::editor (const octave_value_list& args, int nargout) | |
| 72 { | |
| 73 return set_internal_variable (m_editor, args, nargout, "EDITOR", false); | |
| 74 } | |
| 75 | |
| 76 | |
| 77 octave_value | |
| 78 environment::exec_path (const octave_value_list& args, int nargout) | |
| 79 { | |
| 80 octave_value retval | |
| 81 = set_internal_variable (m_exec_path, args, nargout, "EXEC_PATH", false); | |
| 82 | |
| 83 append_to_shell_path (m_exec_path); | |
| 84 | |
| 85 return retval; | |
| 86 } | |
| 87 | |
| 88 std::string environment::exec_path (const std::string& path) | |
| 89 { | |
| 90 std::string old_val = set (m_exec_path, path); | |
| 91 | |
| 92 append_to_shell_path (m_exec_path); | |
| 93 | |
| 94 return old_val; | |
| 95 } | |
| 96 | |
| 97 octave_value | |
| 98 environment::image_path (const octave_value_list& args, int nargout) | |
| 99 { | |
| 100 return set_internal_variable (m_image_path, args, nargout, "IMAGE_PATH", | |
| 101 false); | |
| 102 } | |
| 103 | |
| 104 std::string environment::init_editor (void) | |
| 105 { | |
| 106 std::string retval = "emacs"; | |
| 107 | |
|
25336
389757b7b6af
eliminate redundant octave:: namespace tags
John W. Eaton <jwe@octave.org>
parents:
25103
diff
changeset
|
108 std::string env_editor = sys::env::getenv ("EDITOR"); |
| 23719 | 109 |
| 110 if (! env_editor.empty ()) | |
| 111 retval = env_editor; | |
| 112 | |
| 113 return retval; | |
| 114 } | |
| 115 | |
|
25460
627d6bde9b8d
solve installation info initialization problem differently
John W. Eaton <jwe@octave.org>
parents:
25440
diff
changeset
|
116 std::string environment::init_exec_path (void) |
| 23719 | 117 { |
|
25336
389757b7b6af
eliminate redundant octave:: namespace tags
John W. Eaton <jwe@octave.org>
parents:
25103
diff
changeset
|
118 std::string exec_path = sys::env::getenv ("OCTAVE_EXEC_PATH"); |
| 23719 | 119 |
|
25336
389757b7b6af
eliminate redundant octave:: namespace tags
John W. Eaton <jwe@octave.org>
parents:
25103
diff
changeset
|
120 std::string path_sep = directory_path::path_sep_str (); |
| 23719 | 121 |
| 122 if (exec_path.empty ()) | |
|
25460
627d6bde9b8d
solve installation info initialization problem differently
John W. Eaton <jwe@octave.org>
parents:
25440
diff
changeset
|
123 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
|
124 + 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
|
125 + config::local_arch_lib_dir () + path_sep |
|
627d6bde9b8d
solve installation info initialization problem differently
John W. Eaton <jwe@octave.org>
parents:
25440
diff
changeset
|
126 + config::arch_lib_dir () + path_sep |
|
627d6bde9b8d
solve installation info initialization problem differently
John W. Eaton <jwe@octave.org>
parents:
25440
diff
changeset
|
127 + config::bin_dir ()); |
| 23719 | 128 |
| 129 append_to_shell_path (exec_path); | |
| 130 | |
| 131 return exec_path; | |
| 132 } | |
| 133 | |
|
25460
627d6bde9b8d
solve installation info initialization problem differently
John W. Eaton <jwe@octave.org>
parents:
25440
diff
changeset
|
134 std::string environment::init_image_path (void) |
| 23719 | 135 { |
| 136 std::string image_path = "."; | |
| 137 | |
|
25336
389757b7b6af
eliminate redundant octave:: namespace tags
John W. Eaton <jwe@octave.org>
parents:
25103
diff
changeset
|
138 std::string path_sep = directory_path::path_sep_str (); |
| 23719 | 139 |
|
25336
389757b7b6af
eliminate redundant octave:: namespace tags
John W. Eaton <jwe@octave.org>
parents:
25103
diff
changeset
|
140 std::string env_path = sys::env::getenv ("OCTAVE_IMAGE_PATH"); |
| 23719 | 141 |
| 142 if (! env_path.empty ()) | |
| 143 image_path += path_sep + env_path; | |
| 144 | |
|
25460
627d6bde9b8d
solve installation info initialization problem differently
John W. Eaton <jwe@octave.org>
parents:
25440
diff
changeset
|
145 std::string gen_path = genpath (config::image_dir (), ""); |
| 23719 | 146 |
| 147 if (! gen_path.empty ()) | |
| 148 image_path += path_sep + gen_path; | |
| 149 | |
| 150 return image_path; | |
| 151 } | |
| 152 } | |
| 153 | |
| 154 DEFMETHOD (EDITOR, interp, args, nargout, | |
| 155 doc: /* -*- texinfo -*- | |
| 156 @deftypefn {} {@var{val} =} EDITOR () | |
| 157 @deftypefnx {} {@var{old_val} =} EDITOR (@var{new_val}) | |
| 158 @deftypefnx {} {} EDITOR (@var{new_val}, "local") | |
| 159 Query or set the internal variable that specifies the default text editor. | |
| 160 | |
| 161 The default value is taken from the environment variable @w{@env{EDITOR}} | |
| 162 when Octave starts. If the environment variable is not initialized, | |
| 163 @w{@env{EDITOR}} will be set to @qcode{"emacs"}. | |
| 164 | |
| 165 When called from inside a function with the @qcode{"local"} option, the | |
| 166 variable is changed locally for the function and any subroutines it calls. | |
| 167 The original variable value is restored when exiting the function. | |
| 168 | |
| 169 @seealso{edit, edit_history} | |
| 170 @end deftypefn */) | |
| 171 { | |
| 172 octave::environment& env = interp.get_environment (); | |
| 173 | |
| 174 return env.editor (args, nargout); | |
| 175 } | |
| 176 | |
| 177 /* | |
| 178 %!test | |
| 179 %! orig_val = EDITOR (); | |
| 180 %! old_val = EDITOR ("X"); | |
| 181 %! assert (orig_val, old_val); | |
| 182 %! assert (EDITOR (), "X"); | |
| 183 %! EDITOR (orig_val); | |
| 184 %! assert (EDITOR (), orig_val); | |
| 185 | |
| 186 %!error (EDITOR (1, 2)) | |
| 187 */ | |
| 188 | |
| 189 DEFMETHOD (EXEC_PATH, interp, args, nargout, | |
| 190 doc: /* -*- texinfo -*- | |
| 191 @deftypefn {} {@var{val} =} EXEC_PATH () | |
| 192 @deftypefnx {} {@var{old_val} =} EXEC_PATH (@var{new_val}) | |
| 193 @deftypefnx {} {} EXEC_PATH (@var{new_val}, "local") | |
| 194 Query or set the internal variable that specifies a colon separated | |
| 195 list of directories to append to the shell PATH when executing external | |
| 196 programs. | |
| 197 | |
| 198 The initial value of is taken from the environment variable | |
| 199 @w{@env{OCTAVE_EXEC_PATH}}, but that value can be overridden by the command | |
| 200 line argument @option{--exec-path PATH}. | |
| 201 | |
| 202 When called from inside a function with the @qcode{"local"} option, the | |
| 203 variable is changed locally for the function and any subroutines it calls. | |
| 204 The original variable value is restored when exiting the function. | |
| 205 | |
| 206 @seealso{IMAGE_PATH, OCTAVE_HOME, OCTAVE_EXEC_HOME} | |
| 207 @end deftypefn */) | |
| 208 { | |
| 209 octave::environment& env = interp.get_environment (); | |
| 210 | |
| 211 return env.exec_path (args, nargout); | |
| 212 } | |
| 213 | |
| 214 /* | |
| 215 %!test | |
| 216 %! orig_val = EXEC_PATH (); | |
| 217 %! old_val = EXEC_PATH ("X"); | |
| 218 %! assert (orig_val, old_val); | |
| 219 %! assert (EXEC_PATH (), "X"); | |
| 220 %! EXEC_PATH (orig_val); | |
| 221 %! assert (EXEC_PATH (), orig_val); | |
| 222 | |
| 223 %!error (EXEC_PATH (1, 2)) | |
| 224 */ | |
| 225 | |
| 226 DEFMETHOD (IMAGE_PATH, interp, args, nargout, | |
| 227 doc: /* -*- texinfo -*- | |
| 228 @deftypefn {} {@var{val} =} IMAGE_PATH () | |
| 229 @deftypefnx {} {@var{old_val} =} IMAGE_PATH (@var{new_val}) | |
| 230 @deftypefnx {} {} IMAGE_PATH (@var{new_val}, "local") | |
| 231 Query or set the internal variable that specifies a colon separated | |
| 232 list of directories in which to search for image files. | |
| 233 | |
| 234 When called from inside a function with the @qcode{"local"} option, the | |
| 235 variable is changed locally for the function and any subroutines it calls. | |
| 236 The original variable value is restored when exiting the function. | |
| 237 | |
| 238 @seealso{EXEC_PATH, OCTAVE_HOME, OCTAVE_EXEC_HOME} | |
| 239 @end deftypefn */) | |
| 240 { | |
| 241 octave::environment& env = interp.get_environment (); | |
| 242 | |
| 243 return env.image_path (args, nargout); | |
| 244 } | |
| 245 | |
| 246 /* | |
| 247 %!test | |
| 248 %! orig_val = IMAGE_PATH (); | |
| 249 %! old_val = IMAGE_PATH ("X"); | |
| 250 %! assert (orig_val, old_val); | |
| 251 %! assert (IMAGE_PATH (), "X"); | |
| 252 %! IMAGE_PATH (orig_val); | |
| 253 %! assert (IMAGE_PATH (), orig_val); | |
| 254 | |
| 255 %!error (IMAGE_PATH (1, 2)) | |
| 256 */ |