rabook_compile.h

Go to the documentation of this file.

#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "book.h"
#include "ra8_err.h"

typedef struct {
  /* Pointers grouped before the uint32 caps so the 64-bit host unit-test
   * build has zero inter-field padding (clang-analyzer optin.performance). */
  book_chapter_t*    chapters;       
  book_node_t*       nodes;          
  book_attr_t*       attrs;          
  book_stylesheet_t* stylesheets;    
  book_image_t*      images;         
  char*              string_pool;    
  uint8_t*           image_pool;     
  uint8_t*           out;            
  uint32_t           chapter_cap;    
  uint32_t           node_cap;       
  uint32_t           attr_cap;       
  uint32_t           stylesheet_cap; 
  uint32_t           image_cap;      
  uint32_t           string_cap;     
  uint32_t           image_pool_cap; 
  uint32_t           out_cap;        
} ra8_rabook_buffers_t;

typedef struct {
  ra8_rabook_buffers_t buf;               
  uint32_t             chapter_count;     
  uint32_t             node_count;        
  uint32_t             attr_count;        
  uint32_t             stylesheet_count;  
  uint32_t             image_count;       
  uint32_t             string_size;       
  uint32_t             image_pool_size;   
  uint32_t             title_off;         
  uint32_t             author_off;        
  uint32_t             language_off;      
  uint32_t             identifier_off;    
  uint32_t             cover_image_index; 
  uint32_t             flags;             
  uint8_t              image_pool_mode;   
  bool                 failed;            
} ra8_rabook_ctx_t;

typedef ra8_err_t (*ra8_rabook_image_read_fn)(void*     ctx,
                                              uint32_t  offset,
                                              uint8_t*  dst,
                                              uint32_t  requested,
                                              uint32_t* out_read);

typedef ra8_err_t (*ra8_rabook_write_fn)(void*          ctx,
                                         const uint8_t* src,
                                         uint32_t       requested,
                                         uint32_t*      out_written);

ra8_err_t rabook_compile_init(ra8_rabook_ctx_t* ctx, const ra8_rabook_buffers_t* buf);

uint32_t ra8_rabook_intern(ra8_rabook_ctx_t* ctx, const char* str);

uint32_t ra8_rabook_add_element(ra8_rabook_ctx_t*  ctx,
                                uint32_t           name_off,
                                const book_attr_t* attrs,
                                uint16_t           attr_count);

uint32_t ra8_rabook_add_text(ra8_rabook_ctx_t* ctx, uint32_t text_off);

ra8_err_t ra8_rabook_link_child(ra8_rabook_ctx_t* ctx, uint32_t parent, uint32_t child);

ra8_err_t
ra8_rabook_link_sibling(ra8_rabook_ctx_t* ctx, uint32_t previous_node, uint32_t next_sibling);

uint32_t ra8_rabook_add_chapter(ra8_rabook_ctx_t* ctx,
                                uint32_t          title_off,
                                uint32_t          href_off,
                                uint32_t          root_node);

uint32_t ra8_rabook_add_image(ra8_rabook_ctx_t* ctx,
                              uint32_t          id_off,
                              uint16_t          width,
                              uint16_t          height,
                              uint8_t           format,
                              uint8_t           pixel_format,
                              const uint8_t*    data,
                              uint32_t          data_size);

uint32_t ra8_rabook_add_image_external(ra8_rabook_ctx_t* ctx,
                                       uint32_t          id_off,
                                       uint16_t          width,
                                       uint16_t          height,
                                       uint8_t           format,
                                       uint8_t           pixel_format,
                                       uint32_t          data_size,
                                       uint32_t*         out_data_off);

uint32_t
ra8_rabook_add_stylesheet(ra8_rabook_ctx_t* ctx, uint32_t source_off, uint32_t scope_chapter);

ra8_err_t ra8_rabook_set_metadata(ra8_rabook_ctx_t* ctx,
                                  uint32_t          title_off,
                                  uint32_t          author_off,
                                  uint32_t          language_off,
                                  uint32_t          identifier_off,
                                  uint32_t          cover_image_index);

ra8_err_t ra8_rabook_finalize(ra8_rabook_ctx_t* ctx, const void** out_blob, uint32_t* out_len);

ra8_err_t ra8_rabook_finalize_stream(const ra8_rabook_ctx_t*  ctx,
                                     ra8_rabook_image_read_fn image_read,
                                     void*                    image_ctx,
                                     ra8_rabook_write_fn      write,
                                     void*                    write_ctx,
                                     uint8_t*                 scratch,
                                     uint32_t                 scratch_cap,
                                     uint32_t*                out_len);
 
#ifdef __cplusplus
} /* extern "C" */
#endif