solidc/stdstreams_8h_source.html

#ifndef E8CAA280_1C10_4862_B560_47F74D754175

#define E8CAA280_1C10_4862_B560_47F74D754175


#include "platform.h"


#include <stdbool.h>

#include <stdio.h>

#include <sys/types.h>


#ifdef __cplusplus

extern "C" {

#endif


/* -----------------------------------------------------------------------

 * Debug / release safety guards — zero overhead in release builds.

 * --------------------------------------------------------------------- */

#ifndef NDEBUG

#include <assert.h>

#define STREAM_ASSERT(x) assert(x)

#else

#define STREAM_ASSERT(x) ((void)0)

#endif


/* -----------------------------------------------------------------------

 * Terminal helpers

 * --------------------------------------------------------------------- */


bool readline(const char* prompt, char* buffer, size_t buffer_len);


int getpassword(const char* prompt, char* buffer, size_t buffer_len);


/* -----------------------------------------------------------------------

 * Stream type definitions

 * --------------------------------------------------------------------- */


typedef struct stream* stream_t;


typedef struct string_stream {

    char* data;

    size_t size;

    size_t capacity;

    size_t pos;

} string_stream;


/* -----------------------------------------------------------------------

 * Stream result type — mirrors POSIX read/write semantics

 * --------------------------------------------------------------------- */

typedef ssize_t stream_result_t;


/* -----------------------------------------------------------------------

 * Lifecycle

 * --------------------------------------------------------------------- */


stream_t create_file_stream(FILE* fp);


stream_t create_string_stream(size_t initial_capacity);


void stream_destroy(stream_t stream);


/* -----------------------------------------------------------------------

 * Seeking

 * --------------------------------------------------------------------- */


int stream_seek(stream_t stream, long offset, int whence);


/* -----------------------------------------------------------------------

 * File-stream helpers

 * --------------------------------------------------------------------- */


size_t file_stream_read(stream_t s, void* restrict ptr, size_t size, size_t count);


/* -----------------------------------------------------------------------

 * String-stream helpers

 * --------------------------------------------------------------------- */


int string_stream_write(stream_t stream, const char* str);


int string_stream_write_len(stream_t stream, const char* str, size_t n);


const char* string_stream_data(stream_t stream);


/* -----------------------------------------------------------------------

 * Delimited read

 * --------------------------------------------------------------------- */


ssize_t read_until(stream_t stream, int delim, char* buffer, size_t buffer_size);


/* -----------------------------------------------------------------------

 * Layer 1 — type-specialised fast paths

 * --------------------------------------------------------------------- */


unsigned long string_stream_copy_fast(stream_t dst, stream_t src);


/* -----------------------------------------------------------------------

 * Layer 2 — generic copy

 * --------------------------------------------------------------------- */


unsigned long io_copy(stream_t writer, stream_t reader);


unsigned long io_copy_n(stream_t writer, stream_t reader, size_t n);


#ifdef __cplusplus

}

#endif


#endif /* E8CAA280_1C10_4862_B560_47F74D754175 */

platform.h
Cross-platform compatibility definitions.

file_stream_read
size_t file_stream_read(stream_t s, void *restrict ptr, size_t size, size_t count)
Read up to count objects of size bytes from a file stream into ptr, rewinding to the beginning first.
Definition stdstreams.c:161

stream_destroy
void stream_destroy(stream_t stream)
Destroy a stream and release all connected resources.
Definition stdstreams.c:503

stream_seek
int stream_seek(stream_t stream, long offset, int whence)
Seek within a stream exactly matching POSIX fseek(3) semantics.
Definition stdstreams.c:125

string_stream_data
const char * string_stream_data(stream_t stream)
Fetch a read-only view of the underlying strictly NUL-terminated string data.
Definition stdstreams.c:302

readline
bool readline(const char *prompt, char *buffer, size_t buffer_len)
Read a line from stdin, optionally printing a prompt first.
Definition stdstreams.c:35

stream_t
struct stream * stream_t
Opaque stream handle.
Definition stdstreams.h:81

string_stream_write
int string_stream_write(stream_t stream, const char *str)
Append the NUL-terminated string str to stream.
Definition stdstreams.c:271

getpassword
int getpassword(const char *prompt, char *buffer, size_t buffer_len)
Read a password from the terminal with echo disabled.
Definition stdstreams.c:53

string_stream_write_len
int string_stream_write_len(stream_t stream, const char *str, size_t n)
Append the NUL-terminated string str to stream. This is faster than string_stream_write when the leng...
Definition stdstreams.c:287

io_copy_n
unsigned long io_copy_n(stream_t writer, stream_t reader, size_t n)
Copy tightly capped chunk up to n bytes.
Definition stdstreams.c:451

create_file_stream
stream_t create_file_stream(FILE *fp)
Wrap an existing FILE* in a standardized stream context.
Definition stdstreams.c:145

string_stream_copy_fast
unsigned long string_stream_copy_fast(stream_t dst, stream_t src)
Direct memory-bound string to string copy without generic dispatch.
Definition stdstreams.c:394

io_copy
unsigned long io_copy(stream_t writer, stream_t reader)
Copy contents universally from reader into writer.
Definition stdstreams.c:427

create_string_stream
stream_t create_string_stream(size_t initial_capacity)
Allocate a new in-memory string stream.
Definition stdstreams.c:307

read_until
ssize_t read_until(stream_t stream, int delim, char *buffer, size_t buffer_size)
Read from stream into buffer until delim is found.
Definition stdstreams.c:344

string_stream
String stream internal state structure.
Definition stdstreams.h:91

string_stream::size
size_t size
Definition stdstreams.h:93

string_stream::capacity
size_t capacity
Definition stdstreams.h:94

string_stream::data
char * data
Definition stdstreams.h:92

string_stream::pos
size_t pos
Definition stdstreams.h:95