/**
* librdf_new_uri_from_uri:
* @old_uri: #librdf_uri object
*
* Copy constructor - create a new librdf_uri object from an existing librdf_uri object.
*
* Return value: a new #librdf_uri object or NULL on failure
**/
librdf_uri*
librdf_new_uri_from_uri (librdf_uri* old_uri)
{
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(old_uri, librdf_uri, NULL);
return raptor_uri_copy(old_uri);
}
/**
* librdf_uri_to_filename:
* @uri: #librdf_uri object
*
* Return pointer to filename of URI.
*
* Returns a pointer to a newly allocated buffer that
* the caller must free. This will fail if the URI
* is not a file: URI. This can be checked with #librdf_uri_is_file_uri
*
* Return value: pointer to filename or NULL on failure
**/
const char*
librdf_uri_to_filename(librdf_uri* uri)
{
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(uri, librdf_uri, NULL);
return raptor_uri_uri_string_to_filename(librdf_uri_as_string(uri));
}
/**
* librdf_statement_decode:
* @statement: the statement to deserialise into
* @buffer: the buffer to use
* @length: buffer size
*
* Decodes a statement from a buffer.
*
* Decodes the serialised statement (as created by librdf_statement_encode() )
* from the given buffer.
*
* Return value: number of bytes used or 0 on failure (bad encoding, allocation failure)
**/
size_t
librdf_statement_decode(librdf_statement* statement,
unsigned char *buffer, size_t length)
{
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(statement, librdf_statement, 0);
return librdf_statement_decode_parts(statement, NULL, buffer, length);
}
/**
* librdf_serializer_serialize_stream_to_counted_string:
* @serializer: the serializer
* @base_uri: the base URI to use (or NULL)
* @stream: the #librdf_stream stream to use
* @length_p: pointer to store length or NULL
*
* Write a #librdf_stream to a counted string.
*
* Return value: stream as string or NULL on failure
**/
unsigned char*
librdf_serializer_serialize_stream_to_counted_string(librdf_serializer* serializer,
librdf_uri* base_uri,
librdf_stream* stream,
size_t* length_p)
{
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(serializer, librdf_serializer, NULL);
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(stream, librdf_stream, NULL);
if(length_p)
*length_p=0;
return serializer->factory->serialize_stream_to_counted_string(serializer->context,
base_uri,
stream,
length_p);
}
/**
* librdf_new_uri_from_uri:
* @old_uri: #librdf_uri object
*
* Copy constructor - create a new librdf_uri object from an existing librdf_uri object.
*
* Return value: a new #librdf_uri object or NULL on failure
**/
librdf_uri*
librdf_new_uri_from_uri (librdf_uri* old_uri) {
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(old_uri, librdf_uri, NULL);
old_uri->usage++;
return old_uri;
}
/**
* librdf_storage_context_serialise - List all statements in a storage context (DEPRECATED)
* @storage: &librdf_storage object
* @context: &librdf_node context node
*
* DEPRECATED to reduce confusion with the librdf_serializer class.
* Please use librdf_storage_context_as_stream.
*
* Return value: &librdf_stream of statements or NULL on failure or context is empty
**/
librdf_stream*
librdf_storage_context_serialise(librdf_storage* storage,
librdf_node* context)
{
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(storage, librdf_storage, NULL);
return librdf_storage_context_as_stream(storage, context);
}
/**
* librdf_new_node:
* @world: redland world object
*
* Constructor - create a new #librdf_node object with a private identifier.
*
* Calls librdf_new_node_from_blank_identifier(world, NULL) to
* construct a new redland blank node identifier and make a
* new librdf_node object for it.
*
* Return value: a new #librdf_node object or NULL on failure
**/
librdf_node*
librdf_new_node(librdf_world *world)
{
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(world, librdf_world, NULL);
librdf_world_open(world);
return librdf_new_node_from_blank_identifier(world, (unsigned char*)NULL);
}
/**
* librdf_new_node_from_uri:
* @world: redland world object
* @uri: #librdf_uri object
*
* Constructor - create a new resource #librdf_node object with a given URI.
*
* Return value: a new #librdf_node object or NULL on failure
**/
librdf_node*
librdf_new_node_from_uri(librdf_world *world, librdf_uri *uri)
{
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(world, librdf_world, NULL);
librdf_world_open(world);
return raptor_new_term_from_uri(world->raptor_world_ptr, uri);
}
/**
* librdf_uri_as_counted_string:
* @uri: #librdf_uri object
* @len_p: pointer to location to store length
*
* Get a pointer to the string representation of the URI with length.
*
* Returns a shared pointer to the URI string representation.
* Note: does not allocate a new string so the caller must not free it.
*
* Return value: string representation of URI
**/
unsigned char*
librdf_uri_as_counted_string(librdf_uri *uri, size_t* len_p)
{
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(uri, librdf_uri, NULL);
if(len_p)
*len_p=uri->string_length;
return uri->string;
}
/**
* librdf_query_results_get_binding_value_by_name:
* @query_results: #librdf_query_results query results
* @name: variable name
*
* Get one binding value for a given name in the current result.
*
* Return value: a new #librdf_node binding value or NULL on failure
**/
librdf_node*
librdf_query_results_get_binding_value_by_name(librdf_query_results *query_results, const char *name)
{
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(query_results, librdf_query_results, NULL);
if(query_results->query->factory->results_get_binding_value_by_name)
return query_results->query->factory->results_get_binding_value_by_name(query_results, name);
else
return NULL;
}
/**
* librdf_node_get_literal_value_language:
* @node: the node object
*
* Get the XML language of the node.
*
* Returns a pointer to the literal language value held by the node, it must
* be copied if it is wanted to be used by the caller.
*
* Return value: the XML language string or NULL if node is not a literal
* or there is no XML language defined.
**/
char*
librdf_node_get_literal_value_language(librdf_node *node)
{
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(node, librdf_node, NULL);
if(node->type != RAPTOR_TERM_TYPE_LITERAL)
return NULL;
return (char*)node->value.literal.language;
}
/**
* librdf_query_results_finished:
* @query_results: #librdf_query_results query results
*
* Find out if binding results are exhausted.
*
* Return value: non-0 if results are finished or query failed
**/
int
librdf_query_results_finished(librdf_query_results *query_results)
{
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(query_results, librdf_query_results, 1);
if(query_results->query->factory->results_finished)
return query_results->query->factory->results_finished(query_results);
else
return 1;
}
/**
* librdf_query_results_get_boolean:
* @query_results: #librdf_query_results query_results
*
* Get boolean query result.
*
* The return value is only meaningful if this is a boolean
* query result - see librdf_query_results_is_boolean()
*
* Return value: boolean query result - >0 is true, 0 is false, <0 on error or finished
*/
int
librdf_query_results_get_boolean(librdf_query_results* query_results)
{
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(query_results, query_results, -1);
if(query_results->query->factory->results_get_boolean)
return query_results->query->factory->results_get_boolean(query_results);
else
return -1;
}
/**
* librdf_new_node_from_uri_string:
* @world: redland world object
* @uri_string: string representing a URI
*
* Constructor - create a new #librdf_node object from a URI string.
*
* Return value: a new #librdf_node object or NULL on failure
**/
librdf_node*
librdf_new_node_from_uri_string(librdf_world *world,
const unsigned char *uri_string)
{
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(world, librdf_world, NULL);
librdf_world_open(world);
return raptor_new_term_from_uri_string(world->raptor_world_ptr, uri_string);
}
/**
* librdf_storage_get_contexts - return the list of contexts in the store
* @storage: &librdf_storage object
*
* Returns an iterator of &librdf_node context nodes for each
* context in the store.
*
* Return value: &librdf_iterator of context nodes or NULL on failure or if contexts are not supported
**/
librdf_iterator*
librdf_storage_get_contexts(librdf_storage* storage)
{
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(storage, librdf_storage, NULL);
if(storage->factory->get_contexts)
return storage->factory->get_contexts(storage);
else
return NULL;
}
/**
* librdf_query_results_is_syntax:
* @query_results: #librdf_query_results object
*
* Test if librdf_query_results is a syntax.
*
* If this function returns true, the ONLY result available
* from this query is a syntax that can be serialized using
* one of the #query_result_formatter class methods or with
* librdf_query_results_to_counted_string(), librdf_query_results_to_string(),
* librdf_query_results_to_file_handle() or librdf_query_results_to_file()
*
* Return value: non-0 if true
**/
int
librdf_query_results_is_syntax(librdf_query_results* query_results)
{
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(query_results, query_results, -1);
if(query_results->query->factory->results_is_syntax)
return query_results->query->factory->results_is_syntax(query_results);
else
return -1;
}
/**
* librdf_node_get_uri:
* @node: the node object
*
* Get the URI for a node object.
*
* Returns a pointer to the URI object held by the node, it must be
* copied if it is wanted to be used by the caller.
*
* Return value: URI object or NULL if node has no URI.
**/
librdf_uri*
librdf_node_get_uri(librdf_node *node)
{
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(node, librdf_node, NULL);
if(node->type != RAPTOR_TERM_TYPE_URI)
return NULL;
return node->value.uri;
}
/**
* librdf_query_results_as_stream:
* @query_results: #librdf_query_results query_results
*
* Get a query result as an RDF graph in #librdf_stream form
*
* The return value is only meaningful if this is an RDF graph
* query result - see librdf_query_results_is_graph().
*
* Return value: a new #librdf_stream result or NULL on error
*/
librdf_stream*
librdf_query_results_as_stream(librdf_query_results* query_results)
{
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(query_results, query_results, NULL);
if(query_results->query->factory->results_as_stream)
return query_results->query->factory->results_as_stream(query_results);
else
return NULL;
}
/**
* librdf_node_get_literal_value:
* @node: the node object
*
* Get the string literal value of the node.
*
* Returns a pointer to the literal value held by the node, it must be
* copied if it is wanted to be used by the caller.
*
* Return value: the literal string or NULL if node is not a literal
**/
unsigned char*
librdf_node_get_literal_value(librdf_node *node)
{
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(node, librdf_node, NULL);
if(node->type != RAPTOR_TERM_TYPE_LITERAL)
return NULL;
return node->value.literal.string;
}
/**
* librdf_statement_decode_parts:
* @statement: the statement to deserialise into
* @context_node: pointer to #librdf_node context_node to deserialise into
* @buffer: the buffer to use
* @length: buffer size
*
* Decodes a statement + context node from a buffer.
*
* @Deprecated: Replaced by librdf_statement_decode2()
*
* Decodes the serialised statement (as created by librdf_statement_encode() )
* from the given buffer. If a context node is found and context_node is
* not NULL, a pointer to the new #librdf_node is stored in *context_node.
*
* Return value: number of bytes used or 0 on failure (bad encoding, allocation failure)
**/
size_t
librdf_statement_decode_parts(librdf_statement* statement,
librdf_node** context_node,
unsigned char *buffer, size_t length)
{
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(statement, librdf_statement, 0);
return librdf_statement_decode2(statement->world, statement,
context_node, buffer, length);
}
/**
* librdf_query_results_get_bindings_count:
* @query_results: #librdf_query_results query results
*
* Get the number of bound variables in the result.
*
* Return value: <0 if failed or results exhausted
**/
int
librdf_query_results_get_bindings_count(librdf_query_results *query_results)
{
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(query_results, librdf_query_results, 1);
if(query_results->query->factory->results_get_bindings_count)
return query_results->query->factory->results_get_bindings_count(query_results);
else
return -1;
}
/**
* librdf_uri_as_string:
* @uri: #librdf_uri object
*
* Get a pointer to the string representation of the URI.
*
* Returns a shared pointer to the URI string representation.
* Note: does not allocate a new string so the caller must not free it.
*
* Return value: string representation of URI
**/
unsigned char*
librdf_uri_as_string (librdf_uri *uri)
{
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(uri, librdf_uri, NULL);
#ifdef LIBRDF_USE_RAPTOR_URI
return raptor_uri_as_string(uri);
#else
return uri->string;
#endif
}
librdf_statement*
librdf_new_statement_from_statement(librdf_statement* statement)
{
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(statement, librdf_statement, NULL);
if(!statement)
return NULL;
return raptor_statement_copy(statement);
}
/**
* librdf_new_node_from_blank_identifier:
* @world: redland world object
* @identifier: blank node identifier or NULL
*
* Constructor - create a new blank node #librdf_node object from a blank node identifier.
*
* If no identifier string is given, creates a new internal identifier
* and assigns it.
*
* Return value: new #librdf_node object or NULL on failure
**/
librdf_node*
librdf_new_node_from_blank_identifier(librdf_world *world,
const unsigned char *identifier)
{
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(world, librdf_world, NULL);
librdf_world_open(world);
return raptor_new_term_from_blank(world->raptor_world_ptr,
identifier);
}
/**
* librdf_query_results_get_bindings:
* @query_results: #librdf_query_results query results
* @names: pointer to an array of binding names (or NULL)
* @values: pointer to an array of binding value #librdf_node (or NULL)
*
* Get all binding names, values for current result.
*
* If names is not NULL, it is set to the address of a shared array
* of names of the bindings (an output parameter). These names
* are shared and must not be freed by the caller
*
* If values is not NULL, it is used as an array to store pointers
* to the librdf_node* of the results. These nodes must be freed
* by the caller. The size of the array is determined by the
* number of names of bindings, returned by
* librdf_query_results_get_bindings_count dynamically or
* will be known in advanced if hard-coded into the query string.
*
* Example
*
* const char **names=NULL;
* librdf_node* values[10];
*
* if(librdf_query_results_get_bindings(results, &names, values))
* ...
*
* Return value: non-0 if the assignment failed
**/
int
librdf_query_results_get_bindings(librdf_query_results *query_results,
const char ***names, librdf_node **values)
{
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(query_results, librdf_query_results, 1);
if(query_results->query->factory->results_get_bindings)
return query_results->query->factory->results_get_bindings(query_results, names, values);
else
return 1;
}
size_t
librdf_statement_encode(librdf_statement* statement,
unsigned char *buffer,
size_t length)
{
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(statement, librdf_statement, 0);
return librdf_statement_encode_parts_internal(statement, NULL,
buffer, length,
LIBRDF_STATEMENT_ALL);
}
/**
* librdf_statement_match:
* @statement: statement
* @partial_statement: statement with possible empty parts
*
* Match a statement against a 'partial' statement.
*
* A partial statement is where some parts of the statement -
* subject, predicate or object can be empty (NULL).
* Empty parts match against any value, parts with values
* must match exactly. Node matching is done via librdf_node_equals()
*
* Return value: non 0 on match
**/
int
librdf_statement_match(librdf_statement* statement,
librdf_statement* partial_statement)
{
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(statement, librdf_statement, 0);
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(partial_statement, librdf_statement, 0);
if(partial_statement->subject &&
!librdf_node_equals(statement->subject, partial_statement->subject))
return 0;
if(partial_statement->predicate &&
!librdf_node_equals(statement->predicate, partial_statement->predicate))
return 0;
if(partial_statement->object &&
!librdf_node_equals(statement->object, partial_statement->object))
return 0;
return 1;
}
/**
* librdf_statement_equals:
* @statement1: first #librdf_statement
* @statement2: second #librdf_statement
*
* Check if two statements are equal.
*
* Return value: non 0 if statements are equal
**/
int
librdf_statement_equals(librdf_statement* statement1,
librdf_statement* statement2)
{
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(statement1, librdf_statement, 0);
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(statement2, librdf_statement, 0);
if(!statement1 || !statement2)
return 0;
if(!librdf_node_equals(statement1->subject, statement2->subject))
return 0;
if(!librdf_node_equals(statement1->predicate, statement2->predicate))
return 0;
if(!librdf_node_equals(statement1->object, statement2->object))
return 0;
return 1;
}
/**
* librdf_uri_as_counted_string:
* @uri: #librdf_uri object
* @len_p: pointer to location to store length
*
* Get a pointer to the string representation of the URI with length.
*
* Returns a shared pointer to the URI string representation.
* Note: does not allocate a new string so the caller must not free it.
*
* Return value: string representation of URI
**/
unsigned char*
librdf_uri_as_counted_string(librdf_uri *uri, size_t* len_p)
{
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(uri, librdf_uri, NULL);
#ifdef LIBRDF_USE_RAPTOR_URI
return raptor_uri_as_counted_string(uri, len_p);
#else
if(len_p)
*len_p=uri->string_length;
return uri->string;
#endif
}
/**
* librdf_new_uri_from_uri:
* @old_uri: #librdf_uri object
*
* Copy constructor - create a new librdf_uri object from an existing librdf_uri object.
*
* Return value: a new #librdf_uri object or NULL on failure
**/
librdf_uri*
librdf_new_uri_from_uri (librdf_uri* old_uri) {
LIBRDF_ASSERT_OBJECT_POINTER_RETURN_VALUE(old_uri, librdf_uri, NULL);
#ifdef LIBRDF_USE_RAPTOR_URI
return raptor_uri_copy(old_uri);
#else
old_uri->usage++;
return old_uri;
#endif
}
