diff options
Diffstat (limited to 'seriatom')
-rw-r--r-- | seriatom/seriatom.h | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/seriatom/seriatom.h b/seriatom/seriatom.h new file mode 100644 index 0000000..8381778 --- /dev/null +++ b/seriatom/seriatom.h @@ -0,0 +1,88 @@ +/* + Copyright 2012 David Robillard <http://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 + copyright notice and this permission notice appear in all copies. + + THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +*/ + +/** + @file seriatom.h API for Seriatom, an LV2 Atom RDF serialisation library. +*/ + +#ifndef SERIATOM_SERIATOM_H +#define SERIATOM_SERIATOM_H + +#include <stdint.h> + +#include "lv2/lv2plug.in/ns/ext/atom/atom.h" +#include "lv2/lv2plug.in/ns/ext/urid/urid.h" +#include "serd/serd.h" + +#ifdef SERIATOM_SHARED +# ifdef _WIN32 +# define SERIATOM_LIB_IMPORT __declspec(dllimport) +# define SERIATOM_LIB_EXPORT __declspec(dllexport) +# else +# define SERIATOM_LIB_IMPORT __attribute__((visibility("default"))) +# define SERIATOM_LIB_EXPORT __attribute__((visibility("default"))) +# endif +# ifdef SERIATOM_INTERNAL +# define SERIATOM_API SERIATOM_LIB_EXPORT +# else +# define SERIATOM_API SERIATOM_LIB_IMPORT +# endif +#else +# define SERIATOM_API +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +/** + @defgroup seriatom Seriatom + An LV2 Atom RDF serialisation library. + @{ +*/ + +/** + Serialise an Atom to a SerdWriter. +*/ +SERIATOM_API +void +atom_to_rdf(SerdWriter* writer, + LV2_URID_Unmap* unmap, + const SerdNode* subject, + const SerdNode* predicate, + const LV2_Atom* atom, + uint32_t flags); + +/** + Serialise an Atom to a Turtle string. + The returned string must be free()'d by the caller. +*/ +SERIATOM_API +char* +atom_to_turtle(LV2_URID_Unmap* unmap, + const SerdNode* subject, + const SerdNode* predicate, + const LV2_Atom* atom); + +/** + @} +*/ + +#ifdef __cplusplus +} /* extern "C" */ +#endif + +#endif /* SERIATOM_SERIATOM_H */ |