|
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 |
|
|
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
|
|
20 |
|
|
21 */ |
|
|
22 |
|
|
23 #ifdef HAVE_CONFIG_H |
|
|
24 #include <config.h> |
|
|
25 #endif |
|
|
26 |
|
|
27 #include <cstdlib> |
|
|
28 |
|
3503
|
29 #include <iostream> |
|
2203
|
30 #include <string> |
|
|
31 |
|
|
32 #ifdef HAVE_UNISTD_H |
|
2442
|
33 #ifdef HAVE_SYS_TYPES_H |
|
2203
|
34 #include <sys/types.h> |
|
2442
|
35 #endif |
|
2203
|
36 #include <unistd.h> |
|
|
37 #endif |
|
|
38 |
|
2926
|
39 #include "oct-env.h" |
|
4217
|
40 #include "file-stat.h" |
|
3174
|
41 #include "pathsearch.h" |
|
4217
|
42 #include "str-vec.h" |
|
2926
|
43 |
|
2492
|
44 #include <defaults.h> |
|
2203
|
45 #include "defun.h" |
|
|
46 #include "error.h" |
|
3040
|
47 #include "file-ops.h" |
|
2203
|
48 #include "gripes.h" |
|
|
49 #include "help.h" |
|
3185
|
50 #include "oct-obj.h" |
|
2390
|
51 #include "ov.h" |
|
4217
|
52 #include "parse.h" |
|
2203
|
53 #include "toplev.h" |
|
4217
|
54 #include "unwind-prot.h" |
|
2203
|
55 #include "variables.h" |
|
2492
|
56 #include <version.h> |
|
2203
|
57 |
|
3523
|
58 std::string Voctave_home; |
|
2203
|
59 |
|
3523
|
60 std::string Vbin_dir; |
|
|
61 std::string Vinfo_dir; |
|
|
62 std::string Vdata_dir; |
|
|
63 std::string Vlibexec_dir; |
|
|
64 std::string Varch_lib_dir; |
|
|
65 std::string Vlocal_arch_lib_dir; |
|
3597
|
66 std::string Vlocal_ver_arch_lib_dir; |
|
3523
|
67 std::string Vfcn_file_dir; |
|
2203
|
68 |
|
4447
|
69 // The default path that will be searched for programs that we |
|
|
70 // execute (in addition to the user-specified --exec-path). |
|
|
71 static std::string Vdefault_exec_path; |
|
|
72 |
|
2203
|
73 // The path that will be searched for programs that we execute. |
|
|
74 // (--exec-path path) |
|
3523
|
75 std::string Vexec_path; |
|
2203
|
76 |
|
|
77 // Load path specified on command line. |
|
|
78 // (--path path; -p path) |
|
3523
|
79 static std::string Vload_path; |
|
2203
|
80 |
|
3192
|
81 // The default load path with OCTAVE_HOME appropriately substituted. |
|
3523
|
82 static std::string Vdefault_load_path; |
|
3192
|
83 |
|
3174
|
84 // And the cached directory path corresponding to Vload_path. |
|
|
85 dir_path Vload_path_dir_path; |
|
|
86 |
|
2203
|
87 // Name of the editor to be invoked by the edit_history command. |
|
3523
|
88 std::string Veditor; |
|
2203
|
89 |
|
3523
|
90 std::string Vimagepath; |
|
2203
|
91 |
|
3523
|
92 std::string Vlocal_site_defaults_file; |
|
|
93 std::string Vsite_defaults_file; |
|
2203
|
94 |
|
4773
|
95 #ifdef HAVE_FFTW3 |
|
|
96 // Name of the FFTW wisdom program |
|
|
97 std::string Vwisdom_prog; |
|
|
98 #endif |
|
|
99 |
|
4217
|
100 // Each element of A and B should be directory names. For each |
|
|
101 // element of A not in the list B, execute SCRIPT_FILE in that |
|
|
102 // directory if it exists. |
|
|
103 |
|
|
104 static void |
|
|
105 maybe_add_or_del_packages (const string_vector& a, |
|
|
106 const string_vector& b, |
|
4247
|
107 const std::string& script_file) |
|
4217
|
108 { |
|
|
109 if (! octave_interpreter_ready) |
|
|
110 return; |
|
|
111 |
|
|
112 unwind_protect::begin_frame ("maybe_add_or_del_packages"); |
|
|
113 |
|
|
114 unwind_protect_bool (input_from_startup_file); |
|
|
115 |
|
|
116 input_from_startup_file = true; |
|
|
117 |
|
|
118 int a_len = a.length (); |
|
|
119 int b_len = b.length (); |
|
|
120 |
|
|
121 for (int i = 0; i < a_len; i++) |
|
|
122 { |
|
|
123 std::string a_dir = a[i]; |
|
|
124 |
|
|
125 bool found = false; |
|
|
126 |
|
|
127 for (int j = 0; j < b_len; j++) |
|
|
128 { |
|
|
129 if (b[j] == a_dir) |
|
|
130 { |
|
|
131 found = true; |
|
|
132 break; |
|
|
133 } |
|
|
134 } |
|
|
135 |
|
|
136 if (! found) |
|
|
137 { |
|
|
138 std::string file = a_dir + file_ops::dir_sep_str + script_file; |
|
|
139 |
|
|
140 file_stat fs = file_stat (file); |
|
|
141 |
|
|
142 if (fs.exists ()) |
|
4486
|
143 source_file (file); |
|
4217
|
144 |
|
|
145 if (error_state) |
|
|
146 return; |
|
|
147 } |
|
|
148 } |
|
|
149 |
|
|
150 unwind_protect::run_frame ("maybe_add_or_del_packages"); |
|
|
151 } |
|
|
152 |
|
|
153 static void |
|
|
154 update_load_path_dir_path (void) |
|
|
155 { |
|
|
156 string_vector old_dirs = Vload_path_dir_path.all_directories (); |
|
|
157 |
|
|
158 Vload_path_dir_path = dir_path (Vload_path, Vdefault_load_path); |
|
|
159 |
|
|
160 string_vector new_dirs = Vload_path_dir_path.all_directories (); |
|
|
161 |
|
|
162 maybe_add_or_del_packages (old_dirs, new_dirs, "PKG_DEL"); |
|
|
163 |
|
|
164 if (! error_state) |
|
|
165 maybe_add_or_del_packages (new_dirs, old_dirs, "PKG_ADD"); |
|
|
166 } |
|
|
167 |
|
|
168 void |
|
|
169 execute_default_pkg_add_files (void) |
|
|
170 { |
|
|
171 string_vector old_dirs; |
|
|
172 string_vector new_dirs = Vload_path_dir_path.all_directories (); |
|
|
173 |
|
|
174 maybe_add_or_del_packages (new_dirs, old_dirs, "PKG_ADD"); |
|
|
175 } |
|
|
176 |
|
3535
|
177 static std::string |
|
3523
|
178 subst_octave_home (const std::string& s) |
|
2203
|
179 { |
|
3523
|
180 std::string retval; |
|
2203
|
181 |
|
3523
|
182 std::string prefix = OCTAVE_PREFIX; |
|
2203
|
183 |
|
|
184 retval = s; |
|
|
185 |
|
|
186 if (Voctave_home != prefix) |
|
|
187 { |
|
|
188 int len = prefix.length (); |
|
|
189 size_t start = 0; |
|
2522
|
190 while ((start = retval.find (prefix, start)) != NPOS) |
|
2203
|
191 { |
|
|
192 retval.replace (start, len, Voctave_home); |
|
2522
|
193 start += len; |
|
2203
|
194 } |
|
|
195 } |
|
|
196 |
|
|
197 return retval; |
|
|
198 } |
|
|
199 |
|
|
200 static void |
|
|
201 set_octave_home (void) |
|
|
202 { |
|
3523
|
203 std::string oh = octave_env::getenv ("OCTAVE_HOME"); |
|
2203
|
204 |
|
3523
|
205 Voctave_home = oh.empty () ? std::string (OCTAVE_PREFIX) : oh; |
|
2203
|
206 } |
|
|
207 |
|
|
208 static void |
|
|
209 set_default_info_dir (void) |
|
|
210 { |
|
|
211 Vinfo_dir = subst_octave_home (OCTAVE_INFODIR); |
|
|
212 } |
|
|
213 |
|
|
214 static void |
|
3141
|
215 set_default_data_dir (void) |
|
|
216 { |
|
|
217 Vdata_dir = subst_octave_home (OCTAVE_DATADIR); |
|
|
218 } |
|
|
219 |
|
|
220 static void |
|
|
221 set_default_libexec_dir (void) |
|
|
222 { |
|
|
223 Vlibexec_dir = subst_octave_home (OCTAVE_LIBEXECDIR); |
|
|
224 } |
|
|
225 |
|
|
226 static void |
|
2203
|
227 set_default_arch_lib_dir (void) |
|
|
228 { |
|
|
229 Varch_lib_dir = subst_octave_home (OCTAVE_ARCHLIBDIR); |
|
|
230 } |
|
|
231 |
|
|
232 static void |
|
2439
|
233 set_default_local_arch_lib_dir (void) |
|
|
234 { |
|
|
235 Vlocal_arch_lib_dir = subst_octave_home (OCTAVE_LOCALARCHLIBDIR); |
|
|
236 } |
|
|
237 |
|
|
238 static void |
|
3597
|
239 set_default_local_ver_arch_lib_dir (void) |
|
|
240 { |
|
|
241 Vlocal_ver_arch_lib_dir = subst_octave_home (OCTAVE_LOCALVERARCHLIBDIR); |
|
|
242 } |
|
|
243 |
|
|
244 static void |
|
2203
|
245 set_default_fcn_file_dir (void) |
|
|
246 { |
|
|
247 Vfcn_file_dir = subst_octave_home (OCTAVE_FCNFILEDIR); |
|
|
248 } |
|
|
249 |
|
|
250 static void |
|
|
251 set_default_bin_dir (void) |
|
|
252 { |
|
|
253 Vbin_dir = subst_octave_home (OCTAVE_BINDIR); |
|
|
254 } |
|
|
255 |
|
|
256 static void |
|
4447
|
257 set_default_default_exec_path (void) |
|
|
258 { |
|
|
259 Vdefault_exec_path |
|
|
260 = Vlocal_ver_arch_lib_dir + std::string (SEPCHAR_STR) |
|
|
261 + Vlocal_arch_lib_dir + std::string (SEPCHAR_STR) |
|
|
262 + Varch_lib_dir + std::string (SEPCHAR_STR) |
|
|
263 + Vbin_dir; |
|
|
264 } |
|
|
265 |
|
|
266 static void |
|
2203
|
267 set_default_exec_path (void) |
|
|
268 { |
|
3523
|
269 std::string octave_exec_path = octave_env::getenv ("OCTAVE_EXEC_PATH"); |
|
2203
|
270 |
|
2926
|
271 if (octave_exec_path.empty ()) |
|
2203
|
272 { |
|
3523
|
273 std::string shell_path = octave_env::getenv ("PATH"); |
|
2203
|
274 |
|
2926
|
275 if (! shell_path.empty ()) |
|
2203
|
276 { |
|
3523
|
277 Vexec_path = std::string (":"); |
|
2203
|
278 Vexec_path.append (shell_path); |
|
|
279 } |
|
|
280 } |
|
2926
|
281 else |
|
3523
|
282 Vexec_path = std::string (octave_exec_path); |
|
2203
|
283 } |
|
|
284 |
|
|
285 static void |
|
|
286 set_default_path (void) |
|
|
287 { |
|
3192
|
288 Vdefault_load_path = subst_octave_home (OCTAVE_FCNFILEPATH); |
|
2203
|
289 |
|
3523
|
290 std::string oct_path = octave_env::getenv ("OCTAVE_PATH"); |
|
2203
|
291 |
|
3523
|
292 Vload_path = oct_path.empty () ? std::string (":") : oct_path; |
|
3174
|
293 |
|
4217
|
294 update_load_path_dir_path (); |
|
2203
|
295 } |
|
|
296 |
|
|
297 static void |
|
|
298 set_default_info_file (void) |
|
|
299 { |
|
3523
|
300 std::string std_info_file = subst_octave_home (OCTAVE_INFOFILE); |
|
2512
|
301 |
|
3523
|
302 std::string oct_info_file = octave_env::getenv ("OCTAVE_INFO_FILE"); |
|
2203
|
303 |
|
2926
|
304 Vinfo_file = oct_info_file.empty () ? std_info_file : oct_info_file; |
|
2203
|
305 } |
|
|
306 |
|
|
307 static void |
|
|
308 set_default_info_prog (void) |
|
|
309 { |
|
3523
|
310 std::string oct_info_prog = octave_env::getenv ("OCTAVE_INFO_PROGRAM"); |
|
2203
|
311 |
|
2926
|
312 if (oct_info_prog.empty ()) |
|
3141
|
313 Vinfo_prog = "info"; |
|
2926
|
314 else |
|
3523
|
315 Vinfo_prog = std::string (oct_info_prog); |
|
2203
|
316 } |
|
|
317 |
|
4773
|
318 #ifdef HAVE_FFTW3 |
|
|
319 static void |
|
|
320 set_default_wisdom_prog (void) |
|
|
321 { |
|
|
322 std::string oct_wisdom_prog = octave_env::getenv ("OCTAVE_WISDOM_PROGRAM"); |
|
|
323 |
|
|
324 if (oct_wisdom_prog.empty ()) |
|
|
325 Vwisdom_prog = "fftw-wisdom"; |
|
|
326 else |
|
|
327 Vwisdom_prog = std::string (oct_wisdom_prog); |
|
|
328 } |
|
|
329 #endif |
|
|
330 |
|
2203
|
331 static void |
|
|
332 set_default_editor (void) |
|
|
333 { |
|
2993
|
334 Veditor = "emacs"; |
|
2203
|
335 |
|
3523
|
336 std::string env_editor = octave_env::getenv ("EDITOR"); |
|
2203
|
337 |
|
2926
|
338 if (! env_editor.empty ()) |
|
|
339 Veditor = env_editor; |
|
2203
|
340 } |
|
|
341 |
|
|
342 static void |
|
|
343 set_local_site_defaults_file (void) |
|
|
344 { |
|
|
345 Vlocal_site_defaults_file = subst_octave_home (OCTAVE_LOCALSTARTUPFILEDIR); |
|
|
346 Vlocal_site_defaults_file.append ("/octaverc"); |
|
|
347 } |
|
|
348 |
|
|
349 static void |
|
|
350 set_site_defaults_file (void) |
|
|
351 { |
|
|
352 Vsite_defaults_file = subst_octave_home (OCTAVE_STARTUPFILEDIR); |
|
|
353 Vsite_defaults_file.append ("/octaverc"); |
|
|
354 } |
|
|
355 |
|
3534
|
356 std::string |
|
3523
|
357 maybe_add_default_load_path (const std::string& pathstring) |
|
2203
|
358 { |
|
3523
|
359 std::string retval; |
|
2203
|
360 |
|
|
361 if (! pathstring.empty ()) |
|
|
362 { |
|
|
363 if (pathstring[0] == SEPCHAR) |
|
|
364 { |
|
3192
|
365 retval = Vdefault_load_path; |
|
2203
|
366 retval.append (pathstring); |
|
|
367 } |
|
|
368 else |
|
|
369 retval = pathstring; |
|
|
370 |
|
|
371 if (pathstring[pathstring.length () - 1] == SEPCHAR) |
|
3192
|
372 retval.append (Vdefault_load_path); |
|
|
373 |
|
|
374 size_t pos = 0; |
|
|
375 do |
|
|
376 { |
|
|
377 pos = retval.find ("::"); |
|
|
378 |
|
|
379 if (pos != NPOS) |
|
|
380 retval.insert (pos+1, Vdefault_load_path); |
|
|
381 } |
|
|
382 while (pos != NPOS); |
|
2203
|
383 } |
|
|
384 |
|
|
385 return retval; |
|
|
386 } |
|
|
387 |
|
|
388 void |
|
|
389 install_defaults (void) |
|
|
390 { |
|
|
391 // OCTAVE_HOME must be set first! |
|
|
392 |
|
|
393 set_octave_home (); |
|
|
394 |
|
|
395 set_default_info_dir (); |
|
|
396 |
|
3141
|
397 set_default_data_dir (); |
|
|
398 |
|
|
399 set_default_libexec_dir (); |
|
|
400 |
|
2203
|
401 set_default_arch_lib_dir (); |
|
|
402 |
|
2439
|
403 set_default_local_arch_lib_dir (); |
|
|
404 |
|
3597
|
405 set_default_local_ver_arch_lib_dir (); |
|
|
406 |
|
2203
|
407 set_default_fcn_file_dir (); |
|
|
408 |
|
|
409 set_default_bin_dir (); |
|
|
410 |
|
4447
|
411 set_default_default_exec_path (); |
|
|
412 |
|
2203
|
413 set_default_exec_path (); |
|
|
414 |
|
|
415 set_default_path (); |
|
|
416 |
|
|
417 set_default_info_file (); |
|
|
418 |
|
|
419 set_default_info_prog (); |
|
|
420 |
|
4773
|
421 #ifdef HAVE_FFTW3 |
|
|
422 set_default_wisdom_prog (); |
|
|
423 #endif |
|
|
424 |
|
2203
|
425 set_default_editor (); |
|
|
426 |
|
|
427 set_local_site_defaults_file (); |
|
|
428 |
|
|
429 set_site_defaults_file (); |
|
|
430 } |
|
|
431 |
|
4264
|
432 DEFUN (rehash, , , |
|
|
433 "-*- texinfo -*-\n\ |
|
|
434 @deftypefn {Built-in Function} {} rehash ()\n\ |
|
|
435 Reinitialize Octave's @code{LOADPATH} directory cache.\n\ |
|
|
436 @end deftypefn") |
|
|
437 { |
|
|
438 octave_value_list retval; |
|
|
439 |
|
|
440 Vload_path_dir_path.rehash (); |
|
|
441 |
|
|
442 return retval; |
|
|
443 } |
|
|
444 |
|
2203
|
445 static int |
|
|
446 editor (void) |
|
|
447 { |
|
|
448 int status = 0; |
|
|
449 |
|
3523
|
450 std::string s = builtin_string_variable ("EDITOR"); |
|
2203
|
451 |
|
|
452 if (s.empty ()) |
|
|
453 { |
|
|
454 gripe_invalid_value_specified ("EDITOR"); |
|
|
455 status = -1; |
|
|
456 } |
|
|
457 else |
|
|
458 Veditor = s; |
|
|
459 |
|
|
460 return status; |
|
|
461 } |
|
|
462 |
|
|
463 static int |
|
|
464 exec_path (void) |
|
|
465 { |
|
|
466 int status = 0; |
|
|
467 |
|
3523
|
468 std::string s = builtin_string_variable ("EXEC_PATH"); |
|
2439
|
469 |
|
|
470 if (s.empty ()) |
|
2203
|
471 { |
|
|
472 gripe_invalid_value_specified ("EXEC_PATH"); |
|
|
473 status = -1; |
|
|
474 } |
|
|
475 else |
|
|
476 { |
|
2439
|
477 Vexec_path = s; |
|
|
478 |
|
3523
|
479 std::string path; |
|
2203
|
480 |
|
|
481 int eplen = Vexec_path.length (); |
|
|
482 |
|
|
483 if (eplen > 0) |
|
|
484 { |
|
2926
|
485 bool prepend = (Vexec_path[0] == ':'); |
|
|
486 bool append = (eplen > 1 && Vexec_path[eplen-1] == ':'); |
|
2203
|
487 |
|
|
488 if (prepend) |
|
|
489 { |
|
4447
|
490 path = Vdefault_exec_path + Vexec_path; |
|
2203
|
491 } |
|
|
492 else |
|
|
493 { |
|
2926
|
494 path = Vexec_path; |
|
|
495 |
|
2203
|
496 if (append) |
|
4447
|
497 path.append (Vdefault_exec_path); |
|
2203
|
498 } |
|
|
499 } |
|
|
500 else |
|
4447
|
501 path = Vdefault_exec_path; |
|
2203
|
502 |
|
2926
|
503 octave_env::putenv ("PATH", path); |
|
2203
|
504 } |
|
|
505 |
|
|
506 return status; |
|
|
507 } |
|
|
508 |
|
4773
|
509 #ifdef HAVE_FFTW3 |
|
|
510 static int |
|
|
511 wisdom_prog (void) |
|
|
512 { |
|
|
513 int status = 0; |
|
|
514 |
|
|
515 std::string s = builtin_string_variable ("WISDOM_PROGRAM"); |
|
|
516 |
|
|
517 if (s.empty ()) |
|
|
518 { |
|
|
519 gripe_invalid_value_specified ("WISDOM_PROGRAM"); |
|
|
520 status = -1; |
|
|
521 } |
|
|
522 else |
|
|
523 Vwisdom_prog = s; |
|
|
524 |
|
|
525 return status; |
|
|
526 } |
|
|
527 #endif |
|
|
528 |
|
2203
|
529 static int |
|
4447
|
530 default_exec_path (void) |
|
|
531 { |
|
|
532 int status = 0; |
|
|
533 |
|
|
534 std::string s = builtin_string_variable ("DEFAULT_EXEC_PATH"); |
|
|
535 |
|
|
536 if (s.empty ()) |
|
|
537 { |
|
|
538 gripe_invalid_value_specified ("DEFAULT_EXEC_PATH"); |
|
|
539 status = -1; |
|
|
540 } |
|
|
541 else |
|
|
542 { |
|
|
543 Vdefault_exec_path = s; |
|
|
544 |
|
|
545 // Now also update PATH in environment. |
|
|
546 exec_path (); |
|
|
547 } |
|
|
548 |
|
|
549 return status; |
|
|
550 } |
|
|
551 |
|
|
552 static int |
|
2203
|
553 imagepath (void) |
|
|
554 { |
|
|
555 int status = 0; |
|
|
556 |
|
3523
|
557 std::string s = builtin_string_variable ("IMAGEPATH"); |
|
2203
|
558 |
|
|
559 if (s.empty ()) |
|
|
560 { |
|
|
561 gripe_invalid_value_specified ("IMAGEPATH"); |
|
|
562 status = -1; |
|
|
563 } |
|
|
564 else |
|
|
565 Vimagepath = s; |
|
|
566 |
|
|
567 return status; |
|
|
568 } |
|
|
569 |
|
|
570 static int |
|
|
571 loadpath (void) |
|
|
572 { |
|
|
573 int status = 0; |
|
|
574 |
|
3523
|
575 std::string s = builtin_string_variable ("LOADPATH"); |
|
2203
|
576 |
|
|
577 if (s.empty ()) |
|
|
578 { |
|
|
579 gripe_invalid_value_specified ("LOADPATH"); |
|
|
580 status = -1; |
|
|
581 } |
|
|
582 else |
|
3174
|
583 { |
|
3971
|
584 // I'm not sure whether this causes more problems that it |
|
|
585 // solves... |
|
|
586 // if (! (s[0] == ':' || s[s.length () - 1] == ':' |
|
|
587 // || s.find ("::") != NPOS)) |
|
|
588 // warning ("LOADPATH will ignore default load path"); |
|
3967
|
589 |
|
3195
|
590 Vload_path = s; |
|
3174
|
591 |
|
4217
|
592 update_load_path_dir_path (); |
|
|
593 } |
|
|
594 |
|
|
595 return status; |
|
|
596 } |
|
|
597 |
|
|
598 static int |
|
|
599 default_load_path (void) |
|
|
600 { |
|
|
601 int status = 0; |
|
|
602 |
|
|
603 std::string s = builtin_string_variable ("DEFAULT_LOADPATH"); |
|
|
604 |
|
|
605 if (s.empty ()) |
|
|
606 { |
|
|
607 gripe_invalid_value_specified ("DEFAULT_LOADPATH"); |
|
|
608 status = -1; |
|
|
609 } |
|
|
610 else |
|
|
611 { |
|
|
612 Vdefault_load_path = s; |
|
|
613 |
|
|
614 update_load_path_dir_path (); |
|
3174
|
615 } |
|
2203
|
616 |
|
|
617 return status; |
|
|
618 } |
|
|
619 |
|
|
620 void |
|
|
621 symbols_of_defaults (void) |
|
|
622 { |
|
3258
|
623 DEFVAR (EDITOR, Veditor, editor, |
|
3368
|
624 "-*- texinfo -*-\n\ |
|
|
625 @defvr {Built-in Variable} EDITOR\n\ |
|
|
626 A string naming the editor to use with the @code{edit_history} command.\n\ |
|
|
627 If the environment variable @code{EDITOR} is set when Octave starts, its\n\ |
|
|
628 value is used as the default. Otherwise, @code{EDITOR} is set to\n\ |
|
|
629 @code{\"emacs\"}.\n\ |
|
|
630 @end defvr"); |
|
2203
|
631 |
|
4773
|
632 #ifdef HAVE_FFTW3 |
|
|
633 DEFVAR (WISDOM_PROGRAM, Vwisdom_prog, wisdom_prog, |
|
|
634 "-*- texinfo -*-\n\ |
|
|
635 @defvr {Built-in Variable} WISDOM_PROGRAM\n\ |
|
|
636 A string naming the FFTW wisdom program to use to create wisdom data\n\ |
|
|
637 to accelerate Fourier transforms. If the environment variable\n\ |
|
|
638 @code{OCTAVE_WISDOM_PROGRAM} is set when Octave starts, its value is used\n\ |
|
|
639 as the default. Otherwise, @code{WISDOM_PROGRAM} is set to\n\ |
|
|
640 @code{\"fftw-wisdom\"}.\n\ |
|
|
641 @end defvr"); |
|
|
642 #endif |
|
|
643 |
|
3258
|
644 DEFVAR (EXEC_PATH, Vexec_path, exec_path, |
|
3301
|
645 "-*- texinfo -*-\n\ |
|
|
646 @defvr {Built-in Variable} EXEC_PATH\n\ |
|
|
647 The variable @code{EXEC_PATH} is a colon separated list of directories\n\ |
|
4447
|
648 to search when executing external programs. Its initial value is taken from\n\ |
|
3301
|
649 the environment variable @code{OCTAVE_EXEC_PATH} (if it exists) or\n\ |
|
|
650 @code{PATH}, but that value can be overridden by the command line\n\ |
|
|
651 argument @code{--exec-path PATH}, or by setting the value of\n\ |
|
|
652 @code{EXEC_PATH} in a startup script. If the value of @code{EXEC_PATH}\n\ |
|
|
653 begins (ends) with a colon, the directories\n\ |
|
|
654 \n\ |
|
|
655 @example\n\ |
|
|
656 @group\n\ |
|
|
657 @var{octave-home}/libexec/octave/site/exec/@var{arch}\n\ |
|
|
658 @var{octave-home}/libexec/octave/@var{version}/exec/@var{arch}\n\ |
|
|
659 @end group\n\ |
|
|
660 @end example\n\ |
|
|
661 \n\ |
|
|
662 @noindent\n\ |
|
|
663 are prepended (appended) to @code{EXEC_PATH}, where @var{octave-home}\n\ |
|
|
664 is the top-level directory where all of Octave is installed\n\ |
|
|
665 (the default value is @file{@value{OCTAVEHOME}}). If you don't specify\n\ |
|
|
666 a value for @code{EXEC_PATH} explicitly, these special directories are\n\ |
|
|
667 prepended to your shell path.\n\ |
|
|
668 @end defvr"); |
|
2203
|
669 |
|
4447
|
670 DEFVAR (DEFAULT_EXEC_PATH, Vdefault_exec_path, default_exec_path, |
|
|
671 "-*- texinfo -*-\n\ |
|
|
672 @defvr {Built-in Variable} DEFAULT_EXEC_PATH\n\ |
|
|
673 A colon separated list of directories in which to search when executing\n\ |
|
|
674 external programs. The value of this variable is automatically\n\ |
|
|
675 substituted for leading, trailing, or doubled colons that appear in the\n\ |
|
|
676 built-in variable @code{EXEC_PATH}.\n\ |
|
|
677 @end defvr"); |
|
4773
|
678 |
|
3258
|
679 DEFVAR (LOADPATH, Vload_path, loadpath, |
|
3371
|
680 "-*- texinfo -*-\n\ |
|
|
681 @defvr {Built-in Variable} LOADPATH\n\ |
|
|
682 A colon separated list of directories in which to search for function\n\ |
|
|
683 files. @xref{Functions and Scripts}. The value of @code{LOADPATH}\n\ |
|
|
684 overrides the environment variable @code{OCTAVE_PATH}. @xref{Installation}.\n\ |
|
|
685 \n\ |
|
|
686 @code{LOADPATH} is now handled in the same way as @TeX{} handles\n\ |
|
|
687 @code{TEXINPUTS}. Leading, trailing, or doubled colons that appear in\n\ |
|
|
688 @code{LOADPATH} are replaced by the value of @code{DEFAULT_LOADPATH}.\n\ |
|
|
689 The default value of @code{LOADPATH} is @code{\":\"}, which tells Octave\n\ |
|
|
690 to search in the directories specified by @code{DEFAULT_LOADPATH}.\n\ |
|
|
691 \n\ |
|
|
692 In addition, if any path element ends in @samp{//}, that directory and\n\ |
|
|
693 all subdirectories it contains are searched recursively for function\n\ |
|
|
694 files. This can result in a slight delay as Octave caches the lists of\n\ |
|
|
695 files found in the @code{LOADPATH} the first time Octave searches for a\n\ |
|
|
696 function. After that, searching is usually much faster because Octave\n\ |
|
|
697 normally only needs to search its internal cache for files.\n\ |
|
|
698 \n\ |
|
|
699 To improve performance of recursive directory searching, it is best for\n\ |
|
|
700 each directory that is to be searched recursively to contain\n\ |
|
|
701 @emph{either} additional subdirectories @emph{or} function files, but\n\ |
|
|
702 not a mixture of both.\n\ |
|
|
703 \n\ |
|
3402
|
704 @xref{Organization of Functions}, for a description of the function file\n\ |
|
3371
|
705 directories that are distributed with Octave.\n\ |
|
|
706 @end defvr"); |
|
2203
|
707 |
|
4217
|
708 DEFVAR (DEFAULT_LOADPATH, Vdefault_load_path, default_load_path, |
|
3371
|
709 "-*- texinfo -*-\n\ |
|
|
710 @defvr {Built-in Variable} DEFAULT_LOADPATH\n\ |
|
|
711 A colon separated list of directories in which to search for function\n\ |
|
4447
|
712 files. The value of this variable is automatically substituted for\n\ |
|
|
713 leading, trailing, or doubled colons that appear in the built-in\n\ |
|
|
714 variable @code{LOADPATH}.\n\ |
|
3371
|
715 @end defvr"); |
|
3192
|
716 |
|
3258
|
717 DEFVAR (IMAGEPATH, OCTAVE_IMAGEPATH, imagepath, |
|
3373
|
718 "-*- texinfo -*-\n\ |
|
3532
|
719 @defvr {Built-in Variable} IMAGEPATH\n\ |
|
3373
|
720 A colon separated list of directories in which to search for image\n\ |
|
|
721 files.\n\ |
|
|
722 @end defvr"); |
|
2203
|
723 |
|
3141
|
724 DEFCONST (OCTAVE_HOME, Voctave_home, |
|
3446
|
725 "-*- texinfo -*-\n\ |
|
|
726 @defvr {Built-in Variable} OCTAVE_HOME\n\ |
|
|
727 The name of the top-level Octave installation directory.\n\ |
|
|
728 @end defvr"); |
|
2831
|
729 |
|
3141
|
730 DEFCONSTX ("OCTAVE_VERSION", SBV_OCTAVE_VERSION, OCTAVE_VERSION, |
|
3301
|
731 "-*- texinfo -*-\n\ |
|
3373
|
732 @defvr {Built-in Variable} OCTAVE_VERSION\n\ |
|
3301
|
733 The version number of Octave, as a string.\n\ |
|
|
734 @end defvr"); |
|
3446
|
735 |
|
2203
|
736 } |
|
|
737 |
|
|
738 /* |
|
|
739 ;;; Local Variables: *** |
|
|
740 ;;; mode: C++ *** |
|
|
741 ;;; End: *** |
|
|
742 */ |
