Initialisation

Initialisation — Library startup, shutdown and configuration.

Synopsis

typedef             raptor_world;
raptor_world*       raptor_new_world                    (void);
int                 raptor_world_open                   (raptor_world *world);
void                raptor_free_world                   (raptor_world *world);
enum                raptor_world_flag;
int                 raptor_world_set_flag               (raptor_world *world,
                                                         raptor_world_flag flag,
                                                         int value);
int                 raptor_world_set_libxslt_security_preferences
                                                        (raptor_world *world,
                                                         void *security_preferences);
int                 raptor_world_set_log_handler        (raptor_world *world,
                                                         void *user_data,
                                                         raptor_log_handler handler);
int                 raptor_world_enumerate_parsers      (raptor_world *world,
                                                         unsigned int counter,
                                                         const char **name,
                                                         const char **label,
                                                         const char **mime_type,
                                                         unsigned char **uri_string);
int                 raptor_world_is_parser_name         (raptor_world *world,
                                                         const char *name);
const char*         raptor_world_guess_parser_name      (raptor_world *world,
                                                         raptor_uri *uri,
                                                         const char *mime_type,
                                                         unsigned char *buffer,
                                                         size_t len,
                                                         unsigned char *identifier);
int                 raptor_world_enumerate_serializers  (raptor_world *world,
                                                         unsigned int counter,
                                                         const char **name,
                                                         const char **label,
                                                         const char **mime_type,
                                                         unsigned char **uri_string);
int                 raptor_world_is_serializer_name     (raptor_world *world,
                                                         const char *name);

Description

How to initialise and terminate the library, set library-wide configuration flags and options.

Details

raptor_world

typedef struct raptor_world_s raptor_world;

Raptor world class.

raptor_new_world ()

raptor_world*       raptor_new_world                    (void);

Allocate a new raptor_world object.

The raptor_world is initialized with raptor_world_open(). Allocation and initialization are decoupled to allow changing settings on the world object before init.

Returns :

 uninitialized raptor_world object or NULL on failure

raptor_world_open ()

int                 raptor_world_open                   (raptor_world *world);

Initialise the raptor library.

Initializes a raptor_world object created by raptor_new_world(). Allocation and initialization are decoupled to allow changing settings on the world object before init.

The initialized world object is used with subsequent raptor API calls.

world :

 raptor_world object

Returns :

 non-0 on failure

raptor_free_world ()

void                raptor_free_world                   (raptor_world *world);

Terminate the raptor library.

Destroys the raptor_world object and all related information.

world :

 raptor_world object

enum raptor_world_flag

typedef enum {
  RAPTOR_WORLD_FLAG_LIBXML_GENERIC_ERROR_SAVE = 1,
  RAPTOR_WORLD_FLAG_LIBXML_STRUCTURED_ERROR_SAVE = 2,
  RAPTOR_WORLD_FLAG_URI_INTERNING = 3,
  RAPTOR_WORLD_FLAG_WWW_SKIP_INIT_FINISH = 4
} raptor_world_flag;

Raptor world flags

These are used by raptor_world_set_flags() to control raptor-wide options across classes. These must be set before raptor_world_open() is called explicitly or implicitly (by creating a raptor object). There is no enumeration function for these flags because they are not user options and must be set before the library is initialised. For similar reasons, there is no get function.

If any libxml handler saving/restoring is enabled, any existing handler and context is saved before parsing and restored afterwards. Otherwise, no saving/restoring is performed.

RAPTOR_WORLD_FLAG_LIBXML_GENERIC_ERROR_SAVE

 if set (non-0 value) - save/restore the libxml generic error handler when raptor library initializes (default set)

RAPTOR_WORLD_FLAG_LIBXML_STRUCTURED_ERROR_SAVE

 if set (non-0 value) - save/restore the libxml structured error handler when raptor library terminates (default set)

RAPTOR_WORLD_FLAG_URI_INTERNING

 if set (non-0 value) - each URI is saved interned in-memory and reused (default set)

RAPTOR_WORLD_FLAG_WWW_SKIP_INIT_FINISH

 if set (non-0 value) the raptor will neither initialise or terminate the lower level WWW library. Usually in raptor initialising either curl_global_init (for libcurl) are called and in raptor cleanup, curl_global_cleanup is called. This flag allows the application finer control over these libraries such as setting other global options or potentially calling and terminating raptor several times. It does mean that applications which use this call must do their own extra work in order to allocate and free all resources to the system.

