Xalan-C++ API Reference  1.12.0
XPathAllocator.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(XPATHALLOCATOR_INCLUDE_GUARD_135792455)
20 #define XPATHALLOCATOR_INCLUDE_GUARD_135792455
21 
22 
23 
24 // Base include file. Must be first.
26 
27 
28 
30 
31 
32 
33 #include <xalanc/XPath/XPath.hpp>
34 
35 
36 
37 namespace XALAN_CPP_NAMESPACE {
38 
39 
40 
42 {
43 public:
44 
45  typedef XPath object_type;
46 
47 #if defined(XALAN_NO_DEFAULT_TEMPLATE_ARGUMENTS)
48  typedef ArenaBlock<object_type> ArenaBlockType;
49 
51  ArenaBlockType> ArenaAllocatorType;
52 #else
54 #endif
55 
57 
58  /**
59  * Construct an instance that will allocate blocks of the specified size.
60  *
61  * @param theBlockSize The block size.
62  */
63  XPathAllocator(MemoryManager& theManager, size_type theBlockCount);
64 
65  ~XPathAllocator();
66 
67  /**
68  * Create an XPath object using the allocator.
69  *
70  * @return a pointer to an XPath
71  */
73  create();
74 
75  /**
76  * Determine if an object is owned by the allocator...
77  */
78  bool
79  ownsObject(const object_type* theObject)
80  {
81  return m_allocator.ownsObject(theObject);
82  }
83 
84  /**
85  * Delete all XPath objects allocated.
86  */
87  void
88  reset();
89 
90  /**
91  * Get the number of objects in each block.
92  *
93  * @return The size of the block
94  */
95  size_type
96  getBlockCount() const
97  {
98  return m_allocator.getBlockCount();
99  }
100 
101  /**
102  * Get the number of blocks currently allocated.
103  *
104  * @return The number of blocks.
105  */
106  size_type
107  getBlockSize() const
108  {
109  return m_allocator.getBlockSize();
110  }
111 
112 private:
113 
114  // Not implemented...
116 
118  operator=(const XPathAllocator&);
119 
120  // Data members...
121  ArenaAllocatorType m_allocator;
122 };
123 
124 
125 
126 }
127 
128 
129 
130 #endif // XNUMBERALLOCATOR_INCLUDE_GUARD_135792455
xalanc::ArenaAllocator< object_type >::size_type
ArenaBlock< object_type > ::size_type size_type
Definition: ArenaAllocator.hpp:55
XALAN_CPP_NAMESPACE
#define XALAN_CPP_NAMESPACE
Xalan-C++ namespace, including major and minor version.
Definition: XalanVersion.hpp:76
xalanc::XPathAllocator::object_type
XPath object_type
Definition: XPathAllocator.hpp:45
xalanc::XPath
Definition: XPath.hpp:67
xalanc::size_type
size_t size_type
Definition: XalanMap.hpp:46
xalanc::XPathAllocator::getBlockCount
size_type getBlockCount() const
Get the number of objects in each block.
Definition: XPathAllocator.hpp:96
XALAN_XPATH_EXPORT
#define XALAN_XPATH_EXPORT
Definition: XPathDefinitions.hpp:35
xalanc::ArenaBlock< object_type >
xalanc::XPathAllocator::size_type
ArenaAllocatorType::size_type size_type
Definition: XPathAllocator.hpp:56
xalanc::ArenaAllocator
Definition: ArenaAllocator.hpp:47
ArenaAllocator.hpp
xalanc::XPathAllocator::ArenaAllocatorType
ArenaAllocator< object_type > ArenaAllocatorType
Definition: XPathAllocator.hpp:53
XPath.hpp
xalanc::XPathAllocator::ownsObject
bool ownsObject(const object_type *theObject)
Determine if an object is owned by the allocator...
Definition: XPathAllocator.hpp:79
xalanc::XPathAllocator::getBlockSize
size_type getBlockSize() const
Get the number of blocks currently allocated.
Definition: XPathAllocator.hpp:107
xalanc::XPathAllocator
Definition: XPathAllocator.hpp:41
XPathDefinitions.hpp