diff options
author | jacobkeeler <jacob.keeler@livioradio.com> | 2017-11-30 15:19:11 -0500 |
---|---|---|
committer | jacobkeeler <jacob.keeler@livioradio.com> | 2017-11-30 15:19:11 -0500 |
commit | 273e26304efb215af3416f86ab86c1c7fd39f974 (patch) | |
tree | 5b756554c190eec764565076c84c9a3fb5c3193a /src/components/include | |
parent | 3800d598555ea45f2b61741b53a959cdd678e705 (diff) | |
download | sdl_core-273e26304efb215af3416f86ab86c1c7fd39f974.tar.gz |
Use ValidationReport objects for reporting rather than strings
Diffstat (limited to 'src/components/include')
-rw-r--r-- | src/components/include/rpc_base/validation_report.h | 125 |
1 files changed, 125 insertions, 0 deletions
diff --git a/src/components/include/rpc_base/validation_report.h b/src/components/include/rpc_base/validation_report.h new file mode 100644 index 0000000000..82f265e594 --- /dev/null +++ b/src/components/include/rpc_base/validation_report.h @@ -0,0 +1,125 @@ +/* + * Copyright (c) 2014, Ford Motor Company + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * + * Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following + * disclaimer in the documentation and/or other materials provided with the + * distribution. + * + * Neither the name of the Ford Motor Company nor the names of its contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef SRC_COMPONENTS_RPC_BASE_INCLUDE_RPC_BASE_VALIDATION_REPORT_H_ +#define SRC_COMPONENTS_RPC_BASE_INCLUDE_RPC_BASE_VALIDATION_REPORT_H_ + +#include <string> +#include <list> + +namespace rpc { + +class ValidationReport; +typedef std::list<ValidationReport> ValidationReports; + +class ValidationReport { + public: + explicit ValidationReport(const std::string& object_name); + const std::string& object_name() const; + const std::string& validation_info() const; + void set_validation_info(const std::string& info); + const ValidationReports& subobject_reports() const; + ValidationReport& ReportSubobject(const std::string& object_name); + + private: + std::string object_name_; + std::string validation_info_; + ValidationReports subobject_reports_; +}; + +std::string PrettyFormat(const ValidationReport& report); + +// Implementation + +namespace impl { +inline void PrettyFormat(const ValidationReport& report, + const std::string& parent_path, + std::string* result) { + std::string object_path = parent_path; + if (!object_path.empty() && report.object_name()[0] != '[') { + object_path.append("."); + } + const ValidationReports& subreports = report.subobject_reports(); + object_path.append(report.object_name()); + if (!report.validation_info().empty()) { + // Insert newline between entries + if (!result->empty()) { + result->append("\n"); + } + result->append(object_path); + result->append(": "); + result->append(report.validation_info()); + } + for (ValidationReports::const_iterator i = subreports.begin(), + end = subreports.end(); + i != end; + ++i) { + PrettyFormat(*i, object_path, result); + } +} +} // namespace impl + +inline ValidationReport::ValidationReport(const std::string& object_name) + : object_name_(object_name) {} + +inline const std::string& ValidationReport::object_name() const { + return object_name_; +} + +inline const std::string& ValidationReport::validation_info() const { + return validation_info_; +} + +inline void ValidationReport::set_validation_info(const std::string& info) { + validation_info_ = info; +} + +inline const std::list<ValidationReport>& ValidationReport::subobject_reports() + const { + return subobject_reports_; +} + +inline ValidationReport& ValidationReport::ReportSubobject( + const std::string& object_name) { + subobject_reports_.push_back(ValidationReport(object_name)); + return subobject_reports_.back(); +} + +inline std::string PrettyFormat(const ValidationReport& report) { + std::string result; + impl::PrettyFormat(report, "", &result); + return result; +} + +} // namespace rpc + +#endif // SRC_COMPONENTS_RPC_BASE_INCLUDE_RPC_BASE_VALIDATION_REPORT_H_ |