Mercurial > repo
view interps/cfunge/cfunge-src/src/input.h @ 12514:500486b20e41 draft default tip
<int-e> slwd fungot//s/ds/d s/
author | HackEso <hackeso@esolangs.org> |
---|---|
date | Fri, 27 Sep 2024 20:43:06 +0100 |
parents | 859f9b4339e6 |
children |
line wrap: on
line source
/* -*- mode: C; coding: utf-8; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- * * cfunge - A standard-conforming Befunge93/98/109 interpreter in C. * Copyright (C) 2008-2009 Arvid Norlander <anmaster AT tele2 DOT se> * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at the proxy's option) any later version. Arvid Norlander is a * proxy who can decide which future versions of the GNU General Public * License can be used. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. */ /** * @file * The file input.c contains functions for reading user input from STDIN, * buffered as needed. */ #ifndef FUNGE_HAD_SRC_INPUT_H #define FUNGE_HAD_SRC_INPUT_H #include "global.h" #include <stdbool.h> /** * Return type of input_getint() */ typedef enum ret_getint { rgi_success = 0, ///< Successfully got an integer rgi_eof = 1, ///< We got an EOF and should reflect rgi_noint = 2, ///< We didn't get an int, please call us again. } ret_getint; /** * For use in input instruction & and in some fingerprints. * @param value Pointer to some memory to place the read integer in. * @param base What base to read the number as. * @return * Returns rgi_success if it got an integer in the given base, otherwise * rgi_noint or rgi_eof. * @note The read integer is returned in the value parameter. */ FUNGE_ATTR_NONNULL FUNGE_ATTR_WARN_UNUSED FUNGE_ATTR_FAST ret_getint input_getint(funge_cell * restrict value, int base); /** * For use in input instruction ~ and in some fingerprints. * This uses a buffer and read in one line (if the buffer is empty, * otherwise it reuse the values from the old buffer). * @param chr Pointer to a funge_cell to return value in. * @return True if we got a char, false if we got EOF and should reflect. */ FUNGE_ATTR_NONNULL FUNGE_ATTR_WARN_UNUSED FUNGE_ATTR_FAST bool input_getchar(funge_cell * restrict chr); /** * For use in input some fingerprints. * This will return the whole buffer. * @param str Pointer to a string pointer to fill in. * @return True if we got a string, false if we got EOF and should reflect. */ FUNGE_ATTR_NONNULL FUNGE_ATTR_WARN_UNUSED FUNGE_ATTR_FAST bool input_getline(unsigned char ** str); #endif