diff options
author | David Robillard <d@drobilla.net> | 2012-02-23 02:41:59 +0000 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2012-02-23 02:41:59 +0000 |
commit | f6e4bb2bf9fb001d1c4b0a26eba45da8445dfa6e (patch) | |
tree | d4e051c22b65e279ec618856087d6ef257f53e4e /sratom/seriatom.h | |
parent | 0dc45244615ff7e8c76b1a8a5f585f03dbc6a0bc (diff) | |
download | sratom-f6e4bb2bf9fb001d1c4b0a26eba45da8445dfa6e.tar.gz sratom-f6e4bb2bf9fb001d1c4b0a26eba45da8445dfa6e.tar.bz2 sratom-f6e4bb2bf9fb001d1c4b0a26eba45da8445dfa6e.zip |
Seriatom => Sratom.
git-svn-id: http://svn.drobilla.net/lad/trunk/sratom@3994 a436a847-0d15-0410-975c-d299462d15a1
Diffstat (limited to 'sratom/seriatom.h')
-rw-r--r-- | sratom/seriatom.h | 120 |
1 files changed, 120 insertions, 0 deletions
diff --git a/sratom/seriatom.h b/sratom/seriatom.h new file mode 100644 index 0000000..1fe2547 --- /dev/null +++ b/sratom/seriatom.h @@ -0,0 +1,120 @@ +/* + 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. + @{ +*/ + +/** + Atom serialiser. +*/ +typedef struct SeriatomImpl Seriatom; + +/** + Create a new Atom serialiser. +*/ +SERIATOM_API +Seriatom* +seriatom_new(LV2_URID_Map* map, + LV2_URID_Unmap* unmap); + +/** + Free an Atom serialisation. +*/ +SERIATOM_API +void +seriatom_free(Seriatom* seriatom); + +/** + Serialise an Atom to a SerdWriter. +*/ +SERIATOM_API +void +atom_to_rdf(Seriatom* seriatom, + const SerdNode* subject, + const SerdNode* predicate, + const LV2_Atom* atom, + uint32_t flags); + +/** + Serialise an Atom body to a SerdWriter. +*/ +SERIATOM_API +void +atom_body_to_rdf(Seriatom* seriatom, + const SerdNode* subject, + const SerdNode* predicate, + uint32_t type_urid, + uint32_t size, + const void* body, + 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(Seriatom* seriatom, + const SerdNode* subject, + const SerdNode* predicate, + const LV2_Atom* atom); + +/** + @} +*/ + +#ifdef __cplusplus +} /* extern "C" */ +#endif + +#endif /* SERIATOM_SERIATOM_H */ |