ggetws.h

/** ggetws.h
  *
  * `wchar_t` implementations for `ggets` and `fggets`.
  *
  * Copyright (C) 2020 James D. Lin <jamesdlin@berkeley.edu>
  *
  * The latest version of this file can be downloaded from:
  * <https://github.com/jamesderlin/getline-compatible>
  *
  * This software is provided 'as-is', without any express or implied
  * warranty.  In no event will the authors be held liable for any damages
  * arising from the use of this software.
  *
  * Permission is granted to anyone to use this software for any purpose,
  * including commercial applications, and to alter it and redistribute it
  * freely, subject to the following restrictions:
  *
  * 1. The origin of this software must not be misrepresented; you must not
  *    claim that you wrote the original software. If you use this software
  *    in a product, an acknowledgment in the product documentation would be
  *    appreciated but is not required.
  *
  * 2. Altered source versions must be plainly marked as such, and must not be
  *    misrepresented as being the original software.
  *
  * 3. This notice may not be removed or altered from any source distribution.
  */

#ifndef GGETWS_COMPATIBLE_H
#define GGETWS_COMPATIBLE_H

#include <stdio.h>
#include <wchar.h>


/** fggetws
  *
  *     A `wchar_t` version of `fggets`.
  *
  *     Unlike `fggets`, returns `WEOF` instead of `EOF` if the end-of-file
  *     indicator for `stream` is set.
  */
int fggetws(wchar_t** line, FILE* stream);


/** ggetws
  *
  *     Equivalent to `fggetws(line, stdin)`.
  */
int ggetws(wchar_t** line);


/** fggetws_univ
  *
  *     A version of `fggetws` that recognizes CR, LF, or CR-LF as line
  *     endings, regardless of the platform and of `stream`'s mode.
  */
int fggetws_univ(wchar_t** line, FILE* stream);

#endif /* GGETWS_COMPATIBLE_H */