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/auto_cleaners.hpp 30 /// RAII wrappers to automatically remove file system entries. 31 32 #if !defined(UTILS_FS_AUTO_CLEANERS_HPP) 33 #define UTILS_FS_AUTO_CLEANERS_HPP 34 35 #include "utils/fs/auto_cleaners_fwd.hpp" 36 37 #include <memory> 38 #include <string> 39 40 #include "utils/fs/path_fwd.hpp" 41 42 namespace utils { 43 namespace fs { 44 45 46 /// Grabs ownership of a directory and removes it upon destruction. 47 /// 48 /// This class is reference-counted and therefore only the destruction of the 49 /// last instance will cause the removal of the directory. 50 class auto_directory { 51 struct impl; 52 /// Reference-counted, shared implementation. 53 std::shared_ptr< impl > _pimpl; 54 55 public: 56 explicit auto_directory(const path&); 57 ~auto_directory(void); 58 59 static auto_directory mkdtemp_public(const std::string&); 60 61 const path& directory(void) const; 62 void cleanup(void); 63 }; 64 65 66 /// Grabs ownership of a file and removes it upon destruction. 67 /// 68 /// This class is reference-counted and therefore only the destruction of the 69 /// last instance will cause the removal of the file. 70 class auto_file { 71 struct impl; 72 /// Reference-counted, shared implementation. 73 std::shared_ptr< impl > _pimpl; 74 75 public: 76 explicit auto_file(const path&); 77 ~auto_file(void); 78 79 static auto_file mkstemp(const std::string&); 80 81 const path& file(void) const; 82 void remove(void); 83 }; 84 85 86 } // namespace fs 87 } // namespace utils 88 89 #endif // !defined(UTILS_FS_AUTO_CLEANERS_HPP) 90