1 | // |
---|
2 | // DOMObject.h |
---|
3 | // |
---|
4 | // $Id: //poco/1.3/XML/include/Poco/DOM/DOMObject.h#1 $ |
---|
5 | // |
---|
6 | // Library: XML |
---|
7 | // Package: DOM |
---|
8 | // Module: DOM |
---|
9 | // |
---|
10 | // Definition of the DOMObject class. |
---|
11 | // |
---|
12 | // Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH. |
---|
13 | // and Contributors. |
---|
14 | // |
---|
15 | // Permission is hereby granted, free of charge, to any person or organization |
---|
16 | // obtaining a copy of the software and accompanying documentation covered by |
---|
17 | // this license (the "Software") to use, reproduce, display, distribute, |
---|
18 | // execute, and transmit the Software, and to prepare derivative works of the |
---|
19 | // Software, and to permit third-parties to whom the Software is furnished to |
---|
20 | // do so, all subject to the following: |
---|
21 | // |
---|
22 | // The copyright notices in the Software and this entire statement, including |
---|
23 | // the above license grant, this restriction and the following disclaimer, |
---|
24 | // must be included in all copies of the Software, in whole or in part, and |
---|
25 | // all derivative works of the Software, unless such copies or derivative |
---|
26 | // works are solely in the form of machine-executable object code generated by |
---|
27 | // a source language processor. |
---|
28 | // |
---|
29 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
---|
30 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
---|
31 | // FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT |
---|
32 | // SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE |
---|
33 | // FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, |
---|
34 | // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
---|
35 | // DEALINGS IN THE SOFTWARE. |
---|
36 | // |
---|
37 | |
---|
38 | |
---|
39 | #ifndef DOM_DOMObject_INCLUDED |
---|
40 | #define DOM_DOMObject_INCLUDED |
---|
41 | |
---|
42 | |
---|
43 | #include "Poco/XML/XML.h" |
---|
44 | |
---|
45 | |
---|
46 | namespace Poco { |
---|
47 | namespace XML { |
---|
48 | |
---|
49 | |
---|
50 | class XML_API DOMObject |
---|
51 | /// The base class for all objects in the Document Object Model. |
---|
52 | /// |
---|
53 | /// DOMObject defines the rules for memory management |
---|
54 | /// in this implementation of the DOM. Violation of these |
---|
55 | /// rules, which are outlined in the following, results |
---|
56 | /// in memory leaks or dangling pointers. |
---|
57 | /// |
---|
58 | /// Every object created by new or by a factory |
---|
59 | /// method (for example, Document::create*) must be released |
---|
60 | /// with a call to release() or autoRelease() when it |
---|
61 | /// is no longer needed. |
---|
62 | /// |
---|
63 | /// Every object created by cloning or importing another |
---|
64 | /// object must be released. |
---|
65 | /// For every call to duplicate() there must be a matching |
---|
66 | /// call to release(). |
---|
67 | /// An object obtained via any other way must not be |
---|
68 | /// released, except ownership of it has been explicitely |
---|
69 | /// taken with a call to duplicate(). |
---|
70 | /// |
---|
71 | /// While DOMObjects are safe for use in multithreaded programs, |
---|
72 | /// a DOMObject or one of its subclasses must not be accessed |
---|
73 | /// from multiple threads simultaneously. |
---|
74 | { |
---|
75 | public: |
---|
76 | DOMObject(); |
---|
77 | /// Creates the DOMObject. |
---|
78 | /// The object's reference count is initialized to one. |
---|
79 | |
---|
80 | void duplicate() const; |
---|
81 | /// Increases the object's reference count. |
---|
82 | |
---|
83 | void release() const; |
---|
84 | /// Decreases the object's reference count. |
---|
85 | /// If the reference count reaches zero, |
---|
86 | /// the object is deleted. |
---|
87 | |
---|
88 | virtual void autoRelease() = 0; |
---|
89 | /// Adds the object to an appropriate |
---|
90 | /// AutoReleasePool, which is usually the |
---|
91 | /// AutoReleasePool managed by the Document |
---|
92 | /// to which this object belongs. |
---|
93 | |
---|
94 | protected: |
---|
95 | virtual ~DOMObject(); |
---|
96 | /// Destroys the DOMObject. |
---|
97 | |
---|
98 | private: |
---|
99 | DOMObject(const DOMObject&); |
---|
100 | DOMObject& operator = (const DOMObject&); |
---|
101 | |
---|
102 | mutable int _rc; |
---|
103 | }; |
---|
104 | |
---|
105 | |
---|
106 | // |
---|
107 | // inlines |
---|
108 | // |
---|
109 | inline void DOMObject::duplicate() const |
---|
110 | { |
---|
111 | ++_rc; |
---|
112 | } |
---|
113 | |
---|
114 | |
---|
115 | inline void DOMObject::release() const |
---|
116 | { |
---|
117 | if (--_rc == 0) |
---|
118 | delete this; |
---|
119 | } |
---|
120 | |
---|
121 | |
---|
122 | } } // namespace Poco::XML |
---|
123 | |
---|
124 | |
---|
125 | #endif // DOM_DOMObject_INCLUDED |
---|