buffer.h File Reference

#include <stdint.h>
#include "arc/console/view.h"
#include "arc/std/string.h"

Go to the source code of this file.

Typedefs
typedef struct ARC_ConsoleBuffer	ARC_ConsoleBuffer

Functions
void	ARC_ConsoleBuffer_Create (ARC_ConsoleBuffer **buffer)
	creates ARC_ConsoleBuffer type
void	ARC_ConsoleBuffer_Destroy (ARC_ConsoleBuffer *buffer)
	destroys ARC_ConsoleBuffer type
void	ARC_ConsoleBuffer_Clear (ARC_ConsoleBuffer *buffer)
	clears the contents of a ARC_ConsoleBuffer
void	ARC_ConsoleBuffer_Render (ARC_ConsoleBuffer *buffer, ARC_ConsoleView *view)
	renders a buffer to a ARC_ConsoleView
void	ARC_ConsoleBuffer_RenderSection (ARC_ConsoleBuffer *buffer, ARC_ConsoleView *view, uint32_t startIndex, uint32_t lines)
	renders a section of buffer to a ARC_ConsoleView
void	ARC_ConsoleBuffer_AddChar (ARC_ConsoleBuffer *buffer, char character)
	adds a character to the buffer
void	ARC_ConsoleBuffer_AddString (ARC_ConsoleBuffer *buffer, ARC_String *string)
	adds an ARC_String to the buffer
void	ARC_ConsoleBuffer_AddCString (ARC_ConsoleBuffer *buffer, char *cstring, uint64_t length)
	adds a cstring to the buffer
void	ARC_ConsoleBuffer_AddCStringWithStrlen (ARC_ConsoleBuffer *buffer, char *cstring)
	adds a cstring to the buffer with the cstrings string length
uint32_t	ARC_ConsoleBuffer_GetLineNumbers (ARC_ConsoleBuffer *buffer)
	gets the number of lines from a console line buffer

Typedef Documentation

ARC_ConsoleBuffer

typedef struct ARC_ConsoleBuffer ARC_ConsoleBuffer

Definition at line 15 of file buffer.h.

Function Documentation

ARC_ConsoleBuffer_AddChar()

void ARC_ConsoleBuffer_AddChar	(	ARC_ConsoleBuffer *	buffer,
		char	character )

adds a character to the buffer

Parameters

buffer	ARC_ConsoleBuffer to add character to
character	char to add to ARC_ConsoleBuffer

ARC_ConsoleBuffer_AddCString()

void ARC_ConsoleBuffer_AddCString	(	ARC_ConsoleBuffer *	buffer,
		char *	cstring,
		uint64_t	length )

adds a cstring to the buffer

Parameters

buffer	ARC_ConsoleBuffer to add character to
string	cstring to add to ARC_ConsoleBuffer
length	the length of the c string to add

ARC_ConsoleBuffer_AddCStringWithStrlen()

void ARC_ConsoleBuffer_AddCStringWithStrlen	(	ARC_ConsoleBuffer *	buffer,
		char *	cstring )

adds a cstring to the buffer with the cstrings string length

Parameters

buffer	ARC_ConsoleBuffer to add character to
string	cstring to add to ARC_ConsoleBuffer

ARC_ConsoleBuffer_AddString()

void ARC_ConsoleBuffer_AddString	(	ARC_ConsoleBuffer *	buffer,
		ARC_String *	string )

adds an ARC_String to the buffer

Parameters

buffer	ARC_ConsoleBuffer to add character to
string	ARC_String to add to ARC_ConsoleBuffer

ARC_ConsoleBuffer_Clear()

void ARC_ConsoleBuffer_Clear

(

ARC_ConsoleBuffer *

buffer

)

clears the contents of a ARC_ConsoleBuffer

Parameters

buffer

ARC_ConsoleBuffer to clear

ARC_ConsoleBuffer_Create()

void ARC_ConsoleBuffer_Create

(

ARC_ConsoleBuffer **

buffer

)

creates ARC_ConsoleBuffer type

Parameters

buffer

ARC_ConsoleBuffer to create

ARC_ConsoleBuffer_Destroy()

void ARC_ConsoleBuffer_Destroy

(

ARC_ConsoleBuffer *

buffer

)

destroys ARC_ConsoleBuffer type

Parameters

buffer

ARC_ConsoleBuffer to destroy

ARC_ConsoleBuffer_GetLineNumbers()

uint32_t ARC_ConsoleBuffer_GetLineNumbers

(

ARC_ConsoleBuffer *

buffer

)

gets the number of lines from a console line buffer

Parameters

buffer

ARC_ConsoleBuffer get number of lines from

Returns

the number of lines within an ARC_ConsoleBuffer

ARC_ConsoleBuffer_Render()

void ARC_ConsoleBuffer_Render	(	ARC_ConsoleBuffer *	buffer,
		ARC_ConsoleView *	view )

renders a buffer to a ARC_ConsoleView

Parameters

buffer	ARC_ConsoleBuffer to render
view	ARC_ConsoleView to render the buffer contents to

ARC_ConsoleBuffer_RenderSection()

void ARC_ConsoleBuffer_RenderSection	(	ARC_ConsoleBuffer *	buffer,
		ARC_ConsoleView *	view,
		uint32_t	startIndex,
		uint32_t	lines )

renders a section of buffer to a ARC_ConsoleView

Parameters

buffer	ARC_ConsoleBuffer to render
view	ARC_ConsoleView to render the buffer contents to
startIndex	start index of buffer to render
lines	the number of lines of buffer to render