buffer.h File Reference

buffer interface More...

#include <types.h>
#include <memory.h>

Macros
#define	___BUFFER_H   0
#define	buffer_new()
	buffer_new creates a new buffer with default heap
#define	buffer_create_with_heap(h, c)
#define	buffer_append_with_int_type(b, d, t)
#define	buffer_append_int8(b, d)
#define	buffer_append_int16(b, d)
#define	buffer_append_int32(b, d)
#define	buffer_append_int64(b, d)
#define	buffer_append_uint8(b, d)
#define	buffer_append_uint16(b, d)
#define	buffer_append_uint32(b, d)
#define	buffer_append_uint64(b, d)
#define	buffer_read_with_int_type(b, t)
#define	buffer_read_int8(b)
#define	buffer_read_int16(b)
#define	buffer_read_int32(b)
#define	buffer_read_int64(b)
#define	buffer_read_uint8(b)
#define	buffer_read_uint16(b)
#define	buffer_read_uint32(b)
#define	buffer_read_uint64(b)
#define	buffer_write_all_into(b, d)
#define	buffer_get_view(b, l)
#define	BUFFER_IO_INPUT   0
#define	BUFFER_IO_OUTPUT   1
#define	BUFFER_IO_ERROR   2
#define	buffer_read_line(b)

Typedefs
typedef enum buffer_seek_direction_t	buffer_seek_direction_t
	buffer_seek_direction_t is a enum that buffer seek direction

Enumerations
enum	buffer_seek_direction_t { BUFFER_SEEK_DIRECTION_START , BUFFER_SEEK_DIRECTION_CURRENT , BUFFER_SEEK_DIRECTION_END }
	buffer_seek_direction_t is a enum that buffer seek direction More...

Functions
buffer_t *	buffer_new_with_capacity (memory_heap_t *heap, uint64_t capacity)
	buffer_new_with_capacity creates a new buffer with capacity
memory_heap_t *	buffer_get_heap (buffer_t *buffer)
	buffer_get_heap returns heap of buffer
buffer_t *	buffer_append_byte (buffer_t *buffer, uint8_t data)
	buffer_append_byte appends a byte to buffer
uint64_t	buffer_get_length (const buffer_t *buffer)
	returns length of buffer
boolean_t	buffer_reset (buffer_t *buffer)
	resets buffer, sets length and position to 0 and all bytes to 0, capacity stays same
uint64_t	buffer_get_capacity (buffer_t *buffer)
	returns capacity of buffer
uint64_t	buffer_get_position (buffer_t *buffer)
	returns position of buffer
buffer_t *	buffer_append_bytes (buffer_t *buffer, uint8_t *data, uint64_t length)
	appends bytes to buffer
buffer_t *	buffer_append_buffer (buffer_t *buffer, buffer_t *appenden)
	appends buffer to buffer
uint8_t *	buffer_get_bytes (buffer_t *buffer, uint64_t length)
	returns a byte array from buffer with length, byte array is copied, position is advanced with length
uint8_t	buffer_get_byte (buffer_t *buffer)
	returns a byte array from buffer with length, byte array is copied, position is advanced 1
uint8_t *	buffer_get_all_bytes (buffer_t *buffer, uint64_t *length)
	returns a byte array containing all bytes from buffer, byte array is copied, position is not advanced
uint8_t *	buffer_get_all_bytes_and_reset (buffer_t *buffer, uint64_t *length)
	returns a byte array containing all bytes from buffer, byte array is copied, position is not advanced, buffer is resetted
uint8_t *	buffer_get_all_bytes_and_destroy (buffer_t *buffer, uint64_t *length)
	returns a byte array containing all bytes from buffer, byte array is copied, position is not advanced, buffer is destroyed
boolean_t	buffer_seek (buffer_t *buffer, int64_t position, buffer_seek_direction_t direction)
	changes position of buffer
int8_t	buffer_destroy (buffer_t *buffer)
	destroys buffer
buffer_t *	buffer_encapsulate (uint8_t *data, uint64_t length)
	returns a buffer encapsulating a byte array, byte array is not copied
