epub.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2025 Anna-Lena Marx <mail@marx.engineer>
 *
 * SPDX-License-Identifier: MPL-2.0
 */
 
#ifndef _EPUB_H_
#define _EPUB_H_
 
#include <stdint.h>
#include <stddef.h>


#define EPUB_FILE_LEN_MAX 255

#define EPUB_STATE_STRING_SIZE 500

#define EPUB_CONTAINER_XML_READ_SIZE 350

#define EPUB_OPF_READ_SIZE 800

#define EPUB_LSDIR_CHARS_MAX 4096

#define EPUB_PARSE_BUFFER_SIZE 4096 // Increased to accommodate larger raw content for parsing

#define EPUB_MAX_PAGE_BUFFER_SIZE 1500 // A reasonable maximum for a display page

#define STATE_FILE "/SD:/.statefile"

typedef struct
{
  size_t number;

  char *title;

  char *author;

  char *entry_point;

  char *content_dir;
} book_entry_t;

typedef struct llist
{
  book_entry_t *book;

  struct llist *next;
} book_list_t;

typedef struct
{
  size_t number;

  char *title;

  char *path;
} chapter_entry_t;

typedef struct dllist
{
  chapter_entry_t *chapter;

  struct dllist *next;

  struct dllist *prev;
} chapter_list_t;

typedef struct
{
  uint16_t num_chapters;

  chapter_list_t *chapter_list;

  chapter_list_t *current_chapter;

  char page[EPUB_MAX_PAGE_BUFFER_SIZE];

  char *chapter_filename;

  char *chapter_raw_content;

  size_t chapter_raw_content_size;

  char *chapter_prettified_content;

  size_t chapter_prettified_content_size;

  char *content_dir;

  struct
  {
    // May use title instead of number in future
    char *title;

    int32_t chapter;

    int32_t page;
 
  } state;
 
} current_book_t;

typedef struct
{
  uint32_t count;

  uint32_t current;

  char *title;
 
} chapter_status_t;

int epub_destroy_book_list();

int epub_initialize();

book_list_t *epub_get_book_list();

book_entry_t *epub_get_book_entry_for_num(uint16_t number);

book_entry_t *epub_get_book_entry_for_title(char *title);

int epub_open_book(book_entry_t *book);

int epub_restore_book();

int epub_switch_chapter(uint32_t chapter);

const char *epub_get_current_chapter_content(void);

int epub_get_next_chapter(void);

int epub_get_prev_chapter(void);

chapter_status_t *epub_get_chapter_status(void);

chapter_list_t *epub_get_chapter_list();

void epub_update_page(int32_t update);

int32_t epub_get_page(void);

int epub_write_current_book_state();

current_book_t *epub_get_current_book_state();

int epub_free_current_book_resources();

#endif