Telodendria/src/include/Stream.h

/*
 * Copyright (C) 2022-2023 Jordan Bancino <@jordan:bancino.net>
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation files
 * (the "Software"), to deal in the Software without restriction,
 * including without limitation the rights to use, copy, modify, merge,
 * publish, distribute, sublicense, and/or sell copies of the Software,
 * and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
#ifndef TELODENDRIA_STREAM_H
#define TELODENDRIA_STREAM_H

#include <Io.h>

#include <stdarg.h>

typedef struct Stream Stream;

extern Stream *
 StreamIo(Io * io);

extern Stream *
 StreamFd(int);

extern Stream *
 StreamFile(FILE *);

extern Stream *
 StreamOpen(const char *, const char *);

extern Stream *
 StreamStdout(void);

extern Stream *
 StreamStderr(void);

extern Stream *
 StreamStdin(void);

extern int
 StreamClose(Stream *);

extern int
 StreamVprintf(Stream *, const char *, va_list);

extern int
 StreamPrintf(Stream *, const char *,...);

extern int
 StreamGetc(Stream *);

extern int
 StreamUngetc(Stream *, int);

extern int
 StreamPutc(Stream *, int);

extern int
 StreamPuts(Stream *, char *);

extern char *
 StreamGets(Stream *, char *, int);

extern int
 StreamEof(Stream *);

extern int
 StreamError(Stream *);

extern void
 StreamClearError(Stream *);

extern int
 StreamFlush(Stream *);

extern ssize_t
 StreamCopy(Stream *, Stream *);

extern int
 StreamFileno(Stream *);

#endif                             /* TELODENDRIA_STREAM_H */