Xalan-C++ API Reference 1.12.0
XStringCachedAllocator.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(XSTRINGCACHEDALLOCATOR_INCLUDE_GUARD_1357924680)
20#define XSTRINGCACHEDALLOCATOR_INCLUDE_GUARD_1357924680
21
22
23
24// Base include file. Must be first.
26
27
28
30
31
32
34
35
36
37namespace XALAN_CPP_NAMESPACE {
38
39
40
42{
43public:
44
46
48
51
52 /**
53 * Construct an instance that will allocate blocks of the specified size.
54 *
55 * @param theBlockSize The block size.
56 */
58 MemoryManager& theManager,
60
62
63 /**
64 * Create an XString object from a cached string.
65 *
66 * @param theXObject The source cached string
67 *
68 * @return a pointer to the new XStringCached instance.
69 */
72
73
74 /**
75 * Delete an XStringCached object from allocator.
76 */
77 bool
79
80 /**
81 * Determine if an object is owned by the allocator...
82 */
83 bool
85 {
86 return m_allocator.ownsObject(theObject);
87 }
88
89 /**
90 * Delete all XStringCached objects from allocator.
91 */
92 void
94
95 /**
96 * Get size of an ArenaBlock, that is, the number
97 * of objects in each block.
98 *
99 * @return The size of the block
100 */
103 {
104 return m_allocator.getBlockCount();
105 }
106
107 /**
108 * Get the number of ArenaBlocks currently allocated.
109 *
110 * @return The number of blocks.
111 */
114 {
115 return m_allocator.getBlockSize();
116 }
117
118private:
119
120 // Not implemented...
122
124 operator=(const XStringCachedAllocator&);
125
126 // Data members...
127 ArenaAllocatorType m_allocator;
128};
129
130
131
132}
133
134
135
136#endif // XSTRINGCACHEDALLOCATOR_INCLUDE_GUARD_1357924680
#define XALAN_XPATH_EXPORT
#define XALAN_CPP_NAMESPACE
Xalan-C++ namespace, including major and minor version.
ReusableArenaAllocator< string_type > ArenaAllocatorType
ArenaAllocatorType::size_type size_type
size_type getBlockSize() const
Get the number of ArenaBlocks currently allocated.
size_type getBlockCount() const
Get size of an ArenaBlock, that is, the number of objects in each block.
bool ownsObject(const string_type *theObject)
Determine if an object is owned by the allocator...
bool destroy(string_type *theString)
Delete an XStringCached object from allocator.
void reset()
Delete all XStringCached objects from allocator.
XStringCachedAllocator(MemoryManager &theManager, size_type theBlockCount)
Construct an instance that will allocate blocks of the specified size.
string_type * createString(GetCachedString &theValue)
Create an XString object from a cached string.
string_type::GetCachedString GetCachedString
size_t size_type
Definition XalanMap.hpp:46