1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
// Copyright 2014 The Chromium OS Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef LIBBRILLO_BRILLO_ERRORS_ERROR_H_
#define LIBBRILLO_BRILLO_ERRORS_ERROR_H_
#include <memory>
#include <string>
#include <base/macros.h>
#include <base/tracked_objects.h>
#include <brillo/brillo_export.h>
namespace brillo {
class Error; // Forward declaration.
using ErrorPtr = std::unique_ptr<Error>;
class BRILLO_EXPORT Error {
public:
virtual ~Error() = default;
// Creates an instance of Error class.
static ErrorPtr Create(const tracked_objects::Location& location,
const std::string& domain,
const std::string& code,
const std::string& message);
static ErrorPtr Create(const tracked_objects::Location& location,
const std::string& domain,
const std::string& code,
const std::string& message,
ErrorPtr inner_error);
// If |error| is not nullptr, creates another instance of Error class,
// initializes it with specified arguments and adds it to the head of
// the error chain pointed to by |error|.
static void AddTo(ErrorPtr* error,
const tracked_objects::Location& location,
const std::string& domain,
const std::string& code,
const std::string& message);
// Same as the Error::AddTo above, but allows to pass in a printf-like
// format string and optional parameters to format the error message.
static void AddToPrintf(ErrorPtr* error,
const tracked_objects::Location& location,
const std::string& domain,
const std::string& code,
const char* format,
...) PRINTF_FORMAT(5, 6);
// Clones error with all inner errors.
ErrorPtr Clone() const;
// Returns the error domain, code and message
const std::string& GetDomain() const { return domain_; }
const std::string& GetCode() const { return code_; }
const std::string& GetMessage() const { return message_; }
// Returns the location of the error in the source code.
const tracked_objects::LocationSnapshot& GetLocation() const {
return location_;
}
// Checks if this or any of the inner errors in the chain has the specified
// error domain.
bool HasDomain(const std::string& domain) const;
// Checks if this or any of the inner errors in the chain matches the
// specified error domain and code.
bool HasError(const std::string& domain, const std::string& code) const;
// Gets a pointer to the inner error, if present. Returns nullptr otherwise.
const Error* GetInnerError() const { return inner_error_.get(); }
// Gets a pointer to the first error occurred.
// Returns itself if no inner error are available.
const Error* GetFirstError() const;
// Finds an error object of particular domain in the error chain stating at
// |error_chain_start|. Returns the a pointer to the first matching error
// object found.
// Returns nullptr if no match is found.
// This method is safe to call on a nullptr |error_chain_start| in which case
// the result will also be nullptr.
static const Error* FindErrorOfDomain(const Error* error_chain_start,
const std::string& domain);
// Finds an error of particular domain with the given code in the error chain
// stating at |error_chain_start|. Returns the pointer to the first matching
// error object.
// Returns nullptr if no match is found or if |error_chain_start| is nullptr.
static const Error* FindError(const Error* error_chain_start,
const std::string& domain,
const std::string& code);
protected:
// Constructor is protected since this object is supposed to be
// created via the Create factory methods.
Error(const tracked_objects::Location& location,
const std::string& domain,
const std::string& code,
const std::string& message,
ErrorPtr inner_error);
Error(const tracked_objects::LocationSnapshot& location,
const std::string& domain,
const std::string& code,
const std::string& message,
ErrorPtr inner_error);
// Error domain. The domain defines the scopes for error codes.
// Two errors with the same code but different domains are different errors.
std::string domain_;
// Error code. A unique error code identifier within the given domain.
std::string code_;
// Human-readable error message.
std::string message_;
// Error origin in the source code.
tracked_objects::LocationSnapshot location_;
// Pointer to inner error, if any. This forms a chain of errors.
ErrorPtr inner_error_;
private:
DISALLOW_COPY_AND_ASSIGN(Error);
};
} // namespace brillo
#endif // LIBBRILLO_BRILLO_ERRORS_ERROR_H_
|
