Xalan-C++ API Reference  1.12.0
XStringReferenceAllocator.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(XSTRINGREFERENCEALLOCATOR_INCLUDE_GUARD_1357924680)
20 #define XSTRINGREFERENCEALLOCATOR_INCLUDE_GUARD_1357924680
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 
49 
50  /**
51  * Construct an instance that will allocate blocks of the specified size.
52  *
53  * @param theBlockSize The block size.
54  */
56  MemoryManager& theManager,
57  size_type theBlockCount);
58 
60 
61  /**
62  * Create an XStringReference object from a string.
63  *
64  * @param theString source string
65  *
66  * @return a pointer to string
67  */
69  createString(const XalanDOMString& theString);
70 
71 
72  /**
73  * Delete an XStringReference object from allocator.
74  */
75  bool
76  destroy(string_type* theString);
77 
78  /**
79  * Determine if an object is owned by the allocator...
80  */
81  bool
82  ownsObject(const string_type* theObject)
83  {
84  return m_allocator.ownsObject(theObject);
85  }
86 
87  /**
88  * Delete all XStringReference objects from allocator.
89  */
90  void
91  reset();
92 
93  /**
94  * Get size of an ArenaBlock, that is, the number
95  * of objects in each block.
96  *
97  * @return The size of the block
98  */
99  size_type
101  {
102  return m_allocator.getBlockCount();
103  }
104 
105  /**
106  * Get the number of ArenaBlocks currently allocated.
107  *
108  * @return The number of blocks.
109  */
110  size_type
111  getBlockSize() const
112  {
113  return m_allocator.getBlockSize();
114  }
115 
116 private:
117 
118  // Not implemented...
120 
122  operator=(const XStringReferenceAllocator&);
123 
124  // Data members...
125  ArenaAllocatorType m_allocator;
126 };
127 
128 
129 
130 }
131 
132 
133 
134 #endif // XSTRINGREFERENCEALLOCATOR_INCLUDE_GUARD_1357924680
xalanc::XStringReferenceAllocator::getBlockSize
size_type getBlockSize() const
Get the number of ArenaBlocks currently allocated.
Definition: XStringReferenceAllocator.hpp:111
ReusableArenaAllocator.hpp
xalanc::XStringReference
Definition: XStringReference.hpp:37
XALAN_CPP_NAMESPACE
#define XALAN_CPP_NAMESPACE
Xalan-C++ namespace, including major and minor version.
Definition: XalanVersion.hpp:76
xalanc::XStringReferenceAllocator::getBlockCount
size_type getBlockCount() const
Get size of an ArenaBlock, that is, the number of objects in each block.
Definition: XStringReferenceAllocator.hpp:100
XStringReference.hpp
xalanc::ReusableArenaAllocator< string_type >::size_type
ReusableArenaBlockType::size_type size_type
Definition: ReusableArenaAllocator.hpp:45
xalanc::ReusableArenaAllocator< string_type >
xalanc::size_type
size_t size_type
Definition: XalanMap.hpp:46
xalanc::XStringReferenceAllocator::string_type
XStringReference string_type
Definition: XStringReferenceAllocator.hpp:45
XALAN_XPATH_EXPORT
#define XALAN_XPATH_EXPORT
Definition: XPathDefinitions.hpp:35
xalanc::XStringReferenceAllocator
Definition: XStringReferenceAllocator.hpp:41
xalanc::XStringReferenceAllocator::size_type
ArenaAllocatorType::size_type size_type
Definition: XStringReferenceAllocator.hpp:48
xalanc::XStringReferenceAllocator::ArenaAllocatorType
ReusableArenaAllocator< string_type > ArenaAllocatorType
Definition: XStringReferenceAllocator.hpp:47
xalanc::XStringReferenceAllocator::ownsObject
bool ownsObject(const string_type *theObject)
Determine if an object is owned by the allocator...
Definition: XStringReferenceAllocator.hpp:82
xalanc::XalanDOMString
Definition: XalanDOMString.hpp:45
XPathDefinitions.hpp