## -*- perl -*- ## ## redland.pod - redland Unix manual page ## ## $Id: redland.pod,v 1.1 2008-07-08 10:39:52 larsl Exp $ ## ## Copyright (C) 2002-2006, David Beckett http://purl.org/net/dajobe/ ## Copyright (C) 2002-2004, University of Bristol, UK http://www.bristol.ac.uk/ ## ## This package is Free Software and part of Redland http://librdf.org/ ## ## It is licensed under the following three licenses as alternatives: ## 1. GNU Lesser General Public License (LGPL) V2.1 or any newer version ## 2. GNU General Public License (GPL) V2 or any newer version ## 3. Apache License, V2.0 or any newer version ## ## You may not use this file except in compliance with at least one of ## the above three licenses. ## ## See LICENSE.html or LICENSE.txt at the top of this package for the ## complete terms and further detail along with the license texts for ## the licenses in COPYING.LIB, COPYING and LICENSE-2.0.txt respectively. ## ## =pod =head1 NAME Redland Resource Description Framework (RDF) Library =head1 VERSION REDLAND_VERSION_STRING =head1 SYNOPSIS #include =head1 DESCRIPTION B is a library providing support for the Resource Description Framework (RDF) written in ANSI C with APIs in several other languages. This manual page lists most of the redland public API functions but does not claim to be a complete summary of the entire API. For the complete API with full details of the function interface, see the HTML API documentation either on the Redland web site at L or with the software release in the docs/api directory. =head1 FUNCTIONS The functions defined by B are all defined with the C prefix =head2 class world =over 4 =item librdf_world* B(I) =item void B(librdf_world* I) =item void B(librdf_world* I) =item void B(librdf_world* I, void* I, void (*I)(void* I, const char* I, ...)) =item void B(librdf_world* I, void* I, void (*I)(void* I, const char* I, ...)) =item void B(librdf_world*, const char* I) =item void B(librdf_world* I, librdf_hash* I) =item const char* B(librdf_world* I, librdf_uri* I) =item int B(librdf_world* I, librdf_uri* I, const char* I) =back =head2 class iterator =over 4 =item librdf_iterator* B(librdf_world* I, void* I, int (*I)(void*), void* (*I)(void*), void (*I)(void*)) =item void B(librdf_iterator*) =item int B(librdf_iterator* I) =item int B(librdf_iterator* I) =item int B(librdf_iterator* I) =item void* B(librdf_iterator* I) =item void* B(librdf_iterator* I) =item void* B(librdf_iterator* I) =item void* B(librdf_iterator* I) =item int B(librdf_iterator* I, void* (*I)(void* I, void* I), void* I) =item void* B(void* I, void* I) =back =head2 class digest =over 4 =item void B(librdf_world* I, const char* I, void (*I) (librdf_digest_factory*)) =item librdf_digest_factory* B(librdf_world* I, const char* I) =item librdf_digest* B(librdf_world* I, char* I) =item librdf_digest* B(librdf_world* I, librdf_digest_factory* I) =item void B(librdf_digest* I) =item void B(librdf_digest* I) =item void B(librdf_digest* I, unsigned char* I, size_t I) =item void B(librdf_digest* I) =item void* B(librdf_digest* I) =item char* B(librdf_digest* I) =item void B(librdf_digest* I, FILE* I) =back =head2 class uri =over 4 =item librdf_uri* B(librdf_world* I, const unsigned char * I) =item librdf_uri* B(librdf_uri* I) =item librdf_uri* B(librdf_uri* I, const unsigned char* I) =item void B(librdf_uri* I) =item unsigned char* B(librdf_uri* I) =item unsigned char* B(librdf_uri* I, size_t* I) =item librdf_digest* B(librdf_uri* I) =item void librdf_uri_print>(librdf_uri* I, FILE* I) =item unsigned char* B(librdf_uri* I) =item unsigned char* B(librdf_uri* I, size_t* I) =item int B(librdf_uri* I, librdf_uri* I) =item int B(librdf_uri* I) =item const char* B(librdf_uri* I) =item librdf_uri* B(const unsigned char* I, librdf_uri* I, librdf_uri* I) =item librdf_uri* B(librdf_uri* I, const unsigned char* I) =item librdf_uri* B(librdf_world* I, const char* I) =back =head2 class node =over 4 =item librdf_node* B(librdf_world* I) =item librdf_node* B(librdf_world* I, const char* I) =item librdf_node* B(librdf_world* I, librdf_uri* I) =item librdf_node* B(librdf_world* I, librdf_uri* I, const char* I) =item librdf_node* B(librdf_world* I, const char* I, librdf_uri* I, librdf_uri* I) =item librdf_node* B(librdf_world* I, const char* I, const char* I, int I, int I) =item librdf_node* B(librdf_world* I, const unsigned char* I, const char* I, librdf_uri* I) =item librdf_node* B(librdf_world* I, const unsigned char* I) =item librdf_node* B(librdf_node* I) =item void B(librdf_world* I, librdf_node* I) =item void B(librdf_node* I) =item librdf_uri* B(librdf_node* I) =item librdf_node_type B(librdf_node* I) =item unsigned char* B(librdf_node* I) =item unsigned char* B(librdf_node* I, size_t* I) =item char* B(librdf_node* I) =item char* B(librdf_node* I) =item int B(librdf_node* I) =item librdf_uri* B(librdf_node* I) =item int B(librdf_node* I) =item unsigned char* B(librdf_node* I) =item int B(librdf_node* I) =item int B(librdf_node* I) =item int B(librdf_node* I) =item librdf_digest* B(librdf_node* I) =item size_t B(librdf_node* I, unsigned char* I, size_t I) =item size_t B(librdf_node* I, unsigned char* I, size_t I) =item unsigned char* B(librdf_node* I) =item unsigned char* B(librdf_node* I, size_t* I) =item void B(librdf_node* I, FILE* I) =item int B(librdf_node* I, librdf_node* I) =back =head2 class concepts The library provides macros for all of the RDF and RDFS concepts - nodes and URIs. For example, C for the librdf_node for the rdf:Alt concept and C for the librdf_uri for the URI reference of rdf:Alt. C and C provide the librdf_uri objects for the RDF and RDFS namespace URIs. They must be copied using B to be shared correctly. =over 4 =item void B(librdf_world* I, int I, const char* I, librdf_uri **I, librdf_node **I) =back =head2 class statement =over 4 =item librdf_statement* B(librdf_world* I) =item librdf_statement* B(librdf_statement* I) =item librdf_statement* B(librdf_world* I, librdf_node* I, librdf_node* I, librdf_node* I) =item void B(librdf_world* I, librdf_statement* I) =item void B(librdf_statement* I) =item void B(librdf_statement* I) =item librdf_node* B(librdf_statement* I) =item void B(librdf_statement* I, librdf_node* I) =item librdf_node* B(librdf_statement* I) =item void B(librdf_statement* I, librdf_node* I) =item librdf_node* B(librdf_statement* I) =item void B(librdf_statement* I, librdf_node* I) =item int B(librdf_statement* I) =item char* B(librdf_statement* I) =item void B(librdf_statement* I, FILE* I) =item int B(librdf_statement* I, librdf_statement* I) =item int B(librdf_statement* I, librdf_statement* I) =item size_t B(librdf_statement* I, unsigned char* I, size_t I) =item size_t B(librdf_statement* I, unsigned char* I, size_t I, librdf_statement_part I) =item size_t B(librdf_statement* I, unsigned char* I, size_t I) =item size_t B(librdf_statement* I, librdf_node** I, unsigned char* I, size_t I) =back =head2 class model =over 4 =item librdf_model* B(librdf_world* I, librdf_storage* I, char* I) =item librdf_model* B(librdf_world* I, librdf_storage* I, librdf_hash* I) =item librdf_model* B(librdf_model* I) =item void B(librdf_model* I) =item int B(librdf_model* I) =item int B(librdf_model* I, librdf_node* I, librdf_node* I, librdf_node* I) =item int B(librdf_model* I, librdf_node* I, librdf_node* I, char* I, char* I, int I, int I) =item int B(librdf_model* I, librdf_node* I, librdf_node* I, const unsigned char* I, char* I, librdf_uri* I) =item int B(librdf_model* I, librdf_statement* I) =item int B(librdf_model* I, librdf_stream* I) =item int B(librdf_model* I, librdf_statement* I) =item int B(librdf_model* I, librdf_statement* I) =item int B(librdf_model* I, librdf_node* I, librdf_node* I) =item int B(librdf_model* I, librdf_node* I, librdf_node* I) =item librdf_stream* B(librdf_model* I) =item librdf_stream* B(librdf_model* I, librdf_statement* I) =item librdf_stream* B(librdf_model* I, librdf_statement* I, librdf_node* I) =item librdf_stream* B(librdf_model* I, librdf_statement* I, librdf_node* I, librdf_hash* I) =item librdf_iterator* B(librdf_model* I) =item librdf_iterator* B(librdf_model* I, librdf_node* I, librdf_node* I) =item librdf_iterator* B(librdf_model* I, librdf_node* I, librdf_node* I) =item librdf_iterator* B(librdf_model* I, librdf_node* I, librdf_node* I) =item librdf_node* B(librdf_model* I, librdf_node* I, librdf_node* I) =item librdf_node* B(librdf_model* I, librdf_node* I, librdf_node* I) =item librdf_node* B(librdf_model* I, librdf_node* I, librdf_node* I) =item librdf_iterator* B(librdf_model* I, librdf_node* I) =item librdf_iterator* B(librdf_model* I, librdf_node* I) =item int B(librdf_model* I, librdf_model* I) =item int B(librdf_model* I, librdf_model* I) =item void B(librdf_model* I, FILE* I) =item int B(librdf_model* I, librdf_node* I, librdf_statement* I) =item int B(librdf_model* I, librdf_node* I, librdf_stream* I) =item int B(librdf_model* I, librdf_node* I, librdf_statement* I) =item int B(librdf_model* I, librdf_node* I) =item librdf_stream* B(librdf_model* I, librdf_node* I) =item librdf_stream* B(librdf_model* I, librdf_query* I) =item librdf_stream* B(librdf_model* I, const char* I, librdf_uri* I, const unsigned char* I) =item void B(librdf_model* I) =item librdf_storage* B(librdf_model* I) =item librdf_node* B(librdf_model* I, librdf_uri* I) =item int B(librdf_model* I, librdf_uri* I, librdf_node* I) =back =head2 class storage =over 4 =item void B(const char* I, void (*I) (librdf_storage_factory*)) =item librdf_storage* B(librdf_world* I, char* I, char* I, char* I) =item librdf_storage* B(librdf_world* I, char* I, char* I, librdf_hash* I) =item librdf_storage* B(librdf_storage* I) =item librdf_storage* B(librdf_world* I, librdf_storage_factory* I, char* I, librdf_hash* I) =item void B(librdf_storage* I) =item int B(librdf_storage* I, librdf_model* I) =item int B(librdf_storage* I) =item int B(librdf_storage* I, void* I, size_t I, void **I, size_t* I, unsigned int I) =item int B(librdf_storage* I) =item int B(librdf_storage* I, librdf_statement* I) =item int B(librdf_storage* I, librdf_stream* I) =item int B(librdf_storage* I, librdf_statement* I) =item int B(librdf_storage* I, librdf_statement* I) =item librdf_stream* B(librdf_storage* I) =item librdf_stream* B(librdf_storage* I, librdf_statement* I) =item librdf_iterator* B(librdf_storage* I, librdf_node* I, librdf_node* I) =item librdf_iterator* B(librdf_storage* I, librdf_node* I, librdf_node* I) =item librdf_iterator* B(librdf_storage* I, librdf_node* I, librdf_node* I) =item librdf_iterator* B(librdf_storage* I, librdf_node* I) =item librdf_iterator* B(librdf_storage* I, librdf_node* I) =item int B(librdf_storage* I, librdf_node* I, librdf_node* I) =item int B(librdf_storage* I, librdf_node* I, librdf_node* I) =item int B(librdf_storage* I, librdf_node* I, librdf_statement* I) =item int B(librdf_storage* I, librdf_node* I, librdf_stream* I) =item int B(librdf_storage* I, librdf_node* I, librdf_statement* I) =item int B(librdf_storage* I, librdf_node* I) =item librdf_stream* B(librdf_storage* I, librdf_node* I) =item int B(librdf_storage* I, librdf_query* I) =item librdf_stream* B(librdf_storage* I, librdf_query* I) =item void B(librdf_storage* I) =back =head2 class parser =over 4 =item void B(librdf_world* I, const char* I, const char* I, const char* I, void (*I) (librdf_parser_factory*)) =item librdf_parser* B(librdf_world* I, const char* I, const char* I, librdf_uri* I) =item librdf_parser* B(librdf_world* I, librdf_parser_factory* I) =item void B(librdf_parser* I) =item librdf_stream* B(librdf_parser* I, librdf_uri* I, librdf_uri* I) =item int B(librdf_parser* I, librdf_uri* I, librdf_uri* I, librdf_model* I) =item librdf_stream* B(librdf_parser* I, const unsigned char* I, librdf_uri* I) =item int librdf_parser_parse_string_into_model(librdf_parser* I, const unsigned char* I, librdf_uri* I, librdf_model* I) =item void B(librdf_parser* I, void* I, void (*I)(void* I, const char* I, ...)) =item void B(librdf_parser* I, void* I, void (*I)(void* I, const char* I, ...)) =item librdf_node* B(librdf_parser* I, librdf_uri* I) =item int B(librdf_parser* I, librdf_uri* I, librdf_node* I) =back =head2 class serializer =over 4 =item librdf_serializer* librdf_new_serializer(librdf_world* I, const char *I, const char *I, librdf_uri *I) =item librdf_serializer* librdf_new_serializer_from_factory(librdf_world* I, librdf_serializer_factory *I) =item void librdf_free_serializer(librdf_serializer *I) =item int librdf_serializer_serialize_model(librdf_serializer* I, FILE* I, librdf_uri* I, librdf_model* I) =item int librdf_serializer_serialize_model_to_file(librdf_serializer* I, const char *I, librdf_uri* I, librdf_model* I) =item void librdf_serializer_set_error(librdf_serializer* I, void *I, void (*I)(void *user_data, const char *msg, ...)) =item void librdf_serializer_set_warning(librdf_serializer* I, void *I, void (*I)(void *user_data, const char *msg, ...)) =item librdf_node* librdf_serializer_get_feature(librdf_serializer* I, librdf_uri* I) =item int librdf_serializer_set_feature(librdf_serializer* I, librdf_uri* I, librdf_node* I)b =item int librdf_serializer_set_namespace(librdf_serializer* I, librdf_uri* I, const char* I) =back =head2 class stream =over 4 =item librdf_stream* B(librdf_world* I, void* I, int (*I)(void*), librdf_statement* (*I)(void*), void (*I)(void*)) =item librdf_stream* B(librdf_iterator* I, librdf_statement* I, librdf_statement_part I) =item void B(librdf_stream* I) =item int B(librdf_stream* I) =item int B(librdf_stream* I) =item librdf_statement* B(librdf_stream* I) =item void* B(librdf_stream* I) =item void B(librdf_stream* I, librdf_statement* (*I)(void* I, librdf_statement* I), void* I) =item void B(librdf_stream* I, FILE* I) =back =head1 EXAMPLES #include librdf_storage *storage; librdf_model* model; librdf_statement* statement; librdf_world* world world=librdf_new_world(); librdf_world_open(world); storage=librdf_new_storage(world, "hashes", "test", "hash-type='bdb',dir='.'"); model=librdf_new_model(world, storage, NULL); statement=librdf_new_statement_from_nodes(world, librdf_new_node_from_uri_string(world, "http://purl.org/net/dajobe/"), librdf_new_node_from_uri_string(world, "http://purl.org/dc/elements/1.1/creator"), librdf_new_node_from_literal(world, "Dave Beckett", NULL, 0)); librdf_model_add_statement(model, statement); librdf_free_statement(statement); librdf_model_print(model, stdout); librdf_free_model(model); librdf_free_storage(storage); librdf_free_world(world); =head1 SEE ALSO libraptor(3), libxml(4). =head1 HISTORY The B RDF library was created by Dave Beckett in June 2000. =head1 AUTHOR Dave Beckett L, =cut