mdl_app.h

Go to the documentation of this file.

#pragma once
 
#include <stddef.h>
#include <stdint.h>
 
#include "mdl_cache.h"
#include "mdl_export.h"
#include "mdl_extract.h"
#include "mdl_format.h"
#include "mdl_library.h"
#include "mdl_net.h"
#include "mdl_session.h"
#include "mdl_state.h"
#include "mdl_storage.h"
#include "ra8_err.h"
#include "ra8_io_stream.h"

typedef enum : uint32_t {
  k_page_buf_bytes     = 8U * 1024U * 1024U,  
  k_export_arena_bytes = 96U * 1024U * 1024U, 
  k_storage_work_bytes = 2048U,               
} mdl_app_limits_t;

typedef struct {
  mdl_net_policy_t          policy;           
  const mdl_net_provider_t* net;              
  const char*               contact;          
  bool                      honor_robots;     
  bool                      polite;           
  bool                      allow_incomplete; 
  bool                      progress;         
  bool                      refetch;          
} mdl_run_opts_t;

typedef struct {
  char                          title[k_mdl_title_max];       
  char                          summary[k_mdl_summary_max];   
  char                          writer[k_mdl_person_max];     
  char                          artist[k_mdl_person_max];     
  char                          cover_url[k_mdl_url_max];     
  char                          language[k_mdl_language_max]; 
  mdl_state_reading_direction_t direction;                    
  bool                          title_selected;               
} mdl_series_metadata_t;

typedef struct {
  const char*           cfg_path;     
  const char*           series_url;   
  const char*           out_dir;      
  const char*           cache_dir;    
  mdl_format_t          format;       
  bool                  combine;      
  bool                  update;       
  bool                  from_present; 
  double                from_num;     
  size_t                chapters;     
  uint64_t              seed;         
  uint32_t              timeout;      
  const mdl_run_opts_t* opts;         
} mdl_series_run_t;

typedef struct {
  const char* cfg_path; 
  const char* term;     
  size_t      pick;     
  uint32_t    timeout;  
  uint64_t    seed;     
  bool        browse;   
} mdl_discover_run_t;

typedef struct {
  mdl_session_t           session;                
  mdl_export_workspace_t  export_ws;              
  mdl_storage_t           storage;                
  ra8_io_stream_t*        output;                 
  ra8_io_stream_t*        diagnostic;             
  ra8_err_t               io_error;               
  char                    page[k_page_buf_bytes]; 
  mdl_url_list_t          chapters;               
  mdl_url_list_t          images;                 
  mdl_state_t             state;                  
  mdl_cache_index_t       cache_index;            
  mdl_library_workspace_t library_workspace;      
  union {
    max_align_t align;                         
    uint8_t     bytes[k_mdl_storage_io_bytes]; 
  } admin_directory_workspace;                 
  mdl_series_metadata_t series_metadata;       
} mdl_app_context_t;

void mdl_app_bind(mdl_app_context_t* ctx);

int mdl_app_run_series(const mdl_series_run_t* run);

int mdl_app_run_list(const char* out_dir);

int mdl_app_run_remove(const char* out_dir, const char* url_or_slug);

int mdl_app_run_update_all(const mdl_series_run_t* base);

int mdl_app_run_discover(const mdl_discover_run_t* req,
                         const mdl_run_opts_t*     opts,
                         const mdl_series_run_t*   base);

int mdl_app_run_verify(const char* target_dir);

int mdl_app_run_init_site(const char* url, const char* descriptor_dir);

int mdl_app_run_pack(const char* dir, mdl_format_t format);

int mdl_app_run_artifact(const char*           url,
                         const char*           out_dir,
                         uint32_t              timeout,
                         const mdl_run_opts_t* opts);

int mdl_app_run_page(const char*           url,
                     const char*           out_dir,
                     const char*           attr,
                     uint32_t              max_imgs,
                     uint64_t              seed,
                     uint32_t              timeout,
                     const mdl_run_opts_t* opts);