Top | ![]() |
![]() |
![]() |
![]() |
void | rasqal_free_world () |
rasqal_world * | rasqal_new_world () |
int | rasqal_world_open () |
void | rasqal_world_set_log_handler () |
int | rasqal_world_set_warning_level () |
raptor_world * | rasqal_world_get_raptor () |
void | rasqal_world_set_raptor () |
const raptor_syntax_description * | rasqal_world_get_query_language_description () |
const raptor_syntax_description * | rasqal_world_get_query_results_format_description () |
char * | (*rasqal_generate_bnodeid_handler) () |
int | rasqal_world_set_generate_bnodeid_handler () |
int | rasqal_world_set_default_generate_bnodeid_parameters () |
const char * | rasqal_world_guess_query_results_format_name () |
int | rasqal_language_name_check () |
int | rasqal_languages_enumerate () |
void * | rasqal_alloc_memory () |
void * | rasqal_calloc_memory () |
void | rasqal_free_memory () |
rasqal_feature | rasqal_feature_from_uri () |
int | rasqal_feature_value_type () |
int | rasqal_features_enumerate () |
unsigned int | rasqal_get_feature_count () |
typedef | rasqal_world |
extern const unsigned int | rasqal_version_decimal |
extern const unsigned int | rasqal_version_major |
extern const unsigned int | rasqal_version_minor |
extern const unsigned int | rasqal_version_release |
extern const char * const | rasqal_version_string |
extern const char * const | rasqal_copyright_string |
extern const char * const | rasqal_short_copyright_string |
extern const char * const | rasqal_home_url_string |
extern const char * const | rasqal_license_string |
enum | rasqal_feature |
#define | RASQAL_DEPRECATED |
#define | RASQAL_VERSION |
#define | RASQAL_VERSION_MAJOR |
#define | RASQAL_VERSION_MINOR |
#define | RASQAL_VERSION_RELEASE |
#define | RASQAL_VERSION_STRING |
#define | RASQAL_RAPTOR_VERSION |
void
rasqal_free_world (rasqal_world *world
);
Terminate the rasqal library.
Destroys a rasqal_world object and all static information.
rasqal_world *
rasqal_new_world (void
);
Allocate a new rasqal_world object.
The rasqal_world is initialized with rasqal_world_open()
.
Allocation and initialization are decoupled to allow
changing settings on the world object before init.
int
rasqal_world_open (rasqal_world *world
);
Initialise the rasqal library.
Initializes a rasqal_world object created by rasqal_new_world()
.
Allocation and initialization are decoupled to allow
changing settings on the world object before init.
These settings include e.g. the raptor library instance set with
rasqal_world_set_raptor()
.
The initialized world object is used with subsequent rasqal API calls.
void rasqal_world_set_log_handler (rasqal_world *world
,void *user_data
,raptor_log_handler handler
);
Set the log handler for this rasqal_world.
Also sets the raptor log handler to the same user_data
and
handler
via raptor_world_set_log_handler()
. (Rasqal 0.9.26+)
int rasqal_world_set_warning_level (rasqal_world *world
,unsigned int warning_level
);
Set the rasqal warning reporting level
The warning levels used are as follows:
Level 10 is used for serious warnings that may be errors.
Level 30 is used for moderate style warnings.
Level 90 is used for strict conformance warnings.
When this method is called to set a warning level, only warnings
of less than warning_level
are reported. The default warning
level is 50.
raptor_world *
rasqal_world_get_raptor (rasqal_world *world
);
Get the raptor_world instance used by this rasqal_world.
void rasqal_world_set_raptor (rasqal_world *world
,raptor_world *raptor_world_ptr
);
Set the raptor_world instance to be used with this rasqal_world.
If no raptor_world instance is set with this function,
rasqal_world_open()
creates a new instance.
Ownership of the raptor_world is not taken. If the raptor library
instance is set with this function, rasqal_free_world()
will not
free it.
const raptor_syntax_description * rasqal_world_get_query_language_description (rasqal_world *world
,unsigned int counter
);
Get query language descriptive information
const raptor_syntax_description * rasqal_world_get_query_results_format_description (rasqal_world *world
,unsigned int counter
);
Get query result format descriptive syntax information
char * (*rasqal_generate_bnodeid_handler) (rasqal_world *world
,void *user_data
,unsigned char *user_bnodeid
);
User handler used with rasqal_world_set_generate_bnodeid_handler()
to set method for generating a blank node ID.
int rasqal_world_set_generate_bnodeid_handler (rasqal_world *world
,void *user_data
,rasqal_generate_bnodeid_handler handler
);
Set the generate blank node ID handler function
Sets the function to generate blank node IDs.
The handler is called with a pointer to the rasqal_world, the
user_data
pointer and a user_bnodeid which is the value of
a user-provided blank node identifier (may be NULL).
It can either be returned directly as the generated value when present or
modified. The passed in value must be free()
d if it is not used.
If handler is NULL, the default method is used
world |
rasqal_world object |
|
user_data |
user data pointer for callback |
|
handler |
generate blank ID callback function |
int rasqal_world_set_default_generate_bnodeid_parameters (rasqal_world *world
,char *prefix
,int base
);
Set default bnodeid generation parameters
Sets the parameters for the default algorithm used to generate
blank node IDs. The default algorithm uses both prefix
and base
to generate a new identifier. The exact identifier generated is
not guaranteed to be a strict concatenation of prefix
and base
but will use both parts.
For finer control of the generated identifiers, use
rasqal_world_set_generate_bnodeid_handler()
If prefix is NULL, the default prefix is used (currently "bnodeid") If base is less than 1, it is initialised to 1.
const char * rasqal_world_guess_query_results_format_name (rasqal_world *world
,raptor_uri *uri
,const char *mime_type
,const char *buffer
,size_t len
,const unsigned char *identifier
);
Guess a query results format name for content.
Find a query results format by scoring recognition of the syntax by a block of characters, the content identifier or a mime type. The content identifier is typically a filename or URI or some other identifier.
int rasqal_language_name_check (rasqal_world *world
,const char *name
);
Check name of a query language.
int rasqal_languages_enumerate (rasqal_world *world
,unsigned int counter
,const char **name
,const char **label
,const unsigned char **uri_string
);
rasqal_languages_enumerate
is deprecated and should not be used in newly-written code.
deprecated
: Use rasqal_world_get_query_language_description()
instead.
Get information on query languages.
void *
rasqal_alloc_memory (size_t size
);
Allocate memory inside rasqal.
Some systems require memory allocated in a library to
be deallocated in that library. This function allows
memory to be allocated inside the rasqal shared library
that can be freed inside rasqal either internally or via
rasqal_free_memory()
.
void * rasqal_calloc_memory (size_t nmemb
,size_t size
);
Allocate zeroed array of items inside rasqal.
Some systems require memory allocated in a library to
be deallocated in that library. This function allows
memory to be allocated inside the rasqal shared library
that can be freed inside rasqal either internally or via
rasqal_free_memory()
.
void
rasqal_free_memory (void *ptr
);
Free memory allocated inside rasqal.
Some systems require memory allocated in a library to be deallocated in that library. This function allows memory allocated by rasqal to be freed.
rasqal_feature rasqal_feature_from_uri (rasqal_world *world
,raptor_uri *uri
);
Turn a feature URI into an feature enum.
The allowed feature URIs are available via rasqal_features_enumerate()
.
int
rasqal_feature_value_type (const rasqal_feature feature
);
Get the type of a features.
The type of the feature
is 0=integer , 1=string. Other values are
undefined. Most features are integer values and use
rasqal_query_set_feature rasqal_query_get_feature()
int rasqal_features_enumerate (rasqal_world *world
,const rasqal_feature feature
,const char **name
,raptor_uri **uri
,const char **label
);
Get list of rasqal features.
If uri is not NULL, a pointer to a new raptor_uri is returned
that must be freed by the caller with raptor_free_uri()
.
unsigned int
rasqal_get_feature_count (void
);
Get the count of features defined.
This is prefered to the compile time-only symbol RASQAL_FEATURE_LAST and returns a count of the number of features which is RASQAL_FEATURE_LAST+1.
extern const unsigned int rasqal_version_decimal;
Library full version as a decimal integer.
See also rasqal_version_string.
extern const unsigned int rasqal_version_major;
Library major version number as a decimal integer.
extern const unsigned int rasqal_version_minor;
Library minor version number as a decimal integer.
extern const unsigned int rasqal_version_release;
Library release version number as a decimal integer.
extern const char * const rasqal_version_string;
Library full version as a string.
See also rasqal_version_decimal.
extern const char * const rasqal_copyright_string;
Copyright string (multiple lines).
extern const char * const rasqal_short_copyright_string;
Short copyright string (one line).
#define RASQAL_VERSION 933
Rasqal library version number
Format: major * 10000 + minor * 100 + release