diff options
| author | David Robillard <d@drobilla.net> | 2018-02-10 13:32:06 +0100 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2020-06-21 18:12:03 +0200 |
| commit | 27ee06024c2d54a2340e83e5c90e919f8764ae0f (patch) | |
| tree | 75810ccb7871446552f41c76c10a0821c3d46d9c /serd/serd.h | |
| parent | 77b496a15d3c263a1bbc7c4cc56583f4014c1d22 (diff) | |
| download | serd-27ee06024c2d54a2340e83e5c90e919f8764ae0f.tar.gz serd-27ee06024c2d54a2340e83e5c90e919f8764ae0f.tar.bz2 serd-27ee06024c2d54a2340e83e5c90e919f8764ae0f.zip | |
Simplify reader interface
Diffstat (limited to 'serd/serd.h')
| -rw-r--r-- | serd/serd.h | 55 |
1 files changed, 18 insertions, 37 deletions
diff --git a/serd/serd.h b/serd/serd.h index 55232681..c848cdfe 100644 --- a/serd/serd.h +++ b/serd/serd.h @@ -25,7 +25,6 @@ #include <stdbool.h> #include <stddef.h> #include <stdint.h> -#include <stdio.h> #ifdef SERD_SHARED # ifdef _WIN32 @@ -844,34 +843,26 @@ serd_reader_read_file(SerdReader* reader, const char* uri); /** - Start an incremental read from a file handle. + Prepare to read from a stream. - Iff `bulk` is true, `file` will be read a page at a time. This is more - efficient, but uses a page of memory and means that an entire page of input - must be ready before any callbacks will fire. To react as soon as input - arrives, set `bulk` to false. + The `read_func` is guaranteed to only be called for `page_size` elements + with size 1 (i.e. `page_size` bytes). */ SERD_API SerdStatus -serd_reader_start_stream(SerdReader* reader, - FILE* file, - const char* name, - bool bulk); +serd_reader_start_stream(SerdReader* reader, + SerdSource read_func, + SerdStreamErrorFunc error_func, + void* stream, + const char* name, + size_t page_size); /** - Start an incremental read from a user-specified source. - - The `read_func` is guaranteed to only be called for `page_size` elements - with size 1 (i.e. `page_size` bytes). + Prepare to read from a string. */ SERD_API SerdStatus -serd_reader_start_source_stream(SerdReader* reader, - SerdSource read_func, - SerdStreamErrorFunc error_func, - void* stream, - const char* name, - size_t page_size); +serd_reader_start_string(SerdReader* reader, const char* utf8); /** Read a single "chunk" of data during an incremental read. @@ -886,32 +877,22 @@ SerdStatus serd_reader_read_chunk(SerdReader* reader); /** - Finish an incremental read from a file handle. -*/ -SERD_API -SerdStatus -serd_reader_end_stream(SerdReader* reader); + Read a complete document from the source. -/** - Read `file`. + This function will continue pulling from the source until a complete + document has been read. Note that this may block when used with streams, + for incremental reading use serd_reader_read_chunk(). */ SERD_API SerdStatus -serd_reader_read_file_handle(SerdReader* reader, - FILE* file, - const char* name); +serd_reader_read_document(SerdReader* reader); /** - Read a user-specified byte source. + Finish reading from the source. */ SERD_API SerdStatus -serd_reader_read_source(SerdReader* reader, - SerdSource source, - SerdStreamErrorFunc error, - void* stream, - const char* name, - size_t page_size); +serd_reader_end_stream(SerdReader* reader); /** Read `utf8`. |