Xalan-C++ API Reference 1.12.0
XStringAllocator.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(XSTRINGALLOCATOR_INCLUDE_GUARD_1357924680)
20#define XSTRINGALLOCATOR_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
49
50 /**
51 * Construct an instance that will allocate blocks of the specified size.
52 *
53 * @param theBlockSize The block size.
54 */
56
58
59 /**
60 * Create an XString object from a string.
61 *
62 * @param theString source string
63 *
64 * @return a pointer to string
65 */
68
69 /**
70 * Create an XString object from a null-terminated array of characters.
71 *
72 * @param theString a pointer to the array
73 *
74 * @return a pointer to string
75 */
78
79 /**
80 * Create an XString object from an array of characters.
81 *
82 * @param theString a pointer to the array
83 * @param theLength the length of the array.
84 *
85 * @return a pointer to string
86 */
91
92 /**
93 * Delete an XString object from allocator.
94 */
95 bool
97
98 /**
99 * Determine if an object is owned by the allocator...
100 */
101 bool
103 {
104 return m_allocator.ownsObject(theObject);
105 }
106
107 /**
108 * Delete all XString objects from allocator.
109 */
110 void
112
113 /**
114 * Get size of an ArenaBlock, that is, the number
115 * of objects in each block.
116 *
117 * @return The size of the block
118 */
121 {
122 return m_allocator.getBlockCount();
123 }
124
125 /**
126 * Get the number of ArenaBlocks currently allocated.
127 *
128 * @return The number of blocks.
129 */
132 {
133 return m_allocator.getBlockSize();
134 }
135
136private:
137
138 // Not implemented...
140
142 operator=(const XStringAllocator&);
143
144 // Data members...
145 ArenaAllocatorType m_allocator;
146};
147
148
149
150}
151
152
153
154#endif // XSTRINGALLOCATOR_INCLUDE_GUARD_1357924680
#define XALAN_XPATH_EXPORT
#define XALAN_CPP_NAMESPACE
Xalan-C++ namespace, including major and minor version.
string_type * createString(const XalanDOMChar *theString)
Create an XString object from a null-terminated array of characters.
ArenaAllocatorType::size_type size_type
string_type * createString(const XalanDOMChar *theString, XalanSize_t theLength)
Create an XString object from an array of characters.
ReusableArenaAllocator< string_type > ArenaAllocatorType
size_type getBlockCount() const
Get size of an ArenaBlock, that is, the number of objects in each block.
string_type * createString(const XalanDOMString &theString)
Create an XString object from a string.
size_type getBlockSize() const
Get the number of ArenaBlocks currently allocated.
void reset()
Delete all XString objects from allocator.
bool destroy(string_type *theString)
Delete an XString object from allocator.
XStringAllocator(MemoryManager &theManager, size_type theBlockCount)
Construct an instance that will allocate blocks of the specified size.
bool ownsObject(const string_type *theObject)
Determine if an object is owned by the allocator...
size_t size_type
Definition XalanMap.hpp:46