Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

WvConstInPlaceBuf Class Reference

#include <wvbuf.h>

Inheritance diagram for WvConstInPlaceBuf:

Inheritance graph
[legend]
List of all members.

Detailed Description

The const in place raw memory buffer type.

Refines the interface to add support for untyped pointers.


Public Member Functions

 WvConstInPlaceBuf (const void *_data, size_t _avail)
void reset (const void *_data, size_t _avail)
const unsigned char * ptr () const
 Returns the underlying array pointer.
void reset (const unsigned char *_data, size_t _avail)
 Resets the underlying buffer pointer and properties.
void setavail (size_t _avail)
 Sets the amount of available data using the current buffer and resets the read index to the beginning of the buffer.
 WvBufBase (WvBufStore *store)
void putstr (WvStringParm str)
 Copies a WvString into the buffer, excluding the null-terminator.
void putstr (WVSTRING_FORMAT_DECL)
WvString getstr ()
 Returns the entire buffer as a null-terminated WvString.
WvString getstr (size_t len)
 Returns the first len characters in the buffer.
int getch ()
 Returns a single character from the buffer as an int.
void putch (int ch)
 Puts a single character into the buffer as an int.
int peekch (int offset=0)
 Peeks a single character from the buffer as an int.
size_t strchr (int ch)
 Returns the number of characters that would have to be read to find the first instance of the character.
size_t match (const void *bytelist, size_t numbytes)
 Returns the number of leading buffer elements that match any of those in the list.
size_t match (const char *chlist)
 Returns the number of leading buffer elements that match any of those in the list.
size_t notmatch (const void *bytelist, size_t numbytes)
 Returns the number of leading buffer elements that do not match any of those in the list.
size_t notmatch (const char *chlist)
 Returns the number of leading buffer elements that do not match any of those in the list.
void put (unsigned char value)
void put (const void *data, size_t count)
void put (const unsigned char *data, size_t count)
 Writes the specified number of elements from the specified storage location into the buffer at its tail.
void put (unsigned char &value)
 Writes the element into the buffer at its tail.
void move (void *data, size_t count)
void move (unsigned char *buf, size_t count)
 Efficiently copies the specified number of elements from the buffer to the specified UNINITIALIZED storage location and removes the elements from the buffer.
void poke (void *data, int offset, size_t count)
void poke (const unsigned char *data, int offset, size_t count)
 Efficiently copies the specified number of elements from the specified storage location into the buffer at a particular offset.
void poke (unsigned char &value, int offset)
 Writes the element into the buffer at the specified offset.
WvBufStoregetstore ()
 Returns a pointer to the underlying storage class object.
bool isreadable () const
 Returns true if the buffer supports reading.
size_t used () const
 Returns the number of elements in the buffer currently available for reading.
const unsigned char * get (size_t count)
 Reads exactly the specified number of elements and returns a pointer to a storage location owned by the buffer.
unsigned char get ()
 Reads the next element from the buffer.
void skip (size_t count)
 Skips exactly the specified number of elements.
size_t optgettable () const
 Returns the optimal maximum number of elements in the buffer currently available for reading without incurring significant overhead.
void unget (size_t count)
 Ungets exactly the specified number of elements by returning them to the buffer for subsequent reads.
size_t ungettable () const
 Returns the maximum number of elements that may be ungotten at this time.
const unsigned char * peek (int offset, size_t count)
 Returns a const pointer into the buffer at the specified offset to the specified number of elements without actually adjusting the current get() index.
unsigned char peek (int offset=0)
 Returns the element at the specified offset in the buffer.
size_t peekable (int offset)
size_t optpeekable (int offset)
void zap ()
 Clears the buffer.
void copy (unsigned char *buf, int offset, size_t count)
 Efficiently copies the specified number of elements from the buffer to the specified UNINITIALIZED storage location but does not remove the elements from the buffer.
bool iswritable () const
 Returns true if the buffer supports writing.
size_t free () const
 Returns the number of elements that the buffer can currently accept for writing.
unsigned char * alloc (size_t count)
 Allocates exactly the specified number of elements and returns a pointer to an UNINITIALIZED storage location owned by the buffer.
size_t optallocable () const
 Returns the optimal maximum number of elements that the buffer can currently accept for writing without incurring significant overhead.
void unalloc (size_t count)
 Unallocates exactly the specified number of elements by removing them from the buffer and releasing their storage.
size_t unallocable () const
 Returns the maximum number of elements that may be unallocated at this time.
