src/XPath/XObject.hpp - xalan-c - Git at Google

 /*
  * The Apache Software License, Version 1.1
  *
  *
  * Copyright (c) 1999-2002 The Apache Software Foundation.  All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  *
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in
  *    the documentation and/or other materials provided with the
  *    distribution.
  *
  * 3. The end-user documentation included with the redistribution,
  *    if any, must include the following acknowledgment:
  *       "This product includes software developed by the
  *        Apache Software Foundation (http://www.apache.org/)."
  *    Alternately, this acknowledgment may appear in the software itself,
  *    if and wherever such third-party acknowledgments normally appear.
  *
  * 4. The names "Xalan" and "Apache Software Foundation" must
  *    not be used to endorse or promote products derived from this
  *    software without prior written permission. For written
  *    permission, please contact apache@apache.org.
  *
  * 5. Products derived from this software may not be called "Apache",
  *    nor may "Apache" appear in their name, without prior written
  *    permission of the Apache Software Foundation.
  *
  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
  * ====================================================================
  *
  * This software consists of voluntary contributions made by many
  * individuals on behalf of the Apache Software Foundation and was
  * originally based on software copyright (c) 1999, International
  * Business Machines, Inc., http://www.ibm.com.  For more
  * information on the Apache Software Foundation, please see
  * <http://www.apache.org/>.
  */
 #if !defined(XOBJECT_HEADER_GUARD_1357924680)
 #define XOBJECT_HEADER_GUARD_1357924680


 // Base include file.  Must be first.
 #include <XPath/XPathDefinitions.hpp>


 #include <XalanDOM/XalanDOMString.hpp>


 #include <PlatformSupport/FormatterListener.hpp>
 #include <PlatformSupport/XalanReferenceCountedObject.hpp>


 #include <XPath/XalanXPathException.hpp>


 class MutableNodeRefList;
 class NodeRefListBase;
 class ResultTreeFragBase;
 class XObjectFactory;
 class XObjectTypeCallback;
 class XPathExecutionContext;


 /**
  * Class to hold XPath return types.
  */
 class XALAN_XPATH_EXPORT XObject : protected XalanReferenceCountedObject
 {
 public:

 	friend class XObjectPtr;

 	/**
 	 * Enumeration of possible object types
 	 */
 	enum	eObjectType { eTypeNull = 0,
 						  eTypeUnknown = 1,
 						  eTypeBoolean = 2,
 						  eTypeNumber = 3,
 						  eTypeString = 4,
 						  eTypeNodeSet = 5,
 						  eTypeResultTreeFrag = 6,
 						  eTypeUserDefined = 7,
 						  // These next types are implementation-specific, and
 						  // are never returned by getType().
 						  eTypeStringReference = 8,
 						  eTypeStringAdapter = 9,
 						  eTypeStringCached = 10,
 						  eTypeXTokenNumberAdapter = 11,
 						  eTypeXTokenStringAdapter = 12,
 						  eUnknown
 						};

 	/**
 	 * Create an XObject.
 	 *
 	 * @param theObjectType The enum for the type of the object.
 	 */
 	XObject(eObjectType		theObjectType);

 	XObject(const XObject&	source);

 	/**
 	 * Clone the instance
 	 *
 	 * @param If theAddress is not null, the XObject will clone itself into that address.
 	 * @return a clone of the instance.
 	 */
 	virtual XObject*
 	clone(void*		theAddress = 0) const = 0;

 	/**
 	 * Given a request type, return the equivalent string.
 	 * For diagnostic purposes.
 	 *
 	 * @return string for type
 	 */
 	virtual XalanDOMString
 	getTypeString() const = 0;

 	/**
 	 * Cast result object to a number.
 	 *
 	 * @return numeric value
 	 */
 	virtual double
 	num() const;

 	/**
 	 * Cast result object to a boolean.
 	 *
 	 * @return boolean value
 	 */
 	virtual bool
 	boolean() const;

 	/**
 	 * Cast result object to a string.
 	 *
 	 * @return string value
 	 */
 	virtual const XalanDOMString&
 	str() const;

 	typedef void (FormatterListener::*MemberFunctionPtr)(const XMLCh* const, const unsigned int);

 	/**
 	 * Send the string value to a FormatterListener instance.
 	 *
 	 * @param formatterListener The FormatterListener instance
 	 * @param function A pointer to the member function of FormatterListener to call
 	 *
 	 */
 	virtual void
 	str(
 			FormatterListener&	formatterListener,
 			MemberFunctionPtr	function) const = 0;

 	/**
 	 * Append the string value directly a string
 	 *
 	 * @param theBuffer The buffer for the data
 	 */
 	virtual void
 	str(XalanDOMString&	theBuffer) const;

 	/**
 	 * Cast result object to a result tree fragment.
 	 *
 	 * @return result tree fragment
 	 */
 	virtual const ResultTreeFragBase&
 	rtree() const;

 	/**
 	 * Cast result object to a nodelist.
 	 *
 	 * @return node list
 	 */
 	virtual const NodeRefListBase&
 	nodeset() const;

 	/**
 	 * Process a callback request for preferred type information.
 	 *
 	 * @param theCallbackObject object to call back
 	 */
 	virtual void
 	ProcessXObjectTypeCallback(XObjectTypeCallback&		theCallbackObject) = 0;

 	/**
 	 * Process a callback request for preferred type information.
 	 *
 	 * @param theCallbackObject object to call back
 	 */
 	virtual void
 	ProcessXObjectTypeCallback(XObjectTypeCallback&		theCallbackObject) const = 0;

 	/**
 	 * Tell if two objects are functionally equal.
 	 *
 	 * @param theRHS object to compare
 	 * @param executionContext the current execution context
 	 * @return true if they are equal
 	 */
 	bool
 	equals(
 			const XObject&			theRHS,
 			XPathExecutionContext&	executionContext) const;

 	/**
 	 * Tell if two objects are functionally not equal.
 	 *
 	 * @param theRHS object to compare
 	 * @param executionContext the current execution context
 	 * @return true if they are equal
 	 */
 	bool
 	notEquals(
 			const XObject&			theRHS,
 			XPathExecutionContext&	executionContext) const;

 	/**
 	 * Tell if one object is less than the other.
 	 *
 	 * @param theRHS object to compare
 	 * @return true if they are equal
 	 */
 	bool
 	lessThan(
 			const XObject&			theRHS,
 			XPathExecutionContext&	executionContext) const;

 	/**
 	 * Tell if one object is less than or equal
 	 * the other.
 	 *
 	 * @param theRHS object to compare
 	 * @return true if they are equal
 	 */
 	bool
 	lessThanOrEquals(
 			const XObject&			theRHS,
 			XPathExecutionContext&	executionContext) const;

 	/**
 	 * Tell if one object is greater than the other.
 	 *
 	 * @param theRHS object to compare
 	 * @return true if they are equal
 	 */
 	bool
 	greaterThan(
 			const XObject&			theRHS,
 			XPathExecutionContext&	executionContext) const;

 	/**
 	 * Tell if one object is greater than or equal
 	 * the other.
 	 *
 	 * @param theRHS object to compare
 	 * @return true if they are equal
 	 */
 	bool
 	greaterThanOrEquals(
 			const XObject&			theRHS,
 			XPathExecutionContext&	executionContext) const;

 	/**
 	 * Tell what kind of class this is.
 	 *
 	 * @return numeric type value
 	 */
 	eObjectType
 	getType() const
 	{
 		return m_objectType;
 	}

 	// All XObject instances are controlled by an instance of an XObjectFactory.
 	friend class XObjectFactory;

 	void
 	setFactory(XObjectFactory*	theFactory)
 	{
 		m_factory = theFactory;
 	}

 	// Base class for all XObject exceptions...
 	class XObjectException : public XalanXPathException
 	{
 	public:

 		explicit
 		XObjectException(
 				const XalanDOMString&	message = XalanDOMString(),
 				const XalanNode*		styleNode = 0,
 				const XalanDOMString&	theType = XalanDOMString(XALAN_STATIC_UCODE_STRING("XObjectException")));

 		virtual
 		~XObjectException();
 	};

 	class XObjectInvalidConversionException : public XObjectException
 	{
 	public:

 		XObjectInvalidConversionException(
 				const XalanDOMString&	fromType,
 				const XalanDOMString&	toType);

 		virtual
 		~XObjectInvalidConversionException();

 		const XalanDOMString&
 		getFromType() const
 		{
 			return m_fromType;
 		}

 		const XalanDOMString&
 		getToType() const
 		{
 			return m_toType;
 		}

 	private:

 		static const XalanDOMString
 		formatErrorString(
 				const XalanDOMString&	fromType,
 				const XalanDOMString&	toType);

 		const XalanDOMString	m_fromType;

 		const XalanDOMString	m_toType;
 	};

 protected:

 	/**
 	 * Tell what kind of class this is.
 	 *
 	 * @return numeric type value
 	 */
 	virtual eObjectType
 	getRealType() const;

 	virtual void
 	referenced();

 	virtual void
 	dereferenced();

 	virtual
 	~XObject();

 	static const XalanDOMString		s_nullString;

 private:

 	// Not implemented...
 	XObject&
 	operator=(const XObject&);

 	const eObjectType	m_objectType;

 	XObjectFactory*		m_factory;
 };


 /**
  * Class to hold XObjectPtr return types.
  */
 class XALAN_XPATH_EXPORT XObjectPtr
 {
 public:

 	friend bool operator==(const XObjectPtr&, const XObjectPtr&);
 	friend bool operator<(const XObjectPtr&, const XObjectPtr&);

 	/**
 	 * Create an XObjectPtr.
 	 */
 	explicit
 	XObjectPtr(XObject*		theXObject = 0) :
 		m_xobjectPtr(theXObject)
 	{
 		XalanReferenceCountedObject::addReference(theXObject);
 	}

 	XObjectPtr(const XObjectPtr&	theSource) :
 		m_xobjectPtr(theSource.m_xobjectPtr)
 	{
 		XalanReferenceCountedObject::addReference(m_xobjectPtr);
 	};

 	XObjectPtr&
 	operator=(const XObjectPtr&		theRHS)
 	{
 		if (m_xobjectPtr != theRHS.m_xobjectPtr)
 		{
 			XalanReferenceCountedObject::removeReference(m_xobjectPtr);

 			m_xobjectPtr = theRHS.m_xobjectPtr;

 			XalanReferenceCountedObject::addReference(m_xobjectPtr);
 		}

 		return *this;
 	}

 	~XObjectPtr()
 	{
 		XalanReferenceCountedObject::removeReference(m_xobjectPtr);
 	};

 	bool
 	null() const
 	{
 		return m_xobjectPtr == 0 ? true : false;
 	}

 	const XObject&
 	operator*() const
 	{
 		return *m_xobjectPtr;
 	};

 	XObject&
 	operator*()
 	{
 		return *m_xobjectPtr;
 	};

 	const XObject*
 	operator->() const
 	{
 		return m_xobjectPtr;
 	};

 	XObject*
 	operator->()
 	{
 		return m_xobjectPtr;
 	};

 	const XObject*
 	get() const
 	{
 		return m_xobjectPtr;
 	};

 	XObject*
 	get()
 	{
 		return m_xobjectPtr;
 	};

 private:

 	XObject*	m_xobjectPtr;
 };


 inline bool
 operator==(
 			const XObjectPtr&	theLHS,
 			const XObjectPtr&	theRHS)
 {
 	return theLHS.m_xobjectPtr == theRHS.m_xobjectPtr;
 }


 inline bool
 operator!=(
 			const XObjectPtr&	theLHS,
 			const XObjectPtr&	theRHS)
 {
 	return !(theLHS == theRHS);
 }


 inline bool
 operator<(
 			const XObjectPtr&	theLHS,
 			const XObjectPtr&	theRHS)
 {
 	return theLHS.m_xobjectPtr < theRHS.m_xobjectPtr;
 }


 #endif	// XOBJECT_HEADER_GUARD_1357924680
	/*
	* The Apache Software License, Version 1.1
	*
	*
	* Copyright (c) 1999-2002 The Apache Software Foundation. All rights
	* reserved.
	*
	* Redistribution and use in source and binary forms, with or without
	* modification, are permitted provided that the following conditions
	* are met:
	*
	* 1. Redistributions of source code must retain the above copyright
	* notice, this list of conditions and the following disclaimer.
	*
	* 2. Redistributions in binary form must reproduce the above copyright
	* notice, this list of conditions and the following disclaimer in
	* the documentation and/or other materials provided with the
	* distribution.
	*
	* 3. The end-user documentation included with the redistribution,
	* if any, must include the following acknowledgment:
	* "This product includes software developed by the
	* Apache Software Foundation (http://www.apache.org/)."
	* Alternately, this acknowledgment may appear in the software itself,
	* if and wherever such third-party acknowledgments normally appear.
	*
	* 4. The names "Xalan" and "Apache Software Foundation" must
	* not be used to endorse or promote products derived from this
	* software without prior written permission. For written
	* permission, please contact apache@apache.org.
	*
	* 5. Products derived from this software may not be called "Apache",
	* nor may "Apache" appear in their name, without prior written
	* permission of the Apache Software Foundation.
	*
	* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
	* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
	* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
	* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
	* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
	* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
	* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
	* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	* SUCH DAMAGE.
	* ====================================================================
	*
	* This software consists of voluntary contributions made by many
	* individuals on behalf of the Apache Software Foundation and was
	* originally based on software copyright (c) 1999, International
	* Business Machines, Inc., http://www.ibm.com. For more
	* information on the Apache Software Foundation, please see
	* <http://www.apache.org/>.
	*/
	#if !defined(XOBJECT_HEADER_GUARD_1357924680)
	#define XOBJECT_HEADER_GUARD_1357924680



	// Base include file. Must be first.
	#include <XPath/XPathDefinitions.hpp>



	#include <XalanDOM/XalanDOMString.hpp>



	#include <PlatformSupport/FormatterListener.hpp>
	#include <PlatformSupport/XalanReferenceCountedObject.hpp>



	#include <XPath/XalanXPathException.hpp>



	class MutableNodeRefList;
	class NodeRefListBase;
	class ResultTreeFragBase;
	class XObjectFactory;
	class XObjectTypeCallback;
	class XPathExecutionContext;



	/**
	* Class to hold XPath return types.
	*/
	class XALAN_XPATH_EXPORT XObject : protected XalanReferenceCountedObject
	{
	public:

	friend class XObjectPtr;

	/**
	* Enumeration of possible object types
	*/
	enum eObjectType { eTypeNull = 0,
	eTypeUnknown = 1,
	eTypeBoolean = 2,
	eTypeNumber = 3,
	eTypeString = 4,
	eTypeNodeSet = 5,
	eTypeResultTreeFrag = 6,
	eTypeUserDefined = 7,
	// These next types are implementation-specific, and
	// are never returned by getType().
	eTypeStringReference = 8,
	eTypeStringAdapter = 9,
	eTypeStringCached = 10,
	eTypeXTokenNumberAdapter = 11,
	eTypeXTokenStringAdapter = 12,
	eUnknown
	};

	/**
	* Create an XObject.
	*
	* @param theObjectType The enum for the type of the object.
	*/
	XObject(eObjectType theObjectType);

	XObject(const XObject& source);

	/**
	* Clone the instance
	*
	* @param If theAddress is not null, the XObject will clone itself into that address.
	* @return a clone of the instance.
	*/
	virtual XObject*
	clone(void* theAddress = 0) const = 0;

	/**
	* Given a request type, return the equivalent string.
	* For diagnostic purposes.
	*
	* @return string for type
	*/
	virtual XalanDOMString
	getTypeString() const = 0;

	/**
	* Cast result object to a number.
	*
	* @return numeric value
	*/
	virtual double
	num() const;

	/**
	* Cast result object to a boolean.
	*
	* @return boolean value
	*/
	virtual bool
	boolean() const;

	/**
	* Cast result object to a string.
	*
	* @return string value
	*/
	virtual const XalanDOMString&
	str() const;

	typedef void (FormatterListener::MemberFunctionPtr)(const XMLCh const, const unsigned int);

	/**
	* Send the string value to a FormatterListener instance.
	*
	* @param formatterListener The FormatterListener instance
	* @param function A pointer to the member function of FormatterListener to call
	*
	*/
	virtual void
	str(
	FormatterListener& formatterListener,
	MemberFunctionPtr function) const = 0;

	/**
	* Append the string value directly a string
	*
	* @param theBuffer The buffer for the data
	*/
	virtual void
	str(XalanDOMString& theBuffer) const;

	/**
	* Cast result object to a result tree fragment.
	*
	* @return result tree fragment
	*/
	virtual const ResultTreeFragBase&
	rtree() const;

	/**
	* Cast result object to a nodelist.
	*
	* @return node list
	*/
	virtual const NodeRefListBase&
	nodeset() const;

	/**
	* Process a callback request for preferred type information.
	*
	* @param theCallbackObject object to call back
	*/
	virtual void
	ProcessXObjectTypeCallback(XObjectTypeCallback& theCallbackObject) = 0;

	/**
	* Process a callback request for preferred type information.
	*
	* @param theCallbackObject object to call back
	*/
	virtual void
	ProcessXObjectTypeCallback(XObjectTypeCallback& theCallbackObject) const = 0;

	/**
	* Tell if two objects are functionally equal.
	*
	* @param theRHS object to compare
	* @param executionContext the current execution context
	* @return true if they are equal
	*/
	bool
	equals(
	const XObject& theRHS,
	XPathExecutionContext& executionContext) const;

	/**
	* Tell if two objects are functionally not equal.
	*
	* @param theRHS object to compare
	* @param executionContext the current execution context
	* @return true if they are equal
	*/
	bool
	notEquals(
	const XObject& theRHS,
	XPathExecutionContext& executionContext) const;

	/**
	* Tell if one object is less than the other.
	*
	* @param theRHS object to compare
	* @return true if they are equal
	*/
	bool
	lessThan(
	const XObject& theRHS,
	XPathExecutionContext& executionContext) const;

	/**
	* Tell if one object is less than or equal
	* the other.
	*
	* @param theRHS object to compare
	* @return true if they are equal
	*/
	bool
	lessThanOrEquals(
	const XObject& theRHS,
	XPathExecutionContext& executionContext) const;

	/**
	* Tell if one object is greater than the other.
	*
	* @param theRHS object to compare
	* @return true if they are equal
	*/
	bool
	greaterThan(
	const XObject& theRHS,
	XPathExecutionContext& executionContext) const;

	/**
	* Tell if one object is greater than or equal
	* the other.
	*
	* @param theRHS object to compare
	* @return true if they are equal
	*/
	bool
	greaterThanOrEquals(
	const XObject& theRHS,
	XPathExecutionContext& executionContext) const;

	/**
	* Tell what kind of class this is.
	*
	* @return numeric type value
	*/
	eObjectType
	getType() const
	{
	return m_objectType;
	}

	// All XObject instances are controlled by an instance of an XObjectFactory.
	friend class XObjectFactory;

	void
	setFactory(XObjectFactory* theFactory)
	{
	m_factory = theFactory;
	}

	// Base class for all XObject exceptions...
	class XObjectException : public XalanXPathException
	{
	public:

	explicit
	XObjectException(
	const XalanDOMString& message = XalanDOMString(),
	const XalanNode* styleNode = 0,
	const XalanDOMString& theType = XalanDOMString(XALAN_STATIC_UCODE_STRING("XObjectException")));

	virtual
	~XObjectException();
	};

	class XObjectInvalidConversionException : public XObjectException
	{
	public:

	XObjectInvalidConversionException(
	const XalanDOMString& fromType,
	const XalanDOMString& toType);

	virtual
	~XObjectInvalidConversionException();

	const XalanDOMString&
	getFromType() const
	{
	return m_fromType;
	}

	const XalanDOMString&
	getToType() const
	{
	return m_toType;
	}

	private:

	static const XalanDOMString
	formatErrorString(
	const XalanDOMString& fromType,
	const XalanDOMString& toType);

	const XalanDOMString m_fromType;

	const XalanDOMString m_toType;
	};

	protected:

	/**
	* Tell what kind of class this is.
	*
	* @return numeric type value
	*/
	virtual eObjectType
	getRealType() const;

	virtual void
	referenced();

	virtual void
	dereferenced();

	virtual
	~XObject();

	static const XalanDOMString s_nullString;

	private:

	// Not implemented...
	XObject&
	operator=(const XObject&);

	const eObjectType m_objectType;

	XObjectFactory* m_factory;
	};



	/**
	* Class to hold XObjectPtr return types.
	*/
	class XALAN_XPATH_EXPORT XObjectPtr
	{
	public:

	friend bool operator==(const XObjectPtr&, const XObjectPtr&);
	friend bool operator<(const XObjectPtr&, const XObjectPtr&);

	/**
	* Create an XObjectPtr.
	*/
	explicit
	XObjectPtr(XObject* theXObject = 0) :
	m_xobjectPtr(theXObject)
	{
	XalanReferenceCountedObject::addReference(theXObject);
	}

	XObjectPtr(const XObjectPtr& theSource) :
	m_xobjectPtr(theSource.m_xobjectPtr)
	{
	XalanReferenceCountedObject::addReference(m_xobjectPtr);
	};

	XObjectPtr&
	operator=(const XObjectPtr& theRHS)
	{
	if (m_xobjectPtr != theRHS.m_xobjectPtr)
	{
	XalanReferenceCountedObject::removeReference(m_xobjectPtr);

	m_xobjectPtr = theRHS.m_xobjectPtr;

	XalanReferenceCountedObject::addReference(m_xobjectPtr);
	}

	return *this;
	}

	~XObjectPtr()
	{
	XalanReferenceCountedObject::removeReference(m_xobjectPtr);
	};

	bool
	null() const
	{
	return m_xobjectPtr == 0 ? true : false;
	}

	const XObject&
	operator*() const
	{
	return *m_xobjectPtr;
	};

	XObject&
	operator*()
	{
	return *m_xobjectPtr;
	};

	const XObject*
	operator->() const
	{
	return m_xobjectPtr;
	};

	XObject*
	operator->()
	{
	return m_xobjectPtr;
	};

	const XObject*
	get() const
	{
	return m_xobjectPtr;
	};

	XObject*
	get()
	{
	return m_xobjectPtr;
	};

	private:

	XObject* m_xobjectPtr;
	};



	inline bool
	operator==(
	const XObjectPtr& theLHS,
	const XObjectPtr& theRHS)
	{
	return theLHS.m_xobjectPtr == theRHS.m_xobjectPtr;
	}



	inline bool
	operator!=(
	const XObjectPtr& theLHS,
	const XObjectPtr& theRHS)
	{
	return !(theLHS == theRHS);
	}



	inline bool
	operator<(
	const XObjectPtr& theLHS,
	const XObjectPtr& theRHS)
	{
	return theLHS.m_xobjectPtr < theRHS.m_xobjectPtr;
	}



	#endif // XOBJECT_HEADER_GUARD_1357924680