uint64_t	buffer_remaining (buffer_t *buffer)
	returns how many bytes are remaining in buffer (length - position)
uint8_t	buffer_peek_byte_at_position (buffer_t *buffer, uint64_t position)
	returns a byte from buffer at position, position is not changed
uint8_t	buffer_peek_byte (buffer_t *buffer)
	returns a byte from buffer at current position, position is not changed
uint64_t	buffer_peek_ints_at_position (buffer_t *buffer, uint64_t position, uint8_t bc)
	returns an int from buffer at position, position is not changed
uint64_t	buffer_peek_ints (buffer_t *buffer, uint8_t bc)
	returns an int from buffer at current position, position is not changed
uint64_t	buffer_read_ints (buffer_t *buffer, uint8_t bc)
	returns an int from buffer with byte count, int is copied, position is advanced with byte count
boolean_t	buffer_set_readonly (buffer_t *buffer, boolean_t ro)
	sets readonly flag of buffer
boolean_t	buffer_write_slice_into (buffer_t *buffer, uint64_t pos, uint64_t len, uint8_t *dest)
	copies bytes from buffer to dest (should be at least length long), position is not changed
uint8_t *	buffer_get_view_at_position (const buffer_t *buffer, uint64_t position, uint64_t length)
	returns a byte array from buffer with length, byte array is not copied, position is not changed
buffer_t *	buffer_get_io_buffer (uint64_t buffer_io_id)
	returns a buffer for io buffer id, first three buffers are stdin, stdout, stderr
int64_t	buffer_printf (buffer_t *buffer, const char *format,...)
	prints to buffer, returns number of bytes written
int64_t	buffer_vprintf (buffer_t *buffer, const char *format, va_list args)
	prints to buffer, returns number of bytes written
buffer_t *	buffer_get_tmp_buffer_for_printf (void)
	returns a temporary buffer for printf, before gui is initialized, this is a static buffer, after gui is initialized, this is a buffer allocated with malloc
void	buffer_reset_tmp_buffer_for_printf (void)
	resets temporary buffer for printf
char_t *	buffer_read_line_ext (buffer_t *buffer, char_t line_continuation_char, char_t delimiter_char, uint64_t *length)
	reads a line from buffer, line is null terminated, position is advanced
uint64_t	buffer_get_mark_position (buffer_t *buffer)
boolean_t	buffer_set_mark_position (buffer_t *buffer, uint64_t position)

Detailed Description

buffer interface

This work is licensed under TURNSTONE OS Public License. Please read and understand latest version of Licence.

Macro Definition Documentation

___BUFFER_H

#define ___BUFFER_H   0

macro for avoiding multiple inclusion

buffer_append_int16

#define buffer_append_int16	(		b,
			d )

Value:

buffer_append_with_int_type(b, d, int16)

buffer_append_int32

#define buffer_append_int32	(		b,
			d )

Value:

buffer_append_with_int_type(b, d, int32)

buffer_append_int64

#define buffer_append_int64	(		b,
			d )

Value:

buffer_append_with_int_type(b, d, int64)

buffer_append_int8

#define buffer_append_int8	(		b,
			d )

Value:

buffer_append_with_int_type(b, d, int8)

buffer_append_uint16

#define buffer_append_uint16	(		b,
			d )

Value:

buffer_append_with_int_type(b, d, uint16)

buffer_append_uint32

#define buffer_append_uint32	(		b,
			d )

Value:

buffer_append_with_int_type(b, d, uint32)

buffer_append_uint64

#define buffer_append_uint64	(		b,
			d )

Value:

buffer_append_with_int_type(b, d, uint64)

buffer_append_uint8

#define buffer_append_uint8	(		b,
			d )

Value:

buffer_append_with_int_type(b, d, uint8)

buffer_append_with_int_type

#define buffer_append_with_int_type	(		b,
			d,
			t )

Value:

buffer_append_bytes(b, (uint8_t*)&d, sizeof(t ## _t))

buffer_create_with_heap

#define buffer_create_with_heap	(		h,
			c )

Value:

buffer_new_with_capacity(h, c)

buffer_get_view

#define buffer_get_view	(		b,
			l )

