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