From 4ddc17ed9c1778aef0320304801492ad9c30450e Mon Sep 17 00:00:00 2001 From: Eugene Triguba Date: Thu, 4 Jul 2024 13:57:22 -0400 Subject: Tweak tests and read_word impl --- src/word.h | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'src/word.h') diff --git a/src/word.h b/src/word.h index 327116e..b5d94b5 100644 --- a/src/word.h +++ b/src/word.h @@ -3,9 +3,16 @@ #include +#define READ_WORD_ERR_READ -1 +#define READ_WORD_ERR_EOF 0 +#define READ_WORD_SUCCESS 1 + /** * Read in a word from a file up to size length. * + * If there is any leading whitespace, it will be discarded + * before starting to read in a word. + * * @param[in] fp The file to read a word from. * @param[out] word The word that was read as a null-terminated string. * @param[in] length The length of the word to read in. @@ -13,6 +20,8 @@ * @note `length` should be the number of characters you'd * like to read in plus one to take into account the * null terminator. + * + * @returns < 0 on read error; 0 on EOF; > 0 on success. */ int read_word(FILE *fp, char *word, size_t length); -- cgit v1.2.3