MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
xpathparseresult.h
Go to the documentation of this file.
1 // © Copyright 2010 - 2014 BlackTopp Studios Inc.
2 /* This file is part of The Mezzanine Engine.
3 
4  The Mezzanine Engine is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  The Mezzanine Engine is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16 */
17 /* The original authors have included a copy of the license specified above in the
18  'Docs' folder. See 'gpl.txt'
19 */
20 /* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21  Build professional software and charge for their product.
22 
23  However there are some practical restrictions, so if your project involves
24  any of the following you should contact us and we will try to work something
25  out:
26  - DRM or Copy Protection of any kind(except Copyrights)
27  - Software Patents You Do Not Wish to Freely License
28  - Any Kind of Linking to Non-GPL licensed Works
29  - Are Currently In Violation of Another Copyright Holder's GPL License
30  - If You want to change our code and not add a few hundred MB of stuff to
31  your distribution
32 
33  These and other limitations could cause serious legal problems if you ignore
34  them, so it is best to simply contact us or the Free Software Foundation, if
35  you have any questions.
36 
37  Joseph Toppi - toppij@gmail.com
38  John Blackwood - makoenergy02@gmail.com
39 */
40 /*
41  *
42  * Software, Files, Libraries and all other items referenced in this clause refers only
43  * to the contents of this file and associated documentation.
44  *
45  * Pugixml parser - version 1.0
46  * --------------------------------------------------------
47  * Copyright © 2006-2012, by Arseny Kapoulkine (arseny.kapoulkine@gmail.com)
48  * Report bugs and download new versions at http://pugixml.org/
49  *
50  * This library is distributed under the MIT License. See notice at the end
51  * of this file.
52  *
53  * This work is based on the pugxml parser, which is:
54  * Copyright © 2003, by Kristen Wegner (kristen@tima.net)
55  */
56 #ifndef _xmlxpathparseresults_h
57 #define _xmlxpathparseresults_h
58 
59 /// @file
60 /// @brief Has all the classes for the XPath implementation.
61 
62 #include "datatypes.h"
63 
64 #include "XML/node.h"
65 
66 
67 
68 namespace Mezzanine
69 {
70  namespace XML
71  {
72  /// @brief XPath parsing result
74  {
75  #ifndef SWIG
76  /// @brief Error message (0 if no error)
77  /// @note For compatibility reasons this is not available in scripting languages (const string can lead to memory leak and undefiend behavior.)
78  const char* error;
79  #endif
80 
81  /// @brief Last parsed Offset (in Character units from string start)
82  ptrdiff_t Offset;
83 
84  /// @brief Default constructor, initializes object to failed state.
86 
87  #ifndef SWIG
88  /// @brief Cast to bool operator
89  /// @return This returns true if the ParseResult::Status member is set to ParseStatus::StatusOk, otherwise this returns false.
90  /// @note Not usable from scripting languages.
91  operator bool() const;
92  #endif
93 
94  /// @brief Error message (0 if no error).
95  const char* Description() const;
96  };
97 
98  }
99 } // /namespace Mezzanine
100 
101 
102 
103 #endif // Include guard
104 
105 
106 /*
107  *
108  * Software, Files, Libraries and all other items referenced in this clause refers only
109  * to the contents of this file and associated documentation.
110  *
111  * Copyright © 2006-2012 Arseny Kapoulkine
112  *
113  * Permission is hereby granted, free of charge, to any person
114  * obtaining a copy of this software and associated documentation
115  * files (the "Software"), to deal in the Software without
116  * restriction, including without limitation the rights to use,
117  * copy, modify, merge, publish, distribute, sublicense, and/or sell
118  * copies of the Software, and to permit persons to whom the
119  * Software is furnished to do so, subject to the following
120  * conditions:
121  *
122  * The above copyright notice and this permission notice shall be
123  * included in all copies or substantial portions of the Software.
124  *
125  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
126  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
127  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
128  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
129  * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
130  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
131  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
132  * OTHER DEALINGS IN THE SOFTWARE.
133  */