---

ACE_Obstack_T Class Template Reference

#include <Obstack_T.h>

Inheritance diagram for ACE_Obstack_T:

[legend]Collaboration diagram for ACE_Obstack_T:

[legend]List of all members.

Public Methods
	ACE_Obstack_T (size_t size=(4096 *sizeof(CHAR))-sizeof(ACE_Obchunk), ACE_Allocator *allocator_strategy=0)
	~ACE_Obstack_T (void)
int	request (size_t len)
	Request Obstack to prepare a block at least len long for building a new string. Return -1 if fail, 0 if success. More...
CHAR *	grow (CHAR c)
	Inserting a new CHAR c into the current building block without freezing (null terminating) the block. This function will create new chunk by checking the boundary of current Obchunk. Return the location c gets inserted to, or 0 if error. More...
void	grow_fast (CHAR c)
	Inserting a new CHAR c into the current building block without freezing (null terminating) the block and without checking for out-of-bound error. More...
CHAR *	freeze (void)
	Freeze the current building block by null terminating it. Return the starting address of the current building block, 0 if error occurs. More...
CHAR *	copy (const CHAR *data, size_t len)
	Copy the data into the current Obchunk and freeze the current block. Return the starting address of the current building block, 0 if error occurs. len specify the string length, not the actually data size. More...
size_t	length (void) const
	Return the maximum length or size of a string that can be put into this Obstack. size = length * sizeof (CHAR). Deprecated : No need to use this function as you can put objects of arbitrary lengths into the obstack now. More...
size_t	size (void) const
void	unwind (void *obj)
	"Unwind" the stack. If obj is a null pointer, everything allocated in the stack is released. Otherwise, obj must be an address of an object allocated in the stack. In this case, obj is released along with everthing allocated in the Obstack since obj. More...
void	release (void)
	"Release" the entire stack of Obchunks, putting it back on the free list. More...
void	dump (void) const
	Dump the state of an object. More...
Public Attributes
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks. More...
Protected Methods
ACE_Obchunk *	new_chunk (void)
void	unwind_i (void *obj)
	Search through the list of Obchunks and release them. Helper funtion used by unwind. More...
Protected Attributes
ACE_Allocator *	allocator_strategy_
	Pointer to the allocator used by this Obstack. More...
size_t	size_
	Current size of the Obstack;. More...
ACE_Obchunk *	head_
	Head of the Obchunk chain. More...
ACE_Obchunk *	curr_
	Pointer to the current Obchunk. More...

template<class CHAR>
class ACE_Obstack_T< CHAR >

---

Constructor & Destructor Documentation

template<class CHAR> ACE_Obstack_T< CHAR >::ACE_Obstack_T (  size_t    size = (4096 *sizeof(CHAR))-sizeof(ACE_Obchunk), ACE_Allocator *    allocator_strategy = 0 )

Definition at line 122 of file Obstack_T.cpp. References ACE_ALLOCATOR, ACE_TRACE, allocator_strategy_, curr_, head_, ACE_Allocator::instance, and new_chunk. : allocator_strategy_ (allocator_strategy), size_ (size) { ACE_TRACE ("ACE_Obstack_T<CHAR>::ACE_Obstack"); if (this->allocator_strategy_ == 0) ACE_ALLOCATOR (this->allocator_strategy_, ACE_Allocator::instance ()); this->head_ = this->new_chunk (); this->curr_ = this->head_; }

template<class CHAR> ACE_Obstack_T< CHAR >::~ACE_Obstack_T (  void    )

Definition at line 138 of file Obstack_T.cpp. References ACE_TRACE, allocator_strategy_, ACE_Allocator::free, head_, and ACE_Obchunk::next_. { ACE_TRACE ("ACE_Obstack_T<CHAR>::~ACE_Obstack_T"); ACE_Obchunk *temp = this->head_; while (temp != 0) { ACE_Obchunk *next = temp->next_; temp->next_ = 0; this->allocator_strategy_->free (temp); temp = next; } }

---

Member Function Documentation

template<class CHAR> CHAR * ACE_Obstack_T< CHAR >::copy (  const CHAR *    data, size_t    len )

Copy the data into the current Obchunk and freeze the current block. Return the starting address of the current building block, 0 if error occurs. len specify the string length, not the actually data size. Definition at line 154 of file Obstack_T.cpp. References ACE_TRACE, ACE_Obchunk::cur_, curr_, freeze, ACE_OS_String::memcpy, and request. { ACE_TRACE ("ACE_Obstack_T<CHAR>::copy"); if (this->request (len) != 0) return 0; size_t tsize = len * sizeof (CHAR); ACE_OS::memcpy (this->curr_->cur_, s, tsize); this->curr_->cur_ += tsize ; return this->freeze (); }

