poco/XML/include/Poco/DOM/DOMObject.h
Aleksandar Fabijanic d75e68c027 new trunk (base for 1.5)
windows build only
2012-04-23 01:14:34 +00:00

126 lines
3.7 KiB
C++

//
// DOMObject.h
//
// $Id: //poco/1.4/XML/include/Poco/DOM/DOMObject.h#1 $
//
// Library: XML
// Package: DOM
// Module: DOM
//
// Definition of the DOMObject class.
//
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
// and Contributors.
//
// Permission is hereby granted, free of charge, to any person or organization
// obtaining a copy of the software and accompanying documentation covered by
// this license (the "Software") to use, reproduce, display, distribute,
// execute, and transmit the Software, and to prepare derivative works of the
// Software, and to permit third-parties to whom the Software is furnished to
// do so, all subject to the following:
//
// The copyright notices in the Software and this entire statement, including
// the above license grant, this restriction and the following disclaimer,
// must be included in all copies of the Software, in whole or in part, and
// all derivative works of the Software, unless such copies or derivative
// works are solely in the form of machine-executable object code generated by
// a source language processor.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
#ifndef DOM_DOMObject_INCLUDED
#define DOM_DOMObject_INCLUDED
#include "Poco/XML/XML.h"
namespace Poco {
namespace XML {
class XML_API DOMObject
/// The base class for all objects in the Document Object Model.
///
/// DOMObject defines the rules for memory management
/// in this implementation of the DOM. Violation of these
/// rules, which are outlined in the following, results
/// in memory leaks or dangling pointers.
///
/// Every object created by new or by a factory
/// method (for example, Document::create*) must be released
/// with a call to release() or autoRelease() when it
/// is no longer needed.
///
/// Every object created by cloning or importing another
/// object must be released.
/// For every call to duplicate() there must be a matching
/// call to release().
/// An object obtained via any other way must not be
/// released, except ownership of it has been explicitely
/// taken with a call to duplicate().
///
/// While DOMObjects are safe for use in multithreaded programs,
/// a DOMObject or one of its subclasses must not be accessed
/// from multiple threads simultaneously.
{
public:
DOMObject();
/// Creates the DOMObject.
/// The object's reference count is initialized to one.
void duplicate() const;
/// Increases the object's reference count.
void release() const;
/// Decreases the object's reference count.
/// If the reference count reaches zero,
/// the object is deleted.
virtual void autoRelease() = 0;
/// Adds the object to an appropriate
/// AutoReleasePool, which is usually the
/// AutoReleasePool managed by the Document
/// to which this object belongs.
protected:
virtual ~DOMObject();
/// Destroys the DOMObject.
private:
DOMObject(const DOMObject&);
DOMObject& operator = (const DOMObject&);
mutable int _rc;
};
//
// inlines
//
inline void DOMObject::duplicate() const
{
++_rc;
}
inline void DOMObject::release() const
{
if (--_rc == 0)
delete this;
}
} } // namespace Poco::XML
#endif // DOM_DOMObject_INCLUDED