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