1/*
2 * *****************************************************************************
3 *
4 * SPDX-License-Identifier: BSD-2-Clause
5 *
6 * Copyright (c) 2018-2021 Gavin D. Howard and contributors.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
10 *
11 * * Redistributions of source code must retain the above copyright notice, this
12 *   list of conditions and the following disclaimer.
13 *
14 * * Redistributions in binary form must reproduce the above copyright notice,
15 *   this list of conditions and the following disclaimer in the documentation
16 *   and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
29 *
30 * *****************************************************************************
31 *
32 * Definitions for implementing buffered I/O on my own terms.
33 *
34 */
35
36#ifndef BC_FILE_H
37#define BC_FILE_H
38
39#include <stdarg.h>
40
41#include <vector.h>
42
43#define BC_FILE_ULL_LENGTH (21)
44
45typedef struct BcFile {
46
47	int fd;
48	char *buf;
49	size_t len;
50	size_t cap;
51
52} BcFile;
53
54#if BC_ENABLE_HISTORY
55typedef enum BcFlushType {
56
57	BC_FLUSH_NO_EXTRAS_NO_CLEAR,
58	BC_FLUSH_SAVE_EXTRAS_NO_CLEAR,
59	BC_FLUSH_NO_EXTRAS_CLEAR,
60	BC_FLUSH_SAVE_EXTRAS_CLEAR,
61
62} BcFlushType;
63#else // BC_ENABLE_HISTORY
64#define bc_file_putchar(f, t, c) bc_file_putchar(f, c)
65#define bc_file_flushErr(f, t) bc_file_flushErr(f)
66#define bc_file_flush(f, t) bc_file_flush(f)
67#define bc_file_write(f, t, b, n) bc_file_write(f, b, n)
68#define bc_file_puts(f, t, s) bc_file_puts(f, s)
69#endif // BC_ENABLE_HISTORY
70
71void bc_file_init(BcFile *f, int fd, char *buf, size_t cap);
72void bc_file_free(BcFile *f);
73
74void bc_file_putchar(BcFile *restrict f, BcFlushType type, uchar c);
75BcStatus bc_file_flushErr(BcFile *restrict f, BcFlushType type);
76void bc_file_flush(BcFile *restrict f, BcFlushType type);
77void bc_file_write(BcFile *restrict f, BcFlushType type,
78                   const char *buf, size_t n);
79void bc_file_printf(BcFile *restrict f, const char *fmt, ...);
80void bc_file_vprintf(BcFile *restrict f, const char *fmt, va_list args);
81void bc_file_puts(BcFile *restrict f, BcFlushType type, const char *str);
82
83#if BC_ENABLE_HISTORY
84extern const BcFlushType bc_flush_none;
85extern const BcFlushType bc_flush_err;
86extern const BcFlushType bc_flush_save;
87#endif // BC_ENABLE_HISTORY
88
89#endif // BC_FILE_H
90