MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
xpathvariableset.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 _xpathvariableset_h
57 #define _xpathvariableset_h
58 
59 /// @file
60 /// @brief The definition of the @ref Mezzanine::XML::XPathVariableSet
61 
62 #include "datatypes.h"
63 
64 #include "XML/xmlenumerations.h"
65 
66 
67 
68 namespace Mezzanine
69 {
70  namespace XML
71  {
72  class XPathNodeSet;
73  class XPathVariable;
74 
75  /// @brief A set of XPath variables.
77  {
78  private:
79 
80  /// @internal
81  /// @todo Look into this more carefully.
82  XPathVariable* _data[64];
83 
84  /// @brief Private copy constructor forces non-copyable semantics
86 
87  /// @brief Private copy assignment operator forces non-copyable semantics
88  XPathVariableSet& operator=(const XPathVariableSet&);
89 
90  /// @internal
91  /// @brief Find a variable of a given Name
92  /// @param Name The name of the Node
93  /// @details Performs a linear search.
94  XPathVariable* Find(const Char8* Name) const;
95 
96  public:
97  /// @brief Default Constructor, Blanks any XPathVariable it contains.
99 
100  /// @brief Default Deconstructor, Deletes any XPathVariable it contains.
101  ~XPathVariableSet();
102 
103  /// @brief Add a new variable or get the existing one, if the Types match
104  /// @return A pointer to the XPathVariable you referenced or just created.
105  /// @param Name The name of variable to add.
106  /// @param Type The Type of the new value to add as an XPathValueType.
107  XPathVariable* Add(const Char8* Name, XPathValueType Type);
108 
109  /// @brief Set contained variable Value; no Type conversion is performed.
110  /// @param Name The name of variable to change.
111  /// @param Value The value to attempt to put into the named variable.
112  /// @return True is return, false is returned if there is no such variable or on Type mismatch error.
113  bool Set(const Char8* Name, bool Value);
114 
115  /// @brief Set contained variable Value; no Type conversion is performed.
116  /// @param Name The name of variable to change.
117  /// @param Value The value to attempt to put into the named variable.
118  /// @return True is return, false is returned if there is no such variable or on Type mismatch error.
119  bool Set(const Char8* Name, double Value);
120 
121  /// @brief Set contained variable Value; no Type conversion is performed.
122  /// @param Name The name of variable to change.
123  /// @param Value The value to attempt to put into the named variable.
124  /// @return True is return, false is returned if there is no such variable or on Type mismatch error.
125  bool Set(const Char8* Name, const Char8* Value);
126 
127  /// @brief Set contained variable Value; no Type conversion is performed.
128  /// @param Name The name of variable to change.
129  /// @param Value The value to attempt to put into the named variable.
130  /// @return True is return, false is returned if there is no such variable or on Type mismatch error.
131  bool Set(const Char8* Name, const XPathNodeSet& Value);
132 
133  /// @brief Get the named XPathVariable.
134  /// @return A pointer to the specified XPathVariable.
135  /// @param Name The name of the XPathVariable you want.
136  XPathVariable* Get(const Char8* Name);
137 
138 #if !(defined(SWIG) && defined(MEZZLUA51)) // Stop Swig from making lua bindings but allow other languages
139  /// @brief Get the named XPathVariable.
140  /// @param Name The name of the XPathVariable you want.
141  /// @return A pointer to the specified XPathVariable.
142  /// @note The non-const version is available to scripting languages.
143  const XPathVariable* Get(const Char8* Name) const;
144 #endif
145  };
146  }
147 } // /namespace Mezzanine
148 
149 
150 
151 #endif // Include guard
152 
153 
154 /*
155  *
156  * Software, Files, Libraries and all other items referenced in this clause refers only
157  * to the contents of this file and associated documentation.
158  *
159  * Copyright © 2006-2012 Arseny Kapoulkine
160  *
161  * Permission is hereby granted, free of charge, to any person
162  * obtaining a copy of this software and associated documentation
163  * files (the "Software"), to deal in the Software without
164  * restriction, including without limitation the rights to use,
165  * copy, modify, merge, publish, distribute, sublicense, and/or sell
166  * copies of the Software, and to permit persons to whom the
167  * Software is furnished to do so, subject to the following
168  * conditions:
169  *
170  * The above copyright notice and this permission notice shall be
171  * included in all copies or substantial portions of the Software.
172  *
173  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
174  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
175  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
176  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
177  * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
178  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
179  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
180  * OTHER DEALINGS IN THE SOFTWARE.
181  */