unsigned char * mutablepeek (int offset, size_t count)
 Returns a non-const pointer info the buffer at the specified offset to the specified number of elements without actually adjusting the current get() index.
void merge (Buffer &inbuf, size_t count)
 Efficiently moves count bytes from the specified buffer into this one.
void merge (Buffer &inbuf)
 Efficiently merges the entire contents of a buffer into this one.

Protected Types

typedef unsigned char Elem
typedef WvBufBase< unsigned
char > 
Buffer

Protected Attributes

WvConstInPlaceBufStore mystore
WvBufStorestore


Member Function Documentation

const unsigned char * WvConstInPlaceBufBase< unsigned char >::ptr  )  const [inline, inherited]
 

Returns the underlying array pointer.

Returns: the element pointer

void WvConstInPlaceBufBase< unsigned char >::reset const unsigned char *  _data,
size_t  _avail
[inline, inherited]
 

Resets the underlying buffer pointer and properties.

Never frees the old buffer.

"_data" is the array of data to wrap "_avail" is the amount of data available for reading

void WvConstInPlaceBufBase< unsigned char >::setavail size_t  _avail  )  [inline, inherited]
 

Sets the amount of available data using the current buffer and resets the read index to the beginning of the buffer.

"_avail" is the amount of data available for reading

void WvBufBase< unsigned char >::putstr WvStringParm  str  )  [inherited]
 

Copies a WvString into the buffer, excluding the null-terminator.

"str" is the string

WvString WvBufBase< unsigned char >::getstr  )  [inherited]
 

Returns the entire buffer as a null-terminated WvString.

If the buffer contains null characters, they will seem to prematurely terminate the string.

After this operation, ungettable() >= length of the string.

Returns: the buffer contents as a string

WvString WvBufBase< unsigned char >::getstr size_t  len  )  [inherited]
 

Returns the first len characters in the buffer.

This is equivalent to doing a get(len), but returns it as a WvString instead of as an unsigned char *.

int WvBufBase< unsigned char >::getch  )  [inline, inherited]
 

Returns a single character from the buffer as an int.

The same constraints apply as for get(1).

Returns: the character

void WvBufBase< unsigned char >::putch int  ch  )  [inline, inherited]
 

Puts a single character into the buffer as an int.

The same constraints apply as for alloc(1).

"ch" is the character

int WvBufBase< unsigned char >::peekch int  offset = 0  )  [inline, inherited]
 

Peeks a single character from the buffer as an int.

The same constraints apply as for peek(offset, 1).

"offset" is the offset Returns: the character

size_t WvBufBase< unsigned char >::strchr int  ch  )  [inherited]
 

Returns the number of characters that would have to be read to find the first instance of the character.

"ch" is the character Returns: the number of bytes, or zero if the character is not in the buffer

size_t WvBufBase< unsigned char >::match const void *  bytelist,
size_t  numbytes
[inline, inherited]
 

Returns the number of leading buffer elements that match any of those in the list.

"bytelist" is the list bytes to search for "numbytes" is the number of bytes in the list Returns: the number of leading buffer elements that match

size_t WvBufBase< unsigned char >::match const char *  chlist  )  [inline, inherited]
 

Returns the number of leading buffer elements that match any of those in the list.

"chlist" is a string of characters to search for Returns: the number of leading buffer elements that match

size_t WvBufBase< unsigned char >::notmatch const void *  bytelist,
size_t  numbytes
[inline, inherited]
 

Returns the number of leading buffer elements that do not match any of those in the list.

"bytelist" is the list bytes to search for "numbytes" is the number of bytes in the list Returns: the number of leading buffer elements that don't match

size_t WvBufBase< unsigned char >::notmatch const char *  chlist  )  [inline, inherited]
 

Returns the number of leading buffer elements that do not match any of those in the list.

"chlist" is a string of characters to search for Returns: the number of leading buffer elements that don't match

void WvBufBaseCommonImpl< unsigned char >::put const unsigned char *  data,
size_t  count
[inline, inherited]
 

Writes the specified number of elements from the specified storage location into the buffer at its tail.

It is an error for count to be greater than free().

For maximum efficiency, choose as large a count as possible.

The pointer buf may be NULL only if count == 0.

After this operation, at least count elements may be unallocated.

"data" is the buffer that contains the elements "count" is the number of elements

void WvBufBaseCommonImpl< unsigned char >::put unsigned char &  value  )  [inline, inherited]
 

Writes the element into the buffer at its tail.

It is an error to invoke this method if free() == 0.

After this operation, at least 1 element may be unallocated.

