|
2926
|
1 /* |
|
|
2 |
|
|
3 Copyright (C) 1996, 1997 John W. Eaton |
|
|
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 /* |
|
|
24 |
|
|
25 The functions listed below were adapted from a similar functions |
|
|
26 from GNU Bash, the Bourne Again SHell, copyright (C) 1987, 1989, 1991 |
|
|
27 Free Software Foundation, Inc. |
|
|
28 |
|
|
29 octave_env::do_absolute_pathname |
|
|
30 octave_env::do_base_pathname |
|
|
31 octave_env::do_chdir |
|
|
32 octave_env::do_getcwd |
|
|
33 octave_env::do_make_absolute |
|
|
34 octave_env::do_polite_directory_format |
|
|
35 octave_env::pathname_backup |
|
|
36 |
|
|
37 */ |
|
|
38 |
|
|
39 #ifdef HAVE_CONFIG_H |
|
|
40 #include <config.h> |
|
|
41 #endif |
|
|
42 |
|
4093
|
43 #include <cctype> |
|
2926
|
44 #include <cstdlib> |
|
4093
|
45 |
|
3504
|
46 #include <string> |
|
2926
|
47 |
|
|
48 #ifdef HAVE_UNISTD_H |
|
|
49 #ifdef HAVE_SYS_TYPES_H |
|
|
50 #include <sys/types.h> |
|
|
51 #endif |
|
|
52 #include <unistd.h> |
|
|
53 #endif |
|
|
54 |
|
|
55 #include "lo-error.h" |
|
|
56 #include "lo-sysdep.h" |
|
|
57 #include "lo-utils.h" |
|
|
58 #include "oct-env.h" |
|
2934
|
59 #include "oct-passwd.h" |
|
2947
|
60 #include "oct-syscalls.h" |
|
2926
|
61 |
|
|
62 octave_env::octave_env (void) |
|
|
63 : follow_symbolic_links (true), verbatim_pwd (true), |
|
|
64 current_directory (), program_name (), program_invocation_name (), |
|
|
65 user_name (), host_name () |
|
|
66 { |
|
|
67 // Get a real value for the current directory. |
|
|
68 do_getcwd (); |
|
|
69 |
|
|
70 // Etc. |
|
|
71 do_get_user_name (); |
|
|
72 |
|
|
73 do_get_host_name (); |
|
|
74 } |
|
|
75 |
|
|
76 octave_env *octave_env::instance = 0; |
|
|
77 |
|
|
78 bool |
|
|
79 octave_env::instance_ok (void) |
|
|
80 { |
|
|
81 bool retval = true; |
|
|
82 |
|
|
83 if (! instance) |
|
|
84 instance = new octave_env (); |
|
|
85 |
|
|
86 if (! instance) |
|
|
87 { |
|
|
88 (*current_liboctave_error_handler) |
|
|
89 ("unable to create current working directoy object!"); |
|
|
90 |
|
|
91 retval = false; |
|
|
92 } |
|
|
93 |
|
|
94 return retval; |
|
|
95 } |
|
|
96 |
|
3504
|
97 std::string |
|
|
98 octave_env::polite_directory_format (const std::string& name) |
|
2926
|
99 { |
|
|
100 return (instance_ok ()) |
|
3504
|
101 ? instance->do_polite_directory_format (name) : std::string (); |
|
2926
|
102 } |
|
|
103 |
|
|
104 bool |
|
3504
|
105 octave_env::absolute_pathname (const std::string& s) |
|
2926
|
106 { |
|
|
107 return (instance_ok ()) |
|
|
108 ? instance->do_absolute_pathname (s) : false; |
|
|
109 } |
|
|
110 |
|
3504
|
111 std::string |
|
|
112 octave_env::base_pathname (const std::string& s) |
|
2926
|
113 { |
|
|
114 return (instance_ok ()) |
|
3504
|
115 ? instance->do_base_pathname (s) : std::string (); |
|
2926
|
116 } |
|
|
117 |
|
3504
|
118 std::string |
|
|
119 octave_env::make_absolute (const std::string& s, const std::string& dot_path) |
|
2926
|
120 { |
|
|
121 return (instance_ok ()) |
|
3504
|
122 ? instance->do_make_absolute (s, dot_path) : std::string (); |
|
2926
|
123 } |
|
|
124 |
|
3504
|
125 std::string |
|
2926
|
126 octave_env::getcwd () |
|
|
127 { |
|
|
128 return (instance_ok ()) |
|
3504
|
129 ? instance->do_getcwd () : std::string (); |
|
2926
|
130 } |
|
|
131 |
|
3504
|
132 std::string |
|
2926
|
133 octave_env::get_home_directory () |
|
|
134 { |
|
|
135 return (instance_ok ()) |
|
3504
|
136 ? instance->do_get_home_directory () : std::string (); |
|
2926
|
137 } |
|
|
138 |
|
3504
|
139 std::string |
|
2926
|
140 octave_env::get_program_name (void) |
|
|
141 { |
|
|
142 return (instance_ok ()) |
|
3504
|
143 ? instance->program_name : std::string (); |
|
2926
|
144 } |
|
|
145 |
|
3504
|
146 std::string |
|
2926
|
147 octave_env::get_program_invocation_name (void) |
|
|
148 { |
|
|
149 return (instance_ok ()) |
|
3504
|
150 ? instance->program_invocation_name : std::string (); |
|
2926
|
151 } |
|
|
152 |
|
|
153 void |
|
3504
|
154 octave_env::set_program_name (const std::string& s) |
|
2926
|
155 { |
|
|
156 if (instance_ok ()) |
|
|
157 instance->do_set_program_name (s); |
|
|
158 } |
|
|
159 |
|
3504
|
160 std::string |
|
2926
|
161 octave_env::get_user_name (void) |
|
|
162 { |
|
|
163 return (instance_ok ()) |
|
3504
|
164 ? instance->do_get_user_name () : std::string (); |
|
2926
|
165 } |
|
|
166 |
|
3504
|
167 std::string |
|
2926
|
168 octave_env::get_host_name (void) |
|
|
169 { |
|
|
170 return (instance_ok ()) |
|
3504
|
171 ? instance->do_get_host_name () : std::string (); |
|
2926
|
172 } |
|
|
173 |
|
|
174 // XXX FIXME XXX -- this leaves no way to distinguish between a |
|
|
175 // variable that is not set and one that is set to the empty string. |
|
|
176 // Is this a problem? |
|
|
177 |
|
3504
|
178 std::string |
|
|
179 octave_env::getenv (const std::string& name) |
|
2926
|
180 { |
|
|
181 return (instance_ok ()) |
|
3504
|
182 ? instance->do_getenv (name) : std::string (); |
|
2926
|
183 } |
|
|
184 |
|
|
185 void |
|
3504
|
186 octave_env::putenv (const std::string& name, const std::string& value) |
|
2926
|
187 { |
|
|
188 octave_putenv (name, value); |
|
|
189 } |
|
|
190 |
|
|
191 bool |
|
3504
|
192 octave_env::chdir (const std::string& newdir) |
|
2926
|
193 { |
|
|
194 return (instance_ok ()) |
|
|
195 ? instance->do_chdir (newdir) : false; |
|
|
196 } |
|
|
197 |
|
|
198 void |
|
3504
|
199 octave_env::do_set_program_name (const std::string& s) const |
|
2926
|
200 { |
|
|
201 program_invocation_name = s; |
|
|
202 |
|
|
203 size_t pos = program_invocation_name.rfind ('/'); |
|
|
204 |
|
|
205 program_name = (pos == NPOS) |
|
|
206 ? program_invocation_name : program_invocation_name.substr (pos+1); |
|
|
207 } |
|
|
208 |
|
|
209 // Return a pretty pathname. If the first part of the pathname is the |
|
|
210 // same as $HOME, then replace that with `~'. |
|
|
211 |
|
3504
|
212 std::string |
|
|
213 octave_env::do_polite_directory_format (const std::string& name) const |
|
2926
|
214 { |
|
3504
|
215 std::string retval; |
|
2926
|
216 |
|
3504
|
217 std::string home_dir = do_get_home_directory (); |
|
2926
|
218 |
|
|
219 size_t len = home_dir.length (); |
|
|
220 |
|
3516
|
221 if (len > 1 && home_dir == name.substr (0, len) |
|
2926
|
222 && (name.length () == len || name[len] == '/')) |
|
|
223 { |
|
|
224 retval = "~"; |
|
|
225 retval.append (name.substr (len)); |
|
|
226 } |
|
|
227 else |
|
|
228 retval = name; |
|
|
229 |
|
|
230 return retval; |
|
|
231 } |
|
|
232 |
|
4088
|
233 static inline bool |
|
|
234 is_dir_sep (char c) |
|
|
235 { |
|
4087
|
236 #if defined (__CYGWIN__) |
|
4088
|
237 return (c == '/' || c == '\\'); |
|
4087
|
238 #else |
|
4088
|
239 return (c == '/'); |
|
4087
|
240 #endif |
|
4088
|
241 } |
|
2926
|
242 |
|
|
243 bool |
|
3504
|
244 octave_env::do_absolute_pathname (const std::string& s) const |
|
2926
|
245 { |
|
4087
|
246 size_t len = s.length (); |
|
|
247 |
|
|
248 if (len == 0) |
|
|
249 return false; |
|
2926
|
250 |
|
|
251 if (s[0] == '/') |
|
|
252 return true; |
|
|
253 |
|
4093
|
254 #if defined (__WIN32__) |
|
4088
|
255 if ((len == 2 && isalpha (s[0]) && s[1] == ':') |
|
|
256 || (len > 2 && isalpha (s[0]) && s[1] == ':' && is_dir_sep (s[2]))) |
|
4087
|
257 return true; |
|
|
258 #endif |
|
|
259 |
|
2926
|
260 return false; |
|
|
261 } |
|
|
262 |
|
|
263 // Return the `basename' of the pathname in STRING (the stuff after |
|
|
264 // the last '/'). If STRING is not a full pathname, simply return it. |
|
|
265 |
|
3504
|
266 std::string |
|
|
267 octave_env::do_base_pathname (const std::string& s) const |
|
2926
|
268 { |
|
|
269 if (! do_absolute_pathname (s)) |
|
|
270 return s; |
|
|
271 |
|
|
272 size_t pos = s.rfind ('/'); |
|
|
273 |
|
|
274 if (pos == NPOS) |
|
|
275 return s; |
|
|
276 else |
|
|
277 return s.substr (pos+1); |
|
|
278 } |
|
|
279 |
|
|
280 // Turn STRING (a pathname) into an absolute pathname, assuming that |
|
|
281 // DOT_PATH contains the symbolic location of '.'. |
|
|
282 |
|
3504
|
283 std::string |
|
|
284 octave_env::do_make_absolute (const std::string& s, |
|
|
285 const std::string& dot_path) const |
|
2926
|
286 { |
|
|
287 #if defined (__EMX__) |
|
|
288 if (s.length () > 1 && s[1] == ':') |
|
|
289 return s; |
|
|
290 #endif |
|
|
291 |
|
4087
|
292 if (dot_path.empty () || s.empty () || do_absolute_pathname (s)) |
|
2926
|
293 return s; |
|
|
294 |
|
3504
|
295 std::string current_path = dot_path; |
|
2926
|
296 |
|
|
297 if (current_path.empty ()) |
|
|
298 current_path = "./"; |
|
|
299 |
|
|
300 size_t pos = current_path.length () - 1; |
|
|
301 |
|
|
302 if (current_path[pos] != '/') |
|
|
303 current_path.append ("/"); |
|
|
304 |
|
|
305 size_t i = 0; |
|
|
306 size_t slen = s.length (); |
|
|
307 |
|
|
308 while (i < slen) |
|
|
309 { |
|
|
310 if (s[i] == '.') |
|
|
311 { |
|
|
312 if (i + 1 == slen) |
|
|
313 return current_path; |
|
|
314 |
|
|
315 if (s[i+1] == '/') |
|
|
316 { |
|
|
317 i += 2; |
|
|
318 continue; |
|
|
319 } |
|
|
320 |
|
|
321 if (s[i+1] == '.' && (i + 2 == slen || s[i+2] == '/')) |
|
|
322 { |
|
|
323 i += 2; |
|
|
324 |
|
|
325 if (i != slen) |
|
|
326 i++; |
|
|
327 |
|
|
328 pathname_backup (current_path, 1); |
|
|
329 |
|
|
330 continue; |
|
|
331 } |
|
|
332 } |
|
|
333 |
|
|
334 size_t tmp = s.find ('/', i); |
|
|
335 |
|
|
336 if (tmp == NPOS) |
|
|
337 { |
|
|
338 current_path.append (s, i, tmp-i); |
|
|
339 break; |
|
|
340 } |
|
|
341 else |
|
|
342 { |
|
|
343 current_path.append (s, i, tmp-i+1); |
|
|
344 i = tmp + 1; |
|
|
345 } |
|
|
346 } |
|
|
347 |
|
|
348 return current_path; |
|
|
349 } |
|
|
350 |
|
|
351 // Return a consed string which is the current working directory. |
|
|
352 |
|
3504
|
353 std::string |
|
2926
|
354 octave_env::do_getcwd () |
|
|
355 { |
|
|
356 if (! follow_symbolic_links) |
|
|
357 current_directory = ""; |
|
|
358 |
|
|
359 if (verbatim_pwd || current_directory.empty ()) |
|
|
360 current_directory = ::octave_getcwd (); |
|
|
361 |
|
|
362 return current_directory; |
|
|
363 } |
|
|
364 |
|
|
365 // This value is not cached because it can change while Octave is |
|
|
366 // running. |
|
|
367 |
|
3504
|
368 std::string |
|
2926
|
369 octave_env::do_get_home_directory (void) const |
|
|
370 { |
|
3504
|
371 std::string hd = do_getenv ("HOME"); |
|
2926
|
372 |
|
2947
|
373 if (hd.empty ()) |
|
|
374 { |
|
|
375 octave_passwd pw = octave_passwd::getpwuid (octave_syscalls::getuid ()); |
|
|
376 |
|
3504
|
377 hd = pw ? pw.dir () : std::string ("/"); |
|
2947
|
378 } |
|
|
379 |
|
|
380 return hd; |
|
2926
|
381 } |
|
|
382 |
|
3504
|
383 std::string |
|
2926
|
384 octave_env::do_get_user_name (void) const |
|
|
385 { |
|
|
386 // XXX FIXME XXX -- is it possible for this to change while Octave |
|
|
387 // is running? |
|
|
388 |
|
|
389 if (user_name.empty ()) |
|
|
390 { |
|
2947
|
391 octave_passwd pw = octave_passwd::getpwuid (octave_syscalls::getuid ()); |
|
2926
|
392 |
|
3504
|
393 user_name = pw ? pw.name () : std::string ("unknown"); |
|
2926
|
394 } |
|
|
395 |
|
|
396 return user_name; |
|
|
397 } |
|
|
398 |
|
3504
|
399 std::string |
|
2926
|
400 octave_env::do_get_host_name (void) const |
|
|
401 { |
|
|
402 // XXX FIXME XXX -- is it possible for this to change while Octave |
|
|
403 // is running? |
|
|
404 |
|
|
405 if (host_name.empty ()) |
|
|
406 { |
|
|
407 char hostname[256]; |
|
|
408 |
|
3803
|
409 int status = octave_gethostname (hostname, 255); |
|
2926
|
410 |
|
3185
|
411 host_name = (status < 0) ? "unknown" : hostname; |
|
2926
|
412 } |
|
|
413 |
|
|
414 return host_name; |
|
|
415 } |
|
|
416 |
|
3504
|
417 std::string |
|
|
418 octave_env::do_getenv (const std::string& name) const |
|
2926
|
419 { |
|
|
420 char *value = ::getenv (name.c_str ()); |
|
|
421 |
|
|
422 return value ? value : ""; |
|
|
423 } |
|
|
424 |
|
|
425 // Do the work of changing to the directory NEWDIR. Handle symbolic |
|
|
426 // link following, etc. |
|
|
427 |
|
|
428 bool |
|
3504
|
429 octave_env::do_chdir (const std::string& newdir) |
|
2926
|
430 { |
|
|
431 bool retval = false; |
|
|
432 |
|
3504
|
433 std::string tmp; |
|
2926
|
434 |
|
|
435 if (follow_symbolic_links) |
|
|
436 { |
|
|
437 if (current_directory.empty ()) |
|
|
438 do_getcwd (); |
|
|
439 |
|
|
440 if (current_directory.empty ()) |
|
|
441 tmp = newdir; |
|
|
442 else |
|
|
443 tmp = do_make_absolute (newdir, current_directory); |
|
|
444 |
|
|
445 // Get rid of trailing `/'. |
|
|
446 |
|
|
447 size_t len = tmp.length (); |
|
|
448 |
|
|
449 if (len > 1) |
|
|
450 { |
|
4088
|
451 if (is_dir_sep (tmp[--len])) |
|
2926
|
452 tmp.resize (len); |
|
|
453 } |
|
|
454 |
|
|
455 if (! ::octave_chdir (tmp)) |
|
|
456 { |
|
|
457 current_directory = tmp; |
|
|
458 retval = true; |
|
|
459 } |
|
|
460 } |
|
|
461 else |
|
|
462 retval = (! ::octave_chdir (newdir)); |
|
|
463 |
|
|
464 return retval; |
|
|
465 } |
|
|
466 |
|
|
467 // Remove the last N directories from PATH. |
|
|
468 |
|
|
469 void |
|
3504
|
470 octave_env::pathname_backup (std::string& path, int n) const |
|
2926
|
471 { |
|
|
472 if (path.empty ()) |
|
|
473 return; |
|
|
474 |
|
|
475 size_t i = path.length () - 1; |
|
|
476 |
|
|
477 while (n--) |
|
|
478 { |
|
|
479 while (path[i] == '/' && i > 0) |
|
|
480 i--; |
|
|
481 |
|
|
482 while (path[i] != '/' && i > 0) |
|
|
483 i--; |
|
|
484 |
|
|
485 i++; |
|
|
486 } |
|
|
487 |
|
|
488 path.resize (i); |
|
|
489 } |
|
|
490 |
|
|
491 void |
|
|
492 octave_env::error (int err_num) const |
|
|
493 { |
|
|
494 (*current_liboctave_error_handler) ("%s", strerror (err_num)); |
|
|
495 } |
|
|
496 |
|
|
497 void |
|
3504
|
498 octave_env::error (const std::string& s) const |
|
2926
|
499 { |
|
|
500 (*current_liboctave_error_handler) ("%s", s.c_str ()); |
|
|
501 } |
|
|
502 |
|
|
503 /* |
|
|
504 ;;; Local Variables: *** |
|
|
505 ;;; mode: C++ *** |
|
|
506 ;;; End: *** |
|
|
507 */ |