template<class CHAR> void ACE_Obstack_T< CHAR >::dump (  void    )  const

Dump the state of an object. Definition at line 21 of file Obstack_T.cpp. References ACE_BEGIN_DUMP, ACE_DEBUG, ACE_END_DUMP, ACE_LIB_TEXT, ACE_TRACE, and LM_DEBUG. { ACE_TRACE ("ACE_Obstack_T<CHAR>::dump"); ACE_DEBUG ((LM_DEBUG, ACE_BEGIN_DUMP, this)); ACE_DEBUG ((LM_DEBUG, ACE_LIB_TEXT ("size_ = %d\n"), this->size_)); ACE_DEBUG ((LM_DEBUG, ACE_LIB_TEXT ("head_ = %x\n"), this->head_)); ACE_DEBUG ((LM_DEBUG, ACE_LIB_TEXT ("curr_ = %x\n"), this->curr_)); ACE_DEBUG ((LM_DEBUG, ACE_END_DUMP)); }

template<class CHAR> ACE_INLINE CHAR * ACE_Obstack_T< CHAR >::freeze (  void    )

Freeze the current building block by null terminating it. Return the starting address of the current building block, 0 if error occurs. Definition at line 24 of file Obstack_T.i. References ACE_Obchunk::block_, ACE_Obchunk::cur_, and curr_. Referenced by copy. { CHAR *retv = ACE_reinterpret_cast (CHAR *, this->curr_->block_); * (ACE_reinterpret_cast (CHAR *, this->curr_->cur_)) = 0; this->curr_->cur_ += sizeof (CHAR); this->curr_->block_ = this->curr_->cur_; return retv; }

template<class CHAR> CHAR * ACE_Obstack_T< CHAR >::grow (  CHAR    c )

Inserting a new CHAR c into the current building block without freezing (null terminating) the block. This function will create new chunk by checking the boundary of current Obchunk. Return the location c gets inserted to, or 0 if error. Definition at line 89 of file Obstack_T.cpp. References ACE_TRACE, ACE_Obchunk::cur_, curr_, and request. { ACE_TRACE ("ACE_Obstack_T<CHAR>::grow"); if (this->request (1) == 0) { CHAR *retv = ACE_reinterpret_cast (CHAR *, this->curr_->cur_); this->curr_->cur_ += sizeof (CHAR); *retv = c; return retv; } else return 0; }

template<class CHAR> ACE_INLINE void ACE_Obstack_T< CHAR >::grow_fast (  CHAR    c )

Inserting a new CHAR c into the current building block without freezing (null terminating) the block and without checking for out-of-bound error. Definition at line 16 of file Obstack_T.i. References ACE_Obchunk::cur_, and curr_. { * (ACE_reinterpret_cast (CHAR *, this->curr_->cur_)) = c; this->curr_->cur_ += sizeof (CHAR); }

template<class CHAR> ACE_INLINE size_t ACE_Obstack_T< CHAR >::length (  void    )  const

Return the maximum length or size of a string that can be put into this Obstack. size = length * sizeof (CHAR). Deprecated : No need to use this function as you can put objects of arbitrary lengths into the obstack now. Definition at line 4 of file Obstack_T.i. References size_. { return this->size_ / sizeof (CHAR); }

template<class CHAR> ACE_Obchunk * ACE_Obstack_T< CHAR >::new_chunk (  void    )  [protected]

Definition at line 106 of file Obstack_T.cpp. References ACE_NEW_MALLOC_RETURN, and ACE_TRACE. Referenced by ACE_Obstack_T, and request. { ACE_TRACE ("ACE_Obstack_T<CHAR>::new_chunk"); ACE_Obchunk *temp; ACE_NEW_MALLOC_RETURN (temp, ACE_static_cast (ACE_Obchunk *, this->allocator_strategy_->malloc (sizeof (class ACE_Obchunk) + this->size_)), ACE_Obchunk (this->size_), 0); return temp; }

template<class CHAR> void ACE_Obstack_T< CHAR >::release (  void    )

"Release" the entire stack of Obchunks, putting it back on the free list. Definition at line 198 of file Obstack_T.cpp. References ACE_TRACE, ACE_Obchunk::block_, ACE_Obchunk::contents_, ACE_Obchunk::cur_, curr_, and head_. { ACE_TRACE ("ACE_Obstack_T<CHAR>::release"); this->curr_ = this->head_; this->curr_->block_ = this->curr_->cur_ = this->curr_->contents_; }

template<class CHAR> int ACE_Obstack_T< CHAR >::request (  size_t    len )

