Improve the process for GNU tools
[minix3.git] / external / bsd / kyua-cli / dist / utils / fs / auto_cleaners.hpp
blob677c23eed852874756edc898e1d734fbb987f737
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.
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.
29 /// \file utils/fs/auto_cleaners.hpp
30 /// RAII wrappers to automatically remove file system entries.
32 #if !defined(UTILS_FS_AUTO_CLEANERS_HPP)
33 #define UTILS_FS_AUTO_CLEANERS_HPP
35 #include <string>
37 #include "utils/fs/path.hpp"
38 #include "utils/shared_ptr.hpp"
40 namespace utils {
41 namespace fs {
44 /// Grabs ownership of a directory and removes it upon destruction.
45 ///
46 /// This class is reference-counted and therefore only the destruction of the
47 /// last instance will cause the removal of the directory.
48 class auto_directory {
49 struct impl;
50 /// Reference-counted, shared implementation.
51 std::shared_ptr< impl > _pimpl;
53 public:
54 explicit auto_directory(const path&);
55 ~auto_directory(void);
57 static auto_directory mkdtemp(const std::string&);
59 const path& directory(void) const;
60 void cleanup(void);
64 /// Grabs ownership of a file and removes it upon destruction.
65 ///
66 /// This class is reference-counted and therefore only the destruction of the
67 /// last instance will cause the removal of the file.
68 class auto_file {
69 struct impl;
70 /// Reference-counted, shared implementation.
71 std::shared_ptr< impl > _pimpl;
73 public:
74 explicit auto_file(const path&);
75 ~auto_file(void);
77 static auto_file mkstemp(const std::string&);
79 const path& file(void) const;
80 void remove(void);
84 } // namespace fs
85 } // namespace utils
87 #endif // !defined(UTILS_FS_AUTO_CLEANERS_HPP)