"valid" is the element

void WvBufBaseCommonImpl< unsigned char >::move unsigned char *  buf,
size_t  count
[inline, inherited]
 

Efficiently copies the specified number of elements from the buffer to the specified UNINITIALIZED storage location and removes the elements from the buffer.

It is an error for count to be greater than used().

For maximum efficiency, choose as large a count as possible.

The pointer buf may be NULL only if count == 0.

After this operation, an indeterminate number of elements may be ungotten.

"buf" is the buffer that will receive the elements "count" is the number of elements

void WvBufBaseCommonImpl< unsigned char >::poke const unsigned char *  data,
int  offset,
size_t  count
[inline, inherited]
 

Efficiently copies the specified number of elements from the specified storage location into the buffer at a particular offset.

If offset <= used() and offset + count > used(), the remaining data is simply tacked onto the end of the buffer with put().

It is an error for count to be greater than free() - offset.

"data" is the buffer that contains the elements "count" is the number of elements "offset" is the buffer offset, default 0

void WvBufBaseCommonImpl< unsigned char >::poke unsigned char &  value,
int  offset
[inline, inherited]
 

Writes the element into the buffer at the specified offset.

It is an error to invoke this method if free() == 0.

After this operation, at least 1 element may be unallocated.

"value" is the element "offset" is the buffer offset

WvBufStore* WvBufBaseCommonImpl< unsigned char >::getstore  )  [inline, inherited]
 

Returns a pointer to the underlying storage class object.

Returns: the low-level storage class object pointer, non-null

bool WvBufBaseCommonImpl< unsigned char >::isreadable  )  const [inline, inherited]
 

Returns true if the buffer supports reading.

Returns: true if reading is supported

size_t WvBufBaseCommonImpl< unsigned char >::used  )  const [inline, inherited]
 

Returns the number of elements in the buffer currently available for reading.

This function could also be called gettable().

const unsigned char * WvBufBaseCommonImpl< unsigned char >::get size_t  count  )  [inline, inherited]
 

Reads exactly the specified number of elements and returns a pointer to a storage location owned by the buffer.

The pointer is only valid until the next non-const buffer member is called. eg. alloc(size_t)

If count == 0, a NULL pointer may be returned.

It is an error for count to be greater than used().

For maximum efficiency, call this function multiple times with count no greater than optgettable() each time.

After this operation, at least count elements may be ungotten.

unsigned char WvBufBaseCommonImpl< unsigned char >::get  )  [inline, inherited]
 

Reads the next element from the buffer.

It is an error to invoke this method if used() == 0.

After this operation, at least 1 element may be ungotten.

Returns: the element

void WvBufBaseCommonImpl< unsigned char >::skip size_t  count  )  [inline, inherited]
 

Skips exactly the specified number of elements.

This is equivalent to invoking get(size_t) with the count and discarding the result, but may be faster for certain types of buffers. As with get(size_t), the call may be followed up by an unget(size_t).

"count" is the number of elements

size_t WvBufBaseCommonImpl< unsigned char >::optgettable  )  const [inline, inherited]
 

Returns the optimal maximum number of elements in the buffer currently available for reading without incurring significant overhead.

Invariants:

Returns: the number of elements

void WvBufBaseCommonImpl< unsigned char >::unget size_t  count  )  [inline, inherited]
 

Ungets exactly the specified number of elements by returning them to the buffer for subsequent reads.

This operation may always be safely performed with count less than or equal to that specified in the last get(size_t) if no non-const buffer members have been called since then.

If count == 0, nothing happens.

It is an error for count to be greater than ungettable().

"count" is the number of elements

size_t WvBufBaseCommonImpl< unsigned char >::ungettable  )  const [inline, inherited]
 

Returns the maximum number of elements that may be ungotten at this time.

Returns: the number of elements

const unsigned char * WvBufBaseCommonImpl< unsigned char >::peek int  offset,
size_t  count
[inline, inherited]
 

Returns a const pointer into the buffer at the specified offset to the specified number of elements without actually adjusting the current get() index.

The pointer is only valid until the next non-const buffer member is called. eg. alloc(size_t)

If count == 0, a NULL pointer may be returned.

If offset is greater than zero, then elements will be returned beginning with the with the offset'th element that would be returned by get(size_t).

If offset equals zero, then elements will be returned beginning with the next one available for get(size_t).

If offset is less than zero, then elements will be returned beginning with the first one that would be returned on a get(size_t) following an unget(-offset).

It is an error for count to be greater than peekable(offset).

