Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


XalanSourceTreeCommentAllocator.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(XALANSOURCETREECOMMENTALLOCATOR_INCLUDE_GUARD_12455133)
20 #define XALANSOURCETREECOMMENTALLOCATOR_INCLUDE_GUARD_12455133
21 
22 
23 
25 
26 
27 
29 
30 
31 
33 
34 
35 
36 XALAN_CPP_NAMESPACE_BEGIN
37 
38 
39 
41 {
42 public:
43 
45 
47 
48 #if defined(XALAN_NO_DEFAULT_TEMPLATE_ARGUMENTS)
49  typedef ArenaBlock<ObjectType> ArenaBlockType;
50 
51  typedef ArenaAllocator<ObjectType,
52  ArenaBlockType> ArenaAllocatorType;
53 #else
55 #endif
56 
58 
59  /**
60  * Construct an instance that will allocate blocks of the specified size.
61  *
62  * @param theBlockSize The block size.
63  */
64  XalanSourceTreeCommentAllocator(MemoryManager& theManager, size_type theBlockCount);
65 
67 
68  /**
69  * Create an instance.
70  *
71  * @param theData The data for the comment
72  * @param theOwnerDocument The owner document of the comment node.
73  * @param theParentNode The parent node, if any.
74  * @param thePreviousSibling The next sibling, if any.
75  * @param theNextSibling The next sibling, if any.
76  * @param theIndex The document-order index of the node.
77  *
78  * @return pointer to the instance
79  */
80  ObjectType*
81  create(
82  const XalanDOMString& theData,
83  XalanSourceTreeDocument* theOwnerDocument,
84  XalanNode* theParentNode = 0,
85  XalanNode* thePreviousSibling = 0,
86  XalanNode* theNextSibling = 0,
87  IndexType theIndex = 0);
88 
89  /**
90  * Delete all objects from allocator.
91  */
92  void
93  reset();
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  */
101  size_type
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  */
112  size_type
113  getBlockSize() const
114  {
115  return m_allocator.getBlockSize();
116  }
117 
118 private:
119 
120  // Not implemented...
122 
124  operator=(const XalanSourceTreeCommentAllocator&);
125 
126  // Data members...
127  ArenaAllocatorType m_allocator;
128 };
129 
130 
131 
132 XALAN_CPP_NAMESPACE_END
133 
134 
135 
136 #endif // XALANSOURCETREECOMMENTALLOCATOR_INCLUDE_GUARD_12455133
size_type getBlockSize() const
Get the number of ArenaBlocks currently allocated.
#define XALAN_XALANSOURCETREE_EXPORT
size_type getBlockCount() const
Get size of an ArenaBlock, that is, the number of objects in each block.
unsigned long IndexType
Definition: XalanNode.hpp:64
ArenaBlock< ObjectType > ::size_type size_type

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSLT Processor Version 1.11
Copyright © 1999-2012 The Apache Software Foundation.
All Rights Reserved.

Apache Logo