Maintainer	defanor <defanor@uberspace.net>
Stability	unstable
Portability	non-portable (GHC extensions are used)
Safe Haskell	Safe
Language	Haskell2010

Redland.MidLevel

Contents

Exceptions
FFI utility functions
World
Hashes
RDF Graph (librdf_model)
RDF term (librdf_node)
Parsers
Querying
Query results
RDF Triple (librdf_statement)
Triple stores
Stream of triples (librdf_statement)
URI

Description

Mid-level Redland RDF library bindings: using Haskell naming conventions, common Haskell types, ForeignPtr with finalizers, exceptions, copied structures (as opposed to the shared ones, as nodes in statement-related functions in the C API). Closely follows the original API otherwise.

Synopsis

Exceptions

data RedlandException Source #

Constructors

InitializationException	Happens when an initializer returns NULL. Gets thrown by `initialize`.
OperationException Int	Happens on non-zero return value where a zero is expected. Gets thrown by `perform`.
StringOperationException	Gets thrown by `justCString` and `justSharedCString`.
ParseFailure

Instances

Show RedlandException Source #
Methods showsPrec :: Int -> RedlandException -> ShowS # show :: RedlandException -> String # showList :: [RedlandException] -> ShowS #
Exception RedlandException Source #
Methods toException :: RedlandException -> SomeException # fromException :: SomeException -> Maybe RedlandException # displayException :: RedlandException -> String #

FFI utility functions

type Initializer a = IO (ForeignPtr a) Source #

initialize :: IO (Ptr a) -> FinalizerPtr a -> Initializer a Source #

Initializes a Redland object, throws InitializationException on failure (i.e., if NULL is returned).

perform :: IO CInt -> IO () Source #

Performs an operation, throws OperationException on failure (i.e., on non-zero return value).

withNew :: Initializer a -> (ForeignPtr a -> IO b) -> IO b Source #

Initializes a Redland object, performs an action over it, makes sure to call finalizeForeignPtr afterwards.

withNullablePtr :: (a -> (Ptr b -> c) -> c) -> Maybe a -> (Ptr b -> c) -> c Source #

An abstraction to use with withCString and withForeignPtr.

maybeCString :: CString -> IO (Maybe String) Source #

Checks whether a CString is NULL, frees if it not, returns a Haskell String.

maybeSharedCString :: CString -> IO (Maybe String) Source #

justCString :: CString -> IO String Source #

Like maybeCString, but requires a string to be there, and throws StringOperationException if it isn't.

justSharedCString :: CString -> IO String Source #

Like justCString, but doesn't free the C string.

World

redlandWorld :: Initializer RedlandWorld Source #

Hashes

redlandHash Source #

Arguments

:: ForeignPtr RedlandWorld	world
-> String	hash factory name (e.g., "memory")
-> Initializer RedlandHash

hashPutStrings Source #

Arguments

:: ForeignPtr RedlandHash	hash
-> String	key
-> String	value
-> IO ()

hashGet Source #

Arguments

:: ForeignPtr RedlandHash	hash
-> String	key
-> IO (Maybe String)

hashGetDel Source #

Arguments

:: ForeignPtr RedlandHash	hash
-> String	key
-> IO (Maybe String)

RDF Graph (librdf_model)

redlandModel Source #

Arguments

:: ForeignPtr RedlandWorld	world
-> ForeignPtr RedlandStorage	storage
-> String	options
-> Initializer RedlandModel	model

modelQueryExecute :: ForeignPtr RedlandModel -> ForeignPtr RedlandQuery -> Initializer RedlandQueryResults Source #

Acts as a RedlandQueryResults initializer.

modelFindStatements :: ForeignPtr RedlandModel -> ForeignPtr RedlandStatement -> Initializer RedlandStream Source #

Acts as a RedlandStream initializer.

modelSync :: ForeignPtr RedlandModel -> IO () Source #

modelLoad Source #

Arguments

:: ForeignPtr RedlandModel
-> ForeignPtr RedlandURI	source URI
-> Maybe String	parser name
-> Maybe String	MIME type
-> Maybe (ForeignPtr RedlandURI)	type URI
-> IO ()

RDF term (librdf_node)

redlandNode :: ForeignPtr RedlandWorld -> Initializer RedlandNode Source #

nodeFromNode :: ForeignPtr RedlandNode -> Initializer RedlandNode Source #

nodeFromBlankIdentifier :: ForeignPtr RedlandWorld -> Maybe String -> Initializer RedlandNode Source #

nodeFromLiteral :: ForeignPtr RedlandWorld -> String -> Maybe String -> Bool -> Initializer RedlandNode Source #

nodeFromTypedLiteral :: ForeignPtr RedlandWorld -> String -> Maybe String -> Maybe (ForeignPtr RedlandURI) -> Initializer RedlandNode Source #

nodeFromURI :: ForeignPtr RedlandWorld -> ForeignPtr RedlandURI -> Initializer RedlandNode Source #

nodeFromURIString :: ForeignPtr RedlandWorld -> String -> Initializer RedlandNode Source #

nodeGetBlankIdentifier :: ForeignPtr RedlandNode -> IO String Source #

nodeGetLiteralValue :: ForeignPtr RedlandNode -> IO String Source #

nodeGetURI :: ForeignPtr RedlandNode -> Initializer RedlandURI Source #

