126 lines
3.9 KiB
C
126 lines
3.9 KiB
C
#ifndef __TIDY_BUFFIO_H__
|
|
#define __TIDY_BUFFIO_H__
|
|
|
|
/**************************************************************************//**
|
|
* @file
|
|
* Treat buffer as a stream that Tidy can use for I/O operations. It offers
|
|
* the ability for the buffer to grow as bytes are added, and keeps track
|
|
* of current read and write points.
|
|
*
|
|
* @author
|
|
* HTACG, et al (consult git log)
|
|
*
|
|
* @copyright
|
|
* Copyright (c) 1998-2017 World Wide Web Consortium (Massachusetts
|
|
* Institute of Technology, European Research Consortium for Informatics
|
|
* and Mathematics, Keio University).
|
|
* @copyright
|
|
* See tidy.h for license.
|
|
*
|
|
* @date
|
|
* Consult git log.
|
|
******************************************************************************/
|
|
|
|
#include "tidyplatform.h"
|
|
#include "tidy.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/** A TidyBuffer is chunk of memory that can be used for multiple I/O purposes
|
|
** within Tidy.
|
|
** @ingroup IO
|
|
*/
|
|
TIDY_STRUCT
|
|
struct _TidyBuffer
|
|
{
|
|
TidyAllocator* allocator; /**< Memory allocator */
|
|
byte* bp; /**< Pointer to bytes */
|
|
uint size; /**< Number of bytes currently in use */
|
|
uint allocated; /**< Number of bytes allocated */
|
|
uint next; /**< Offset of current input position */
|
|
};
|
|
|
|
/** Initialize data structure using the default allocator */
|
|
TIDY_EXPORT void TIDY_CALL tidyBufInit( TidyBuffer* buf );
|
|
|
|
/** Initialize data structure using the given custom allocator */
|
|
TIDY_EXPORT void TIDY_CALL tidyBufInitWithAllocator( TidyBuffer* buf, TidyAllocator* allocator );
|
|
|
|
/** Free current buffer, allocate given amount, reset input pointer,
|
|
use the default allocator */
|
|
TIDY_EXPORT void TIDY_CALL tidyBufAlloc( TidyBuffer* buf, uint allocSize );
|
|
|
|
/** Free current buffer, allocate given amount, reset input pointer,
|
|
use the given custom allocator */
|
|
TIDY_EXPORT void TIDY_CALL tidyBufAllocWithAllocator( TidyBuffer* buf,
|
|
TidyAllocator* allocator,
|
|
uint allocSize );
|
|
|
|
/** Expand buffer to given size.
|
|
** Chunk size is minimum growth. Pass 0 for default of 256 bytes.
|
|
*/
|
|
TIDY_EXPORT void TIDY_CALL tidyBufCheckAlloc( TidyBuffer* buf,
|
|
uint allocSize, uint chunkSize );
|
|
|
|
/** Free current contents and zero out */
|
|
TIDY_EXPORT void TIDY_CALL tidyBufFree( TidyBuffer* buf );
|
|
|
|
/** Set buffer bytes to 0 */
|
|
TIDY_EXPORT void TIDY_CALL tidyBufClear( TidyBuffer* buf );
|
|
|
|
/** Attach to existing buffer */
|
|
TIDY_EXPORT void TIDY_CALL tidyBufAttach( TidyBuffer* buf, byte* bp, uint size );
|
|
|
|
/** Detach from buffer. Caller must free. */
|
|
TIDY_EXPORT void TIDY_CALL tidyBufDetach( TidyBuffer* buf );
|
|
|
|
|
|
/** Append bytes to buffer. Expand if necessary. */
|
|
TIDY_EXPORT void TIDY_CALL tidyBufAppend( TidyBuffer* buf, void* vp, uint size );
|
|
|
|
/** Append one byte to buffer. Expand if necessary. */
|
|
TIDY_EXPORT void TIDY_CALL tidyBufPutByte( TidyBuffer* buf, byte bv );
|
|
|
|
/** Get byte from end of buffer */
|
|
TIDY_EXPORT int TIDY_CALL tidyBufPopByte( TidyBuffer* buf );
|
|
|
|
|
|
/** Get byte from front of buffer. Increment input offset. */
|
|
TIDY_EXPORT int TIDY_CALL tidyBufGetByte( TidyBuffer* buf );
|
|
|
|
/** At end of buffer? */
|
|
TIDY_EXPORT Bool TIDY_CALL tidyBufEndOfInput( TidyBuffer* buf );
|
|
|
|
/** Put a byte back into the buffer. Decrement input offset. */
|
|
TIDY_EXPORT void TIDY_CALL tidyBufUngetByte( TidyBuffer* buf, byte bv );
|
|
|
|
|
|
/**************
|
|
TIDY
|
|
**************/
|
|
|
|
/* Forward declarations
|
|
*/
|
|
|
|
/** Initialize a buffer input source */
|
|
TIDY_EXPORT void TIDY_CALL tidyInitInputBuffer( TidyInputSource* inp, TidyBuffer* buf );
|
|
|
|
/** Initialize a buffer output sink */
|
|
TIDY_EXPORT void TIDY_CALL tidyInitOutputBuffer( TidyOutputSink* outp, TidyBuffer* buf );
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#endif /* __TIDY_BUFFIO_H__ */
|
|
|
|
/*
|
|
* local variables:
|
|
* mode: c
|
|
* indent-tabs-mode: nil
|
|
* c-basic-offset: 4
|
|
* eval: (c-set-offset 'substatement-open 0)
|
|
* end:
|
|
*/
|