General

General — General library constants and utility functions

Synopsis

extern              const unsigned int raptor_version_major;
extern              const unsigned int raptor_version_minor;
extern              const unsigned int raptor_version_release;
extern              const unsigned int raptor_version_decimal;
void                (*raptor_statement_handler)         (void *user_data,
                                                         raptor_statement *statement);
char*               raptor_vsnprintf                    (const char *message);
void                (*raptor_log_handler)               (void *user_data,
                                                         raptor_log_message *message);
enum                raptor_log_level;
const char*         raptor_log_level_get_label          (raptor_log_level level);
enum                raptor_domain;
const char*         raptor_domain_get_label             (raptor_domain domain);
int                 (*raptor_data_compare_function)     (const void *data1,
                                                         const void *data2);
void                (*raptor_data_free_function)        (void *data);

Description

How to get access to version numbers, set message and error handlers, list the parsed and serialized syntaxes provided in the library and various other utility functions.

Details

raptor_version_major

extern const unsigned int raptor_version_major;

Library major version number as a decimal integer.


raptor_version_minor

extern const unsigned int raptor_version_minor;

Library minor version number as a decimal integer.


raptor_version_release

extern const unsigned int raptor_version_release;

Library release version number as a decimal integer.


raptor_version_decimal

extern const unsigned int raptor_version_decimal;

Library full version as a decimal integer.

See also raptor_version_string.


raptor_statement_handler ()

void                (*raptor_statement_handler)         (void *user_data,
                                                         raptor_statement *statement);

Statement (triple) reporting handler function.

user_data :

user data

statement :

statement to report

raptor_vsnprintf ()

char*               raptor_vsnprintf                    (const char *message);

Format output for a variable arguments list.

This is a wrapper around system versions of vsnprintf with different call and return conventions.

message :

printf-style format string

Returns :

a newly allocated string as the format result or NULL on failure

raptor_log_handler ()

void                (*raptor_log_handler)               (void *user_data,
                                                         raptor_log_message *message);

Handler function for log messages with location

Used during parsing and serializing for errors and warnings that may include location information. Handlers may be set by raptor_world_set_log_handler().

user_data :

user data

message :

log message

enum raptor_log_level

typedef enum {
  RAPTOR_LOG_LEVEL_NONE,
  RAPTOR_LOG_LEVEL_TRACE,
  RAPTOR_LOG_LEVEL_DEBUG,
  RAPTOR_LOG_LEVEL_INFO,
  RAPTOR_LOG_LEVEL_WARN,
  RAPTOR_LOG_LEVEL_ERROR,
  RAPTOR_LOG_LEVEL_FATAL,
  RAPTOR_LOG_LEVEL_LAST = RAPTOR_LOG_LEVEL_FATAL
} raptor_log_level;

Log levels

RAPTOR_LOG_LEVEL_NONE

Internal

RAPTOR_LOG_LEVEL_TRACE

very fine-grained tracing messages information

RAPTOR_LOG_LEVEL_DEBUG

fine-grained tracing messages suitable for debugging

RAPTOR_LOG_LEVEL_INFO

coarse-grained information messages

RAPTOR_LOG_LEVEL_WARN

warning messages of potentially harmful problems

RAPTOR_LOG_LEVEL_ERROR

error messages where the application can continue

RAPTOR_LOG_LEVEL_FATAL

fatal error message where the application will likely abort

RAPTOR_LOG_LEVEL_LAST

Internal

raptor_log_level_get_label ()

const char*         raptor_log_level_get_label          (raptor_log_level level);

Get label for a log message level

level :

log message level

Returns :

label string or NULL if level is not valid

enum raptor_domain

typedef enum {
  RAPTOR_DOMAIN_NONE,
  RAPTOR_DOMAIN_IOSTREAM,
  RAPTOR_DOMAIN_NAMESPACE,
  RAPTOR_DOMAIN_PARSER,
  RAPTOR_DOMAIN_QNAME,
  RAPTOR_DOMAIN_SAX2,
  RAPTOR_DOMAIN_SERIALIZER,
  RAPTOR_DOMAIN_TERM,
  RAPTOR_DOMAIN_URI,
  RAPTOR_DOMAIN_WORLD,
  RAPTOR_DOMAIN_WWW,
  RAPTOR_DOMAIN_XML_WRITER,
  RAPTOR_DOMAIN_LAST = RAPTOR_DOMAIN_XML_WRITER
} raptor_domain;

Log domain

RAPTOR_DOMAIN_NONE

Internal

RAPTOR_DOMAIN_IOSTREAM

I/O stream

RAPTOR_DOMAIN_NAMESPACE

XML Namespace / namespace stack

RAPTOR_DOMAIN_PARSER

RDF Parser

RAPTOR_DOMAIN_QNAME

XML QName

RAPTOR_DOMAIN_SAX2

XML SAX2

RAPTOR_DOMAIN_SERIALIZER

RDF Serializer

RAPTOR_DOMAIN_TERM

RDF Term

RAPTOR_DOMAIN_URI

RDF Uri

RAPTOR_DOMAIN_WORLD

RDF world

RAPTOR_DOMAIN_WWW

WWW

RAPTOR_DOMAIN_XML_WRITER

XML Writer

RAPTOR_DOMAIN_LAST

Internal

raptor_domain_get_label ()

const char*         raptor_domain_get_label             (raptor_domain domain);

Get label for a domain

domain :

domain

Returns :

label string or NULL if domain is not valid

raptor_data_compare_function ()

int                 (*raptor_data_compare_function)     (const void *data1,
                                                         const void *data2);

Function to compare two data objects - signature like strcmp() and function pssed to qsort()

Designed to be passed into generic data structure constructors like raptor_new_avltree().

data1 :

first data object

data2 :

second data object

Returns :

compare value - <0 if data1 is before data2, =0 if equal, >0 if data1 is after data2

raptor_data_free_function ()

void                (*raptor_data_free_function)        (void *data);

Function to free a data object - signature like free()

Designed to be passed into generic data structure constructors like raptor_new_avltree().

data :

data object


Navigation: Redland Home Page

Copyright 2000-2010 Dave Beckett