nodeIsBlank :: ForeignPtr RedlandNode -> IO Bool Source #

nodeIsLiteral :: ForeignPtr RedlandNode -> IO Bool Source #

nodeIsResource :: ForeignPtr RedlandNode -> IO Bool Source #

nodeToString :: ForeignPtr RedlandNode -> IO String Source #

Parsers

redlandParser Source #

Arguments

:: ForeignPtr RedlandWorld	world
-> Maybe String	parser name (e.g., "rdfxml", "turtle")
-> Maybe String	MIME type
-> Maybe (ForeignPtr RedlandURI)	type URI
-> Initializer RedlandParser

parseStringIntoModel Source #

Arguments

:: ForeignPtr RedlandParser	parser
-> String	string to parse
-> ForeignPtr RedlandURI	base URI
-> ForeignPtr RedlandModel	model
-> IO ()

parserGuessName2 Source #

Arguments

:: ForeignPtr RedlandWorld
-> Maybe String	MIME type
-> Maybe String	content
-> Maybe String	content identifier
-> IO (Maybe String)

Querying

redlandQuery Source #

Arguments

:: ForeignPtr RedlandWorld
-> String	language name
-> Maybe (ForeignPtr RedlandURI)	language URI
-> String	query string
-> Maybe (ForeignPtr RedlandURI)	base URI
-> Initializer RedlandQuery

Query results

queryResultsGetCount :: ForeignPtr RedlandQueryResults -> IO Int Source #

queryResultsNext Source #

Arguments

:: ForeignPtr RedlandQueryResults
-> IO Bool	`True` if it's not finished.

queryResultsFinished :: ForeignPtr RedlandQueryResults -> IO Bool Source #

queryResultsGetBindingValue :: ForeignPtr RedlandQueryResults -> Int -> Initializer RedlandNode Source #

Acts as a RedlandNode initializer.

queryResultsGetBindingName :: ForeignPtr RedlandQueryResults -> Int -> IO String Source #

queryResultsGetBindingValueByName :: ForeignPtr RedlandQueryResults -> String -> Initializer RedlandNode Source #

Acts as a RedlandNode initializer.

queryResultsGetBindingsCount :: ForeignPtr RedlandQueryResults -> IO Int Source #

queryExecute :: ForeignPtr RedlandQuery -> ForeignPtr RedlandModel -> Initializer RedlandQueryResults Source #

Acts as a RedlandQueryResults initializer.

RDF Triple (librdf_statement)

redlandStatement :: ForeignPtr RedlandWorld -> Initializer RedlandStatement Source #

statementFromNodes Source #

Arguments

:: ForeignPtr RedlandWorld
-> Maybe (ForeignPtr RedlandNode)	subject
-> Maybe (ForeignPtr RedlandNode)	predicate
-> Maybe (ForeignPtr RedlandNode)	object
-> Initializer RedlandStatement

statementGet :: (Ptr RedlandStatement -> IO (Ptr RedlandNode)) -> ForeignPtr RedlandStatement -> IO (Maybe (ForeignPtr RedlandNode)) Source #

An abstraction used for getting statement components.

statementSet :: (Ptr RedlandStatement -> Ptr RedlandNode -> IO ()) -> ForeignPtr RedlandStatement -> Maybe (ForeignPtr RedlandNode) -> IO () Source #

An abstraction used for setting statement components.

statementGetSubject :: ForeignPtr RedlandStatement -> IO (Maybe (ForeignPtr RedlandNode)) Source #

statementSetSubject :: ForeignPtr RedlandStatement -> Maybe (ForeignPtr RedlandNode) -> IO () Source #

statementGetPredicate :: ForeignPtr RedlandStatement -> IO (Maybe (ForeignPtr RedlandNode)) Source #

statementSetPredicate :: ForeignPtr RedlandStatement -> Maybe (ForeignPtr RedlandNode) -> IO () Source #

statementGetObject :: ForeignPtr RedlandStatement -> IO (Maybe (ForeignPtr RedlandNode)) Source #

statementSetObject :: ForeignPtr RedlandStatement -> Maybe (ForeignPtr RedlandNode) -> IO () Source #

Triple stores

redlandStorage Source #

Arguments

:: ForeignPtr RedlandWorld	world
-> String	storage type name ("hashes", "memory", "file", etc)
-> String	storage identifier
-> String	options
-> Initializer RedlandStorage

redlandStorageWithOptions Source #

Arguments

:: ForeignPtr RedlandWorld	world
-> String	storage type name ("hashes", "memory", "file", etc)
-> String	storage identifier
-> ForeignPtr RedlandHash	options
-> Initializer RedlandStorage

Stream of triples (librdf_statement)

streamEnd :: ForeignPtr RedlandStream -> IO Bool Source #

streamNext Source #

Arguments

:: ForeignPtr RedlandStream
-> IO Bool	`True` if it's not finished.

streamGetObject :: ForeignPtr RedlandStream -> Initializer RedlandStatement Source #

URI

redlandURI Source #

Arguments

:: ForeignPtr RedlandWorld	world
-> String	URI string
-> Initializer RedlandURI

uriFromURI :: ForeignPtr RedlandURI -> Initializer RedlandURI Source #

uriAsString :: ForeignPtr RedlandURI -> IO String Source #