external/bsd/kyua-cli/dist/utils/fs/operations.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/operations.hpp
  30 /// File system algorithms and access functions.
  31 ///
  32 /// The functions in this module are exception-based, type-improved wrappers
  33 /// over the functions provided by libc.
  34
  35 #if !defined(UTILS_FS_OPERATIONS_HPP)
  36 #define UTILS_FS_OPERATIONS_HPP
  37
  38 #include <string>
  39
  40 #include "utils/optional.hpp"
  41
  42 namespace utils {
  43 namespace fs {
  44
  45
  46 class path;
  47
  48
  49 path current_path(void);
  50 bool exists(const fs::path&);
  51 utils::optional< path > find_in_path(const char*);
  52 void mkdir(const path&, const int);
  53 void mkdir_p(const path&, const int);
  54 fs::path mkdtemp(const std::string&);
  55 fs::path mkstemp(const std::string&);
  56 void rm_r(const path&);
  57 void rmdir(const path&);
  58 void unlink(const path&);
  59
  60
  61 }  // namespace fs
  62 }  // namespace utils
  63
  64 #endif  // !defined(UTILS_FS_OPERATIONS_HPP)