book_stream_internal.h

Go to the documentation of this file.

#pragma once
 
#include "book_stream.h"
#include "ra8_attributes.h"

typedef enum : uint8_t {
  k_stream_hdr_version       = 8U,  
  k_stream_hdr_total         = 12U, 
  k_stream_hdr_flags         = 16U, 
  k_stream_hdr_title         = 20U, 
  k_stream_hdr_author        = 24U, 
  k_stream_hdr_language      = 28U, 
  k_stream_hdr_identifier    = 32U, 
  k_stream_hdr_cover         = 36U, 
  k_stream_hdr_chapter_count = 40U, 
  k_stream_hdr_chapter_off   = 44U, 
  k_stream_hdr_node_count    = 48U, 
  k_stream_hdr_node_off      = 52U, 
  k_stream_hdr_attr_count    = 56U, 
  k_stream_hdr_attr_off      = 60U, 
  k_stream_hdr_style_count   = 64U, 
  k_stream_hdr_style_off     = 68U, 
  k_stream_hdr_image_count   = 72U, 
  k_stream_hdr_image_off     = 76U, 
  k_stream_hdr_string_off    = 80U, 
  k_stream_hdr_string_size   = 84U, 
  k_stream_hdr_pool_off      = 88U, 
  k_stream_hdr_pool_size     = 92U, 
  k_stream_hdr_crc           = 96U, 
} stream_header_off_t;

typedef enum : uint8_t {
  k_stream_node_kind         = 0U,  
  k_stream_node_reserved     = 1U,  
  k_stream_node_attr_count   = 2U,  
  k_stream_node_name         = 4U,  
  k_stream_node_text         = 8U,  
  k_stream_node_first_attr   = 12U, 
  k_stream_node_first_child  = 16U, 
  k_stream_node_next_sibling = 20U, 
} stream_node_off_t;

typedef enum : uint8_t {
  k_stream_image_id        = 0U,  
  k_stream_image_width     = 4U,  
  k_stream_image_height    = 6U,  
  k_stream_image_format    = 8U,  
  k_stream_image_pixfmt    = 9U,  
  k_stream_image_reserved  = 10U, 
  k_stream_image_data_off  = 12U, 
  k_stream_image_data_size = 16U, 
  k_stream_image_raw_size  = 20U, 
} stream_image_off_t;

typedef enum : uint8_t {
  k_stream_bits_per_byte = 8U,  
  k_stream_mark_round    = 7U,  
  k_stream_le_shift_3    = 24U, 
} stream_bit_t;

RA8_INTERNAL static inline uint16_t internal_book_stream_le16(const uint8_t* p)
{
  return (uint16_t)((uint16_t)p[0] | ((uint16_t)p[1] << k_stream_bits_per_byte));
}

RA8_INTERNAL static inline uint32_t internal_book_stream_le32(const uint8_t* p)
{
  return (uint32_t)p[0] | ((uint32_t)p[1] << k_stream_bits_per_byte) |
         ((uint32_t)p[2] << (2U * k_stream_bits_per_byte)) |
         ((uint32_t)p[3] << k_stream_le_shift_3);
}

typedef struct {
  book_stream_read_fn read;        
  void*               read_ctx;    
  uint64_t            source_size; 
  uint8_t*            scratch;     
  uint32_t            scratch_cap; 
  book_header_t       hdr;         
} stream_validate_t;

RA8_PRIV ra8_err_t priv_book_stream_read_validate_header(stream_validate_t* ctx);

RA8_PRIV ra8_err_t priv_book_stream_string_ref(const stream_validate_t* ctx, uint32_t off);

RA8_PRIV ra8_err_t priv_book_stream_nonempty_string_ref(const stream_validate_t* ctx, uint32_t off);

RA8_PRIV ra8_err_t priv_book_stream_read(const stream_validate_t* ctx,
                                         uint64_t                 off,
                                         uint8_t*                 dst,
                                         uint32_t                 len);

RA8_PRIV ra8_err_t priv_book_stream_validate_string_envelope(const stream_validate_t* ctx);

RA8_PRIV ra8_err_t priv_book_stream_validate_metadata(const stream_validate_t* ctx);

RA8_PRIV ra8_err_t priv_book_stream_validate_element(const stream_validate_t* ctx,
                                                     const uint8_t*           rec,
                                                     uint32_t*                attr_cursor);

RA8_PRIV ra8_err_t priv_book_stream_validate_text(const stream_validate_t* ctx, const uint8_t* rec);

RA8_PRIV ra8_err_t priv_book_stream_validate_styles(const stream_validate_t* ctx);