#include "microtar.h"
#include "logger.h"

Include dependency graph for bufferreader.h:

This graph shows which files directly or indirectly include this file:

Functions
BufferReader *	bufferreader_create ()

size_t	bufferreader_current_line (BufferReader *br)

char *	bufferreader_data (BufferReader *br)

size_t	bufferreader_data_length (BufferReader *br)

void	bufferreader_destroy (BufferReader *br)

char *	bufferreader_get_line (BufferReader br, char buffer, size_t length)

BufferReader *	bufferreader_init_from_file (BufferReader br, const char filepath, const char *failureMessage, LogLevel failureLevel)

BufferReader *	bufferreader_init_from_memory (BufferReader br, const char data, size_t length)

void	bufferreader_init_from_tar_file (BufferReader br, mtar_t tar, mtar_header_t *h)

char *	bufferreader_next_line (BufferReader *br)

Detailed Description

Implements a buffer reader.

Usage is: BufferReader *reader = bufferreader_create(); bufferreader_init_from_file(reader, opened_file); char *buf: while ((buf = bufferreader_next_line(reader)) != NULL) { (...) } bufferreader_destroy(reader);

Alternative is to access the buffer's full data through bufferreader_data() and bufferreader_data_length().

Buffer may and should be reused to avoid allocating/freeing memory all the time.

No function ever fails. In case not enough memory is available, {} is called.

Definition in file bufferreader.h.

Function Documentation

◆ bufferreader_create()

BufferReader* bufferreader_create ( )

Create a new BufferReader.

Returns: new buffer, never NULL.

Definition at line 31 of file bufferreader.cpp.

References fatal(), and OUT_OF_MEMORY.

Referenced by AssetCollector::AssetCollector(), bufferreader_init_from_file(), bufferreader_init_from_memory(), and TarLoader::TarLoader().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ bufferreader_current_line()

size_t bufferreader_current_line ( BufferReader * br )

Return the index of the last line returned by bufferreader_next_line().

Parameters

br	buffer to get the line index of.

Returns: line index, starting from 1.

Definition at line 140 of file bufferreader.cpp.

References BufferReader::line_index.

Referenced by init_formulae(), ArtifactLoader::load(), MessageLoader::load(), TreasureLoader::load(), QuestLoader::load(), load_bells(), load_citylife(), TreasureLoader::loadTreasure(), and LicenseManager::parseLicenseFile().

Here is the caller graph for this function:

◆ bufferreader_data()

char* bufferreader_data ( BufferReader * br )

Get the whole buffer, independently of the calls to bufferreader_next_line().

Parameters

br buffer.

Returns: buffer data, may be NULL.

Definition at line 148 of file bufferreader.cpp.

References BufferReader::buf.

Referenced by PngLoader::load(), and tar_read().

Here is the caller graph for this function:

◆ bufferreader_data_length()

size_t bufferreader_data_length ( BufferReader * br )

Return the length of the buffer data.

Parameters

br buffer.

Returns: buffer length.

Definition at line 144 of file bufferreader.cpp.

References BufferReader::buffer_length.

Referenced by PngLoader::load(), and tar_read().

Here is the caller graph for this function:

◆ bufferreader_destroy()

void bufferreader_destroy ( BufferReader * br )

Destroy a BufferReader.

Parameters

br	buffer to destroy, pointer becomes invalid after the call.

Definition at line 40 of file bufferreader.cpp.

References BufferReader::buf.

Referenced by accounts_load(), display_help_file(), i18n_init(), SoundFiles::refreshSounds(), ArchetypeWrapper::setRaw(), write_load(), AssetCollector::~AssetCollector(), and TarLoader::~TarLoader().

Here is the caller graph for this function:

◆ bufferreader_get_line()

char* bufferreader_get_line	(	BufferReader *	br,
		char *	buffer,
		size_t	length
	)

Copy the next line in the buffer, keeping the newline.

Parameters

br	buffer to get the line from.
buffer	where to put the line.
length	maximum length of buffer.

Returns: NULL if no more data is available, buffer else.

Definition at line 119 of file bufferreader.cpp.

References BufferReader::current_line, BufferReader::line_index, and MIN.

Referenced by load_object_from_reader().

Here is the caller graph for this function:

◆ bufferreader_init_from_file()

BufferReader* bufferreader_init_from_file	(	BufferReader *	br,
		const char *	filepath,
		const char *	failureMessage,
		LogLevel	failureLevel
	)

Initialize or create a BufferReader from a file path. The whole file is read into memory.

Parameters

br	buffer to initialize, if NULL then a new BufferReader is created.
filepath	path of the file to read.
failureMessage	message to LOG() in case of open failure. Must contain 2 placeholders 's' for the filepath and the error message.
failureLevel	log level to use in case of failure.