aboutsummaryrefslogtreecommitdiffstats
path: root/src/linebuffer.h
blob: b6f6e7e20501e5d2cc2f08d0205a96188832df56 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
#ifndef LINEBUFFER_H
#define LINEBUFFER_H

#include <stdio.h>
#include <stddef.h>

typedef struct {
    size_t _num_words;
    size_t _buffer_length;
    size_t _buffer_capacity;
    char *_buffer;
} LineBuffer;

/**
 * Create a new LineBuffer
 *
 * Args:
 *   line_length: The length of the buffer to use.
 *
 * Returns:
 *   The newly allocated LineBuffer; otherwise NULL
 *   if the allocation fails.
 */
LineBuffer *linebuffer_create(size_t line_length);

/**
 * Release any allocated memory for the LineBuffer
 *
 * Args:
 *   lb: The LineBuffer to destroy.
 */
void linebuffer_destroy(LineBuffer *lb);

/**
 * Clear the current buffer
 *
 * Args:
 *   lb: The LineBuffer to clear.
 */
void linebuffer_clear(LineBuffer *lb);

/**
 * Append a word to the end of the buffer.
 *
 * Args:
 *   lb: The line buffer to append to.
 *   word: The word to append.
 */
void linebuffer_append_word(LineBuffer *lb, const char *word);

/**
 * Check how many characters can be added.
 *
 * Args:
 *   lb: The line buffer to check the space of.
 *
 * Returns:
 *   The number of characters left in the line.
 */
size_t linebuffer_space_remaining(LineBuffer *lb);

/**
 * Write the current line.
 *
 * Args:
 *   lb: The line buffer to read.
 *   fp: The file to write out the line buffer to.
 *
 * Returns:
 *   >= 0 on success; EOF on error.
 */
int linebuffer_write(LineBuffer *lb, FILE *fp);

/**
 * Write the current line as justified text.
 *
 * Args:
 *   lb: The line buffer to read.
 *   fp: The file to write out the line buffer to.
 *
 * Returns:
 *   >= 0 on success; EOF on error.
 */
int linebuffer_write_justified(LineBuffer *lb, FILE *fp);

#endif