Split up public API header

1 files changed, 103 insertions, 0 deletions

diff --git a/include/serd/env.h b/include/serd/env.h
new file mode 100644
index 00000000..906ec2f7
--- /dev/null
+++ b/include/serd/env.h
@@ -0,0 +1,103 @@
+// Copyright 2011-2022 David Robillard <d@drobilla.net>
+// SPDX-License-Identifier: ISC
+
+#ifndef SERD_ENV_H
+#define SERD_ENV_H
+
+#include "serd/attributes.h"
+#include "serd/node.h"
+#include "serd/sink.h"
+#include "serd/status.h"
+#include "serd/string_view.h"
+#include "serd/uri.h"
+
+#include <stdbool.h>
+
+SERD_BEGIN_DECLS
+
+/**
+   @defgroup serd_env Environment
+   @ingroup serd_streaming
+   @{
+*/
+
+/// Lexical environment for relative URIs or CURIEs (base URI and namespaces)
+typedef struct SerdEnvImpl SerdEnv;
+
+/// Create a new environment
+SERD_API SerdEnv* SERD_ALLOCATED
+serd_env_new(const SerdNode* SERD_NULLABLE base_uri);
+
+/// Free `env`
+SERD_API void
+serd_env_free(SerdEnv* SERD_NULLABLE env);
+
+/// Get the current base URI
+SERD_API const SerdNode* SERD_NONNULL
+serd_env_base_uri(const SerdEnv* SERD_NONNULL env,
+                  SerdURIView* SERD_NULLABLE  out);
+
+/// Set the current base URI
+SERD_API SerdStatus
+serd_env_set_base_uri(SerdEnv* SERD_NONNULL         env,
+                      const SerdNode* SERD_NULLABLE uri);
+
+/**
+   Set a namespace prefix.
+
+   A namespace prefix is used to expand CURIE nodes, for example, with the
+   prefix "xsd" set to "http://www.w3.org/2001/XMLSchema#", "xsd:decimal" will
+   expand to "http://www.w3.org/2001/XMLSchema#decimal".
+*/
+SERD_API SerdStatus
+serd_env_set_prefix(SerdEnv* SERD_NONNULL        env,
+                    const SerdNode* SERD_NONNULL name,
+                    const SerdNode* SERD_NONNULL uri);
+
+/// Set a namespace prefix
+SERD_API SerdStatus
+serd_env_set_prefix_from_strings(SerdEnv* SERD_NONNULL    env,
+                                 const char* SERD_NONNULL name,
+                                 const char* SERD_NONNULL uri);
+
+/// Qualify `uri` into a CURIE if possible
+SERD_API bool
+serd_env_qualify(const SerdEnv* SERD_NULLABLE env,
+                 const SerdNode* SERD_NONNULL uri,
+                 SerdNode* SERD_NONNULL       prefix,
+                 SerdStringView* SERD_NONNULL suffix);
+
+/**
+   Expand `curie`.
+
+   Errors: SERD_ERR_BAD_ARG if `curie` is not valid, or SERD_ERR_BAD_CURIE if
+   prefix is not defined in `env`.
+*/
+SERD_API SerdStatus
+serd_env_expand(const SerdEnv* SERD_NULLABLE env,
+                const SerdNode* SERD_NONNULL curie,
+                SerdStringView* SERD_NONNULL uri_prefix,
+                SerdStringView* SERD_NONNULL uri_suffix);
+
+/**
+   Expand `node`, which must be a CURIE or URI, to a full URI.
+
+   Returns null if `node` can not be expanded.
+*/
+SERD_API SerdNode
+serd_env_expand_node(const SerdEnv* SERD_NULLABLE env,
+                     const SerdNode* SERD_NONNULL node);
+
+/// Call `func` for each prefix defined in `env`
+SERD_API void
+serd_env_foreach(const SerdEnv* SERD_NONNULL env,
+                 SerdPrefixFunc SERD_NONNULL func,
+                 void* SERD_NULLABLE         handle);
+
+/**
+   @}
+*/
+
+SERD_END_DECLS
+
+#endif // SERD_ENV_H