-/*\r
- * Copyright 2001-2006 Internet2\r
- * \r
- * Licensed under the Apache License, Version 2.0 (the "License");\r
- * you may not use this file except in compliance with the License.\r
- * You may obtain a copy of the License at\r
- *\r
- * http://www.apache.org/licenses/LICENSE-2.0\r
- *\r
- * Unless required by applicable law or agreed to in writing, software\r
- * distributed under the License is distributed on an "AS IS" BASIS,\r
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
- * See the License for the specific language governing permissions and\r
- * limitations under the License.\r
- */\r
-\r
-/**\r
- * @file Namespace.h\r
- * \r
- * Representing XML namespace attributes \r
- */\r
-\r
-#if !defined(__xmltooling_namespace_h__)\r
-#define __xmltooling_namespace_h__\r
-\r
-#include <xmltooling/unicode.h>\r
-\r
-namespace xmltooling {\r
- \r
- /**\r
- * A data structure for encapsulating XML Namespace attributes\r
- */\r
- class XMLTOOL_API Namespace\r
- {\r
- public:\r
- /**\r
- * Constructor\r
- * @param uri namespace URI\r
- * @param prefix namespace prefix (without the colon)\r
- * @param alwaysDeclare true iff the namespace should always be declared regardless of in-scope declarations\r
- */\r
- Namespace(const XMLCh* uri=NULL, const XMLCh* prefix=NULL, bool alwaysDeclare=false);\r
- \r
- ~Namespace();\r
-#ifndef HAVE_GOOD_STL\r
- /**\r
- * Deep copy constructor\r
- */\r
- Namespace(const Namespace& src);\r
-\r
- /**\r
- * Deep assignment operator\r
- */\r
- Namespace& operator=(const Namespace& src);\r
-#endif\r
- \r
-#ifdef HAVE_GOOD_STL\r
- /**\r
- * Returns the namespace prefix\r
- * @return Null-terminated Unicode string containing the prefix, without the colon\r
- */\r
- const XMLCh* getNamespacePrefix() const { return m_prefix.c_str(); }\r
-\r
- /**\r
- * Returns the namespace URI\r
- * @return Null-terminated Unicode string containing the URI\r
- */\r
- const XMLCh* getNamespaceURI() const { return m_uri.c_str(); }\r
-#else\r
- /**\r
- * Returns the namespace prefix\r
- * @return Null-terminated Unicode string containing the prefix, without the colon\r
- */\r
- const XMLCh* getNamespacePrefix() const { return m_prefix; }\r
-\r
- /**\r
- * Returns the namespace URI\r
- * @return Null-terminated Unicode string containing the URI\r
- */\r
- const XMLCh* getNamespaceURI() const { return m_uri; }\r
-#endif\r
-\r
- /**\r
- * Returns true iff the namespace should always be declared regardless of in-scope declarations\r
- * @return the alwaysDeclared setting\r
- */\r
- const bool alwaysDeclare() const { return m_pinned; } \r
-\r
- /**\r
- * Sets the namespace prefix\r
- * @param prefix Null-terminated Unicode string containing the prefix, without the colon\r
- */\r
- void setNamespacePrefix(const XMLCh* prefix);\r
-\r
- /**\r
- * Sets the namespace URI\r
- * @param uri Null-terminated Unicode string containing the URI\r
- */\r
- void setNamespaceURI(const XMLCh* uri);\r
-\r
- /**\r
- * Sets the alwaysDeclared property\r
- * @param alwaysDeclare true iff the namespace should always be declared regardless of in-scope declarations\r
- */\r
- void setAlwaysDeclare(bool alwaysDeclare) { m_pinned = alwaysDeclare; } \r
- \r
- private:\r
- bool m_pinned;\r
-#ifdef HAVE_GOOD_STL\r
- xstring m_uri;\r
- xstring m_prefix;\r
-#else\r
- XMLCh* m_uri;\r
- XMLCh* m_prefix;\r
-#endif\r
- };\r
-\r
- /**\r
- * Returns true iff op1's namespace lexically compares less than op2's namespace,\r
- * or if equal, iff op1's prefix lexically compares less than op2's prefix.\r
- * \r
- * Needed for use with sorted STL containers.\r
- * \r
- * @param op1 First namspace to compare\r
- * @param op2 Second namespace to compare\r
- */\r
- extern XMLTOOL_API bool operator<(const Namespace& op1, const Namespace& op2);\r
-\r
-#ifndef HAVE_GOOD_STL\r
- /**\r
- * Returns true iff op1's namespace and prefix are equal to op2's namespace and prefix.\r
- * @param op1 First namspace to compare\r
- * @param op2 Second namespace to compare\r
- */\r
- extern XMLTOOL_API bool operator==(const Namespace& op1, const Namespace& op2);\r
-#endif\r
-\r
-};\r
-\r
-#endif /* __xmltooling_namespace_h__ */\r
+/**
+ * Licensed to the University Corporation for Advanced Internet
+ * Development, Inc. (UCAID) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
+ *
+ * UCAID licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the
+ * License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
+ */
+
+/**
+ * @file xmltooling/Namespace.h
+ *
+ * Representing XML namespace attributes.
+ */
+
+#if !defined(__xmltooling_namespace_h__)
+#define __xmltooling_namespace_h__
+
+#include <xmltooling/unicode.h>
+
+namespace xmltooling {
+
+#if defined (_MSC_VER)
+ #pragma warning( push )
+ #pragma warning( disable : 4251 )
+#endif
+
+ /**
+ * A data structure for encapsulating XML Namespace attributes.
+ */
+ class XMLTOOL_API Namespace
+ {
+ public:
+ /**
+ * Tri-state indicator of namespace usage.
+ */
+ enum namespace_usage_t {
+ Indeterminate,
+ NonVisiblyUsed,
+ VisiblyUsed
+ };
+
+ /**
+ * Constructor
+ * @param uri namespace URI
+ * @param prefix namespace prefix (without the colon)
+ * @param alwaysDeclare true iff the namespace should always be declared regardless of in-scope declarations
+ * @param usage indicates usage of namespace in the context of an XMLObject
+ */
+ Namespace(const XMLCh* uri=nullptr, const XMLCh* prefix=nullptr, bool alwaysDeclare=false, namespace_usage_t usage=Indeterminate);
+
+ ~Namespace();
+
+ /**
+ * Returns the namespace prefix
+ * @return Null-terminated Unicode string containing the prefix, without the colon
+ */
+ const XMLCh* getNamespacePrefix() const { return m_prefix.c_str(); }
+
+ /**
+ * Returns the namespace URI
+ * @return Null-terminated Unicode string containing the URI
+ */
+ const XMLCh* getNamespaceURI() const { return m_uri.c_str(); }
+
+ /**
+ * Returns true iff the namespace should always be declared regardless of in-scope declarations
+ * @return the alwaysDeclared setting
+ */
+ const bool alwaysDeclare() const { return m_pinned; }
+
+ /**
+ * Returns the usage of the namespace by an XMLObject
+ * @return the usage setting
+ */
+ const namespace_usage_t usage() const { return m_usage; }
+
+ /**
+ * Sets the namespace prefix
+ * @param prefix Null-terminated Unicode string containing the prefix, without the colon
+ */
+ void setNamespacePrefix(const XMLCh* prefix);
+
+ /**
+ * Sets the namespace URI
+ * @param uri Null-terminated Unicode string containing the URI
+ */
+ void setNamespaceURI(const XMLCh* uri);
+
+ /**
+ * Sets the alwaysDeclared property
+ * @param alwaysDeclare true iff the namespace should always be declared regardless of in-scope declarations
+ */
+ void setAlwaysDeclare(bool alwaysDeclare) { m_pinned = alwaysDeclare; }
+
+ /**
+ * Sets the usage property
+ * @param usage usage of the namespace by an XMLObject
+ */
+ void setUsage(namespace_usage_t usage) { m_usage = usage; }
+
+ private:
+ bool m_pinned;
+ namespace_usage_t m_usage;
+ xstring m_uri;
+ xstring m_prefix;
+ };
+
+#if defined (_MSC_VER)
+ #pragma warning( pop )
+#endif
+
+ /**
+ * Returns true iff op1's namespace lexically compares less than op2's namespace,
+ * or if equal, iff op1's prefix lexically compares less than op2's prefix.
+ *
+ * Needed for use with sorted STL containers.
+ *
+ * @param op1 First namspace to compare
+ * @param op2 Second namespace to compare
+ */
+ extern XMLTOOL_API bool operator<(const Namespace& op1, const Namespace& op2);
+
+ /**
+ * Returns true iff op1's namespace and prefix are equal to op2's namespace and prefix.
+ * @param op1 First namspace to compare
+ * @param op2 Second namespace to compare
+ */
+ extern XMLTOOL_API bool operator==(const Namespace& op1, const Namespace& op2);
+
+};
+
+#endif /* __xmltooling_namespace_h__ */
projects / shibboleth / cpp-xmltooling.git / blobdiff