Request Obstack to prepare a block at least len long for building a new string. Return -1 if fail, 0 if success. Definition at line 33 of file Obstack_T.cpp. References ACE_TRACE, ACE_Obchunk::block_, ACE_Obchunk::contents_, ACE_Obchunk::cur_, curr_, ACE_Obchunk::end_, ACE_OS_String::memcpy, new_chunk, ACE_Obchunk::next_, and size_. Referenced by copy, and grow. { ACE_TRACE ("ACE_Obstack_T<CHAR>::request"); // normalize the length. len *= sizeof (CHAR); // Check to see if there's room for the requested length, including // any part of an existing string, if any. size_t resulting_len = (this->curr_->cur_ - this->curr_->block_) + len; // Increase the length of the underlying chunks if the request made is // for bigger sized chunks. if (this->size_ < resulting_len) this->size_ = this->size_ << 1; // We now know the request will fit; see if it can fit in the current // chunk or will need a new one. if (this->curr_->cur_ + len >= this->curr_->end_) { // Need a new chunk. Save the current one so the current string can be // copied to the new chunk. ACE_Obchunk *temp = this->curr_; if (this->curr_->next_ == 0) { // We must allocate new memory. ACE_Obchunk* tmp = this->new_chunk(); if (!tmp) return -1; this->curr_->next_ = tmp; this->curr_ = this->curr_->next_; } else { // We can reuse previously allocated memory. this->curr_ = this->curr_->next_; this->curr_->block_ = this->curr_->cur_ = this->curr_->contents_; } // Copy any initial characters to the new chunk. if (temp->cur_ != temp->block_) { size_t datasize = temp->cur_ - temp->block_; ACE_OS::memcpy (this->curr_->block_, temp->block_, datasize); this->curr_->cur_ = this->curr_->block_ + datasize; // Reset the old chunk. temp->cur_ = temp->block_; } } return 0; }

template<class CHAR> ACE_INLINE size_t ACE_Obstack_T< CHAR >::size (  void    )  const

Definition at line 10 of file Obstack_T.i. References size_. { return this->size_; }

template<class CHAR> void ACE_Obstack_T< CHAR >::unwind (  void *    obj )

"Unwind" the stack. If obj is a null pointer, everything allocated in the stack is released. Otherwise, obj must be an address of an object allocated in the stack. In this case, obj is released along with everthing allocated in the Obstack since obj. Definition at line 169 of file Obstack_T.cpp. References ACE_Obchunk::block_, ACE_Obchunk::contents_, ACE_Obchunk::cur_, curr_, ACE_Obchunk::end_, and unwind_i. { if (obj >= this->curr_->contents_ && obj < this->curr_->end_) this->curr_->block_ = this->curr_->cur_ = ACE_reinterpret_cast (char*, obj); else this->unwind_i (obj); }

template<class CHAR> void ACE_Obstack_T< CHAR >::unwind_i (  void *    obj )  [protected]

Search through the list of Obchunks and release them. Helper funtion used by unwind. Definition at line 179 of file Obstack_T.cpp. References ACE_ERROR, ACE_LIB_TEXT, ACE_Obchunk::block_, ACE_Obchunk::contents_, ACE_Obchunk::cur_, curr_, ACE_Obchunk::end_, head_, LM_ERROR, and ACE_Obchunk::next_. Referenced by unwind. { ACE_Obchunk* curr; curr = this->head_; while (curr != 0 && (curr->contents_ > obj || curr->end_ < obj)) curr = curr->next_; if (curr) { this->curr_ = curr; this->curr_->block_ = this->curr_->cur_ = ACE_reinterpret_cast (char*, obj); } else if (obj != 0) ACE_ERROR ((LM_ERROR, ACE_LIB_TEXT ("Deletion of non-existent object.\n%a"))); }

---

Member Data Documentation

template<class CHAR> ACE_Obstack_T::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks. Definition at line 89 of file Obstack_T.h.

template<class CHAR> ACE_Allocator* ACE_Obstack_T::allocator_strategy_ [protected]

Pointer to the allocator used by this Obstack. Definition at line 99 of file Obstack_T.h. Referenced by ACE_Obstack_T, and ~ACE_Obstack_T.

template<class CHAR> class ACE_Obchunk* ACE_Obstack_T::curr_ [protected]

Pointer to the current Obchunk. Definition at line 109 of file Obstack_T.h. Referenced by ACE_Obstack_T, copy, freeze, grow, grow_fast, release, request, unwind, and unwind_i.

template<class CHAR> class ACE_Obchunk* ACE_Obstack_T::head_ [protected]

Head of the Obchunk chain. Definition at line 106 of file Obstack_T.h. Referenced by ACE_Obstack_T, release, unwind_i, and ~ACE_Obstack_T.

template<class CHAR> size_t ACE_Obstack_T::size_ [protected]

Current size of the Obstack;. Definition at line 102 of file Obstack_T.h. Referenced by length, request, and size.

---

The documentation for this class was generated from the following files:

• Obstack_T.h
• Obstack_T.cpp
• Obstack_T.i

---