Manage document while setting DOM.
[shibboleth/cpp-xmltooling.git] / xmltooling / AbstractDOMCachingXMLObject.cpp
1 /*\r
2  *  Copyright 2001-2006 Internet2\r
3  * \r
4  * Licensed under the Apache License, Version 2.0 (the "License");\r
5  * you may not use this file except in compliance with the License.\r
6  * You may obtain a copy of the License at\r
7  *\r
8  *     http://www.apache.org/licenses/LICENSE-2.0\r
9  *\r
10  * Unless required by applicable law or agreed to in writing, software\r
11  * distributed under the License is distributed on an "AS IS" BASIS,\r
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
13  * See the License for the specific language governing permissions and\r
14  * limitations under the License.\r
15  */\r
16 \r
17 /**\r
18  * AbstractDOMCachingXMLObject.cpp\r
19  * \r
20  * Extension of AbstractXMLObject that implements a DOMCachingXMLObject. \r
21  */\r
22 \r
23 #include "internal.h"\r
24 #include "exceptions.h"\r
25 #include "AbstractDOMCachingXMLObject.h"\r
26 \r
27 #include <algorithm>\r
28 #include <functional>\r
29 #include <log4cpp/Category.hh>\r
30 \r
31 using namespace xmltooling;\r
32 using namespace log4cpp;\r
33 using namespace std;\r
34 \r
35 AbstractDOMCachingXMLObject::~AbstractDOMCachingXMLObject()\r
36 {\r
37     if (m_document)\r
38         m_document->release();\r
39 }\r
40 \r
41 void AbstractDOMCachingXMLObject::setDOM(DOMElement* dom, bool bindDocument)\r
42 {\r
43     m_dom=dom;\r
44     if (dom) {\r
45         if (bindDocument) {\r
46             DOMDocument* tmp=setDocument(dom->getOwnerDocument());\r
47             if (tmp)\r
48                 tmp->release();\r
49         }\r
50     }\r
51     else if (m_document) {\r
52         m_document->release();\r
53         m_document=NULL;\r
54     }\r
55 }\r
56 \r
57 void AbstractDOMCachingXMLObject::releaseDOM()\r
58 {\r
59     Category& log=Category::getInstance(XMLTOOLING_LOGCAT".DOM");\r
60     if (log.isDebugEnabled())\r
61         log.debug("Releasing cached DOM reprsentation for %s", getElementQName().toString().c_str());\r
62 \r
63     // We don't get rid of the document we're holding, if any.\r
64     // The marshalling process deals with that.\r
65     setDOM(NULL);\r
66 }\r
67 \r
68 void AbstractDOMCachingXMLObject::releaseParentDOM(bool propagateRelease)\r
69 {\r
70     Category& log=Category::getInstance(XMLTOOLING_LOGCAT".DOM");\r
71     if (log.isDebugEnabled()) {\r
72         log.debug(\r
73             "Releasing cached DOM representation for parent of %s with propagation set to %s",\r
74             getElementQName().toString().c_str(), propagateRelease ? "true" : "false"\r
75             );\r
76     }\r
77 \r
78     DOMCachingXMLObject* domCachingParent = dynamic_cast<DOMCachingXMLObject*>(getParent());\r
79     if (domCachingParent) {\r
80         domCachingParent->releaseDOM();\r
81         if (propagateRelease)\r
82             domCachingParent->releaseParentDOM(propagateRelease);\r
83     }\r
84 }\r
85 \r
86 class _release : public binary_function<XMLObject*,bool,void> {\r
87 public:\r
88     void operator()(XMLObject* obj, bool propagate) const {\r
89         DOMCachingXMLObject* domCachingParent = dynamic_cast<DOMCachingXMLObject*>(obj);\r
90         if (domCachingParent) {\r
91             domCachingParent->releaseDOM();\r
92             if (propagate)\r
93                 domCachingParent->releaseChildrenDOM(propagate);\r
94         }\r
95     }\r
96 };\r
97 \r
98 void AbstractDOMCachingXMLObject::releaseChildrenDOM(bool propagateRelease)\r
99 {\r
100     Category& log=Category::getInstance(XMLTOOLING_LOGCAT".DOM");\r
101     if (log.isDebugEnabled()) {\r
102         log.debug(\r
103             "Releasing cached DOM representation for children of %s with propagation set to %s",\r
104             getElementQName().toString().c_str(), propagateRelease ? "true" : "false"\r
105             );\r
106     }\r
107     \r
108     vector<XMLObject*> children;\r
109     if (getOrderedChildren(children))\r
110         for_each(children.begin(),children.end(),bind2nd(_release(),propagateRelease));\r
111 }\r
112 \r
113 XMLObject* AbstractDOMCachingXMLObject::prepareForAssignment(const XMLObject* oldValue, XMLObject* newValue) {\r
114 \r
115     if (newValue && newValue->hasParent())\r
116         throw XMLObjectException("child XMLObject cannot be added - it is already the child of another XMLObject");\r
117 \r
118     if (!oldValue) {\r
119         if (newValue) {\r
120             releaseThisandParentDOM();\r
121             newValue->setParent(this);\r
122             return newValue;\r
123         }\r
124         else {\r
125             return NULL;\r
126         }\r
127     }\r
128 \r
129     if (oldValue != newValue) {\r
130         delete oldValue;\r
131         releaseThisandParentDOM();\r
132         newValue->setParent(this);\r
133     }\r
134 \r
135     return newValue;\r
136 }\r