File size: 15,518 Bytes
9375c9a |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 |
// Copyright (C) 2003 Davis E. King (davis@dlib.net)
// License: Boost Software License See LICENSE.txt for the full license.
#undef DLIB_DIR_NAV_KERNEl_ABSTRACT_
#ifdef DLIB_DIR_NAV_KERNEl_ABSTRACT_
#include <string>
#include <vector>
#include "../uintn.h"
#include "../algs.h"
#include <chrono>
namespace dlib
{
// ----------------------------------------------------------------------------------------
/*!
GENERAL WARNING
Don't call any of these functions or make any of these objects
before main() has been entered. That means no instances
of file or directory at the global scope.
!*/
// ----------------------------------------------------------------------------------------
template <
typename queue_of_dir
>
void get_filesystem_roots (
queue_of_dir& roots
);
/*!
requires
- queue_of_dirs == an implementation of queue/queue_kernel_abstract.h with T
set to directory or a std::vector<directory> or dlib::std_vector_c<directory>.
ensures
- #roots == a queue containing directories that represent all the roots
of the filesystem on this machine. (e.g. in windows you have c:\, d:\
etc.)
throws
- std::bad_alloc
!*/
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
// file object
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
class file
{
/*!
WHAT THIS OBJECT REPRESENTS
This object represents a file.
Note that the size of a file is determined at the time the file
object is constructed. Thus if a file changes sizes after its
file object has been created its file object's size() method
will not reflect the new file size.
!*/
public:
class file_not_found : public error {};
file (
);
/*!
ensures
- #*this has been properly initialized
- #name() == ""
- #full_name() == ""
- #size() == 0
- #*this does not represent any file
throws
- std::bad_alloc
!*/
file (
const std::string& name
);
/*!
ensures
- #*this has been properly initialized
- #*this represents the file given by name
Note that name can be a fully qualified path or just a path
relative to the current working directory. Also, any symbolic
links in name will be resolved.
throws
- std::bad_alloc
- file_not_found
This exception is thrown if the file can not be found or
accessed.
!*/
file (
const char* name
);
/*!
ensures
- this function is identical to file(const std::string& name)
!*/
file (
const file& item
);
/*!
ensures
- #*this == item
throws
- std::bad_alloc
!*/
~file (
);
/*!
ensures
- all resources associated with *this have been released
!*/
const std::string& name (
) const;
/*!
ensures
- returns the name of the file. This is full_name() minus
the path to the file.
!*/
const std::string& full_name (
) const;
/*!
ensures
- returns the fully qualified name for the file represented by *this
!*/
uint64 size (
) const;
/*!
ensures
- returns the size of this file in bytes.
!*/
std::chrono::time_point<std::chrono::system_clock> last_modified (
) const;
/*!
ensures
- returns the time the file was last modified.
!*/
operator std::string (
) const;
/*!
ensures
- returns full_name()
(i.e. provides an implicit conversion to string from dlib::file)
!*/
file& operator= (
const file& rhs
);
/*!
ensures
- #*this == rhs
!*/
bool operator == (
const file& rhs
) const;
/*!
ensures
- if (*this and rhs represent the same file) then
- returns true
- else
- returns false
!*/
bool operator != (
const file& rhs
) const;
/*!
ensures
- if (*this and rhs represent the same file) then
- returns false
- else
- returns true
!*/
bool operator < (
const file& item
) const;
/*!
ensures
- if (full_name() < item.full_name()) then
- returns true
- else
- returns false
!*/
void swap (
file& item
);
/*!
ensures
- swaps *this and item
!*/
};
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
// directory object
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
class directory
{
/*!
WHAT THIS OBJECT REPRESENTS
This object represents a directory in a file system. It gives
the ability to traverse a directory tree.
Note that the directories . and .. are not returned by get_dirs()
!*/
public:
class dir_not_found : public error {};
class listing_error : public error {};
directory (
);
/*!
ensures
- #*this has been properly initialized
- #full_name() == ""
- #name() == ""
- #is_root() == true
- #*this does not represent any directory
throws
- std::bad_alloc
!*/
directory (
const std::string& name
);
/*!
ensures
- #*this has been properly initialized
- #*this represents the directory given by name.
Note that name can be a fully qualified path or just a path
relative to the current working directory. Also, any symbolic
links in name will be resolved.
throws
- std::bad_alloc
- dir_not_found
This exception is thrown if the directory can not be found or
accessed.
!*/
directory (
const char* name
);
/*!
ensures
- this function is identical to directory(const std::string& name)
!*/
directory (
const directory& item
);
/*!
ensures
- #*this == item
throws
- std::bad_alloc
!*/
~directory (
);
/*!
ensures
- all resources associated with *this have been released
!*/
static char get_separator (
);
/*!
ensures
- returns the character used to separate directories and file names in a
path. (i.e. \ on windows and / in unix)
!*/
template <
typename queue_of_files
>
void get_files (
queue_of_files& files
) const;
/*!
requires
- queue_of_files == an implementation of queue/queue_kernel_abstract.h with T
set to file or a std::vector<file> or dlib::std_vector_c<file>.
ensures
- #files == A queue containing all the files present in this directory.
(Note that symbolic links will not have been resolved in the names
of the returned files.)
- #files.size() == the number of files in this directory
throws
- bad_alloc
If this exception is thrown then the call to get_files() has
no effect on *this and #files is unusable until files.clear()
is called and succeeds.
- listing_error
This exception is thrown if listing access has been denied to this
directory or if some error occurred that prevented us from successfully
getting the contents of this directory.
If this exception is thrown then the call to get_files() has
no effect on *this and #files.size()==0.
!*/
std::vector<file> get_files (
) const;
/*!
ensures
- This function simply calls get_files(temp_vector) and then returns temp_vector.
!*/
template <
typename queue_of_dirs
>
void get_dirs (
queue_of_dirs& dirs
) const;
/*!
requires
- queue_of_dirs == an implementation of queue/queue_kernel_abstract.h with T
set to directory or a std::vector<directory> or dlib::std_vector_c<directory>.
ensures
- #dirs == a queue containing all the directories present in this directory.
(note that symbolic links will not have been resolved in the names
of the returned directories.)
- #dirs.size() == the number of subdirectories in this directory
throws
- bad_alloc
If this exception is thrown then the call to get_files() has
no effect on *this and #files is unusable until files.clear()
is called and succeeds.
- listing_error
This exception is thrown if listing access has been denied to this
directory or if some error occurred that prevented us from successfully
getting the contents of this directory.
If this exception is thrown then the call to get_dirs() has
no effect on *this and #dirs.size()==0.
!*/
std::vector<directory> get_dirs (
) const;
/*!
ensures
- This function simply calls get_dirs(temp_vector) and then returns temp_vector.
!*/
bool is_root (
) const;
/*!
ensures
- if (*this represents the root of this directory tree) then
- returns true
- else
- returns false
!*/
const directory get_parent (
) const;
/*!
ensures
- if (is_root()) then
- returns a copy of *this
- else
- returns the parent directory of *this
throws
- bad_alloc
If this exception is thrown then the call to get_parent() will
have no effect.
!*/
const std::string& name (
) const;
/*!
ensures
- if (is_root()) then
- returns ""
- else
- returns the name of the directory. This is full_name() minus
the path to the directory.
!*/
const std::string& full_name (
) const;
/*!
ensures
- returns the fully qualified directory name for *this
- if (is_root()) then
- the last character of #full_name() is get_separator()
- else
- the last character of #full_name() is NOT get_separator()
!*/
operator std::string (
) const;
/*!
ensures
- returns full_name()
(i.e. provides an implicit conversion to string from dlib::directory)
!*/
directory& operator= (
const directory& rhs
);
/*!
ensures
- #*this == rhs
!*/
bool operator == (
const directory& rhs
) const;
/*!
ensures
- if (*this and rhs represent the same directory) then
- returns true
- else
- returns false
!*/
bool operator != (
const directory& rhs
) const;
/*!
ensures
- if (*this and rhs represent the same directory) then
- returns false
- else
- returns true
!*/
bool operator < (
const directory& item
) const;
/*!
ensures
- if (full_name() < item.full_name()) then
- returns true
- else
- returns false
!*/
void swap (
directory& item
);
/*!
ensures
- swaps *this and item
!*/
};
// ----------------------------------------------------------------------------------------
inline std::ostream& operator<< (
std::ostream& out,
const directory& item
);
/*!
ensures
- performs: out << item.full_name()
- returns out
!*/
inline std::ostream& operator<< (
std::ostream& out,
const file& item
);
/*!
ensures
- performs: out << item.full_name()
- returns out
!*/
// ----------------------------------------------------------------------------------------
inline void swap (
file& a,
file& b
) { a.swap(b); }
/*!
provides a global swap function for file objects
!*/
// ----------------------------------------------------------------------------------------
inline void swap (
directory& a,
directory& b
) { a.swap(b); }
/*!
provides a global swap function for directory objects
!*/
// ----------------------------------------------------------------------------------------
}
#endif // DLIB_DIR_NAV_KERNEl_ABSTRACT_
|