aboutsummaryrefslogtreecommitdiffstats
path: root/include/serd/serd.h
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2021-04-12 22:54:20 -0400
committerDavid Robillard <d@drobilla.net>2021-04-12 23:40:12 -0400
commit9a417d684750af2f812289c1439ca8e73fd7b3f2 (patch)
tree833176c6ab5c50dd344acfc61104f798ddcd3630 /include/serd/serd.h
parent5ea3ffb3ae0d5d718f5f2077e61af21470856d6c (diff)
downloadserd-9a417d684750af2f812289c1439ca8e73fd7b3f2.tar.gz
serd-9a417d684750af2f812289c1439ca8e73fd7b3f2.tar.bz2
serd-9a417d684750af2f812289c1439ca8e73fd7b3f2.zip
Group API declarations by topic
Diffstat (limited to 'include/serd/serd.h')
-rw-r--r--include/serd/serd.h89
1 files changed, 47 insertions, 42 deletions
diff --git a/include/serd/serd.h b/include/serd/serd.h
index 32488e18..2fab2695 100644
--- a/include/serd/serd.h
+++ b/include/serd/serd.h
@@ -1,5 +1,5 @@
/*
- Copyright 2011-2020 David Robillard <d@drobilla.net>
+ Copyright 2011-2021 David Robillard <d@drobilla.net>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
@@ -83,7 +83,6 @@ extern "C" {
/**
@defgroup serd Serd C API
- This is the complete public C API of serd.
@{
*/
@@ -96,19 +95,6 @@ typedef struct SerdReaderImpl SerdReader;
/// Streaming serialiser that writes a text stream as statements are pushed
typedef struct SerdWriterImpl SerdWriter;
-/// Return status code
-typedef enum {
- SERD_SUCCESS, ///< No error
- SERD_FAILURE, ///< Non-fatal failure
- SERD_ERR_UNKNOWN, ///< Unknown error
- SERD_ERR_BAD_SYNTAX, ///< Invalid syntax
- SERD_ERR_BAD_ARG, ///< Invalid argument
- SERD_ERR_NOT_FOUND, ///< Not found
- SERD_ERR_ID_CLASH, ///< Encountered clashing blank node IDs
- SERD_ERR_BAD_CURIE, ///< Invalid CURIE (e.g. prefix does not exist)
- SERD_ERR_INTERNAL ///< Unexpected internal error (should not happen)
-} SerdStatus;
-
/// RDF syntax type
typedef enum {
SERD_TURTLE = 1, ///< Terse triples http://www.w3.org/TR/turtle
@@ -210,32 +196,6 @@ typedef struct {
size_t len; ///< Length of chunk in bytes
} SerdChunk;
-/// An error description
-typedef struct {
- SerdStatus status; ///< Error code
- const uint8_t* SERD_NULLABLE filename; ///< File with error
- unsigned line; ///< Line in file with error or 0
- unsigned col; ///< Column in file with error
- const char* SERD_NONNULL fmt; ///< Printf-style format string
- va_list* SERD_NONNULL args; ///< Arguments for fmt
-} SerdError;
-
-/**
- A parsed URI
-
- This struct directly refers to chunks in other strings, it does not own any
- memory itself. Thus, URIs can be parsed and/or resolved against a base URI
- in-place without allocating memory.
-*/
-typedef struct {
- SerdChunk scheme; ///< Scheme
- SerdChunk authority; ///< Authority
- SerdChunk path_base; ///< Path prefix if relative
- SerdChunk path; ///< Path suffix
- SerdChunk query; ///< Query
- SerdChunk fragment; ///< Fragment
-} SerdURI;
-
/**
Syntax style options.
@@ -263,16 +223,35 @@ void
serd_free(void* SERD_NULLABLE ptr);
/**
- @defgroup serd_string String Utilities
+ @defgroup serd_status Status Codes
@{
*/
+/// Return status code
+typedef enum {
+ SERD_SUCCESS, ///< No error
+ SERD_FAILURE, ///< Non-fatal failure
+ SERD_ERR_UNKNOWN, ///< Unknown error
+ SERD_ERR_BAD_SYNTAX, ///< Invalid syntax
+ SERD_ERR_BAD_ARG, ///< Invalid argument
+ SERD_ERR_NOT_FOUND, ///< Not found
+ SERD_ERR_ID_CLASH, ///< Encountered clashing blank node IDs
+ SERD_ERR_BAD_CURIE, ///< Invalid CURIE (e.g. prefix does not exist)
+ SERD_ERR_INTERNAL ///< Unexpected internal error (should not happen)
+} SerdStatus;
+
/// Return a string describing a status code
SERD_CONST_API
const uint8_t* SERD_NONNULL
serd_strerror(SerdStatus status);
/**
+ @}
+ @defgroup serd_string String Utilities
+ @{
+*/
+
+/**
Measure a UTF-8 string.
@return Length of `str` in characters (except NULL).
@@ -358,6 +337,22 @@ typedef size_t (*SerdSink)(const void* SERD_NONNULL buf,
@{
*/
+/**
+ A parsed URI
+
+ This struct directly refers to chunks in other strings, it does not own any
+ memory itself. Thus, URIs can be parsed and/or resolved against a base URI
+ in-place without allocating memory.
+*/
+typedef struct {
+ SerdChunk scheme; ///< Scheme
+ SerdChunk authority; ///< Authority
+ SerdChunk path_base; ///< Path prefix if relative
+ SerdChunk path; ///< Path suffix
+ SerdChunk query; ///< Query
+ SerdChunk fragment; ///< Fragment
+} SerdURI;
+
static const SerdURI SERD_URI_NULL =
{{NULL, 0}, {NULL, 0}, {NULL, 0}, {NULL, 0}, {NULL, 0}, {NULL, 0}};
@@ -598,6 +593,16 @@ serd_node_free(SerdNode* SERD_NULLABLE node);
@{
*/
+/// An error description
+typedef struct {
+ SerdStatus status; ///< Error code
+ const uint8_t* SERD_NULLABLE filename; ///< File with error
+ unsigned line; ///< Line in file with error or 0
+ unsigned col; ///< Column in file with error
+ const char* SERD_NONNULL fmt; ///< Printf-style format string
+ va_list* SERD_NONNULL args; ///< Arguments for fmt
+} SerdError;
+
/**
Sink (callback) for errors.