1 | // Copyright (c) 2012 by István Váradi
|
---|
2 |
|
---|
3 | // This file is part of libxplcommon, a common utility library for
|
---|
4 | // development related to X-Plane
|
---|
5 |
|
---|
6 | // Redistribution and use in source and binary forms, with or without
|
---|
7 | // modification, are permitted provided that the following conditions are met:
|
---|
8 |
|
---|
9 | // 1. Redistributions of source code must retain the above copyright notice, this
|
---|
10 | // list of conditions and the following disclaimer.
|
---|
11 | // 2. Redistributions in binary form must reproduce the above copyright notice,
|
---|
12 | // this list of conditions and the following disclaimer in the documentation
|
---|
13 | // and/or other materials provided with the distribution.
|
---|
14 |
|
---|
15 | // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
---|
16 | // ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
---|
17 | // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
---|
18 | // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
|
---|
19 | // ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
---|
20 | // (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
---|
21 | // LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
---|
22 | // ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
---|
23 | // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
---|
24 | // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
---|
25 |
|
---|
26 | // The views and conclusions contained in the software and documentation are those
|
---|
27 | // of the authors and should not be interpreted as representing official policies,
|
---|
28 | // either expressed or implied, of the FreeBSD Project.
|
---|
29 |
|
---|
30 | #ifndef XPLCOMMON_FAILABLE_H
|
---|
31 | #define XPLCOMMON_FAILABLE_H
|
---|
32 | //------------------------------------------------------------------------------
|
---|
33 |
|
---|
34 | #include "types.h"
|
---|
35 |
|
---|
36 | //------------------------------------------------------------------------------
|
---|
37 |
|
---|
38 | namespace xplcommon {
|
---|
39 |
|
---|
40 | //------------------------------------------------------------------------------
|
---|
41 |
|
---|
42 | /**
|
---|
43 | * An object whose instances can fail, and the reason of the failure
|
---|
44 | * is indicated by an integral error code.
|
---|
45 | */
|
---|
46 | class Failable
|
---|
47 | {
|
---|
48 | private:
|
---|
49 | /**
|
---|
50 | * The error code.
|
---|
51 | */
|
---|
52 | errorCode_t errorCode;
|
---|
53 |
|
---|
54 | public:
|
---|
55 | /**
|
---|
56 | * Construct the object and initialize the error code to indicate
|
---|
57 | * no error.
|
---|
58 | */
|
---|
59 | Failable();
|
---|
60 |
|
---|
61 | /**
|
---|
62 | * Indicate if the object has failed.
|
---|
63 | */
|
---|
64 | bool failed() const;
|
---|
65 |
|
---|
66 | /**
|
---|
67 | * Get the error code.
|
---|
68 | */
|
---|
69 | errorCode_t getErrorCode() const;
|
---|
70 |
|
---|
71 | /**
|
---|
72 | * Discard the error code.
|
---|
73 | */
|
---|
74 | void repair();
|
---|
75 |
|
---|
76 | protected:
|
---|
77 | /**
|
---|
78 | * Set the error code.
|
---|
79 | */
|
---|
80 | void setErrorCode(errorCode_t ec);
|
---|
81 | };
|
---|
82 |
|
---|
83 | //------------------------------------------------------------------------------
|
---|
84 |
|
---|
85 | /**
|
---|
86 | * An object that references another failable object and fails
|
---|
87 | * together with that object.
|
---|
88 | *
|
---|
89 | * The Child class should contain a function named getFailable()
|
---|
90 | * which returns the failable object.
|
---|
91 | */
|
---|
92 | template <class Child>
|
---|
93 | class FailableReference
|
---|
94 | {
|
---|
95 | public:
|
---|
96 | /**
|
---|
97 | * Indicate if the referenced object has failed.
|
---|
98 | */
|
---|
99 | bool failed() const;
|
---|
100 |
|
---|
101 | /**
|
---|
102 | * Get the error code from the referenced object.
|
---|
103 | */
|
---|
104 | errorCode_t getErrorCode() const;
|
---|
105 |
|
---|
106 | /**
|
---|
107 | * Discard the error code of the referenced object.
|
---|
108 | */
|
---|
109 | void repair();
|
---|
110 | };
|
---|
111 |
|
---|
112 | //------------------------------------------------------------------------------
|
---|
113 | // Inline definitions
|
---|
114 | //------------------------------------------------------------------------------
|
---|
115 |
|
---|
116 | inline Failable::Failable() :
|
---|
117 | errorCode(NO_ERROR)
|
---|
118 | {
|
---|
119 | }
|
---|
120 |
|
---|
121 | //------------------------------------------------------------------------------
|
---|
122 |
|
---|
123 | inline bool Failable::failed() const
|
---|
124 | {
|
---|
125 | return errorCode!=NO_ERROR;
|
---|
126 | }
|
---|
127 |
|
---|
128 | //------------------------------------------------------------------------------
|
---|
129 |
|
---|
130 | inline errorCode_t Failable::getErrorCode() const
|
---|
131 | {
|
---|
132 | return errorCode;
|
---|
133 | }
|
---|
134 |
|
---|
135 | //------------------------------------------------------------------------------
|
---|
136 |
|
---|
137 | inline void Failable::repair()
|
---|
138 | {
|
---|
139 | errorCode = NO_ERROR;
|
---|
140 | }
|
---|
141 |
|
---|
142 | //------------------------------------------------------------------------------
|
---|
143 |
|
---|
144 | inline void Failable::setErrorCode(errorCode_t ec)
|
---|
145 | {
|
---|
146 | errorCode = ec;
|
---|
147 | }
|
---|
148 |
|
---|
149 | //------------------------------------------------------------------------------
|
---|
150 | //------------------------------------------------------------------------------
|
---|
151 |
|
---|
152 | template <class Child>
|
---|
153 | inline bool FailableReference<Child>::failed() const
|
---|
154 | {
|
---|
155 | return static_cast<const Child*>(this)->getFailable().failed();
|
---|
156 | }
|
---|
157 |
|
---|
158 | //------------------------------------------------------------------------------
|
---|
159 |
|
---|
160 | template <class Child>
|
---|
161 | inline errorCode_t FailableReference<Child>::getErrorCode() const
|
---|
162 | {
|
---|
163 | return static_cast<const Child*>(this)->getFailable().getErrorCode();
|
---|
164 | }
|
---|
165 |
|
---|
166 | //------------------------------------------------------------------------------
|
---|
167 |
|
---|
168 | template <class Child>
|
---|
169 | inline void FailableReference<Child>::repair()
|
---|
170 | {
|
---|
171 | static_cast<Child*>(this)->getFailable().repair();
|
---|
172 | }
|
---|
173 |
|
---|
174 | //------------------------------------------------------------------------------
|
---|
175 |
|
---|
176 | } /* namespace xplcommon */
|
---|
177 |
|
---|
178 | //------------------------------------------------------------------------------
|
---|
179 | #endif // XPLCOMMON_FAILABLE_H
|
---|
180 |
|
---|
181 | // Local Variables:
|
---|
182 | // mode: C++
|
---|
183 | // c-basic-offset: 4
|
---|
184 | // indent-tabs-mode: nil
|
---|
185 | // End:
|
---|