Xalan-C++ API Reference  1.12.0
XalanElemEmptyAllocator.hpp
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements. See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership. The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 
19 #if !defined(XALANELEMEMPTYALLOCATOR_INCLUDE_GUARD_12455133)
20 #define XALANELEMEMPTYALLOCATOR_INCLUDE_GUARD_12455133
21 
22 
23 
24 // Base include file. Must be first.
26 
27 
28 
30 
31 
32 
34 
35 
36 
37 namespace XALAN_CPP_NAMESPACE {
38 
39 
40 
42 {
43 public:
44 
46 
48 
50 
51  /**
52  * Construct an instance that will allocate blocks of the specified size.
53  *
54  * @param theBlockSize The block size.
55  */
57  MemoryManager& theManager,
58  size_type theBlockCount);
59 
61 
62  /**
63  * Construct an instance
64  *
65  * @param constructionContext The current construction context
66  * @param stylesheetTree The stylesheet containing element
67  * @param lineNumber The line number in the document
68  * @param columnNumber The column number in the document
69  * @param elementName The name of element. Can be 0.
70  *
71  * @return A pointer to the new instance.
72  */
73  data_type*
74  create(
75  StylesheetConstructionContext& constructionContext,
76  Stylesheet& stylesheetTree,
77  XalanFileLoc lineNumber,
78  XalanFileLoc columnNumber,
79  const XalanDOMString* elementName = 0);
80 
81  /**
82  * Construct an instance
83  *
84  * @param constructionContext The current construction context
85  * @param stylesheetTree The stylesheet containing element
86  * @param elementName The name of element. Can be 0.
87  */
88  data_type*
89  create(
90  StylesheetConstructionContext& constructionContext,
91  Stylesheet& stylesheetTree,
92  const XalanDOMString* elementName = 0);
93 
94  /**
95  * Destroy an instance previously created.
96  *
97  * @param theObject A pointer to the instance to destroy.
98  *
99  * @return true if the instance was destroyed, false if not.
100  */
101  bool
102  destroy(data_type* theObject)
103  {
104  return m_allocator.destroyObject(theObject);
105  }
106 
107  /**
108  * Determine if an object is owned by the allocator...
109  */
110  bool
111  ownsObject(const data_type* theObject)
112  {
113  return m_allocator.ownsObject(theObject);
114  }
115 
116  /**
117  * Delete all objects from the allocator.
118  */
119  void
121  {
122  m_allocator.reset();
123  }
124 
125  /**
126  * Get the number of ArenaBlocks currently allocated.
127  *
128  * @return The number of blocks.
129  */
130  size_type
132  {
133  return m_allocator.getBlockCount();
134  }
135 
136  /**
137  * Get size of an ArenaBlock, that is, the number
138  * of objects in each block.
139  *
140  * @return The size of the block
141  */
142  size_type
143  getBlockSize() const
144  {
145  return m_allocator.getBlockSize();
146  }
147 
148 private:
149 
150  // Not implemented...
152 
154  operator=(const XalanElemEmptyAllocator&);
155 
156  // Data members...
157  ArenaAllocatorType m_allocator;
158 };
159 
160 
161 
162 }
163 
164 
165 
166 #endif // XALANELEMEMPTYALLOCATOR_INCLUDE_GUARD_12455133
ReusableArenaAllocator.hpp
xalanc::ElemEmpty
Definition: ElemEmpty.hpp:40
XALAN_CPP_NAMESPACE
#define XALAN_CPP_NAMESPACE
Xalan-C++ namespace, including major and minor version.
Definition: XalanVersion.hpp:76
xalanc::XalanElemEmptyAllocator::reset
void reset()
Delete all objects from the allocator.
Definition: XalanElemEmptyAllocator.hpp:120
xalanc::ReusableArenaAllocator< data_type >::size_type
ReusableArenaBlockType::size_type size_type
Definition: ReusableArenaAllocator.hpp:45
xalanc::ReusableArenaAllocator< data_type >
XALAN_XSLT_EXPORT
#define XALAN_XSLT_EXPORT
Definition: XSLTDefinitions.hpp:27
xalanc::size_type
size_t size_type
Definition: XalanMap.hpp:46
ElemEmpty.hpp
xalanc::XalanElemEmptyAllocator::data_type
ElemEmpty data_type
Definition: XalanElemEmptyAllocator.hpp:45
xalanc::XalanElemEmptyAllocator::size_type
ArenaAllocatorType::size_type size_type
Definition: XalanElemEmptyAllocator.hpp:49
xalanc::XalanElemEmptyAllocator::ArenaAllocatorType
ReusableArenaAllocator< data_type > ArenaAllocatorType
Definition: XalanElemEmptyAllocator.hpp:47
xalanc::XalanElemEmptyAllocator
Definition: XalanElemEmptyAllocator.hpp:41
xalanc::StylesheetConstructionContext
Definition: StylesheetConstructionContext.hpp:83
xalanc::XalanElemEmptyAllocator::destroy
bool destroy(data_type *theObject)
Destroy an instance previously created.
Definition: XalanElemEmptyAllocator.hpp:102
xalanc::XalanElemEmptyAllocator::getBlockSize
size_type getBlockSize() const
Get size of an ArenaBlock, that is, the number of objects in each block.
Definition: XalanElemEmptyAllocator.hpp:143
XSLTDefinitions.hpp
xalanc::XalanElemEmptyAllocator::ownsObject
bool ownsObject(const data_type *theObject)
Determine if an object is owned by the allocator...
Definition: XalanElemEmptyAllocator.hpp:111
xalanc::Stylesheet
This class represents the base stylesheet or an "import" stylesheet.
Definition: Stylesheet.hpp:86
xalanc::XalanElemEmptyAllocator::getBlockCount
size_type getBlockCount() const
Get the number of ArenaBlocks currently allocated.
Definition: XalanElemEmptyAllocator.hpp:131
xalanc::XalanDOMString
Definition: XalanDOMString.hpp:45