annotate liboctave/pathsearch.h @ 8920:eb63fbe60fab

update copyright notices
author John W. Eaton <jwe@octave.org>
date Sat, 07 Mar 2009 10:41:27 -0500
parents 0e9b6af36559
children 1d3b91166b9c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1786
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
1 /*
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
2
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 8010
diff changeset
3 Copyright (C) 1996, 1997, 1998, 2000, 2002, 2003, 2005, 2006, 2007, 2008
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
4 John W. Eaton
1786
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
5
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
6 This file is part of Octave.
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
7
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
8 Octave is free software; you can redistribute it and/or modify it
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
9 under the terms of the GNU General Public License as published by the
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6108
diff changeset
10 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6108
diff changeset
11 option) any later version.
1786
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
12
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
13 Octave is distributed in the hope that it will be useful, but WITHOUT
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
16 for more details.
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
17
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
18 You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6108
diff changeset
19 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6108
diff changeset
20 <http://www.gnu.org/licenses/>.
1786
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
21
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
22 */
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
23
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
24 #if !defined (octave_pathsearch_h)
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
25 #define octave_pathsearch_h 1
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
26
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
27 #include <string>
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
28
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
29 #include "str-vec.h"
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
30
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
31 class
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5777
diff changeset
32 OCTAVE_API
1786
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
33 dir_path
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
34 {
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
35 public:
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
36
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3196
diff changeset
37 dir_path (const std::string& s = std::string (),
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3196
diff changeset
38 const std::string& d = std::string ())
3196
3ac3e8edc258 [project @ 1998-10-28 23:04:39 by jwe]
jwe
parents: 3185
diff changeset
39 : p_orig (s), p_default (d), initialized (false)
1786
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
40 {
3174
390d5e396682 [project @ 1998-05-04 16:36:17 by jwe]
jwe
parents: 3024
diff changeset
41 if (! p_orig.empty ())
1786
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
42 init ();
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
43 }
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
44
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
45 dir_path (const dir_path& dp)
3196
3ac3e8edc258 [project @ 1998-10-28 23:04:39 by jwe]
jwe
parents: 3185
diff changeset
46 : p_orig (dp.p_orig), p_default (dp.p_default),
3ac3e8edc258 [project @ 1998-10-28 23:04:39 by jwe]
jwe
parents: 3185
diff changeset
47 initialized (dp.initialized), p (dp.p), pv (dp.pv)
3174
390d5e396682 [project @ 1998-05-04 16:36:17 by jwe]
jwe
parents: 3024
diff changeset
48 { }
1786
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
49
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
50 dir_path& operator = (const dir_path& dp)
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
51 {
3174
390d5e396682 [project @ 1998-05-04 16:36:17 by jwe]
jwe
parents: 3024
diff changeset
52 p_orig = dp.p_orig;
3196
3ac3e8edc258 [project @ 1998-10-28 23:04:39 by jwe]
jwe
parents: 3185
diff changeset
53 p_default = dp.p_default;
3174
390d5e396682 [project @ 1998-05-04 16:36:17 by jwe]
jwe
parents: 3024
diff changeset
54 initialized = dp.initialized;
1786
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
55 p = dp.p;
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
56 pv = dp.pv;
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
57 return *this;
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
58 }
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
59
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
60 ~dir_path (void) { }
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
61
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3196
diff changeset
62 void set (const std::string& s)
1786
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
63 {
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
64 initialized = false;
3174
390d5e396682 [project @ 1998-05-04 16:36:17 by jwe]
jwe
parents: 3024
diff changeset
65 p_orig = s;
1786
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
66 init ();
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
67 }
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
68
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
69 string_vector elements (void);
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
70 string_vector all_directories (void);
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
71
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3196
diff changeset
72 std::string find_first (const std::string&);
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3196
diff changeset
73 std::string find (const std::string& nm) { return find_first (nm); }
1786
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
74
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3196
diff changeset
75 string_vector find_all (const std::string&);
1786
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
76
4242
4d3994172bd5 [project @ 2002-12-26 22:06:10 by jwe]
jwe
parents: 3504
diff changeset
77 std::string find_first_of (const string_vector& names);
4d3994172bd5 [project @ 2002-12-26 22:06:10 by jwe]
jwe
parents: 3504
diff changeset
78 string_vector find_all_first_of (const string_vector& names);
4d3994172bd5 [project @ 2002-12-26 22:06:10 by jwe]
jwe
parents: 3504
diff changeset
79
3185
9580887dd160 [project @ 1998-09-26 02:45:55 by jwe]
jwe
parents: 3174
diff changeset
80 void rehash (void)
9580887dd160 [project @ 1998-09-26 02:45:55 by jwe]
jwe
parents: 3174
diff changeset
81 {
9580887dd160 [project @ 1998-09-26 02:45:55 by jwe]
jwe
parents: 3174
diff changeset
82 initialized = false;
9580887dd160 [project @ 1998-09-26 02:45:55 by jwe]
jwe
parents: 3174
diff changeset
83 init ();
9580887dd160 [project @ 1998-09-26 02:45:55 by jwe]
jwe
parents: 3174
diff changeset
84 }
9580887dd160 [project @ 1998-09-26 02:45:55 by jwe]
jwe
parents: 3174
diff changeset
85
8010
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
86 static char path_sep_char (void)
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
87 {
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
88 return static_members::path_sep_char ();
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
89 }
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
90
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
91 static std::string path_sep_str (void)
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
92 {
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
93 return static_members::path_sep_str ();
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
94 }
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
95
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
96 static bool is_path_sep (char c) { return c == path_sep_char (); }
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
97
8008
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
98 private:
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
99
8010
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
100 // The colon separated list that we were given.
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
101 std::string p_orig;
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
102
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
103 // The default path. If specified, replaces leading, trailing, or
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
104 // doubled colons in p_orig.
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
105 std::string p_default;
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
106
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
107 // TRUE means we've unpacked p.
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
108 bool initialized;
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
109
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
110 // A version of the colon separate list on which we have performed
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
111 // tilde, variable, and possibly default path expansion.
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
112 std::string p;
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
113
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
114 // The elements of the list.
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
115 string_vector pv;
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
116
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
117 void init (void);
0e9b6af36559 style fixes
John W. Eaton <jwe@octave.org>
parents: 8008
diff changeset
118
8008
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
119 // Use a singleton class for these data members instead of just
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
120 // making them static members of the dir_path class so that we can
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
121 // ensure proper initialization.
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
122
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
123 class static_members
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
124 {
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
125 public:
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
126
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
127 static_members (void);
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
128
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
129 static char path_sep_char (void)
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
130 {
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
131 return instance_ok () ? instance->xpath_sep_char : 0;
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
132 }
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
133
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
134 static std::string path_sep_str (void)
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
135 {
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
136 return instance_ok () ? instance->xpath_sep_str : std::string ();
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
137 }
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
138
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
139 private:
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
140
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
141 static static_members *instance;
5777
246b1fc1e628 [project @ 2006-04-26 18:16:24 by jwe]
jwe
parents: 5307
diff changeset
142
8008
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
143 static bool instance_ok (void);
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
144
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
145 // No copying!
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
146
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
147 static_members (const static_members&);
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
148
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
149 static_members& operator = (const static_members&);
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
150
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
151 char xpath_sep_char;
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
152
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
153 std::string xpath_sep_str;
4d13a7a2f6ab dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
154 };
1786
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
155 };
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
156
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
157 #endif
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
158
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
159 /*
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
160 ;;; Local Variables: ***
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
161 ;;; mode: C++ ***
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
162 ;;; End: ***
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe]
jwe
parents:
diff changeset
163 */