Value:

buffer_get_view_at_position(b, buffer_get_position(b), l)

macro to get view from buffer from current position

See also

buffer_get_view_at_position

BUFFER_IO_ERROR

#define BUFFER_IO_ERROR   2

default io buffer id for stderr

BUFFER_IO_INPUT

#define BUFFER_IO_INPUT   0

default io buffer id for stdin

BUFFER_IO_OUTPUT

#define BUFFER_IO_OUTPUT   1

default io buffer id for stdout

buffer_new

#define buffer_new

(

void

)

Value:

buffer_new_with_capacity(NULL, 128)

buffer_new creates a new buffer with default heap

Returns

buffer_t* pointer to buffer

buffer_read_int16

#define buffer_read_int16

(

b

)

Value:

buffer_read_with_int_type(b, int16)

buffer_read_int32

#define buffer_read_int32

(

b

)

Value:

buffer_read_with_int_type(b, int32)

buffer_read_int64

#define buffer_read_int64

(

b

)

Value:

buffer_read_with_int_type(b, int64)

buffer_read_int8

#define buffer_read_int8

(

b

)

Value:

buffer_read_with_int_type(b, int8)

buffer_read_line

#define buffer_read_line

(

b

)

Value:

buffer_read_line_ext(b, '\\', '\n', NULL)

macro to read a line from buffer, line is null terminated, position is advanced

buffer_read_uint16

#define buffer_read_uint16

(

b

)

Value:

buffer_read_with_int_type(b, uint16)

buffer_read_uint32

#define buffer_read_uint32

(

b

)

Value:

buffer_read_with_int_type(b, uint32)

buffer_read_uint64

#define buffer_read_uint64

(

b

)

Value:

buffer_read_with_int_type(b, uint64)

buffer_read_uint8

#define buffer_read_uint8

(

b

)

Value:

buffer_read_with_int_type(b, uint8)

buffer_read_with_int_type

#define buffer_read_with_int_type	(		b,
			t )

Value:

