byte_buffer.h

Go to the documentation of this file.

/*
** Copyright 2014-2016 The Earlham Institute
** 
** Licensed under the Apache License, Version 2.0 (the "License");
** you may not use this file except in compliance with the License.
** You may obtain a copy of the License at
** 
**     http://www.apache.org/licenses/LICENSE-2.0
** 
** Unless required by applicable law or agreed to in writing, software
** distributed under the License is distributed on an "AS IS" BASIS,
** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
** See the License for the specific language governing permissions and
** limitations under the License.
*/
 
#ifndef BYTE_BUFFER_H
#define BYTE_BUFFER_H
 
#include <stdarg.h>
#include <stddef.h>
 
#include "grassroots_util_library.h"
#include "typedefs.h"
 
typedef struct ByteBuffer
{
  char *bb_data_p;
  size_t bb_size;
  size_t bb_current_index;
} ByteBuffer;
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
GRASSROOTS_UTIL_API ByteBuffer *AllocateByteBuffer (size_t initial_size);
 
 
GRASSROOTS_UTIL_API void FreeByteBuffer (ByteBuffer *buffer_p);
 
 
GRASSROOTS_UTIL_API bool ResizeByteBuffer (ByteBuffer *buffer_p, size_t new_size);
 
 
GRASSROOTS_UTIL_API bool ExtendByteBuffer (ByteBuffer *buffer_p, size_t increment);
 
 
GRASSROOTS_UTIL_API bool AppendToByteBuffer (ByteBuffer *buffer_p, const void *data_p, const size_t data_length);
 
 
GRASSROOTS_UTIL_API bool AppendStringToByteBuffer (ByteBuffer *buffer_p, const char * const value_s);
 
 
GRASSROOTS_UTIL_API bool AppendStringsToByteBuffer (ByteBuffer *buffer_p, const char *value_s, ...);
 
 
GRASSROOTS_UTIL_API bool AppendVarArgsToByteBuffer (ByteBuffer *buffer_p, const char *value_s, va_list args);
 
 
GRASSROOTS_UTIL_API void ResetByteBuffer (ByteBuffer *buffer_p);
 
 
GRASSROOTS_UTIL_API size_t GetRemainingSpaceInByteBuffer (const ByteBuffer * const buffer_p);
 
 
GRASSROOTS_UTIL_API size_t GetByteBufferSize (const ByteBuffer * const buffer_p);
 
 
GRASSROOTS_UTIL_API const char *GetByteBufferData (const ByteBuffer * const buffer_p);
 
 
 
GRASSROOTS_UTIL_API char *DetachByteBufferData (ByteBuffer * const buffer_p);
 
 
 
GRASSROOTS_UTIL_API void RemoveFromByteBuffer (ByteBuffer *buffer_p, size_t size);
 
 
GRASSROOTS_UTIL_API void ReplaceCharsInByteBuffer (ByteBuffer *buffer_p, char old_data, char new_data);
 
 
#ifdef __cplusplus
}
#endif
 
 
 
#endif    /* #ifndef BYTE_BUFFER_H */