include/file.h

   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 <history.h>
  42 #include <vector.h>
  43
  44 #define BC_FILE_ULL_LENGTH (21)
  45
  46 #if BC_ENABLE_LINE_LIB
  47
  48 #include <stdio.h>
  49
  50 /// The file struct.
  51 typedef struct BcFile
  52 {
  53         // The file. This is here simply to make the line lib code as compatible
  54         // with the existing code as possible.
  55         FILE* f;
  56
  57 } BcFile;
  58
  59 #else // BC_ENABLE_LINE_LIB
  60
  61 /// The file struct.
  62 typedef struct BcFile
  63 {
  64         // The actual file descriptor.
  65         int fd;
  66
  67         // The buffer for the file.
  68         char* buf;
  69
  70         // The length (number of actual chars) in the buffer.
  71         size_t len;
  72
  73         // The capacity (max number of chars) of the buffer.
  74         size_t cap;
  75
  76 } BcFile;
  77
  78 #endif // BC_ENABLE_LINE_LIB
  79
  80 #if BC_ENABLE_HISTORY && !BC_ENABLE_LINE_LIB
  81
  82 /// Types of flushing. These are important because of history and printing
  83 /// strings without newlines, something that users could use as their own
  84 /// prompts.
  85 typedef enum BcFlushType
  86 {
  87         /// Do not clear the stored partial line, but don't add to it.
  88         BC_FLUSH_NO_EXTRAS_NO_CLEAR,
  89
  90         /// Do not clear the stored partial line and add to it.
  91         BC_FLUSH_SAVE_EXTRAS_NO_CLEAR,
  92
  93         /// Clear the stored partial line and do not save the new stuff either.
  94         BC_FLUSH_NO_EXTRAS_CLEAR,
  95
  96         /// Clear the stored partial line, but save the new stuff.
  97         BC_FLUSH_SAVE_EXTRAS_CLEAR,
  98
  99 } BcFlushType;
 100
 101 #else // BC_ENABLE_HISTORY && !BC_ENABLE_LINE_LIB
 102
 103 // These make sure that the BcFlushType parameter disappears if history is not
 104 // used, editline is used, or readline is used.
 105
 106 #define bc_file_putchar(f, t, c) bc_file_putchar(f, c)
 107 #define bc_file_flushErr(f, t) bc_file_flushErr(f)
 108 #define bc_file_flush(f, t) bc_file_flush(f)
 109 #define bc_file_write(f, t, b, n) bc_file_write(f, b, n)
 110 #define bc_file_puts(f, t, s) bc_file_puts(f, s)
 111
 112 #endif // BC_ENABLE_HISTORY && !BC_ENABLE_LINE_LIB
 113
 114 #if BC_ENABLE_LINE_LIB
 115
 116 /**
 117  * Initialize a file.
 118  * @param f     The file to initialize.
 119  * @param file  The stdio file.
 120  */
 121 void
 122 bc_file_init(BcFile* f, FILE* file);
 123
 124 #else // BC_ENABLE_LINE_LIB
 125
 126 /**
 127  * Initialize a file.
 128  * @param f    The file to initialize.
 129  * @param fd   The file descriptor.
 130  * @param buf  The buffer for the file.
 131  * @param cap  The capacity of the buffer.
 132  */
 133 void
 134 bc_file_init(BcFile* f, int fd, char* buf, size_t cap);
 135
 136 #endif // BC_ENABLE_LINE_LIB
 137
 138 /**
 139  * Frees a file, including flushing it.
 140  * @param f  The file to free.
 141  */
 142 void
 143 bc_file_free(BcFile* f);
 144
 145 /**
 146  * Print a char into the file.
 147  * @param f     The file to print to.
 148  * @param type  The flush type.
 149  * @param c     The character to write.
 150  */
 151 void
 152 bc_file_putchar(BcFile* restrict f, BcFlushType type, uchar c);
 153
 154 /**
 155  * Flush and return an error if it failed. This is meant to be used when needing
 156  * to flush in error situations when an error is already in flight. It would be
 157  * a very bad deal to throw another error.
 158  * @param f     The file to flush.
 159  * @param type  The flush type.
 160  * @return      A status indicating if an error occurred.
 161  */
 162 BcStatus
 163 bc_file_flushErr(BcFile* restrict f, BcFlushType type);
 164
 165 /**
 166  * Flush and throw an error on failure.
 167  * @param f     The file to flush.
 168  * @param type  The flush type.
 169  */
 170 void
 171 bc_file_flush(BcFile* restrict f, BcFlushType type);
 172
 173 /**
 174  * Write the contents of buf to the file.
 175  * @param f     The file to flush.
 176  * @param type  The flush type.
 177  * @param buf   The buffer whose contents will be written to the file.
 178  * @param n     The length of buf.
 179  */
 180 void
 181 bc_file_write(BcFile* restrict f, BcFlushType type, const char* buf, size_t n);
 182
 183 /**
 184  * Write to the file like fprintf would. This is very rudimentary.
 185  * @param f    The file to flush.
 186  * @param fmt  The format string.
 187  */
 188 void
 189 bc_file_printf(BcFile* restrict f, const char* fmt, ...);
 190
 191 /**
 192  * Write to the file like vfprintf would. This is very rudimentary.
 193  * @param f    The file to flush.
 194  * @param fmt  The format string.
 195  */
 196 void
 197 bc_file_vprintf(BcFile* restrict f, const char* fmt, va_list args);
 198
 199 /**
 200  * Write str to the file.
 201  * @param f     The file to flush.
 202  * @param type  The flush type.
 203  * @param str   The string to write to the file.
 204  */
 205 void
 206 bc_file_puts(BcFile* restrict f, BcFlushType type, const char* str);
 207
 208 #if BC_ENABLE_HISTORY && !BC_ENABLE_LINE_LIB
 209
 210 // Some constant flush types for ease of use.
 211 extern const BcFlushType bc_flush_none;
 212 extern const BcFlushType bc_flush_err;
 213 extern const BcFlushType bc_flush_save;
 214
 215 #endif // BC_ENABLE_HISTORY && !BC_ENABLE_LINE_LIB
 216
 217 #endif // BC_FILE_H