wa_text.h

/*
 * The text the Wi-Fi page reads and writes: a card path out of a URL
 * (uniform resource locator), names into HTML (hypertext markup language)
 * and back into URLs, a form field, a cookie, and a download's file name.
 *
 * The path is the part that decides what leaves the card, so it is read by
 * one rule and everything else is refused (wa_path_decode()).  The page only
 * ever links paths that rule takes.
 *
 * Pure C, no ESP-IDF (Espressif Internet-of-Things Development Framework).
 *
 * SPDX-License-Identifier: MIT
 */
 
#ifndef RCBENCH_WA_TEXT_H
#define RCBENCH_WA_TEXT_H
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif

#define WA_PATH_MAX       384u
#define WA_NAME_UNITS     255u
#define WA_NAME_BYTES     (WA_NAME_UNITS * 3u + 1u)
 
typedef enum {
    WA_PATH_OK = 0,
    WA_PATH_EMPTY,          
    WA_PATH_ABSOLUTE,       
    WA_PATH_DOTS,           
    WA_PATH_BACKSLASH,      
    WA_PATH_ENCODED_SLASH,  
    WA_PATH_NUL,            
    WA_PATH_CONTROL,        
    WA_PATH_ESCAPE,         
    WA_PATH_UTF8,           
    WA_PATH_EMPTY_NAME,     
    WA_PATH_NAME_LONG,      
    WA_PATH_LONG,           
} wa_path_err_t;

wa_path_err_t wa_path_decode(const char *in, size_t n, char *out, size_t cap);

long wa_utf8_units(const char *s, size_t n);
 
/* ----------------------------------------------------------- output */

typedef bool (*wa_sink_fn)(void *ctx, const void *data, size_t n);
 
#define WA_OUT_BUF 1024u

typedef struct {
    wa_sink_fn sink;
    void      *ctx;
    char       buf[WA_OUT_BUF];
    size_t     used;
    bool       failed;   
    uint64_t   total;    
} wa_out_t;
 
void wa_out_init(wa_out_t *o, wa_sink_fn sink, void *ctx);
void wa_out_raw(wa_out_t *o, const void *data, size_t n);
void wa_out_str(wa_out_t *o, const char *s);
void wa_out_html(wa_out_t *o, const char *s);
void wa_out_js(wa_out_t *o, const char *s);
void wa_out_url(wa_out_t *o, const char *path);
void wa_out_u64(wa_out_t *o, uint64_t v);
bool wa_out_flush(wa_out_t *o);
 
/* ------------------------------------------------------ what comes in */

bool wa_form_get(const char *body, size_t n, const char *key, char *out,
                 size_t cap);

bool wa_cookie_get(const char *header, const char *name, char *out,
                   size_t cap);

size_t wa_disposition(char *out, size_t cap, const char *name);

typedef struct {
    int year, month, day, hour, min, sec;
} wa_civil_t;

wa_civil_t wa_civil(int64_t t);

void wa_out_time(wa_out_t *o, int64_t t);

const char *wa_basename(const char *path);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RCBENCH_WA_TEXT_H */