1// Copyright 2010 The Kyua Authors. 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 "utils/fs/path_fwd.hpp" 40 41#include <string> 42#include <ostream> 43 44namespace utils { 45namespace fs { 46 47 48/// Representation and manipulation of a file system path. 49/// 50/// Application code should always use this class to represent a path instead of 51/// std::string, because this class is more semantically representative, ensures 52/// that the values are valid and provides some useful manipulation functions. 53/// 54/// Conversions to and from strings are always explicit. 55class path { 56 /// Internal representation of the path. 57 std::string _repr; 58 59public: 60 explicit path(const std::string&); 61 62 const char* c_str(void) const; 63 const std::string& str(void) const; 64 65 path branch_path(void) const; 66 std::string leaf_name(void) const; 67 path to_absolute(void) const; 68 69 bool is_absolute(void) const; 70 bool is_parent_of(path) const; 71 int ncomponents(void) const; 72 73 bool operator<(const path&) const; 74 bool operator==(const path&) const; 75 bool operator!=(const path&) const; 76 path operator/(const std::string&) const; 77 path operator/(const path&) const; 78}; 79 80 81std::ostream& operator<<(std::ostream&, const path&); 82 83 84} // namespace fs 85} // namespace utils 86 87#endif // !defined(UTILS_FS_PATH_HPP) 88