raptor_world_set_flag ()

int                 raptor_world_set_flag               (raptor_world *world,
                                                         raptor_world_flag flag,
                                                         int value);

Set library-wide configuration

This function is used to control raptor-wide options across classes. These options must be set before raptor_world_open() is called explicitly or implicitly (by creating a raptor object). There is no enumeration function for these flags because they are not user options and must be set before the library is initialised. For similar reasons, there is no get function.

See the raptor_world_flags documentation for full details of what the flags mean.

world :

 world

flag :

 flag

value :

 value

Returns :

 0 on success, non-0 on failure: <0 on errors (-1 if flag is unknown, -2 if value is illegal) and >0 if world is already opened

raptor_world_set_libxslt_security_preferences ()

int                 raptor_world_set_libxslt_security_preferences
                                                        (raptor_world *world,
                                                         void *security_preferences);

Set libxslt security preferences policy object

The security_preferences object will NOT become owned by raptor_world

If libxslt is compiled into the library, security_preferences should be an xsltSecurityPrefsPtr and will be used to call xsltSetCtxtSecurityPrefs() when an XSLT engine is initialised.

If libxslt is not compiled in, the object set here is not used.

world :

 world

security_preferences :

 security preferences (an xsltSecurityPrefsPtr)

Returns :

 0 on success, non-0 on failure: <0 on errors and >0 if world is already opened

raptor_world_set_log_handler ()

int                 raptor_world_set_log_handler        (raptor_world *world,
                                                         void *user_data,
                                                         raptor_log_handler handler);

Set the message (error, warning, info) handling function.

The function will receive callbacks when messages are generated

world :

 world object

user_data :

 user data to pass to function

handler :

 pointer to the function

Returns :

 non-0 on failure

raptor_world_enumerate_parsers ()

int                 raptor_world_enumerate_parsers      (raptor_world *world,
                                                         unsigned int counter,
                                                         const char **name,
                                                         const char **label,
                                                         const char **mime_type,
                                                         unsigned char **uri_string);

Get information on syntaxes.

world :

 raptor_world object

counter :

 index into the list of syntaxes

name :

 pointer to store the name of the syntax (or NULL)

label :

 pointer to store syntax readable label (or NULL)

mime_type :

 pointer to store syntax MIME Type (or NULL)

uri_string :

 pointer to store syntax URI string (or NULL)

Returns :

 non 0 on failure of if counter is out of range

raptor_world_is_parser_name ()

int                 raptor_world_is_parser_name         (raptor_world *world,
                                                         const char *name);

Check name of a parser.

world :

 raptor_world object

name :

 the syntax name

Returns :

 non 0 if name is a known syntax name

raptor_world_guess_parser_name ()

const char*         raptor_world_guess_parser_name      (raptor_world *world,
                                                         raptor_uri *uri,
                                                         const char *mime_type,
                                                         unsigned char *buffer,
                                                         size_t len,
                                                         unsigned char *identifier);

Guess a parser name for content.

Find a parser 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.

world :

 raptor_world object

uri :

 URI identifying the syntax (or NULL)

mime_type :

 mime type identifying the content (or NULL)

buffer :

 buffer of content to guess (or NULL)

len :

 length of buffer

identifier :

 identifier of content (or NULL)

Returns :

 a parser name or NULL if no guess could be made

raptor_world_enumerate_serializers ()

int                 raptor_world_enumerate_serializers  (raptor_world *world,
                                                         unsigned int counter,
                                                         const char **name,
                                                         const char **label,
                                                         const char **mime_type,
                                                         unsigned char **uri_string);

Get information on syntax serializers.

world :

 raptor_world object

counter :

 index into the list of syntaxes

name :

 pointer to store the name of the syntax (or NULL)

label :

 pointer to store syntax readable label (or NULL)

mime_type :

 pointer to store syntax MIME Type (or NULL)

uri_string :

 pointer to store syntax URI string (or NULL)

Returns :

 non 0 on failure of if counter is out of range

raptor_world_is_serializer_name ()

int                 raptor_world_is_serializer_name     (raptor_world *world,
                                                         const char *name);

Check name of a serializer.

world :

 raptor_world object

name :

 the syntax name

Returns :

 non 0 if name is a known syntax name
Generated by GTK-Doc V1.13

Navigation: Redland Home Page

Copyright 2000-2010 Dave Beckett