rdff.h

Go to the documentation of this file.

/*
  RDFF - RDF in RIFF
  Copyright 2011 David Robillard <http://drobilla.net>

  Permission to use, copy, modify, and/or distribute this software for any
  purpose with or without fee is hereby granted, provided that the above
  copyright notice and this permission notice appear in all copies.

  THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/

#ifndef RDFF_RDFF_H
#define RDFF_RDFF_H

#include <stdbool.h>
#include <stdint.h>

#ifdef __GNUC__
#    define PACKED __attribute__((__packed__))
#else
#    define PACKED
#endif

#ifdef __cplusplus
extern "C" {
#endif

typedef struct _RDFF* RDFF;

typedef enum {
        RDFF_STATUS_OK            = 0,  
        RDFF_STATUS_UNKNOWN_ERROR = 1,  
        RDFF_STATUS_EOF           = 2,  
        RDFF_STATUS_CORRUPT       = 3   
} RDFFStatus;

typedef struct {
        char     type[4];  
        uint32_t size;     
        char     data[];   
} PACKED RDFFChunk;

typedef struct {
        uint32_t id;     
        char     uri[];  
} PACKED RDFFURIChunk;

typedef struct {
        uint32_t subject;      
        uint32_t predicate;    
        uint32_t object_type;  
        uint32_t object_size;  
        char     object[];     
} PACKED RDFFTripleChunk;

RDFF
rdff_open(const char* path, bool write);

RDFFStatus
rdff_write_uri(RDFF        file,
               uint32_t    id,
               uint32_t    len,
               const char* uri);

RDFFStatus
rdff_write_triple(RDFF        file,
                  uint32_t    subject,
                  uint32_t    predicate,
                  uint32_t    object_type,
                  uint32_t    object_size,
                  const void* object);

RDFFStatus
rdff_read_chunk(RDFF        file,
                RDFFChunk** buf);

bool
rdff_chunk_is_uri(RDFFChunk* chunk);

bool
rdff_chunk_is_triple(RDFFChunk* chunk);

void
rdff_close(RDFF file);

#ifdef __cplusplus
} /* extern "C" */
#endif

#endif /* RDFF_RDFF_H */