cannam@110: /* cannam@110: Copyright 2011-2013 David Robillard cannam@110: cannam@110: Permission to use, copy, modify, and/or distribute this software for any cannam@110: purpose with or without fee is hereby granted, provided that the above cannam@110: copyright notice and this permission notice appear in all copies. cannam@110: cannam@110: THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES cannam@110: WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF cannam@110: MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR cannam@110: ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES cannam@110: WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN cannam@110: ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF cannam@110: OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. cannam@110: */ cannam@110: cannam@110: /** cannam@110: @file sord.h API for Sord, a lightweight RDF model library. cannam@110: */ cannam@110: cannam@110: #ifndef SORD_SORD_H cannam@110: #define SORD_SORD_H cannam@110: cannam@110: #include cannam@110: #include cannam@110: #include cannam@110: cannam@110: #include "serd/serd.h" cannam@110: cannam@110: #ifdef SORD_SHARED cannam@110: # ifdef _WIN32 cannam@110: # define SORD_LIB_IMPORT __declspec(dllimport) cannam@110: # define SORD_LIB_EXPORT __declspec(dllexport) cannam@110: # else cannam@110: # define SORD_LIB_IMPORT __attribute__((visibility("default"))) cannam@110: # define SORD_LIB_EXPORT __attribute__((visibility("default"))) cannam@110: # endif cannam@110: # ifdef SORD_INTERNAL cannam@110: # define SORD_API SORD_LIB_EXPORT cannam@110: # else cannam@110: # define SORD_API SORD_LIB_IMPORT cannam@110: # endif cannam@110: #else cannam@110: # define SORD_API cannam@110: #endif cannam@110: cannam@110: #ifdef __cplusplus cannam@110: extern "C" { cannam@110: #else cannam@110: # include cannam@110: #endif cannam@110: cannam@110: /** cannam@110: @defgroup sord Sord cannam@110: A lightweight RDF model library. cannam@110: cannam@110: Sord stores RDF (subject object predicate context) quads, where the context cannam@110: may be omitted (to represent triples in the default graph). cannam@110: @{ cannam@110: */ cannam@110: cannam@110: /** cannam@110: Sord World. cannam@110: The World represents all library state, including interned strings. cannam@110: */ cannam@110: typedef struct SordWorldImpl SordWorld; cannam@110: cannam@110: /** cannam@110: Sord Model. cannam@110: cannam@110: A model is an indexed set of Quads (i.e. it can contain several RDF cannam@110: graphs). It may be searched using various patterns depending on which cannam@110: indices are enabled. cannam@110: */ cannam@110: typedef struct SordModelImpl SordModel; cannam@110: cannam@110: /** cannam@110: Model Inserter. cannam@110: cannam@110: An inserter is used for writing statements to a model using the Serd sink cannam@110: interface. This makes it simple to write to a model directly using a cannam@110: SerdReader, or any other code that writes statements to a SerdStatementSink. cannam@110: */ cannam@110: typedef struct SordInserterImpl SordInserter; cannam@110: cannam@110: /** cannam@110: Model Iterator. cannam@110: */ cannam@110: typedef struct SordIterImpl SordIter; cannam@110: cannam@110: /** cannam@110: RDF Node. cannam@110: A Node is a component of a Quad. Nodes may be URIs, blank nodes, or cannam@110: (in the case of quad objects only) string literals. Literal nodes may cannam@110: have an associate language or datatype (but not both). cannam@110: */ cannam@110: typedef struct SordNodeImpl SordNode; cannam@110: cannam@110: /** cannam@110: Quad of nodes (a statement), or a quad pattern. cannam@110: cannam@110: Nodes are ordered (S P O G). The ID of the default graph is 0. cannam@110: */ cannam@110: typedef const SordNode* SordQuad[4]; cannam@110: cannam@110: /** cannam@110: Index into a SordQuad. cannam@110: */ cannam@110: typedef enum { cannam@110: SORD_SUBJECT = 0, /**< Subject */ cannam@110: SORD_PREDICATE = 1, /**< Predicate (a.k.a. "key") */ cannam@110: SORD_OBJECT = 2, /**< Object (a.k.a. "value") */ cannam@110: SORD_GRAPH = 3 /**< Graph (a.k.a. "context") */ cannam@110: } SordQuadIndex; cannam@110: cannam@110: /** cannam@110: Type of a node. cannam@110: */ cannam@110: typedef enum { cannam@110: SORD_URI = 1, /**< URI */ cannam@110: SORD_BLANK = 2, /**< Blank node identifier */ cannam@110: SORD_LITERAL = 3 /**< Literal (string with optional lang or datatype) */ cannam@110: } SordNodeType; cannam@110: cannam@110: /** cannam@110: Indexing option. cannam@110: */ cannam@110: typedef enum { cannam@110: SORD_SPO = 1, /**< Subject, Predicate, Object */ cannam@110: SORD_SOP = 1 << 1, /**< Subject, Object, Predicate */ cannam@110: SORD_OPS = 1 << 2, /**< Object, Predicate, Subject */ cannam@110: SORD_OSP = 1 << 3, /**< Object, Subject, Predicate */ cannam@110: SORD_PSO = 1 << 4, /**< Predicate, Subject, Object */ cannam@110: SORD_POS = 1 << 5 /**< Predicate, Object, Subject */ cannam@110: } SordIndexOption; cannam@110: cannam@110: /** cannam@110: @name World cannam@110: @{ cannam@110: */ cannam@110: cannam@110: /** cannam@110: Create a new Sord World. cannam@110: It is safe to use multiple worlds in one process, though no data cannam@110: (e.g. nodes) can be shared between worlds, and this should be avoided if cannam@110: possible for performance reasons. cannam@110: */ cannam@110: SORD_API cannam@110: SordWorld* cannam@110: sord_world_new(void); cannam@110: cannam@110: /** cannam@110: Free @c world. cannam@110: */ cannam@110: SORD_API cannam@110: void cannam@110: sord_world_free(SordWorld* world); cannam@110: cannam@110: /** cannam@110: Set a function to be called when errors occur. cannam@110: cannam@110: The @p error_sink will be called with @p handle as its first argument. If cannam@110: no error function is set, errors are printed to stderr. cannam@110: */ cannam@110: SORD_API cannam@110: void cannam@110: sord_world_set_error_sink(SordWorld* world, cannam@110: SerdErrorSink error_sink, cannam@110: void* handle); cannam@110: cannam@110: /** cannam@110: @} cannam@110: @name Node cannam@110: @{ cannam@110: */ cannam@110: cannam@110: /** cannam@110: Get a URI node from a string. cannam@110: cannam@110: Note this function measures @c str, which is a common bottleneck. cannam@110: Use sord_node_from_serd_node instead if @c str is already measured. cannam@110: */ cannam@110: SORD_API cannam@110: SordNode* cannam@110: sord_new_uri(SordWorld* world, const uint8_t* uri); cannam@110: cannam@110: /** cannam@110: Get a URI node from a relative URI string. cannam@110: */ cannam@110: SORD_API cannam@110: SordNode* cannam@110: sord_new_relative_uri(SordWorld* world, cannam@110: const uint8_t* str, cannam@110: const uint8_t* base_uri); cannam@110: cannam@110: /** cannam@110: Get a blank node from a string. cannam@110: cannam@110: Note this function measures @c str, which is a common bottleneck. cannam@110: Use sord_node_from_serd_node instead if @c str is already measured. cannam@110: */ cannam@110: SORD_API cannam@110: SordNode* cannam@110: sord_new_blank(SordWorld* world, const uint8_t* str); cannam@110: cannam@110: /** cannam@110: Get a literal node from a string. cannam@110: cannam@110: Note this function measures @c str, which is a common bottleneck. cannam@110: Use sord_node_from_serd_node instead if @c str is already measured. cannam@110: */ cannam@110: SORD_API cannam@110: SordNode* cannam@110: sord_new_literal(SordWorld* world, cannam@110: SordNode* datatype, cannam@110: const uint8_t* str, cannam@110: const char* lang); cannam@110: cannam@110: /** cannam@110: Copy a node (obtain a reference). cannam@110: cannam@110: Node that since nodes are interned and reference counted, this does not cannam@110: actually create a deep copy of @c node. cannam@110: */ cannam@110: SORD_API cannam@110: SordNode* cannam@110: sord_node_copy(const SordNode* node); cannam@110: cannam@110: /** cannam@110: Free a node (drop a reference). cannam@110: */ cannam@110: SORD_API cannam@110: void cannam@110: sord_node_free(SordWorld* world, SordNode* node); cannam@110: cannam@110: /** cannam@110: Return the type of a node (SORD_URI, SORD_BLANK, or SORD_LITERAL). cannam@110: */ cannam@110: SORD_API cannam@110: SordNodeType cannam@110: sord_node_get_type(const SordNode* node); cannam@110: cannam@110: /** cannam@110: Return the string value of a node. cannam@110: */ cannam@110: SORD_API cannam@110: const uint8_t* cannam@110: sord_node_get_string(const SordNode* node); cannam@110: cannam@110: /** cannam@110: Return the string value of a node, and set @c len to its length. cannam@110: */ cannam@110: SORD_API cannam@110: const uint8_t* cannam@110: sord_node_get_string_counted(const SordNode* node, size_t* len); cannam@110: cannam@110: /** cannam@110: Return the language of a literal node (or NULL). cannam@110: */ cannam@110: SORD_API cannam@110: const char* cannam@110: sord_node_get_language(const SordNode* node); cannam@110: cannam@110: /** cannam@110: Return the datatype URI of a literal node (or NULL). cannam@110: */ cannam@110: SORD_API cannam@110: SordNode* cannam@110: sord_node_get_datatype(const SordNode* node); cannam@110: cannam@110: /** cannam@110: Return the flags (string attributes) of a node. cannam@110: */ cannam@110: SORD_API cannam@110: SerdNodeFlags cannam@110: sord_node_get_flags(const SordNode* node); cannam@110: cannam@110: /** cannam@110: Return true iff node can be serialised as an inline object. cannam@110: cannam@110: More specifically, this returns true iff the node is the object field cannam@110: of exactly one statement, and therefore can be inlined since it needn't cannam@110: be referred to by name. cannam@110: */ cannam@110: SORD_API cannam@110: bool cannam@110: sord_node_is_inline_object(const SordNode* node); cannam@110: cannam@110: /** cannam@110: Return true iff @c a is equal to @c b. cannam@110: cannam@110: Note this is much faster than comparing the node's strings. cannam@110: */ cannam@110: SORD_API cannam@110: bool cannam@110: sord_node_equals(const SordNode* a, cannam@110: const SordNode* b); cannam@110: cannam@110: /** cannam@110: Return a SordNode as a SerdNode. cannam@110: cannam@110: The returned node is shared and must not be freed or modified. cannam@110: */ cannam@110: SORD_API cannam@110: const SerdNode* cannam@110: sord_node_to_serd_node(const SordNode* node); cannam@110: cannam@110: /** cannam@110: Create a new SordNode from a SerdNode. cannam@110: cannam@110: The returned node must be freed using sord_node_free. cannam@110: */ cannam@110: SORD_API cannam@110: SordNode* cannam@110: sord_node_from_serd_node(SordWorld* world, cannam@110: SerdEnv* env, cannam@110: const SerdNode* node, cannam@110: const SerdNode* datatype, cannam@110: const SerdNode* lang); cannam@110: cannam@110: /** cannam@110: @} cannam@110: @name Model cannam@110: @{ cannam@110: */ cannam@110: cannam@110: /** cannam@110: Create a new model. cannam@110: cannam@110: @param world The world in which to make this model. cannam@110: cannam@110: @param indices SordIndexOption flags (e.g. SORD_SPO|SORD_OPS). Be sure to cannam@110: enable an index where the most significant node(s) are not variables in your cannam@110: queries (e.g. to make (? P O) queries, enable either SORD_OPS or SORD_POS). cannam@110: cannam@110: @param graphs If true, store (and index) graph contexts. cannam@110: */ cannam@110: SORD_API cannam@110: SordModel* cannam@110: sord_new(SordWorld* world, cannam@110: unsigned indices, cannam@110: bool graphs); cannam@110: cannam@110: /** cannam@110: Close and free @c model. cannam@110: */ cannam@110: SORD_API cannam@110: void cannam@110: sord_free(SordModel* model); cannam@110: cannam@110: /** cannam@110: Get the world associated with @c model. cannam@110: */ cannam@110: SORD_API cannam@110: SordWorld* cannam@110: sord_get_world(SordModel* model); cannam@110: cannam@110: /** cannam@110: Return the number of nodes stored in @c world. cannam@110: cannam@110: Nodes are included in this count iff they are a part of a quad in @c world. cannam@110: */ cannam@110: SORD_API cannam@110: size_t cannam@110: sord_num_nodes(const SordWorld* world); cannam@110: cannam@110: /** cannam@110: Return the number of quads stored in @c model. cannam@110: */ cannam@110: SORD_API cannam@110: size_t cannam@110: sord_num_quads(const SordModel* model); cannam@110: cannam@110: /** cannam@110: Return an iterator to the start of @c model. cannam@110: */ cannam@110: SORD_API cannam@110: SordIter* cannam@110: sord_begin(const SordModel* model); cannam@110: cannam@110: /** cannam@110: Search for statements by a quad pattern. cannam@110: @return an iterator to the first match, or NULL if no matches found. cannam@110: */ cannam@110: SORD_API cannam@110: SordIter* cannam@110: sord_find(SordModel* model, const SordQuad pat); cannam@110: cannam@110: /** cannam@110: Search for statements by nodes. cannam@110: @return an iterator to the first match, or NULL if no matches found. cannam@110: */ cannam@110: SORD_API cannam@110: SordIter* cannam@110: sord_search(SordModel* model, cannam@110: const SordNode* s, cannam@110: const SordNode* p, cannam@110: const SordNode* o, cannam@110: const SordNode* g); cannam@110: /** cannam@110: Search for a single node that matches a pattern. cannam@110: Exactly one of @p s, @p p, @p o must be NULL. cannam@110: This function is mainly useful for predicates that only have one value. cannam@110: The returned node must be freed using sord_node_free. cannam@110: @return the first matching node, or NULL if no matches are found. cannam@110: */ cannam@110: SORD_API cannam@110: SordNode* cannam@110: sord_get(SordModel* model, cannam@110: const SordNode* s, cannam@110: const SordNode* p, cannam@110: const SordNode* o, cannam@110: const SordNode* g); cannam@110: cannam@110: /** cannam@110: Return true iff a statement exists. cannam@110: */ cannam@110: SORD_API cannam@110: bool cannam@110: sord_ask(SordModel* model, cannam@110: const SordNode* s, cannam@110: const SordNode* p, cannam@110: const SordNode* o, cannam@110: const SordNode* g); cannam@110: cannam@110: /** cannam@110: Return the number of matching statements. cannam@110: */ cannam@110: SORD_API cannam@110: uint64_t cannam@110: sord_count(SordModel* model, cannam@110: const SordNode* s, cannam@110: const SordNode* p, cannam@110: const SordNode* o, cannam@110: const SordNode* g); cannam@110: cannam@110: /** cannam@110: Check if @a model contains a triple pattern. cannam@110: */ cannam@110: SORD_API cannam@110: bool cannam@110: sord_contains(SordModel* model, const SordQuad pat); cannam@110: cannam@110: /** cannam@110: Add a quad to a model. cannam@110: */ cannam@110: SORD_API cannam@110: bool cannam@110: sord_add(SordModel* model, const SordQuad quad); cannam@110: cannam@110: /** cannam@110: Remove a quad from a model. cannam@110: cannam@110: Note that is it illegal to remove while iterating over @c model. cannam@110: */ cannam@110: SORD_API cannam@110: void cannam@110: sord_remove(SordModel* model, const SordQuad quad); cannam@110: cannam@110: /** cannam@110: @} cannam@110: @name Inserter cannam@110: @{ cannam@110: */ cannam@110: cannam@110: /** cannam@110: Create an inserter for writing statements to a model. cannam@110: */ cannam@110: SORD_API cannam@110: SordInserter* cannam@110: sord_inserter_new(SordModel* model, cannam@110: SerdEnv* env); cannam@110: cannam@110: /** cannam@110: Free an inserter. cannam@110: */ cannam@110: SORD_API cannam@110: void cannam@110: sord_inserter_free(SordInserter* inserter); cannam@110: cannam@110: /** cannam@110: Set the current base URI for writing to the model. cannam@110: cannam@110: Note this function can be safely casted to SerdBaseSink. cannam@110: */ cannam@110: SORD_API cannam@110: SerdStatus cannam@110: sord_inserter_set_base_uri(SordInserter* inserter, cannam@110: const SerdNode* uri); cannam@110: cannam@110: /** cannam@110: Set a namespace prefix for writing to the model. cannam@110: cannam@110: Note this function can be safely casted to SerdPrefixSink. cannam@110: */ cannam@110: SORD_API cannam@110: SerdStatus cannam@110: sord_inserter_set_prefix(SordInserter* inserter, cannam@110: const SerdNode* name, cannam@110: const SerdNode* uri); cannam@110: cannam@110: /** cannam@110: Write a statement to the model. cannam@110: cannam@110: Note this function can be safely casted to SerdStatementSink. cannam@110: */ cannam@110: SORD_API cannam@110: SerdStatus cannam@110: sord_inserter_write_statement(SordInserter* inserter, cannam@110: SerdStatementFlags flags, cannam@110: const SerdNode* graph, cannam@110: const SerdNode* subject, cannam@110: const SerdNode* predicate, cannam@110: const SerdNode* object, cannam@110: const SerdNode* object_datatype, cannam@110: const SerdNode* object_lang); cannam@110: cannam@110: /** cannam@110: @} cannam@110: @name Iteration cannam@110: @{ cannam@110: */ cannam@110: cannam@110: /** cannam@110: Set @c quad to the quad pointed to by @c iter. cannam@110: */ cannam@110: SORD_API cannam@110: void cannam@110: sord_iter_get(const SordIter* iter, SordQuad quad); cannam@110: cannam@110: /** cannam@110: Return a field of the quad pointed to by @c iter. cannam@110: */ cannam@110: SORD_API cannam@110: const SordNode* cannam@110: sord_iter_get_node(const SordIter* iter, SordQuadIndex index); cannam@110: cannam@110: /** cannam@110: Return the store pointed to by @c iter. cannam@110: */ cannam@110: SORD_API cannam@110: const SordModel* cannam@110: sord_iter_get_model(SordIter* iter); cannam@110: cannam@110: /** cannam@110: Increment @c iter to point to the next statement. cannam@110: */ cannam@110: SORD_API cannam@110: bool cannam@110: sord_iter_next(SordIter* iter); cannam@110: cannam@110: /** cannam@110: Return true iff @c iter is at the end of its range. cannam@110: */ cannam@110: SORD_API cannam@110: bool cannam@110: sord_iter_end(const SordIter* iter); cannam@110: cannam@110: /** cannam@110: Free @c iter. cannam@110: */ cannam@110: SORD_API cannam@110: void cannam@110: sord_iter_free(SordIter* iter); cannam@110: cannam@110: /** cannam@110: @} cannam@110: @name Utilities cannam@110: @{ cannam@110: */ cannam@110: cannam@110: /** cannam@110: Match two quads (using ID comparison only). cannam@110: cannam@110: This function is a straightforward and fast equivalence match with wildcard cannam@110: support (ID 0 is a wildcard). It does not actually read node data. cannam@110: @return true iff @c x and @c y match. cannam@110: */ cannam@110: SORD_API cannam@110: bool cannam@110: sord_quad_match(const SordQuad x, const SordQuad y); cannam@110: cannam@110: /** cannam@110: @} cannam@110: @name Serialisation cannam@110: @{ cannam@110: */ cannam@110: cannam@110: /** cannam@110: Return a reader that will read into @c model. cannam@110: */ cannam@110: SORD_API cannam@110: SerdReader* cannam@110: sord_new_reader(SordModel* model, cannam@110: SerdEnv* env, cannam@110: SerdSyntax syntax, cannam@110: SordNode* graph); cannam@110: cannam@110: /** cannam@110: Write a model to a writer. cannam@110: */ cannam@110: SORD_API cannam@110: bool cannam@110: sord_write(SordModel* model, cannam@110: SerdWriter* writer, cannam@110: SordNode* graph); cannam@110: cannam@110: /** cannam@110: Write a range to a writer. cannam@110: cannam@110: This increments @c iter to its end, then frees it. cannam@110: */ cannam@110: SORD_API cannam@110: bool cannam@110: sord_write_iter(SordIter* iter, cannam@110: SerdWriter* writer); cannam@110: cannam@110: /** cannam@110: @} cannam@110: @} cannam@110: */ cannam@110: cannam@110: #ifdef __cplusplus cannam@110: } /* extern "C" */ cannam@110: #endif cannam@110: cannam@110: #endif /* SORD_SORD_H */