1 /* 2 * ***************************************************************************** 3 * 4 * SPDX-License-Identifier: BSD-2-Clause 5 * 6 * Copyright (c) 2018-2023 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 * Code to handle special I/O for bc. 33 * 34 */ 35 36 #ifndef BC_READ_H 37 #define BC_READ_H 38 39 #include <stdlib.h> 40 41 #include <status.h> 42 #include <vector.h> 43 44 /** 45 * Returns true if @a c is a non-ASCII (invalid) char. 46 * @param c The character to test. 47 * @return True if @a c is an invalid char. 48 */ 49 #define BC_READ_BIN_CHAR(c) (!(c)) 50 51 /** 52 * Reads a line from stdin after printing prompt, if desired. 53 * @param vec The vector to put the stdin data into. 54 * @param prompt The prompt to print, if desired. 55 */ 56 BcStatus 57 bc_read_line(BcVec* vec, const char* prompt); 58 59 /** 60 * Read a file and return a buffer with the data. The buffer must be freed by 61 * the caller. 62 * @param path The path to the file to read. 63 */ 64 char* 65 bc_read_file(const char* path); 66 67 /** 68 * Helper function for reading characters from stdin. This takes care of a bunch 69 * of complex error handling. Thus, it returns a status instead of throwing an 70 * error, except for fatal errors. 71 * @param vec The vec to put the stdin into. 72 * @param prompt The prompt to print, if desired. 73 */ 74 BcStatus 75 bc_read_chars(BcVec* vec, const char* prompt); 76 77 /** 78 * Read a line from buf into vec. 79 * @param vec The vector to read data into. 80 * @param buf The buffer to read from. 81 * @param buf_len The length of the buffer. 82 */ 83 bool 84 bc_read_buf(BcVec* vec, char* buf, size_t* buf_len); 85 86 #endif // BC_READ_H 87