xref: /freebsd/contrib/kyua/utils/fs/exceptions.hpp (revision b0d29bc47dba79f6f38e67eabadfb4b32ffd9390)
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/exceptions.hpp
30 /// Exception types raised by the fs module.
31 
32 #if !defined(UTILS_FS_EXCEPTIONS_HPP)
33 #define UTILS_FS_EXCEPTIONS_HPP
34 
35 #include <stdexcept>
36 #include <string>
37 
38 namespace utils {
39 namespace fs {
40 
41 
42 /// Base exception for fs errors.
43 class error : public std::runtime_error {
44 public:
45     explicit error(const std::string&);
46     virtual ~error(void) throw();
47 };
48 
49 
50 /// Error denoting an invalid path while constructing a fs::path object.
51 class invalid_path_error : public error {
52     /// Raw value of the invalid path.
53     std::string _textual_path;
54 
55 public:
56     explicit invalid_path_error(const std::string&, const std::string&);
57     virtual ~invalid_path_error(void) throw();
58 
59     const std::string& invalid_path(void) const;
60 };
61 
62 
63 /// Paths cannot be joined.
64 class join_error : public error {
65     /// Raw value of the first path in the join operation.
66     std::string _textual_path1;
67 
68     /// Raw value of the second path in the join operation.
69     std::string _textual_path2;
70 
71 public:
72     explicit join_error(const std::string&, const std::string&,
73                         const std::string&);
74     virtual ~join_error(void) throw();
75 
76     const std::string& textual_path1(void) const;
77     const std::string& textual_path2(void) const;
78 };
79 
80 
81 /// Exceptions for errno-based errors.
82 ///
83 /// TODO(jmmv): This code is duplicated in, at least, utils::process.  Figure
84 /// out a way to reuse this exception while maintaining the correct inheritance
85 /// (i.e. be able to keep it as a child of fs::error).
86 class system_error : public error {
87     /// Error number describing this libc error condition.
88     int _original_errno;
89 
90 public:
91     explicit system_error(const std::string&, const int);
92     ~system_error(void) throw();
93 
94     int original_errno(void) const throw();
95 };
96 
97 
98 /// Exception to denote an unsupported operation.
99 class unsupported_operation_error : public error {
100 public:
101     explicit unsupported_operation_error(const std::string&);
102     virtual ~unsupported_operation_error(void) throw();
103 };
104 
105 
106 }  // namespace fs
107 }  // namespace utils
108 
109 
110 #endif  // !defined(UTILS_FS_EXCEPTIONS_HPP)
111