For maximum efficiency, call this function multiple times with count no greater than that returned by optpeekable(size_t) at incremental offsets.

"offset" is the buffer offset "count" is the number of elements Returns: the element storage pointer

unsigned char WvBufBaseCommonImpl< unsigned char >::peek int  offset = 0  )  [inline, inherited]
 

Returns the element at the specified offset in the buffer.

It is an error to invoke this method if used() == 0.

"offset" is the offset, default 0 Returns: the element

void WvBufBaseCommonImpl< unsigned char >::zap  )  [inline, inherited]
 

Clears the buffer.

For many types of buffers, calling zap() will increased the amount of free space available for writing (see below) by an amount greater than used(). Hence it is wise to zap() a buffer just before writing to it to maximize free space.

After this operation, used() == 0, and often ungettable() == 0.

void WvBufBaseCommonImpl< unsigned char >::copy unsigned char *  buf,
int  offset,
size_t  count
[inline, inherited]
 

Efficiently copies the specified number of elements from the buffer to the specified UNINITIALIZED storage location but does not remove the elements from the buffer.

It is an error for count to be greater than peekable(offset).

For maximum efficiency, choose as large a count as possible.

The pointer buf may be NULL only if count == 0.

"buf" is the buffer that will receive the elements "offset" is the buffer offset "count" is the number of elements

bool WvBufBaseCommonImpl< unsigned char >::iswritable  )  const [inline, inherited]
 

Returns true if the buffer supports writing.

Returns: true if writing is supported

size_t WvBufBaseCommonImpl< unsigned char >::free  )  const [inline, inherited]
 

Returns the number of elements that the buffer can currently accept for writing.

Returns: the number of elements

unsigned char * WvBufBaseCommonImpl< unsigned char >::alloc size_t  count  )  [inline, inherited]
 

Allocates exactly the specified number of elements and returns a pointer to an UNINITIALIZED storage location owned by the buffer.

The pointer is only valid until the next non-const buffer member is called. eg. alloc(size_t)

If count == 0, a NULL pointer may be returned.

It is an error for count to be greater than free().

For best results, call this function multiple times with count no greater than optallocable() each time.

After this operation, at least count elements may be unallocated.

"count" is the number of elements Returns: the element storage pointer

size_t WvBufBaseCommonImpl< unsigned char >::optallocable  )  const [inline, inherited]
 

Returns the optimal maximum number of elements that the buffer can currently accept for writing without incurring significant overhead.

Invariants:

Returns: the number of elements

void WvBufBaseCommonImpl< unsigned char >::unalloc size_t  count  )  [inline, inherited]
 

Unallocates exactly the specified number of elements by removing them from the buffer and releasing their storage.

This operation may always be safely performed with count less than or equal to that specified in the last alloc(size_t) or put(const T*, size_t) if no non-const buffer members have been called since then.

If count == 0, nothing happens.

It is an error for count to be greater than unallocable().

"count" is the number of elements

size_t WvBufBaseCommonImpl< unsigned char >::unallocable  )  const [inline, inherited]
 

Returns the maximum number of elements that may be unallocated at this time.

For all practical purposes, this number will always be at least as large as the amount currently in use. It is provided primarily for symmetry, but also to handle cases where buffer reading (hence used()) is not supported by the implementation.

Invariants:

Returns: the number of elements

unsigned char * WvBufBaseCommonImpl< unsigned char >::mutablepeek int  offset,
size_t  count
[inline, inherited]
 

Returns a non-const pointer info the buffer at the specified offset to the specified number of elements without actually adjusting the current get() index.

Other than the fact that the returned storage is mutable, operates identically to peek(int, size_t).

"offset" is the buffer offset "count" is the number of elements Returns: the element storage pointer

void WvBufBaseCommonImpl< unsigned char >::merge Buffer inbuf,
size_t  count
[inline, inherited]
 

Efficiently moves count bytes from the specified buffer into this one.

In some cases, this may be a zero-copy operation.

It is an error for count to be greater than inbuf.used().

For maximum efficiency, choose as large a count as possible.

After this operation, an indeterminate number of elements may be ungotten from inbuf.

"inbuf" is the buffer from which to read "count" is the number of elements

void WvBufBaseCommonImpl< unsigned char >::merge Buffer inbuf  )  [inline, inherited]
 

Efficiently merges the entire contents of a buffer into this one.

"inbuf" is the buffer from which to read


The documentation for this class was generated from the following file:
Generated on Sun Jul 10 16:28:16 2005 for WvStreams by  doxygen 1.4.0