Lunchbox  1.10.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
result.h
1 
2 /* Copyright (c) 2013, Stefan.Eilemann@epfl.ch
3  *
4  * This library is free software; you can redistribute it and/or modify it under
5  * the terms of the GNU Lesser General Public License version 2.1 as published
6  * by the Free Software Foundation.
7  *
8  * This library is distributed in the hope that it will be useful, but WITHOUT
9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
10  * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
11  * details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this library; if not, write to the Free Software Foundation, Inc.,
15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
16  */
17 
18 #ifndef LUNCHBOX_RESULT_H
19 #define LUNCHBOX_RESULT_H
20 
21 #include <lunchbox/api.h>
22 #include <lunchbox/log.h>
23 #include <lunchbox/types.h>
24 
25 #include <iostream>
26 
27 namespace lunchbox
28 {
29 
31 class Result
32 {
33  typedef void (Result::*bool_t)() const;
34  void bool_true() const {}
35 
36 public:
37  static const int32_t SUCCESS = 0;
38 
40  explicit Result( const int32_t code ) : code_( code ){}
41 
43  virtual ~Result(){}
44 
46  operator bool_t() const { return code_ == SUCCESS ? &Result::bool_true : 0;}
47 
49  bool operator !() const { return code_ != SUCCESS; }
50 
52  bool operator == ( const int32_t code ) const { return code_ == code; }
53 
55  bool operator != ( const int32_t code ) const { return code != code_; }
56 
58  int32_t getCode() const { return code_; }
59 
61  virtual std::string getString() const
62  { return code_ == SUCCESS ? "success" : "result"; }
63 
64 protected:
65  int32_t code_;
66 };
67 
68 inline std::ostream& operator << ( std::ostream& os, const Result& result )
69 {
70  return os << result.getString() << " (" << result.getCode() << ")";
71 }
72 
73 }
74 #endif //LUNCHBOX_RESULT_H
Defines export visibility macros for Lunchbox.
Basic type definitions not provided by the operating system.
virtual std::string getString() const
Definition: result.h:61
bool operator==(const int32_t code) const
Definition: result.h:52
A result returns an error code and behaves like a boolean.
Definition: result.h:31
Result(const int32_t code)
Construct a new result.
Definition: result.h:40
std::ostream & operator<<(std::ostream &os, const Array< T > &array)
Pretty-print all members of the array.
Definition: array.h:47
virtual ~Result()
Destruct the result.
Definition: result.h:43
bool operator!=(const int32_t code) const
Definition: result.h:55
int32_t getCode() const
Definition: result.h:58
This file contains logging classes.
bool operator!() const
Definition: result.h:49