Mercurial > octave
annotate libinterp/corefcn/load-path.h @ 19075:14bb81940528 stable
doc: Update docstring for datenum to describe format argument (bug #43181)
* datenum.m: Update docstring to describe the format argument exactly like
the docstring for datevec. Add test using format argument.
| author | Mike Miller <mtmiller@ieee.org> |
|---|---|
| date | Wed, 10 Sep 2014 08:19:43 -0400 |
| parents | 175b392e91fe |
| children | 97e49b588f5d |
| rev | line source |
|---|---|
| 5832 | 1 /* |
| 2 | |
|
17744
d63878346099
maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents:
16892
diff
changeset
|
3 Copyright (C) 2006-2013 John W. Eaton |
|
10521
4d1fc073fbb7
add some missing copyright stmts
Jaroslav Hajek <highegg@gmail.com>
parents:
10321
diff
changeset
|
4 Copyright (C) 2010 VZLU Prague |
| 5832 | 5 |
| 6 This file is part of Octave. | |
| 7 | |
| 8 Octave is free software; you can redistribute it and/or modify it | |
| 9 under the terms of the GNU General Public License as published by the | |
| 7016 | 10 Free Software Foundation; either version 3 of the License, or (at your |
| 11 option) any later version. | |
| 5832 | 12 |
| 13 Octave is distributed in the hope that it will be useful, but WITHOUT | |
| 14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 16 for more details. | |
| 17 | |
| 18 You should have received a copy of the GNU General Public License | |
| 7016 | 19 along with Octave; see the file COPYING. If not, see |
| 20 <http://www.gnu.org/licenses/>. | |
| 5832 | 21 |
| 22 */ | |
| 23 | |
| 24 #if !defined (octave_load_path_h) | |
| 25 #define octave_load_path_h 1 | |
| 26 | |
|
8950
d865363208d6
include <iosfwd> instead of <iostream> in header files
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
27 #include <iosfwd> |
| 5832 | 28 #include <list> |
| 29 #include <map> | |
| 30 #include <string> | |
| 31 | |
| 5835 | 32 #include "pathsearch.h" |
| 5832 | 33 #include "str-vec.h" |
| 34 | |
| 35 class | |
| 6241 | 36 OCTINTERP_API |
| 5832 | 37 load_path |
| 38 { | |
| 39 protected: | |
| 40 | |
|
9010
f914834836e7
Partial implementation of derived classes using the old form with "@" files.
rtshort@smoketree.phaselocked.com
parents:
8950
diff
changeset
|
41 load_path (void) |
|
15008
ff9a638a5555
preserve order of path elements when doing "path (new_path)"
John W. Eaton <jwe@octave.org>
parents:
14861
diff
changeset
|
42 : dir_info_list (), fcn_map (), private_fcn_map (), method_map (), |
|
ff9a638a5555
preserve order of path elements when doing "path (new_path)"
John W. Eaton <jwe@octave.org>
parents:
14861
diff
changeset
|
43 init_dirs () { } |
| 5832 | 44 |
| 45 public: | |
| 46 | |
| 7336 | 47 typedef void (*hook_fcn_ptr) (const std::string& dir); |
| 5832 | 48 |
| 49 ~load_path (void) { } | |
| 50 | |
| 6365 | 51 static void initialize (bool set_initial_path = false) |
| 5832 | 52 { |
| 53 if (instance_ok ()) | |
| 6365 | 54 instance->do_initialize (set_initial_path); |
| 5832 | 55 } |
| 56 | |
| 57 static void clear (void) | |
| 58 { | |
| 59 if (instance_ok ()) | |
|
15008
ff9a638a5555
preserve order of path elements when doing "path (new_path)"
John W. Eaton <jwe@octave.org>
parents:
14861
diff
changeset
|
60 instance->do_clear (); |
| 5832 | 61 } |
| 62 | |
| 5867 | 63 static void set (const std::string& p, bool warn = false) |
| 5832 | 64 { |
| 65 if (instance_ok ()) | |
| 5867 | 66 instance->do_set (p, warn); |
| 5832 | 67 } |
| 68 | |
| 5867 | 69 static void append (const std::string& dir, bool warn = false) |
| 5832 | 70 { |
| 71 if (instance_ok ()) | |
| 5867 | 72 instance->do_append (dir, warn); |
| 5832 | 73 } |
| 74 | |
| 5867 | 75 static void prepend (const std::string& dir, bool warn = false) |
| 5832 | 76 { |
| 77 if (instance_ok ()) | |
| 5867 | 78 instance->do_prepend (dir, warn); |
| 5832 | 79 } |
| 80 | |
| 81 static bool remove (const std::string& dir) | |
| 82 { | |
| 83 return instance_ok () ? instance->do_remove (dir) : false; | |
| 84 } | |
| 85 | |
| 86 static void update (void) | |
| 87 { | |
| 88 if (instance_ok ()) | |
| 89 instance->do_update (); | |
| 90 } | |
| 91 | |
|
16547
3cd80afc3509
improve debugging with the GUI
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
92 static bool contains_canonical (const std::string& dir_name) |
|
3cd80afc3509
improve debugging with the GUI
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
93 { |
|
3cd80afc3509
improve debugging with the GUI
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
94 return instance_ok () ? instance->do_contains_canonical (dir_name) : false; |
|
3cd80afc3509
improve debugging with the GUI
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
95 } |
|
3cd80afc3509
improve debugging with the GUI
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
96 |
| 7336 | 97 static std::string find_method (const std::string& class_name, |
| 10313 | 98 const std::string& meth, |
| 99 std::string& dir_name) | |
| 7336 | 100 { |
| 101 return instance_ok () | |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
102 ? instance->do_find_method (class_name, meth, dir_name) |
|
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
103 : std::string (); |
| 7336 | 104 } |
| 105 | |
| 106 static std::string find_method (const std::string& class_name, | |
| 10313 | 107 const std::string& meth) |
| 7336 | 108 { |
| 109 std::string dir_name; | |
| 110 return find_method (class_name, meth, dir_name); | |
| 111 } | |
| 112 | |
| 113 static std::list<std::string> methods (const std::string& class_name) | |
| 114 { | |
| 115 return instance_ok () | |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
116 ? instance->do_methods (class_name) : std::list<std::string> (); |
| 7336 | 117 } |
| 118 | |
|
10321
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
119 static std::list<std::string> overloads (const std::string& meth) |
|
9458
0c7d84a65386
allow taking handles of methods with no base overload
Jaroslav Hajek <highegg@gmail.com>
parents:
9261
diff
changeset
|
120 { |
|
0c7d84a65386
allow taking handles of methods with no base overload
Jaroslav Hajek <highegg@gmail.com>
parents:
9261
diff
changeset
|
121 return instance_ok () |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
122 ? instance->do_overloads (meth) : std::list<std::string> (); |
|
9458
0c7d84a65386
allow taking handles of methods with no base overload
Jaroslav Hajek <highegg@gmail.com>
parents:
9261
diff
changeset
|
123 } |
|
0c7d84a65386
allow taking handles of methods with no base overload
Jaroslav Hajek <highegg@gmail.com>
parents:
9261
diff
changeset
|
124 |
| 7336 | 125 static std::string find_fcn (const std::string& fcn, std::string& dir_name) |
| 126 { | |
| 127 return instance_ok () | |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
128 ? instance->do_find_fcn (fcn, dir_name) : std::string (); |
| 7336 | 129 } |
| 130 | |
| 5832 | 131 static std::string find_fcn (const std::string& fcn) |
| 132 { | |
| 7336 | 133 std::string dir_name; |
| 134 return find_fcn (fcn, dir_name); | |
| 135 } | |
| 136 | |
| 137 static std::string find_private_fcn (const std::string& dir, | |
| 10313 | 138 const std::string& fcn) |
| 7336 | 139 { |
| 5832 | 140 return instance_ok () |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
141 ? instance->do_find_private_fcn (dir, fcn) : std::string (); |
| 5832 | 142 } |
| 143 | |
| 144 static std::string find_fcn_file (const std::string& fcn) | |
| 145 { | |
| 7336 | 146 std::string dir_name; |
| 147 | |
| 5832 | 148 return instance_ok () ? |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
149 instance->do_find_fcn (fcn, dir_name, M_FILE) : std::string (); |
| 5832 | 150 } |
| 151 | |
| 152 static std::string find_oct_file (const std::string& fcn) | |
| 153 { | |
| 7336 | 154 std::string dir_name; |
| 155 | |
| 5832 | 156 return instance_ok () ? |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
157 instance->do_find_fcn (fcn, dir_name, OCT_FILE) : std::string (); |
| 5832 | 158 } |
| 159 | |
| 5864 | 160 static std::string find_mex_file (const std::string& fcn) |
| 161 { | |
| 7336 | 162 std::string dir_name; |
| 163 | |
| 5864 | 164 return instance_ok () ? |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
165 instance->do_find_fcn (fcn, dir_name, MEX_FILE) : std::string (); |
| 5864 | 166 } |
| 167 | |
| 5832 | 168 static std::string find_file (const std::string& file) |
| 169 { | |
| 170 return instance_ok () | |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
171 ? instance->do_find_file (file) : std::string (); |
| 5832 | 172 } |
| 173 | |
|
8041
a14bdf90be55
Add a search for Contents.m files to the help function
David Bateman <dbateman@free.fr>
parents:
8008
diff
changeset
|
174 static std::string find_dir (const std::string& dir) |
|
a14bdf90be55
Add a search for Contents.m files to the help function
David Bateman <dbateman@free.fr>
parents:
8008
diff
changeset
|
175 { |
|
a14bdf90be55
Add a search for Contents.m files to the help function
David Bateman <dbateman@free.fr>
parents:
8008
diff
changeset
|
176 return instance_ok () |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
177 ? instance->do_find_dir (dir) : std::string (); |
|
8041
a14bdf90be55
Add a search for Contents.m files to the help function
David Bateman <dbateman@free.fr>
parents:
8008
diff
changeset
|
178 } |
|
a14bdf90be55
Add a search for Contents.m files to the help function
David Bateman <dbateman@free.fr>
parents:
8008
diff
changeset
|
179 |
|
9806
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9748
diff
changeset
|
180 static string_vector find_matching_dirs (const std::string& dir) |
|
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9748
diff
changeset
|
181 { |
|
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9748
diff
changeset
|
182 return instance_ok () |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
183 ? instance->do_find_matching_dirs (dir) : string_vector (); |
|
9806
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9748
diff
changeset
|
184 } |
|
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9748
diff
changeset
|
185 |
| 5832 | 186 static std::string find_first_of (const string_vector& files) |
| 187 { | |
| 188 return instance_ok () ? | |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
189 instance->do_find_first_of (files) : std::string (); |
| 5832 | 190 } |
| 191 | |
| 192 static string_vector find_all_first_of (const string_vector& files) | |
| 193 { | |
| 194 return instance_ok () ? | |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
195 instance->do_find_all_first_of (files) : string_vector (); |
| 5832 | 196 } |
| 197 | |
| 198 static string_vector dirs (void) | |
| 199 { | |
| 200 return instance_ok () ? instance->do_dirs () : string_vector (); | |
| 201 } | |
| 202 | |
| 203 static std::list<std::string> dir_list (void) | |
| 204 { | |
| 205 return instance_ok () | |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
206 ? instance->do_dir_list () : std::list<std::string> (); |
| 5832 | 207 } |
| 208 | |
|
9261
95445f9f5976
omit file extensions from __list_functions__ output
John W. Eaton <jwe@octave.org>
parents:
9010
diff
changeset
|
209 static string_vector files (const std::string& dir, bool omit_exts = false) |
| 5832 | 210 { |
|
9261
95445f9f5976
omit file extensions from __list_functions__ output
John W. Eaton <jwe@octave.org>
parents:
9010
diff
changeset
|
211 return instance_ok () |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
212 ? instance->do_files (dir, omit_exts) : string_vector (); |
| 5832 | 213 } |
| 214 | |
| 215 static string_vector fcn_names (void) | |
| 216 { | |
| 217 return instance_ok () ? instance->do_fcn_names () : string_vector (); | |
| 218 } | |
| 219 | |
| 220 static std::string path (void) | |
| 221 { | |
| 222 return instance_ok () ? instance->do_path () : std::string (); | |
| 223 } | |
| 224 | |
| 225 static void display (std::ostream& os) | |
| 226 { | |
| 227 if (instance_ok ()) | |
| 228 instance->do_display (os); | |
| 229 } | |
| 230 | |
| 7336 | 231 static void set_add_hook (hook_fcn_ptr f) { add_hook = f; } |
| 5832 | 232 |
| 7336 | 233 static void set_remove_hook (hook_fcn_ptr f) { remove_hook = f; } |
| 5832 | 234 |
| 235 static void set_command_line_path (const std::string& p) | |
| 236 { | |
| 5835 | 237 if (command_line_path.empty ()) |
| 238 command_line_path = p; | |
| 239 else | |
|
8008
4d13a7a2f6ab
dir_path: use singleton class for static data members
John W. Eaton <jwe@octave.org>
parents:
7971
diff
changeset
|
240 command_line_path += dir_path::path_sep_str () + p; |
| 5832 | 241 } |
| 242 | |
|
8586
31ab3b83bc8a
savepath: Respect cmd-line and env paths.
Ben Abbott <bpabbott@mac.com>
parents:
8329
diff
changeset
|
243 static std::string get_command_line_path (void) |
|
31ab3b83bc8a
savepath: Respect cmd-line and env paths.
Ben Abbott <bpabbott@mac.com>
parents:
8329
diff
changeset
|
244 { |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
245 return instance_ok () ? instance->do_get_command_line_path () |
|
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
246 : std::string (); |
|
8586
31ab3b83bc8a
savepath: Respect cmd-line and env paths.
Ben Abbott <bpabbott@mac.com>
parents:
8329
diff
changeset
|
247 } |
|
31ab3b83bc8a
savepath: Respect cmd-line and env paths.
Ben Abbott <bpabbott@mac.com>
parents:
8329
diff
changeset
|
248 |
| 6626 | 249 static std::string system_path (void) |
| 250 { | |
| 6630 | 251 return instance_ok () ? instance->do_system_path () : std::string (); |
| 6626 | 252 } |
| 253 | |
| 5832 | 254 private: |
| 255 | |
| 256 static const int M_FILE = 1; | |
| 257 static const int OCT_FILE = 2; | |
| 5864 | 258 static const int MEX_FILE = 4; |
| 5832 | 259 |
| 260 class dir_info | |
| 261 { | |
| 262 public: | |
| 263 | |
| 7336 | 264 // <FCN_NAME, TYPE> |
| 265 typedef std::map<std::string, int> fcn_file_map_type; | |
| 266 | |
| 267 typedef fcn_file_map_type::const_iterator const_fcn_file_map_iterator; | |
| 268 typedef fcn_file_map_type::iterator fcn_file_map_iterator; | |
| 269 | |
|
7971
dd5cc5016487
handle private functions in class directories
John W. Eaton <jwe@octave.org>
parents:
7336
diff
changeset
|
270 struct class_info |
|
dd5cc5016487
handle private functions in class directories
John W. Eaton <jwe@octave.org>
parents:
7336
diff
changeset
|
271 { |
|
11515
6dbf9bcce90e
more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents:
10907
diff
changeset
|
272 class_info (void) : method_file_map (), private_file_map () { } |
|
6dbf9bcce90e
more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents:
10907
diff
changeset
|
273 |
|
6dbf9bcce90e
more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents:
10907
diff
changeset
|
274 class_info (const class_info& ci) |
|
6dbf9bcce90e
more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents:
10907
diff
changeset
|
275 : method_file_map (ci.method_file_map), |
|
6dbf9bcce90e
more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents:
10907
diff
changeset
|
276 private_file_map (ci.private_file_map) { } |
|
6dbf9bcce90e
more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents:
10907
diff
changeset
|
277 |
|
6dbf9bcce90e
more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents:
10907
diff
changeset
|
278 class_info& operator = (const class_info& ci) |
|
6dbf9bcce90e
more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents:
10907
diff
changeset
|
279 { |
|
6dbf9bcce90e
more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents:
10907
diff
changeset
|
280 if (this != &ci) |
|
6dbf9bcce90e
more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents:
10907
diff
changeset
|
281 { |
|
6dbf9bcce90e
more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents:
10907
diff
changeset
|
282 method_file_map = ci.method_file_map; |
|
6dbf9bcce90e
more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents:
10907
diff
changeset
|
283 private_file_map = ci.private_file_map; |
|
6dbf9bcce90e
more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents:
10907
diff
changeset
|
284 } |
|
6dbf9bcce90e
more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents:
10907
diff
changeset
|
285 return *this; |
|
6dbf9bcce90e
more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents:
10907
diff
changeset
|
286 } |
|
6dbf9bcce90e
more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents:
10907
diff
changeset
|
287 |
|
6dbf9bcce90e
more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents:
10907
diff
changeset
|
288 ~class_info (void) { } |
|
6dbf9bcce90e
more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents:
10907
diff
changeset
|
289 |
|
7971
dd5cc5016487
handle private functions in class directories
John W. Eaton <jwe@octave.org>
parents:
7336
diff
changeset
|
290 fcn_file_map_type method_file_map; |
|
dd5cc5016487
handle private functions in class directories
John W. Eaton <jwe@octave.org>
parents:
7336
diff
changeset
|
291 fcn_file_map_type private_file_map; |
|
dd5cc5016487
handle private functions in class directories
John W. Eaton <jwe@octave.org>
parents:
7336
diff
changeset
|
292 }; |
|
dd5cc5016487
handle private functions in class directories
John W. Eaton <jwe@octave.org>
parents:
7336
diff
changeset
|
293 |
|
dd5cc5016487
handle private functions in class directories
John W. Eaton <jwe@octave.org>
parents:
7336
diff
changeset
|
294 // <CLASS_NAME, CLASS_INFO> |
|
dd5cc5016487
handle private functions in class directories
John W. Eaton <jwe@octave.org>
parents:
7336
diff
changeset
|
295 typedef std::map<std::string, class_info> method_file_map_type; |
| 7336 | 296 |
| 297 typedef method_file_map_type::const_iterator const_method_file_map_iterator; | |
| 298 typedef method_file_map_type::iterator method_file_map_iterator; | |
| 299 | |
|
8329
c91b59532f32
load-path.cc (load_path::dir_info::update): smarter handling of relative names
John W. Eaton <jwe@octave.org>
parents:
8041
diff
changeset
|
300 // This default constructor is only provided so we can create a |
|
c91b59532f32
load-path.cc (load_path::dir_info::update): smarter handling of relative names
John W. Eaton <jwe@octave.org>
parents:
8041
diff
changeset
|
301 // std::map of dir_info objects. You should not use this |
|
c91b59532f32
load-path.cc (load_path::dir_info::update): smarter handling of relative names
John W. Eaton <jwe@octave.org>
parents:
8041
diff
changeset
|
302 // constructor for any other purpose. |
|
11515
6dbf9bcce90e
more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents:
10907
diff
changeset
|
303 dir_info (void) |
|
6dbf9bcce90e
more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents:
10907
diff
changeset
|
304 : dir_name (), abs_dir_name (), is_relative (false), |
|
15008
ff9a638a5555
preserve order of path elements when doing "path (new_path)"
John W. Eaton <jwe@octave.org>
parents:
14861
diff
changeset
|
305 dir_mtime (), dir_time_last_checked (), |
|
14376
7dd6ac033e69
Warn when the default path is overwritten
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
14138
diff
changeset
|
306 all_files (), fcn_files (), private_file_map (), method_file_map () |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
307 { } |
|
8329
c91b59532f32
load-path.cc (load_path::dir_info::update): smarter handling of relative names
John W. Eaton <jwe@octave.org>
parents:
8041
diff
changeset
|
308 |
|
11515
6dbf9bcce90e
more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents:
10907
diff
changeset
|
309 dir_info (const std::string& d) |
|
6dbf9bcce90e
more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents:
10907
diff
changeset
|
310 : dir_name (d), abs_dir_name (), is_relative (false), |
|
15008
ff9a638a5555
preserve order of path elements when doing "path (new_path)"
John W. Eaton <jwe@octave.org>
parents:
14861
diff
changeset
|
311 dir_mtime (), dir_time_last_checked (), |
|
14376
7dd6ac033e69
Warn when the default path is overwritten
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
14138
diff
changeset
|
312 all_files (), fcn_files (), private_file_map (), method_file_map () |
|
11515
6dbf9bcce90e
more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents:
10907
diff
changeset
|
313 { |
|
6dbf9bcce90e
more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents:
10907
diff
changeset
|
314 initialize (); |
|
6dbf9bcce90e
more data member initialization fixes
John W. Eaton <jwe@octave.org>
parents:
10907
diff
changeset
|
315 } |
| 5832 | 316 |
| 317 dir_info (const dir_info& di) | |
|
8329
c91b59532f32
load-path.cc (load_path::dir_info::update): smarter handling of relative names
John W. Eaton <jwe@octave.org>
parents:
8041
diff
changeset
|
318 : dir_name (di.dir_name), abs_dir_name (di.abs_dir_name), |
| 10313 | 319 is_relative (di.is_relative), |
| 320 dir_mtime (di.dir_mtime), | |
|
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
321 dir_time_last_checked (di.dir_time_last_checked), |
| 10313 | 322 all_files (di.all_files), fcn_files (di.fcn_files), |
| 323 private_file_map (di.private_file_map), | |
| 324 method_file_map (di.method_file_map) { } | |
| 5832 | 325 |
| 326 ~dir_info (void) { } | |
| 327 | |
| 328 dir_info& operator = (const dir_info& di) | |
| 329 { | |
| 330 if (&di != this) | |
| 10313 | 331 { |
| 332 dir_name = di.dir_name; | |
| 333 abs_dir_name = di.abs_dir_name; | |
| 334 is_relative = di.is_relative; | |
| 335 dir_mtime = di.dir_mtime; | |
| 336 dir_time_last_checked = di.dir_time_last_checked; | |
| 337 all_files = di.all_files; | |
| 338 fcn_files = di.fcn_files; | |
| 339 private_file_map = di.private_file_map; | |
| 340 method_file_map = di.method_file_map; | |
| 341 } | |
| 5832 | 342 |
| 343 return *this; | |
| 344 } | |
| 345 | |
| 346 void update (void); | |
| 347 | |
| 348 std::string dir_name; | |
|
8329
c91b59532f32
load-path.cc (load_path::dir_info::update): smarter handling of relative names
John W. Eaton <jwe@octave.org>
parents:
8041
diff
changeset
|
349 std::string abs_dir_name; |
| 5832 | 350 bool is_relative; |
| 351 octave_time dir_mtime; | |
|
9748
d6b2b708b6b0
load-path: compare directory timestamps with tolerance
John W. Eaton <jwe@octave.org>
parents:
9581
diff
changeset
|
352 octave_time dir_time_last_checked; |
| 5832 | 353 string_vector all_files; |
| 354 string_vector fcn_files; | |
| 7336 | 355 fcn_file_map_type private_file_map; |
| 356 method_file_map_type method_file_map; | |
| 5832 | 357 |
| 358 private: | |
| 359 | |
| 360 void initialize (void); | |
| 361 | |
| 7336 | 362 void get_file_list (const std::string& d); |
| 363 | |
| 364 void get_private_file_map (const std::string& d); | |
| 5832 | 365 |
| 7336 | 366 void get_method_file_map (const std::string& d, |
| 10313 | 367 const std::string& class_name); |
| 7336 | 368 |
| 369 friend fcn_file_map_type get_fcn_files (const std::string& d); | |
| 5832 | 370 }; |
| 371 | |
| 372 class file_info | |
| 373 { | |
| 374 public: | |
| 375 | |
| 376 file_info (const std::string& d, int t) : dir_name (d), types (t) { } | |
| 377 | |
| 378 file_info (const file_info& fi) | |
| 379 : dir_name (fi.dir_name), types (fi.types) { } | |
| 380 | |
| 381 ~file_info (void) { } | |
| 382 | |
| 383 file_info& operator = (const file_info& fi) | |
| 384 { | |
| 385 if (&fi != this) | |
| 10313 | 386 { |
| 387 dir_name = fi.dir_name; | |
| 388 types = fi.types; | |
| 389 } | |
| 5832 | 390 |
| 391 return *this; | |
| 392 } | |
| 393 | |
| 394 std::string dir_name; | |
| 395 int types; | |
| 396 }; | |
| 397 | |
| 398 // We maintain two ways of looking at the same information. | |
| 399 // | |
| 400 // First, a list of directories and the set of "public" files and | |
| 401 // private files (those found in the special "private" subdirectory) | |
| 402 // in each directory. | |
| 403 // | |
| 404 // Second, a map from file names (the union of all "public" files for all | |
| 7336 | 405 // directories, but without filename extensions) to a list of |
| 5832 | 406 // corresponding information (directory name and file types). This |
| 407 // way, we can quickly find shadowed file names and look up all | |
| 408 // overloaded functions (in the "@" directories used to implement | |
| 409 // classes). | |
| 410 | |
| 7336 | 411 typedef std::list<dir_info> dir_info_list_type; |
| 412 | |
| 413 typedef dir_info_list_type::const_iterator const_dir_info_list_iterator; | |
| 414 typedef dir_info_list_type::iterator dir_info_list_iterator; | |
| 415 | |
|
8329
c91b59532f32
load-path.cc (load_path::dir_info::update): smarter handling of relative names
John W. Eaton <jwe@octave.org>
parents:
8041
diff
changeset
|
416 typedef std::map<std::string, dir_info> abs_dir_cache_type; |
|
c91b59532f32
load-path.cc (load_path::dir_info::update): smarter handling of relative names
John W. Eaton <jwe@octave.org>
parents:
8041
diff
changeset
|
417 |
|
c91b59532f32
load-path.cc (load_path::dir_info::update): smarter handling of relative names
John W. Eaton <jwe@octave.org>
parents:
8041
diff
changeset
|
418 typedef abs_dir_cache_type::const_iterator const_abs_dir_cache_iterator; |
|
c91b59532f32
load-path.cc (load_path::dir_info::update): smarter handling of relative names
John W. Eaton <jwe@octave.org>
parents:
8041
diff
changeset
|
419 typedef abs_dir_cache_type::iterator abs_dir_cache_iterator; |
|
c91b59532f32
load-path.cc (load_path::dir_info::update): smarter handling of relative names
John W. Eaton <jwe@octave.org>
parents:
8041
diff
changeset
|
420 |
| 7336 | 421 typedef std::list<file_info> file_info_list_type; |
| 422 | |
| 423 typedef file_info_list_type::const_iterator const_file_info_list_iterator; | |
| 424 typedef file_info_list_type::iterator file_info_list_iterator; | |
| 425 | |
| 426 // <FCN_NAME, FILE_INFO_LIST> | |
| 427 typedef std::map<std::string, file_info_list_type> fcn_map_type; | |
| 428 | |
| 429 typedef fcn_map_type::const_iterator const_fcn_map_iterator; | |
| 430 typedef fcn_map_type::iterator fcn_map_iterator; | |
| 5832 | 431 |
| 7336 | 432 // <DIR_NAME, <FCN_NAME, TYPE>> |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
433 typedef std::map<std::string, dir_info::fcn_file_map_type> |
|
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
434 private_fcn_map_type; |
| 7336 | 435 |
| 436 typedef private_fcn_map_type::const_iterator const_private_fcn_map_iterator; | |
| 437 typedef private_fcn_map_type::iterator private_fcn_map_iterator; | |
| 438 | |
| 439 // <CLASS_NAME, <FCN_NAME, FILE_INFO_LIST>> | |
| 440 typedef std::map<std::string, fcn_map_type> method_map_type; | |
| 441 | |
| 442 typedef method_map_type::const_iterator const_method_map_iterator; | |
| 443 typedef method_map_type::iterator method_map_iterator; | |
|
10907
6105ed2db9d7
load_path::dir_info::initialize: clear method_file_map before updating file list
John W. Eaton <jwe@octave.org>
parents:
10521
diff
changeset
|
444 |
| 7336 | 445 mutable dir_info_list_type dir_info_list; |
| 446 | |
| 447 mutable fcn_map_type fcn_map; | |
| 448 | |
| 449 mutable private_fcn_map_type private_fcn_map; | |
| 450 | |
| 451 mutable method_map_type method_map; | |
| 5832 | 452 |
|
15008
ff9a638a5555
preserve order of path elements when doing "path (new_path)"
John W. Eaton <jwe@octave.org>
parents:
14861
diff
changeset
|
453 mutable std::set<std::string> init_dirs; |
|
ff9a638a5555
preserve order of path elements when doing "path (new_path)"
John W. Eaton <jwe@octave.org>
parents:
14861
diff
changeset
|
454 |
| 5832 | 455 static load_path *instance; |
| 456 | |
|
13983
7dd7cccf0757
clean up memory allocated for singletons before exit
John W. Eaton <jwe@octave.org>
parents:
11586
diff
changeset
|
457 static void cleanup_instance (void) { delete instance; instance = 0; } |
|
7dd7cccf0757
clean up memory allocated for singletons before exit
John W. Eaton <jwe@octave.org>
parents:
11586
diff
changeset
|
458 |
| 7336 | 459 static hook_fcn_ptr add_hook; |
| 5832 | 460 |
| 7336 | 461 static hook_fcn_ptr remove_hook; |
| 5832 | 462 |
| 463 static std::string command_line_path; | |
| 464 | |
| 6626 | 465 static std::string sys_path; |
| 466 | |
|
8329
c91b59532f32
load-path.cc (load_path::dir_info::update): smarter handling of relative names
John W. Eaton <jwe@octave.org>
parents:
8041
diff
changeset
|
467 static abs_dir_cache_type abs_dir_cache; |
|
c91b59532f32
load-path.cc (load_path::dir_info::update): smarter handling of relative names
John W. Eaton <jwe@octave.org>
parents:
8041
diff
changeset
|
468 |
| 5832 | 469 static bool instance_ok (void); |
| 470 | |
| 471 const_dir_info_list_iterator find_dir_info (const std::string& dir) const; | |
| 472 dir_info_list_iterator find_dir_info (const std::string& dir); | |
| 473 | |
| 474 bool contains (const std::string& dir) const; | |
| 475 | |
|
16547
3cd80afc3509
improve debugging with the GUI
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
476 bool do_contains_canonical (const std::string& dir) const; |
|
3cd80afc3509
improve debugging with the GUI
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
477 |
| 7336 | 478 void move_fcn_map (const std::string& dir, |
| 10313 | 479 const string_vector& fcn_files, bool at_end); |
| 7336 | 480 |
| 481 void move_method_map (const std::string& dir, bool at_end); | |
| 482 | |
| 5832 | 483 void move (std::list<dir_info>::iterator i, bool at_end); |
| 484 | |
| 6365 | 485 void do_initialize (bool set_initial_path); |
| 5832 | 486 |
|
15008
ff9a638a5555
preserve order of path elements when doing "path (new_path)"
John W. Eaton <jwe@octave.org>
parents:
14861
diff
changeset
|
487 void do_clear (void); |
| 5832 | 488 |
|
15008
ff9a638a5555
preserve order of path elements when doing "path (new_path)"
John W. Eaton <jwe@octave.org>
parents:
14861
diff
changeset
|
489 void do_set (const std::string& p, bool warn, bool is_init = false); |
| 5867 | 490 |
|
15008
ff9a638a5555
preserve order of path elements when doing "path (new_path)"
John W. Eaton <jwe@octave.org>
parents:
14861
diff
changeset
|
491 void do_append (const std::string& dir, bool warn); |
| 5832 | 492 |
| 5867 | 493 void do_prepend (const std::string& dir, bool warn); |
| 5832 | 494 |
|
15008
ff9a638a5555
preserve order of path elements when doing "path (new_path)"
John W. Eaton <jwe@octave.org>
parents:
14861
diff
changeset
|
495 void do_add (const std::string& dir, bool at_end, bool warn); |
| 5832 | 496 |
| 7336 | 497 void remove_fcn_map (const std::string& dir, const string_vector& fcn_files); |
| 498 | |
| 499 void remove_private_fcn_map (const std::string& dir); | |
| 500 | |
| 501 void remove_method_map (const std::string& dir); | |
| 502 | |
| 5832 | 503 bool do_remove (const std::string& dir); |
| 504 | |
| 505 void do_update (void) const; | |
| 506 | |
| 7336 | 507 static bool |
| 508 check_file_type (std::string& fname, int type, int possible_types, | |
| 10313 | 509 const std::string& fcn, const char *who); |
| 7336 | 510 |
| 5832 | 511 std::string do_find_fcn (const std::string& fcn, |
| 10313 | 512 std::string& dir_name, |
| 513 int type = M_FILE | OCT_FILE | MEX_FILE) const; | |
| 5832 | 514 |
| 7336 | 515 std::string do_find_private_fcn (const std::string& dir, |
| 10313 | 516 const std::string& fcn, |
| 517 int type = M_FILE | OCT_FILE | MEX_FILE) const; | |
| 7336 | 518 |
| 519 std::string do_find_method (const std::string& class_name, | |
| 10313 | 520 const std::string& meth, |
| 521 std::string& dir_name, | |
| 522 int type = M_FILE | OCT_FILE | MEX_FILE) const; | |
| 7336 | 523 |
| 524 std::list<std::string> do_methods (const std::string& class_name) const; | |
| 525 | |
|
10321
97b4bd6f0925
partially rewrite function handles
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
526 std::list<std::string> do_overloads (const std::string& meth) const; |
|
9458
0c7d84a65386
allow taking handles of methods with no base overload
Jaroslav Hajek <highegg@gmail.com>
parents:
9261
diff
changeset
|
527 |
| 5832 | 528 std::string do_find_file (const std::string& file) const; |
| 529 | |
|
8041
a14bdf90be55
Add a search for Contents.m files to the help function
David Bateman <dbateman@free.fr>
parents:
8008
diff
changeset
|
530 std::string do_find_dir (const std::string& dir) const; |
|
a14bdf90be55
Add a search for Contents.m files to the help function
David Bateman <dbateman@free.fr>
parents:
8008
diff
changeset
|
531 |
|
9806
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9748
diff
changeset
|
532 string_vector do_find_matching_dirs (const std::string& dir) const; |
|
8e345f2fe4d6
improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents:
9748
diff
changeset
|
533 |
| 5832 | 534 std::string do_find_first_of (const string_vector& files) const; |
| 535 | |
| 536 string_vector do_find_all_first_of (const string_vector& files) const; | |
| 537 | |
| 538 string_vector do_dirs (void) const; | |
| 539 | |
| 540 std::list<std::string> do_dir_list (void) const; | |
| 541 | |
|
9261
95445f9f5976
omit file extensions from __list_functions__ output
John W. Eaton <jwe@octave.org>
parents:
9010
diff
changeset
|
542 string_vector do_files (const std::string& dir, bool omit_exts) const; |
| 5832 | 543 |
| 544 string_vector do_fcn_names (void) const; | |
| 545 | |
| 546 std::string do_path (void) const; | |
| 547 | |
| 7336 | 548 friend void print_types (std::ostream& os, int types); |
| 549 | |
| 550 friend string_vector get_file_list (const dir_info::fcn_file_map_type& lst); | |
| 551 | |
| 552 friend void | |
| 553 print_fcn_list (std::ostream& os, const dir_info::fcn_file_map_type& lst); | |
| 554 | |
| 5832 | 555 void do_display (std::ostream& os) const; |
| 556 | |
| 6629 | 557 std::string do_system_path (void) const { return sys_path; } |
| 6626 | 558 |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
559 std::string do_get_command_line_path (void) const |
|
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
560 { return command_line_path; } |
|
8586
31ab3b83bc8a
savepath: Respect cmd-line and env paths.
Ben Abbott <bpabbott@mac.com>
parents:
8329
diff
changeset
|
561 |
| 5832 | 562 void add_to_fcn_map (const dir_info& di, bool at_end) const; |
| 7336 | 563 |
| 564 void add_to_private_fcn_map (const dir_info& di) const; | |
| 565 | |
| 566 void add_to_method_map (const dir_info& di, bool at_end) const; | |
| 567 | |
| 568 friend dir_info::fcn_file_map_type get_fcn_files (const std::string& d); | |
| 5832 | 569 }; |
| 570 | |
| 571 extern std::string | |
| 572 genpath (const std::string& dir, const string_vector& skip = "private"); | |
| 573 | |
| 574 extern void execute_pkg_add (const std::string& dir); | |
| 575 extern void execute_pkg_del (const std::string& dir); | |
| 576 | |
| 577 #endif |