external/bsd/kyua-cli/dist/utils/fs/path.hpp

   1 // Copyright 2010 Google Inc.
   2 // All rights reserved.
   3 //
   4 // Redistribution and use in source and binary forms, with or without
   5 // modification, are permitted provided that the following conditions are
   6 // met:
   7 //
   8 // * Redistributions of source code must retain the above copyright
   9 //   notice, this list of conditions and the following disclaimer.
  10 // * Redistributions in binary form must reproduce the above copyright
  11 //   notice, this list of conditions and the following disclaimer in the
  12 //   documentation and/or other materials provided with the distribution.
  13 // * Neither the name of Google Inc. nor the names of its contributors
  14 //   may be used to endorse or promote products derived from this software
  15 //   without specific prior written permission.
  16 //
  17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28
  29 /// \file utils/fs/path.hpp
  30 /// Provides the utils::fs::path class.
  31 ///
  32 /// This is a poor man's reimplementation of the path class provided by
  33 /// Boost.Filesystem, in the sense that it tries to follow the same API but is
  34 /// much simplified.
  35
  36 #if !defined(UTILS_FS_PATH_HPP)
  37 #define UTILS_FS_PATH_HPP
  38
  39 #include <string>
  40 #include <ostream>
  41
  42 namespace utils {
  43 namespace fs {
  44
  45
  46 /// Representation and manipulation of a file system path.
  47 ///
  48 /// Application code should always use this class to represent a path instead of
  49 /// std::string, because this class is more semantically representative, ensures
  50 /// that the values are valid and provides some useful manipulation functions.
  51 ///
  52 /// Conversions to and from strings are always explicit.
  53 class path {
  54     /// Internal representation of the path.
  55     std::string _repr;
  56
  57 public:
  58     explicit path(const std::string&);
  59
  60     const char* c_str(void) const;
  61     const std::string& str(void) const;
  62
  63     path branch_path(void) const;
  64     std::string leaf_name(void) const;
  65     path to_absolute(void) const;
  66
  67     bool is_absolute(void) const;
  68     bool is_parent_of(path) const;
  69     int ncomponents(void) const;
  70
  71     bool operator<(const path&) const;
  72     bool operator==(const path&) const;
  73     bool operator!=(const path&) const;
  74     path operator/(const std::string&) const;
  75     path operator/(const path&) const;
  76 };
  77
  78
  79 std::ostream& operator<<(std::ostream&, const path&);
  80
  81
  82 }  // namespace fs
  83 }  // namespace utils
  84
  85 #endif  // !defined(UTILS_FS_PATH_HPP)