|
2203
|
1 /* |
|
|
2 |
|
2847
|
3 Copyright (C) 1996, 1997 John W. Eaton |
|
2203
|
4 |
|
|
5 This file is part of Octave. |
|
|
6 |
|
|
7 Octave is free software; you can redistribute it and/or modify it |
|
|
8 under the terms of the GNU General Public License as published by the |
|
|
9 Free Software Foundation; either version 2, or (at your option) any |
|
|
10 later version. |
|
|
11 |
|
|
12 Octave is distributed in the hope that it will be useful, but WITHOUT |
|
|
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
|
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
|
15 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, write to the Free |
|
5307
|
19 Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
|
|
20 02110-1301, USA. |
|
2203
|
21 |
|
|
22 */ |
|
|
23 |
|
|
24 #ifdef HAVE_CONFIG_H |
|
|
25 #include <config.h> |
|
|
26 #endif |
|
|
27 |
|
|
28 #include <cstdlib> |
|
|
29 |
|
3503
|
30 #include <iostream> |
|
2203
|
31 #include <string> |
|
|
32 |
|
|
33 #ifdef HAVE_UNISTD_H |
|
2442
|
34 #ifdef HAVE_SYS_TYPES_H |
|
2203
|
35 #include <sys/types.h> |
|
2442
|
36 #endif |
|
2203
|
37 #include <unistd.h> |
|
|
38 #endif |
|
|
39 |
|
5814
|
40 #include "dir-ops.h" |
|
2926
|
41 #include "oct-env.h" |
|
4217
|
42 #include "file-stat.h" |
|
3174
|
43 #include "pathsearch.h" |
|
4217
|
44 #include "str-vec.h" |
|
2926
|
45 |
|
2492
|
46 #include <defaults.h> |
|
2203
|
47 #include "defun.h" |
|
|
48 #include "error.h" |
|
3040
|
49 #include "file-ops.h" |
|
2203
|
50 #include "gripes.h" |
|
|
51 #include "help.h" |
|
5395
|
52 #include "input.h" |
|
5832
|
53 #include "load-path.h" |
|
3185
|
54 #include "oct-obj.h" |
|
2390
|
55 #include "ov.h" |
|
4217
|
56 #include "parse.h" |
|
2203
|
57 #include "toplev.h" |
|
4217
|
58 #include "unwind-prot.h" |
|
2203
|
59 #include "variables.h" |
|
2492
|
60 #include <version.h> |
|
2203
|
61 |
|
3523
|
62 std::string Voctave_home; |
|
2203
|
63 |
|
3523
|
64 std::string Vbin_dir; |
|
|
65 std::string Vinfo_dir; |
|
|
66 std::string Vdata_dir; |
|
|
67 std::string Vlibexec_dir; |
|
|
68 std::string Varch_lib_dir; |
|
|
69 std::string Vlocal_arch_lib_dir; |
|
3597
|
70 std::string Vlocal_ver_arch_lib_dir; |
|
5814
|
71 |
|
|
72 std::string Vlocal_ver_oct_file_dir; |
|
|
73 std::string Vlocal_api_oct_file_dir; |
|
|
74 std::string Vlocal_oct_file_dir; |
|
2203
|
75 |
|
5814
|
76 std::string Vlocal_ver_fcn_file_dir; |
|
|
77 std::string Vlocal_api_fcn_file_dir; |
|
|
78 std::string Vlocal_fcn_file_dir; |
|
|
79 |
|
|
80 std::string Voct_file_dir; |
|
|
81 std::string Vfcn_file_dir; |
|
|
82 |
|
|
83 std::string Vimage_dir; |
|
4447
|
84 |
|
2203
|
85 // The path that will be searched for programs that we execute. |
|
|
86 // (--exec-path path) |
|
5794
|
87 static std::string VEXEC_PATH; |
|
2203
|
88 |
|
|
89 // Name of the editor to be invoked by the edit_history command. |
|
5794
|
90 std::string VEDITOR; |
|
2203
|
91 |
|
5814
|
92 static std::string VIMAGE_PATH; |
|
2203
|
93 |
|
3523
|
94 std::string Vlocal_site_defaults_file; |
|
|
95 std::string Vsite_defaults_file; |
|
2203
|
96 |
|
4776
|
97 // Name of the FFTW wisdom program. |
|
5794
|
98 std::string Vfftw_wisdom_program; |
|
4773
|
99 |
|
3535
|
100 static std::string |
|
3523
|
101 subst_octave_home (const std::string& s) |
|
2203
|
102 { |
|
3523
|
103 std::string retval; |
|
2203
|
104 |
|
3523
|
105 std::string prefix = OCTAVE_PREFIX; |
|
2203
|
106 |
|
|
107 retval = s; |
|
|
108 |
|
|
109 if (Voctave_home != prefix) |
|
|
110 { |
|
5275
|
111 octave_idx_type len = prefix.length (); |
|
2203
|
112 size_t start = 0; |
|
2522
|
113 while ((start = retval.find (prefix, start)) != NPOS) |
|
2203
|
114 { |
|
|
115 retval.replace (start, len, Voctave_home); |
|
2522
|
116 start += len; |
|
2203
|
117 } |
|
|
118 } |
|
|
119 |
|
|
120 return retval; |
|
|
121 } |
|
|
122 |
|
|
123 static void |
|
|
124 set_octave_home (void) |
|
|
125 { |
|
3523
|
126 std::string oh = octave_env::getenv ("OCTAVE_HOME"); |
|
2203
|
127 |
|
3523
|
128 Voctave_home = oh.empty () ? std::string (OCTAVE_PREFIX) : oh; |
|
2203
|
129 } |
|
|
130 |
|
|
131 static void |
|
|
132 set_default_info_dir (void) |
|
|
133 { |
|
|
134 Vinfo_dir = subst_octave_home (OCTAVE_INFODIR); |
|
|
135 } |
|
|
136 |
|
|
137 static void |
|
3141
|
138 set_default_data_dir (void) |
|
|
139 { |
|
|
140 Vdata_dir = subst_octave_home (OCTAVE_DATADIR); |
|
|
141 } |
|
|
142 |
|
|
143 static void |
|
|
144 set_default_libexec_dir (void) |
|
|
145 { |
|
|
146 Vlibexec_dir = subst_octave_home (OCTAVE_LIBEXECDIR); |
|
|
147 } |
|
|
148 |
|
|
149 static void |
|
2203
|
150 set_default_arch_lib_dir (void) |
|
|
151 { |
|
|
152 Varch_lib_dir = subst_octave_home (OCTAVE_ARCHLIBDIR); |
|
|
153 } |
|
|
154 |
|
|
155 static void |
|
2439
|
156 set_default_local_arch_lib_dir (void) |
|
|
157 { |
|
|
158 Vlocal_arch_lib_dir = subst_octave_home (OCTAVE_LOCALARCHLIBDIR); |
|
|
159 } |
|
|
160 |
|
|
161 static void |
|
3597
|
162 set_default_local_ver_arch_lib_dir (void) |
|
|
163 { |
|
|
164 Vlocal_ver_arch_lib_dir = subst_octave_home (OCTAVE_LOCALVERARCHLIBDIR); |
|
|
165 } |
|
|
166 |
|
|
167 static void |
|
5814
|
168 set_default_local_ver_oct_file_dir (void) |
|
|
169 { |
|
|
170 Vlocal_ver_oct_file_dir = subst_octave_home (OCTAVE_LOCALVEROCTFILEDIR); |
|
|
171 } |
|
|
172 |
|
|
173 static void |
|
|
174 set_default_local_api_oct_file_dir (void) |
|
|
175 { |
|
|
176 Vlocal_api_oct_file_dir = subst_octave_home (OCTAVE_LOCALAPIOCTFILEDIR); |
|
|
177 } |
|
|
178 |
|
|
179 static void |
|
|
180 set_default_local_oct_file_dir (void) |
|
|
181 { |
|
|
182 Vlocal_oct_file_dir = subst_octave_home (OCTAVE_LOCALOCTFILEDIR); |
|
|
183 } |
|
|
184 |
|
|
185 static void |
|
|
186 set_default_local_ver_fcn_file_dir (void) |
|
|
187 { |
|
|
188 Vlocal_ver_fcn_file_dir = subst_octave_home (OCTAVE_LOCALVERFCNFILEDIR); |
|
|
189 } |
|
|
190 |
|
|
191 static void |
|
|
192 set_default_local_api_fcn_file_dir (void) |
|
|
193 { |
|
|
194 Vlocal_api_fcn_file_dir = subst_octave_home (OCTAVE_LOCALAPIFCNFILEDIR); |
|
|
195 } |
|
|
196 |
|
|
197 static void |
|
|
198 set_default_local_fcn_file_dir (void) |
|
|
199 { |
|
|
200 Vlocal_fcn_file_dir = subst_octave_home (OCTAVE_LOCALFCNFILEDIR); |
|
|
201 } |
|
|
202 |
|
|
203 static void |
|
2203
|
204 set_default_fcn_file_dir (void) |
|
|
205 { |
|
|
206 Vfcn_file_dir = subst_octave_home (OCTAVE_FCNFILEDIR); |
|
|
207 } |
|
|
208 |
|
|
209 static void |
|
5814
|
210 set_default_image_dir (void) |
|
|
211 { |
|
|
212 Vimage_dir = subst_octave_home (OCTAVE_IMAGEDIR); |
|
|
213 } |
|
|
214 |
|
|
215 static void |
|
5397
|
216 set_default_oct_file_dir (void) |
|
|
217 { |
|
|
218 Voct_file_dir = subst_octave_home (OCTAVE_OCTFILEDIR); |
|
|
219 } |
|
|
220 |
|
|
221 static void |
|
2203
|
222 set_default_bin_dir (void) |
|
|
223 { |
|
|
224 Vbin_dir = subst_octave_home (OCTAVE_BINDIR); |
|
|
225 } |
|
|
226 |
|
5814
|
227 void |
|
|
228 set_exec_path (const std::string& path) |
|
4447
|
229 { |
|
5814
|
230 VEXEC_PATH = Vlocal_ver_arch_lib_dir + dir_path::path_sep_str |
|
5777
|
231 + Vlocal_arch_lib_dir + dir_path::path_sep_str |
|
|
232 + Varch_lib_dir + dir_path::path_sep_str |
|
4447
|
233 + Vbin_dir; |
|
5814
|
234 |
|
|
235 // This is static so that even if set_exec_path is called more than |
|
|
236 // once, shell_path is the original PATH from the environment, |
|
|
237 // before we start modifying it. |
|
|
238 static std::string shell_path = octave_env::getenv ("PATH"); |
|
|
239 |
|
|
240 if (! shell_path.empty ()) |
|
|
241 VEXEC_PATH += dir_path::path_sep_str + shell_path; |
|
|
242 |
|
|
243 std::string tpath = path; |
|
|
244 |
|
|
245 if (tpath.empty ()) |
|
|
246 tpath = octave_env::getenv ("OCTAVE_EXEC_PATH"); |
|
|
247 |
|
|
248 if (! tpath.empty ()) |
|
|
249 VEXEC_PATH = tpath + dir_path::path_sep_str + VEXEC_PATH; |
|
|
250 |
|
|
251 octave_env::putenv ("PATH", VEXEC_PATH); |
|
|
252 } |
|
|
253 |
|
|
254 void |
|
|
255 set_image_path (const std::string& path) |
|
|
256 { |
|
|
257 VIMAGE_PATH = "."; |
|
|
258 |
|
|
259 std::string tpath = path; |
|
|
260 |
|
|
261 if (tpath.empty ()) |
|
|
262 tpath = octave_env::getenv ("OCTAVE_IMAGE_PATH"); |
|
|
263 |
|
|
264 if (! tpath.empty ()) |
|
|
265 VIMAGE_PATH += dir_path::path_sep_str + tpath; |
|
|
266 |
|
5832
|
267 tpath = genpath (Vimage_dir, ""); |
|
|
268 |
|
|
269 if (! tpath.empty ()) |
|
|
270 VIMAGE_PATH += dir_path::path_sep_str + tpath; |
|
5814
|
271 } |
|
|
272 |
|
2203
|
273 static void |
|
|
274 set_default_info_file (void) |
|
|
275 { |
|
3523
|
276 std::string std_info_file = subst_octave_home (OCTAVE_INFOFILE); |
|
2512
|
277 |
|
3523
|
278 std::string oct_info_file = octave_env::getenv ("OCTAVE_INFO_FILE"); |
|
2203
|
279 |
|
2926
|
280 Vinfo_file = oct_info_file.empty () ? std_info_file : oct_info_file; |
|
2203
|
281 } |
|
|
282 |
|
|
283 static void |
|
|
284 set_default_info_prog (void) |
|
|
285 { |
|
3523
|
286 std::string oct_info_prog = octave_env::getenv ("OCTAVE_INFO_PROGRAM"); |
|
2203
|
287 |
|
2926
|
288 if (oct_info_prog.empty ()) |
|
5794
|
289 Vinfo_program = "info"; |
|
2926
|
290 else |
|
5794
|
291 Vinfo_program = std::string (oct_info_prog); |
|
2203
|
292 } |
|
|
293 |
|
4773
|
294 static void |
|
4776
|
295 set_default_fftw_wisdom_prog (void) |
|
4773
|
296 { |
|
4776
|
297 std::string oct_wisdom_prog = octave_env::getenv ("OCTAVE_FFTW_WISDOM_PROGRAM"); |
|
4773
|
298 |
|
|
299 if (oct_wisdom_prog.empty ()) |
|
5794
|
300 Vfftw_wisdom_program = "fftw-wisdom"; |
|
4773
|
301 else |
|
5794
|
302 Vfftw_wisdom_program = std::string (oct_wisdom_prog); |
|
4773
|
303 } |
|
|
304 |
|
2203
|
305 static void |
|
|
306 set_default_editor (void) |
|
|
307 { |
|
5794
|
308 VEDITOR = "emacs"; |
|
2203
|
309 |
|
3523
|
310 std::string env_editor = octave_env::getenv ("EDITOR"); |
|
2203
|
311 |
|
2926
|
312 if (! env_editor.empty ()) |
|
5794
|
313 VEDITOR = env_editor; |
|
2203
|
314 } |
|
|
315 |
|
|
316 static void |
|
|
317 set_local_site_defaults_file (void) |
|
|
318 { |
|
5781
|
319 std::string lsf = octave_env::getenv ("OCTAVE_LOCAL_SITE_INITFILE"); |
|
|
320 |
|
|
321 if (lsf.empty ()) |
|
|
322 { |
|
|
323 Vlocal_site_defaults_file = subst_octave_home (OCTAVE_LOCALSTARTUPFILEDIR); |
|
|
324 Vlocal_site_defaults_file.append ("/octaverc"); |
|
|
325 } |
|
|
326 else |
|
|
327 Vlocal_site_defaults_file = lsf; |
|
2203
|
328 } |
|
|
329 |
|
|
330 static void |
|
|
331 set_site_defaults_file (void) |
|
|
332 { |
|
5781
|
333 std::string sf = octave_env::getenv ("OCTAVE_SITE_INITFILE"); |
|
|
334 |
|
|
335 if (sf.empty ()) |
|
|
336 { |
|
|
337 Vsite_defaults_file = subst_octave_home (OCTAVE_STARTUPFILEDIR); |
|
|
338 Vsite_defaults_file.append ("/octaverc"); |
|
|
339 } |
|
|
340 else |
|
|
341 Vsite_defaults_file = sf; |
|
2203
|
342 } |
|
|
343 |
|
|
344 void |
|
|
345 install_defaults (void) |
|
|
346 { |
|
|
347 // OCTAVE_HOME must be set first! |
|
|
348 |
|
|
349 set_octave_home (); |
|
|
350 |
|
|
351 set_default_info_dir (); |
|
|
352 |
|
3141
|
353 set_default_data_dir (); |
|
|
354 |
|
|
355 set_default_libexec_dir (); |
|
|
356 |
|
2203
|
357 set_default_arch_lib_dir (); |
|
|
358 |
|
2439
|
359 set_default_local_arch_lib_dir (); |
|
|
360 |
|
3597
|
361 set_default_local_ver_arch_lib_dir (); |
|
|
362 |
|
5814
|
363 set_default_local_ver_oct_file_dir (); |
|
|
364 set_default_local_api_oct_file_dir (); |
|
|
365 set_default_local_oct_file_dir (); |
|
2203
|
366 |
|
5814
|
367 set_default_local_ver_fcn_file_dir (); |
|
|
368 set_default_local_api_fcn_file_dir (); |
|
|
369 set_default_local_fcn_file_dir (); |
|
|
370 |
|
|
371 set_default_fcn_file_dir (); |
|
5397
|
372 set_default_oct_file_dir (); |
|
|
373 |
|
5814
|
374 set_default_image_dir (); |
|
|
375 |
|
2203
|
376 set_default_bin_dir (); |
|
|
377 |
|
5814
|
378 set_exec_path (); |
|
4447
|
379 |
|
5814
|
380 set_image_path (); |
|
2203
|
381 |
|
|
382 set_default_info_file (); |
|
|
383 |
|
|
384 set_default_info_prog (); |
|
|
385 |
|
4776
|
386 set_default_fftw_wisdom_prog (); |
|
4773
|
387 |
|
2203
|
388 set_default_editor (); |
|
|
389 |
|
|
390 set_local_site_defaults_file (); |
|
|
391 |
|
|
392 set_site_defaults_file (); |
|
|
393 } |
|
|
394 |
|
5794
|
395 DEFUN (EDITOR, args, nargout, |
|
|
396 "-*- texinfo -*-\n\ |
|
|
397 @deftypefn {Built-in Function} {@var{val} =} EDITOR ()\n\ |
|
|
398 @deftypefnx {Built-in Function} {@var{old_val} =} EDITOR (@var{new_val})\n\ |
|
|
399 Query or set the internal variable that specifies the editor to\n\ |
|
|
400 use with the @code{edit_history} command. If the environment\n\ |
|
|
401 variable @code{EDITOR} is set when Octave starts, its\n\ |
|
|
402 value is used as the default. Otherwise, @code{EDITOR} is set to\n\ |
|
|
403 @code{\"emacs\"}.\n\ |
|
|
404 @seealso{edit_history}\n\ |
|
|
405 @end deftypefn") |
|
2203
|
406 { |
|
5794
|
407 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (EDITOR); |
|
2203
|
408 } |
|
|
409 |
|
5794
|
410 DEFUN (EXEC_PATH, args, nargout, |
|
|
411 "-*- texinfo -*-\n\ |
|
|
412 @deftypefn {Built-in Function} {@var{val} =} EXEC_PATH ()\n\ |
|
|
413 @deftypefnx {Built-in Function} {@var{old_val} =} EXEC_PATH (@var{new_val})\n\ |
|
|
414 Query or set the internal variable that specifies a colon separated\n\ |
|
|
415 list of directories to search when executing external programs.\n\ |
|
|
416 Its initial value is taken from the environment variable\n\ |
|
|
417 @code{OCTAVE_EXEC_PATH} (if it exists) or @code{PATH}, but that\n\ |
|
|
418 value can be overridden by the command line argument\n\ |
|
5814
|
419 @code{--exec-path PATH}. At startup, an additional set of\n\ |
|
|
420 directories (including the shell PATH) is appended to the path\n\ |
|
|
421 specified in the environment or on the command line. If you use\n\ |
|
|
422 the @code{EXEC_PATH} function to modify the path, you should take\n\ |
|
|
423 care to preserve these additional directories.\n\ |
|
5794
|
424 @end deftypefn") |
|
4217
|
425 { |
|
5794
|
426 std::string saved_exec_path = VEXEC_PATH; |
|
4217
|
427 |
|
5794
|
428 octave_value retval = SET_NONEMPTY_INTERNAL_STRING_VARIABLE (EXEC_PATH); |
|
4217
|
429 |
|
5794
|
430 if (VEXEC_PATH != saved_exec_path) |
|
5814
|
431 octave_env::putenv ("PATH", VEXEC_PATH); |
|
2203
|
432 |
|
5794
|
433 return retval; |
|
2203
|
434 } |
|
|
435 |
|
5794
|
436 DEFUN (fftw_wisdom_program, args, nargout, |
|
3301
|
437 "-*- texinfo -*-\n\ |
|
5794
|
438 @deftypefn {Built-in Function} {@var{val} =} FFTW_WISDOM_PROGRAM ()\n\ |
|
|
439 @deftypefnx {Built-in Function} {@var{old_val} =} FFTW_WISDOM_PROGRAM (@var{new_val})\n\ |
|
|
440 Query or set the internal variable that specifies the FFTW wisdom\n\ |
|
|
441 program to use to create wisdom data to accelerate Fourier transforms.\n\ |
|
|
442 If the environment variable @code{OCTAVE_WISDOM_PROGRAM} is set when\n\ |
|
|
443 Octave starts, its value is used as the default. Otherwise,\n\ |
|
|
444 @code{WISDOM_PROGRAM} is set to @code{\"fftw-wisdom\"}.\n\ |
|
|
445 @end deftypefn") |
|
|
446 { |
|
|
447 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (fftw_wisdom_program); |
|
|
448 } |
|
2203
|
449 |
|
5814
|
450 DEFUN (IMAGE_PATH, args, nargout, |
|
5794
|
451 "-*- texinfo -*-\n\ |
|
5814
|
452 @deftypefn {Built-in Function} {@var{val} =} IMAGE_PATH ()\n\ |
|
|
453 @deftypefnx {Built-in Function} {@var{old_val} =} IMAGE_PATH (@var{new_val})\n\ |
|
5794
|
454 Query or set the internal variable that specifies a colon separated\n\ |
|
|
455 list of directories in which to search for image files.\n\ |
|
|
456 @end deftypefn") |
|
|
457 { |
|
5814
|
458 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (IMAGE_PATH); |
|
5794
|
459 } |
|
|
460 |
|
5780
|
461 DEFUN (OCTAVE_HOME, args, , |
|
|
462 "-*- texinfo -*-\n\ |
|
|
463 @deftypefn {Built-in Function} {} OCTAVE_HOME ()\n\ |
|
|
464 Return the name of the top-level Octave installation directory.\n\ |
|
|
465 @end deftypefn") |
|
|
466 { |
|
|
467 octave_value retval; |
|
2831
|
468 |
|
5780
|
469 if (args.length () == 0) |
|
|
470 retval = Voctave_home; |
|
|
471 else |
|
5823
|
472 print_usage (); |
|
5780
|
473 |
|
|
474 return retval; |
|
5749
|
475 } |
|
3446
|
476 |
|
5749
|
477 DEFUNX ("OCTAVE_VERSION", FOCTAVE_VERSION, args, , |
|
|
478 "-*- texinfo -*-\n\ |
|
|
479 @deftypefn {Built-in Function} {} OCTAVE_VERSION ()\n\ |
|
|
480 Return the version number of Octave, as a string.\n\ |
|
|
481 @end deftypefn") |
|
|
482 { |
|
|
483 octave_value retval; |
|
|
484 |
|
|
485 int nargin = args.length (); |
|
|
486 |
|
|
487 if (nargin == 0) |
|
|
488 retval = OCTAVE_VERSION; |
|
|
489 else |
|
5823
|
490 print_usage (); |
|
5749
|
491 |
|
|
492 return retval; |
|
2203
|
493 } |
|
|
494 |
|
|
495 /* |
|
|
496 ;;; Local Variables: *** |
|
|
497 ;;; mode: C++ *** |
|
|
498 ;;; End: *** |
|
|
499 */ |
