reflow_api.h

Go to the documentation of this file.

 
#pragma once
 
#include <stddef.h>
#include <stdint.h>
 
#include "ra8_err.h"
#include "ra8_glyph_atlas.h" /* ra8_glyph_atlas_t + storage descriptor types (#164) */
#include "reflow_image.h"    /* ra8_img_arena_t for the decode scratch              */
#include "reflow_types.h"    /* reflow_t + supporting data model                    */
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ===========================================================================
 * Public API -- lifecycle
 * ===========================================================================
 */

[[nodiscard]] ra8_err_t reflow_init(uint16_t       viewport_w,
                                    uint16_t       viewport_h,
                                    const uint8_t* font_data,
                                    size_t         font_len,
                                    uint16_t       font_px,
                                    uint32_t       body_color,
                                    uint32_t       link_color,
                                    reflow_t*      out_engine);

[[nodiscard]] ra8_err_t reflow_close(reflow_t* engine);

[[nodiscard]] ra8_err_t reflow_set_image_loader(reflow_t*              engine,
                                                reflow_image_loader_fn loader,
                                                void*                  ctx,
                                                ra8_img_arena_t*       arena);

[[nodiscard]] ra8_err_t
reflow_set_css_loader(reflow_t* engine, reflow_css_loader_fn loader, void* ctx);

typedef struct {
  uint8_t*             cell_mem;     
  uint32_t             cell_bytes;   
  uint32_t             cell_count;   
  ra8_keycache_cell_t* meta;         
  ra8_glyph_key_t*     keys;         
  ra8_glyph_dims_t*    dims;         
  int32_t*             buckets;      
  uint32_t             bucket_count; 
} reflow_glyph_atlas_storage_t;

[[nodiscard]] ra8_err_t reflow_set_glyph_atlas(reflow_t*                           engine,
                                               ra8_glyph_atlas_t*                  atlas,
                                               const reflow_glyph_atlas_storage_t* storage);

[[nodiscard]] ra8_err_t reflow_hit_test_link(const reflow_t* engine,
                                             uint32_t        page_idx,
                                             int32_t         x,
                                             int32_t         y,
                                             uint32_t*       out_href_off,
                                             uint32_t*       out_href_len);

[[nodiscard]] ra8_err_t reflow_hit_test_image(const reflow_t* engine,
                                              uint32_t        page_idx,
                                              int32_t         x,
                                              int32_t         y,
                                              uint32_t*       out_index);

[[nodiscard]] ra8_err_t
reflow_find_anchor(const reflow_t* engine, const char* id, uint32_t id_len, uint32_t* out_page);

[[nodiscard]] ra8_err_t reflow_href_split(const char*         href,
                                          uint32_t            len,
                                          reflow_href_kind_t* out_kind,
                                          uint32_t*           out_path_len,
                                          uint32_t*           out_frag_off,
                                          uint32_t*           out_frag_len);
 
/* ===========================================================================
 * Public API -- layout
 * ===========================================================================
 */

[[nodiscard]] ra8_err_t reflow_layout_chapter(reflow_t*      engine,
                                              const uint8_t* xhtml_buf,
                                              size_t         xhtml_len,
                                              uint32_t*      out_total_pages);

[[nodiscard]] ra8_err_t
reflow_render_page(const reflow_t* engine, uint32_t page_idx, void* framebuffer);

[[nodiscard]] ra8_err_t reflow_render_page_at(const reflow_t* engine,
                                              uint32_t        page_idx,
                                              int32_t         origin_x,
                                              int32_t         origin_y);

[[nodiscard]] ra8_err_t reflow_get_page_count(const reflow_t* engine, uint32_t* out_count);

[[nodiscard]] ra8_err_t reflow_set_font_size(reflow_t* engine, uint16_t new_font_px);

[[nodiscard]] ra8_err_t
reflow_bind_font(reflow_t* engine, const uint8_t* font_data, size_t font_len);

[[nodiscard]] ra8_err_t
reflow_register_face(reflow_t* engine, uint8_t css_face_idx, const uint8_t* blob, size_t len);
 
/* ===========================================================================
 * Internal -- exposed for the parse / layout / render TUs
 * ===========================================================================
 */

[[nodiscard]] ra8_err_t
reflow_parse_xhtml(reflow_t* engine, const uint8_t* xhtml_buf, size_t xhtml_len);

[[nodiscard]] ra8_err_t reflow_run_layout(reflow_t* engine);
 
#ifdef __cplusplus
}
#endif