((t ## _t)buffer_read_ints(b, sizeof(t ## _t)))

buffer_write_all_into

#define buffer_write_all_into	(		b,
			d )

Value:

buffer_write_slice_into(b, 0, buffer_get_length(b), d)

macro to write all bytes from buffer into dest

See also

buffer_write_slice_into

Enumeration Type Documentation

buffer_seek_direction_t

enum buffer_seek_direction_t

buffer_seek_direction_t is a enum that buffer seek direction

Enumerator
BUFFER_SEEK_DIRECTION_START	seek from start
BUFFER_SEEK_DIRECTION_CURRENT	seek from current position
BUFFER_SEEK_DIRECTION_END	seek from end

Function Documentation

buffer_append_buffer()

buffer_t * buffer_append_buffer	(	buffer_t *	buffer,
		buffer_t *	appenden )

appends buffer to buffer

Parameters

[in]	buffer	buffer to append
[in]	appenden	buffer to append

Returns

buffer_t* pointer to buffer

buffer_append_byte()

buffer_t * buffer_append_byte	(	buffer_t *	buffer,
		uint8_t	data )

buffer_append_byte appends a byte to buffer

Parameters

[in]	buffer	buffer to append
[in]	data	byte to append

Returns

buffer_t* pointer to buffer

buffer_append_bytes()

buffer_t * buffer_append_bytes	(	buffer_t *	buffer,
		uint8_t *	data,
		uint64_t	length )

appends bytes to buffer

Parameters

[in]	buffer	buffer to append
[in]	data	bytes to append
[in]	length	length of bytes

Returns

buffer_t* pointer to buffer

buffer_destroy()

int8_t buffer_destroy

(

buffer_t *

buffer

)

destroys buffer

Parameters

[in]

buffer

buffer to destroy

Returns

0 if success

buffer_encapsulate()

buffer_t * buffer_encapsulate	(	uint8_t *	data,
		uint64_t	length )

returns a buffer encapsulating a byte array, byte array is not copied

Parameters

[in]	data	byte array to encapsulate
[in]	length	length of byte array

Returns

buffer_t* pointer to buffer

buffer_get_all_bytes()

uint8_t * buffer_get_all_bytes	(	buffer_t *	buffer,
		uint64_t *	length )

returns a byte array containing all bytes from buffer, byte array is copied, position is not advanced

Parameters

[in]	buffer	buffer to get bytes
[out]	length	length of bytes returned

Returns

uint8_t* pointer to byte array

buffer_get_all_bytes_and_destroy()

uint8_t * buffer_get_all_bytes_and_destroy	(	buffer_t *	buffer,
		uint64_t *	length )

returns a byte array containing all bytes from buffer, byte array is copied, position is not advanced, buffer is destroyed

Parameters

[in]	buffer	buffer to get bytes
[out]	length	length of bytes returned

Returns

uint8_t* pointer to byte array

buffer_get_all_bytes_and_reset()

uint8_t * buffer_get_all_bytes_and_reset	(	buffer_t *	buffer,
		uint64_t *	length )

returns a byte array containing all bytes from buffer, byte array is copied, position is not advanced, buffer is resetted

Parameters

[in]	buffer	buffer to get bytes
[out]	length	length of bytes returned

Returns

uint8_t* pointer to byte array

buffer_get_byte()

uint8_t buffer_get_byte

(

buffer_t *

buffer

)

returns a byte array from buffer with length, byte array is copied, position is advanced 1

Parameters

[in]

buffer

buffer to get bytes

Returns

a single byte

buffer_get_bytes()

uint8_t * buffer_get_bytes	(	buffer_t *	buffer,
		uint64_t	length )

returns a byte array from buffer with length, byte array is copied, position is advanced with length

Parameters

[in]	buffer	buffer to get bytes
[in]	length	length of bytes

Returns

uint8_t* pointer to byte array

buffer_get_capacity()

uint64_t buffer_get_capacity

(

buffer_t *

buffer

)

returns capacity of buffer

Parameters

[in]

buffer

buffer to get capacity

Returns

uint64_t capacity of buffer

buffer_get_heap()

memory_heap_t * buffer_get_heap

(

buffer_t *

buffer

)

buffer_get_heap returns heap of buffer

Parameters

[in]

buffer

buffer to get heap

Returns

memory_heap_t* pointer to heap

buffer_get_io_buffer()

buffer_t * buffer_get_io_buffer

(

uint64_t

buffer_io_id

)

returns a buffer for io buffer id, first three buffers are stdin, stdout, stderr

Parameters

[in]

buffer_io_id

io buffer id

Returns

buffer_t* pointer to buffer

buffer_get_length()

uint64_t buffer_get_length

(

const buffer_t *

buffer

)

returns length of buffer

Parameters

[in]

buffer

buffer to get length

Returns

uint64_t length of buffer

buffer_get_position()

uint64_t buffer_get_position

(

buffer_t *

buffer

)

returns position of buffer

Parameters

[in]

buffer

buffer to get position

Returns

uint64_t position of buffer

buffer_get_tmp_buffer_for_printf()

buffer_t * buffer_get_tmp_buffer_for_printf

(

void

)

returns a temporary buffer for printf, before gui is initialized, this is a static buffer, after gui is initialized, this is a buffer allocated with malloc

Returns

buffer_t* pointer to buffer

buffer_get_view_at_position()

uint8_t * buffer_get_view_at_position	(	const buffer_t *	buffer,
		uint64_t	position,
		uint64_t	length )

returns a byte array from buffer with length, byte array is not copied, position is not changed

Parameters

[in]	buffer	buffer to get bytes
[in]	position	position to get bytes
[in]	length	length of bytes

Returns

uint8_t* pointer to byte array, or null if position + length > buffer length

buffer_new_with_capacity()

buffer_t * buffer_new_with_capacity	(	memory_heap_t *	heap,
		uint64_t	capacity )

buffer_new_with_capacity creates a new buffer with capacity

Parameters

heap	heap to allocate buffer
capacity	capacity of buffer

Returns

buffer_t* pointer to buffer

buffer_peek_byte()

uint8_t buffer_peek_byte

(

buffer_t *

buffer

)

returns a byte from buffer at current position, position is not changed

Parameters

[in]

buffer

buffer to peek

Returns

uint8_t byte at position

buffer_peek_byte_at_position()

uint8_t buffer_peek_byte_at_position	(	buffer_t *	buffer,
		uint64_t	position )

returns a byte from buffer at position, position is not changed

Parameters

[in]	buffer	buffer to peek
[in]	position	position to peek

Returns

uint8_t byte at position

buffer_peek_ints()

uint64_t buffer_peek_ints	(	buffer_t *	buffer,
		uint8_t	bc )

returns an int from buffer at current position, position is not changed

Parameters

[in]	buffer	buffer to peek
[in]	bc	byte count of int

Returns

uint64_t int at position

buffer_peek_ints_at_position()

uint64_t buffer_peek_ints_at_position	(	buffer_t *	buffer,
		uint64_t	position,
		uint8_t	bc )

returns an int from buffer at position, position is not changed

Parameters

[in]	buffer	buffer to peek
[in]	position	position to peek
[in]	bc	byte count of int

Returns

uint64_t int at position

buffer_printf()

int64_t buffer_printf	(	buffer_t *	buffer,
		const char *	format,
			... )

prints to buffer, returns number of bytes written

Parameters

[in]	buffer	buffer to print to
[in]	format	format string
[in]	...	arguments

Returns

int64_t number of bytes written

buffer_read_ints()

uint64_t buffer_read_ints	(	buffer_t *	buffer,
		uint8_t	bc )

returns an int from buffer with byte count, int is copied, position is advanced with byte count

Parameters

[in]	buffer	buffer to get int
[in]	bc	byte count of int

Returns

uint64_t int

buffer_read_line_ext()

char_t * buffer_read_line_ext	(	buffer_t *	buffer,
		char_t	line_continuation_char,
		char_t	delimiter_char,
		uint64_t *	length )

reads a line from buffer, line is null terminated, position is advanced

Parameters

[in]	buffer	buffer to read line
[in]	line_continuation_char	line continuation char
[in]	delimiter_char	delimiter char
[out]	length	length of line optional parameter

Returns

char_t* pointer to line

buffer_remaining()

uint64_t buffer_remaining

(

buffer_t *

buffer

)

returns how many bytes are remaining in buffer (length - position)

Parameters

[in]

buffer

buffer to get remaining bytes

Returns

uint64_t remaining bytes

buffer_reset()

boolean_t buffer_reset

(

buffer_t *

buffer

)

resets buffer, sets length and position to 0 and all bytes to 0, capacity stays same

Parameters

[in]

buffer

buffer to reset

Returns

boolean_t true if success

buffer_seek()

boolean_t buffer_seek	(	buffer_t *	buffer,
		int64_t	position,
		buffer_seek_direction_t	direction )

changes position of buffer

Parameters

[in]	buffer	buffer to change position
[in]	position	position to change
[in]	direction	direction to change

Returns

boolean_t true if success

buffer_set_readonly()

boolean_t buffer_set_readonly	(	buffer_t *	buffer,
		boolean_t	ro )

sets readonly flag of buffer

Parameters

[in]	buffer	buffer to set readonly
[in]	ro	readonly flag

Returns

boolean_t true if success

buffer_vprintf()

int64_t buffer_vprintf	(	buffer_t *	buffer,
		const char *	format,
		va_list	args )

prints to buffer, returns number of bytes written

Parameters

[in]	buffer	buffer to print to
[in]	format	format string
[in]	args	va_list of arguments

Returns

int64_t number of bytes written

buffer_write_slice_into()

boolean_t buffer_write_slice_into	(	buffer_t *	buffer,
		uint64_t	pos,
		uint64_t	len,
		uint8_t *	dest )

copies bytes from buffer to dest (should be at least length long), position is not changed

Parameters

[in]	buffer	buffer to copy
[in]	pos	position to copy
[in]	len	length to copy
[out]	dest	destination to copy to, dest should be at least len long

Returns

boolean_t true if success