Crossfire Server  1.75.0
bufferreader.h
Go to the documentation of this file.
1 /*
2  * Crossfire -- cooperative multi-player graphical RPG and adventure game
3  *
4  * Copyright (c) 2021 the Crossfire Development Team
5  *
6  * Crossfire is free software and comes with ABSOLUTELY NO WARRANTY. You are
7  * welcome to redistribute it under certain conditions. For details, please
8  * see COPYING and LICENSE.
9  *
10  * The authors can be reached via e-mail at <crossfire@metalforge.org>.
11  */
12 
37 #ifndef BUFFERREADER_H
38 #define BUFFERREADER_H
39 
40 #include "microtar.h"
41 #include "logger.h"
42 
46 struct BufferReader;
47 
52 BufferReader *bufferreader_create();
53 
58 void bufferreader_destroy(BufferReader *br);
59 
71 BufferReader *bufferreader_init_from_file(BufferReader *br, const char *filepath, const char *failureMessage, LogLevel failureLevel);
72 
79 void bufferreader_init_from_tar_file(BufferReader *br, mtar_t *tar, mtar_header_t *h);
80 
88 BufferReader *bufferreader_init_from_memory(BufferReader *br, const char *data, size_t length);
89 
95 char *bufferreader_next_line(BufferReader *br);
96 
104 char *bufferreader_get_line(BufferReader *br, char *buffer, size_t length);
105 
111 size_t bufferreader_current_line(BufferReader *br);
112 
118 size_t bufferreader_data_length(BufferReader *br);
119 
125 char *bufferreader_data(BufferReader *br);
126 
127 #endif /* BUFFERREADER_H */
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.
Definition: bufferreader.cpp:65
mtar_header_t
Definition: microtar.h:38
bufferreader_destroy
void bufferreader_destroy(BufferReader *br)
Destroy a BufferReader.
Definition: bufferreader.cpp:40
bufferreader_current_line
size_t bufferreader_current_line(BufferReader *br)
Return the index of the last line returned by bufferreader_next_line().
Definition: bufferreader.cpp:140
bufferreader_create
BufferReader * bufferreader_create()
Create a new BufferReader.
Definition: bufferreader.cpp:31
LogLevel
LogLevel
Log levels for the LOG() function.
Definition: logger.h:10
bufferreader_get_line
char * bufferreader_get_line(BufferReader *br, char *buffer, size_t length)
Copy the next line in the buffer, keeping the newline.
Definition: bufferreader.cpp:119
bufferreader_data_length
size_t bufferreader_data_length(BufferReader *br)
Return the length of the buffer data.
Definition: bufferreader.cpp:144
logger.h
Log levels.
bufferreader_next_line
char * bufferreader_next_line(BufferReader *br)
Return the next line in the buffer, as separated by a newline.
Definition: bufferreader.cpp:102
mtar_t
Definition: microtar.h:51
bufferreader_init_from_memory
BufferReader * bufferreader_init_from_memory(BufferReader *br, const char *data, size_t length)
Initialize or create a BufferReader from a memory block.
Definition: bufferreader.cpp:93
bufferreader_data
char * bufferreader_data(BufferReader *br)
Get the whole buffer, independently of the calls to bufferreader_next_line().
Definition: bufferreader.cpp:148
bufferreader_init_from_tar_file
void bufferreader_init_from_tar_file(BufferReader *br, mtar_t *tar, mtar_header_t *h)
Initialize a BufferReader from a tar file entry.
Definition: bufferreader.cpp:88