consoleXMLExport.h

Engine/source/console/consoleXMLExport.h

More...

Classes:

Namespaces:

Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _CONSOLEXMLEXPORT_H_
25#define _CONSOLEXMLEXPORT_H_
26
27#ifndef _TORQUE_STRING_H_
28#include "core/util/str.h"
29#endif
30
31class SimXMLDocument;
32
33/// @defgroup console_reflection Reflection
34/// @ingroup console_system Console System
35///
36/// Exports console information to XML representation
37/// @{
38
39namespace Con {
40
41   class XMLExport
42   {
43
44   public:
45
46      XMLExport();
47      ~XMLExport();
48
49      // writes console information in XML format to  the file specified
50      void exportXML(String& str);
51
52   private:
53
54      void exportBaseTypes();
55      void exportEntryTypes();
56      void exportNamespaces();
57
58      SimXMLDocument *mXML;
59
60   };
61
62};
63
64/// @}
65
66#endif //_CONSOLEXMLEXPORT_H_
67