Xerces-C++ 3.2.4

DOMMemoryManager.hpp
Go to the documentation of this file.
1/*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18#if !defined(XERCESC_INCLUDE_GUARD_DOMMEMORYMANAGER_HPP)
19#define XERCESC_INCLUDE_GUARD_DOMMEMORYMANAGER_HPP
20
21//------------------------------------------------------------------------------------
22// Includes
23//------------------------------------------------------------------------------------
24
25 XERCES_CPP_NAMESPACE_BEGIN
26
32 class CDOM_EXPORT DOMMemoryManager
33{
34 protected:
35 // -----------------------------------------------------------------------
36 // Hidden constructors
37 // -----------------------------------------------------------------------
40 DOMMemoryManager() {};
42
43 private:
44 // -----------------------------------------------------------------------
45 // Unimplemented constructors and operators
46 // -----------------------------------------------------------------------
49 DOMMemoryManager(const DOMMemoryManager &);
50 DOMMemoryManager & operator = (const DOMMemoryManager &);
52
53 public:
54
55 // -----------------------------------------------------------------------
56 // All constructors are hidden, just the destructor is available
57 // -----------------------------------------------------------------------
64 virtual ~DOMMemoryManager() {};
66
67 // -----------------------------------------------------------------------
68 // data types
69 // -----------------------------------------------------------------------
70 enum NodeObjectType {
71 ATTR_OBJECT = 0,
72 ATTR_NS_OBJECT = 1,
73 CDATA_SECTION_OBJECT = 2,
74 COMMENT_OBJECT = 3,
75 DOCUMENT_FRAGMENT_OBJECT = 4,
76 DOCUMENT_TYPE_OBJECT = 5,
77 ELEMENT_OBJECT = 6,
78 ELEMENT_NS_OBJECT = 7,
79 ENTITY_OBJECT = 8,
80 ENTITY_REFERENCE_OBJECT = 9,
81 NOTATION_OBJECT = 10,
82 PROCESSING_INSTRUCTION_OBJECT = 11,
83 TEXT_OBJECT = 12
84 };
85
87 // -----------------------------------------------------------------------
88 // Getter methods
89 // -----------------------------------------------------------------------
95 virtual XMLSize_t getMemoryAllocationBlockSize() const = 0;
96
98
100 // -----------------------------------------------------------------------
101 // Setter methods
102 // -----------------------------------------------------------------------
108 virtual void setMemoryAllocationBlockSize(XMLSize_t size) = 0;
110
112 // -----------------------------------------------------------------------
113 // Operations
114 // -----------------------------------------------------------------------
122 virtual void* allocate(XMLSize_t amount) = 0;
123
132 virtual void* allocate(XMLSize_t amount, DOMMemoryManager::NodeObjectType type) = 0;
133
140 virtual void release(DOMNode* object, DOMMemoryManager::NodeObjectType type) = 0;
141
149 virtual XMLCh* cloneString(const XMLCh *src) = 0;
151
152};
153
154 XERCES_CPP_NAMESPACE_END
155
156#endif
157
CDOM_EXPORT
#define CDOM_EXPORT
Definition: XercesDefs.hpp:166
XERCES_CPP_NAMESPACE_BEGIN
#define XERCES_CPP_NAMESPACE_BEGIN
Definition: XercesDefs.hpp:112
XERCES_CPP_NAMESPACE_END
#define XERCES_CPP_NAMESPACE_END
Definition: XercesDefs.hpp:113
XMLCh
uint16_t XMLCh
Definition: Xerces_autoconf_config.hpp:120
XMLSize_t
size_t XMLSize_t
Definition: Xerces_autoconf_config.hpp:112
DOMMemoryManager
The DOMMemoryManager interface exposes the memory allocation-related functionalities of a DOMDocument
Definition: DOMMemoryManager.hpp:33
DOMMemoryManager::cloneString
virtual XMLCh * cloneString(const XMLCh *src)=0
Allocate a memory block from the mnaged pool and copy the provided string.
DOMMemoryManager::NodeObjectType
NodeObjectType
Definition: DOMMemoryManager.hpp:70
DOMMemoryManager::release
virtual void release(DOMNode *object, DOMMemoryManager::NodeObjectType type)=0
Release a DOM object and place its memory back in the pool.
DOMMemoryManager::~DOMMemoryManager
virtual ~DOMMemoryManager()
Destructor.
Definition: DOMMemoryManager.hpp:64
DOMMemoryManager::allocate
virtual void * allocate(XMLSize_t amount)=0
Allocate a memory block of the requested size from the managed pool.
DOMMemoryManager::setMemoryAllocationBlockSize
virtual void setMemoryAllocationBlockSize(XMLSize_t size)=0
Set the size of the chunks of memory allocated by the memory manager.
DOMMemoryManager::DOMMemoryManager
DOMMemoryManager()
Definition: DOMMemoryManager.hpp:40
DOMMemoryManager::allocate
virtual void * allocate(XMLSize_t amount, DOMMemoryManager::NodeObjectType type)=0
Allocate a memory block of the requested size from the managed pool of DOM objects.
DOMMemoryManager::getMemoryAllocationBlockSize
virtual XMLSize_t getMemoryAllocationBlockSize() const =0
Returns the size of the chunks of memory allocated by the memory manager.
DOMNode
The DOMNode interface is the primary datatype for the entire Document Object Model.
Definition: DOMNode.hpp:139