• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2011-2015, Intel Corporation
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without modification,
6  * are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice, this
9  * list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation and/or
13  * other materials provided with the distribution.
14  *
15  * 3. Neither the name of the copyright holder nor the names of its contributors
16  * may be used to endorse or promote products derived from this software without
17  * specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
23  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
26  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 #pragma once
31 
32 #include "ErrorContext.hpp"
33 
34 #include <string>
35 
36 /** Forward declare libxml2 handler structure. */
37 struct _xmlError;
38 
39 /** Class that gather errors during serialization.
40  *
41  * Provided with an initial empty buffer (strError), an instance of this class
42  * can describe an error.
43  *
44  * This error will be accessible formated in the aforementioned buffer
45  * _after_ destruction.
46  * Ie. the provided buffer (strError) is in an undefined state between
47  * construction and destruction and should not be accessed in between.
48  */
49 class CXmlSerializingContext : public utility::ErrorContext
50 {
51 public:
52     CXmlSerializingContext(std::string &strError);
53     ~CXmlSerializingContext();
54 
55     // Error
56     void appendLineToError(const std::string &strAppend);
57 
58     /** XML error handler
59       *
60       * @param[in] userData pointer to the serializing context
61       * @param[in] error the xml error output format
62       *
63       */
64     static void structuredErrorHandler(void *userData, _xmlError *error);
65 
66 private:
67     std::string _strXmlError;
68 };
69