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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
/*
* *****************************************************************************
*
* SPDX-License-Identifier: BSD-2-Clause
*
* Copyright (c) 2018-2021 Gavin D. Howard and contributors.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* *****************************************************************************
*
* Definitions for implementing buffered I/O on my own terms.
*
*/
#ifndef BC_FILE_H
#define BC_FILE_H
#include <stdarg.h>
#include <history.h>
#include <vector.h>
#define BC_FILE_ULL_LENGTH (21)
#if BC_ENABLE_LINE_LIB
#include <stdio.h>
/// The file struct.
typedef struct BcFile
{
// The file. This is here simply to make the line lib code as compatible
// with the existing code as possible.
FILE* f;
} BcFile;
#else // BC_ENABLE_LINE_LIB
/// The file struct.
typedef struct BcFile
{
// The actual file descriptor.
int fd;
// The buffer for the file.
char* buf;
// The length (number of actual chars) in the buffer.
size_t len;
// The capacity (max number of chars) of the buffer.
size_t cap;
} BcFile;
#endif // BC_ENABLE_LINE_LIB
#if BC_ENABLE_HISTORY && !BC_ENABLE_LINE_LIB
/// Types of flushing. These are important because of history and printing
/// strings without newlines, something that users could use as their own
/// prompts.
typedef enum BcFlushType
{
/// Do not clear the stored partial line, but don't add to it.
BC_FLUSH_NO_EXTRAS_NO_CLEAR,
/// Do not clear the stored partial line and add to it.
BC_FLUSH_SAVE_EXTRAS_NO_CLEAR,
/// Clear the stored partial line and do not save the new stuff either.
BC_FLUSH_NO_EXTRAS_CLEAR,
/// Clear the stored partial line, but save the new stuff.
BC_FLUSH_SAVE_EXTRAS_CLEAR,
} BcFlushType;
#else // BC_ENABLE_HISTORY && !BC_ENABLE_LINE_LIB
// These make sure that the BcFlushType parameter disappears if history is not
// used, editline is used, or readline is used.
#define bc_file_putchar(f, t, c) bc_file_putchar(f, c)
#define bc_file_flushErr(f, t) bc_file_flushErr(f)
#define bc_file_flush(f, t) bc_file_flush(f)
#define bc_file_write(f, t, b, n) bc_file_write(f, b, n)
#define bc_file_puts(f, t, s) bc_file_puts(f, s)
#endif // BC_ENABLE_HISTORY && !BC_ENABLE_LINE_LIB
#if BC_ENABLE_LINE_LIB
/**
* Initialize a file.
* @param f The file to initialize.
* @param file The stdio file.
*/
void
bc_file_init(BcFile* f, FILE* file);
#else // BC_ENABLE_LINE_LIB
/**
* Initialize a file.
* @param f The file to initialize.
* @param fd The file descriptor.
* @param buf The buffer for the file.
* @param cap The capacity of the buffer.
*/
void
bc_file_init(BcFile* f, int fd, char* buf, size_t cap);
#endif // BC_ENABLE_LINE_LIB
/**
* Frees a file, including flushing it.
* @param f The file to free.
*/
void
bc_file_free(BcFile* f);
/**
* Print a char into the file.
* @param f The file to print to.
* @param type The flush type.
* @param c The character to write.
*/
void
bc_file_putchar(BcFile* restrict f, BcFlushType type, uchar c);
/**
* Flush and return an error if it failed. This is meant to be used when needing
* to flush in error situations when an error is already in flight. It would be
* a very bad deal to throw another error.
* @param f The file to flush.
* @param type The flush type.
* @return A status indicating if an error occurred.
*/
BcStatus
bc_file_flushErr(BcFile* restrict f, BcFlushType type);
/**
* Flush and throw an error on failure.
* @param f The file to flush.
* @param type The flush type.
*/
void
bc_file_flush(BcFile* restrict f, BcFlushType type);
/**
* Write the contents of buf to the file.
* @param f The file to flush.
* @param type The flush type.
* @param buf The buffer whose contents will be written to the file.
* @param n The length of buf.
*/
void
bc_file_write(BcFile* restrict f, BcFlushType type, const char* buf, size_t n);
/**
* Write to the file like fprintf would. This is very rudimentary.
* @param f The file to flush.
* @param fmt The format string.
*/
void
bc_file_printf(BcFile* restrict f, const char* fmt, ...);
/**
* Write to the file like vfprintf would. This is very rudimentary.
* @param f The file to flush.
* @param fmt The format string.
*/
void
bc_file_vprintf(BcFile* restrict f, const char* fmt, va_list args);
/**
* Write str to the file.
* @param f The file to flush.
* @param type The flush type.
* @param str The string to write to the file.
*/
void
bc_file_puts(BcFile* restrict f, BcFlushType type, const char* str);
#if BC_ENABLE_HISTORY && !BC_ENABLE_LINE_LIB
// Some constant flush types for ease of use.
extern const BcFlushType bc_flush_none;
extern const BcFlushType bc_flush_err;
extern const BcFlushType bc_flush_save;
#endif // BC_ENABLE_HISTORY && !BC_ENABLE_LINE_LIB
#endif // BC_FILE_H
|
