xml.h

Go to the documentation of this file.

#pragma once
 
#include <stddef.h>
#include <stdint.h>
 
#include "ra8_err.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum : uint16_t {
  k_xml_max_element_depth = 499U, 
  k_xml_workspace_frames  = 512U, 
} xml_limits_t;

typedef struct {
  uint32_t offset; 
  uint32_t length; 
} xml_span_t;

typedef struct {
  uint32_t name_offset; 
  uint16_t name_length; 
  uint16_t consumer;    
} xml_frame_t;

typedef struct {
  xml_frame_t frames[k_xml_workspace_frames]; 
} xml_workspace_t;

typedef enum : uint8_t {
  k_xml_event_none  = 0U, 
  k_xml_event_start = 1U, 
  k_xml_event_end   = 2U, 
  k_xml_event_text  = 3U, 
  k_xml_event_cdata = 4U, 
} xml_event_kind_t;

typedef struct {
  xml_span_t markup;          
  xml_span_t name;            
  uint16_t   depth;           
  uint16_t   attribute_count; 
  uint8_t    kind;            
  uint8_t    self_closing;    
} xml_event_t;

typedef struct {
  xml_span_t name;  
  xml_span_t value; 
} xml_attribute_t;

typedef struct {
  uint32_t position; 
  uint16_t emitted;  
} xml_attr_cursor_t;

typedef struct {
  const uint8_t*   source;           
  size_t           source_len;       
  size_t           position;         
  xml_workspace_t* workspace;        
  uint16_t         stack_size;       
  uint8_t          root_count;       
  uint8_t          root_closed;      
  uint8_t          declaration_seen; 
  uint8_t          doctype_seen;     
  uint8_t          finished;         
} xml_reader_t;

[[nodiscard]] ra8_err_t xml_reader_init(xml_reader_t*    reader,
                                        const uint8_t*   source,
                                        size_t           source_len,
                                        xml_workspace_t* workspace);

[[nodiscard]] ra8_err_t xml_reader_next(xml_reader_t* reader, xml_event_t* out_event);

[[nodiscard]] ra8_err_t
xml_validate(const uint8_t* source, size_t source_len, xml_workspace_t* workspace);

void xml_attr_begin(const xml_event_t* event, xml_attr_cursor_t* cursor);

[[nodiscard]] ra8_err_t xml_attr_next(const uint8_t*     source,
                                      size_t             source_len,
                                      const xml_event_t* event,
                                      xml_attr_cursor_t* cursor,
                                      xml_attribute_t*   out_attribute,
                                      bool*              out_has_value);

[[nodiscard]] bool
xml_span_equal(const uint8_t* source, size_t source_len, xml_span_t span, const char* literal);

[[nodiscard]] bool xml_span_local_equal(const uint8_t* source,
                                        size_t         source_len,
                                        xml_span_t     span,
                                        const char*    literal);

[[nodiscard]] bool
xml_decoded_equal(const uint8_t* source, size_t source_len, xml_span_t left, xml_span_t right);

[[nodiscard]] ra8_err_t xml_decode(const uint8_t* source,
                                   size_t         source_len,
                                   xml_span_t     span,
                                   char*          destination,
                                   size_t         capacity,
                                   size_t*        out_length);

[[nodiscard]] ra8_err_t
xml_decoded_size(const uint8_t* source, size_t source_len, xml_span_t span, size_t* out_length);

[[nodiscard]] ra8_err_t xml_decode_prefix(const uint8_t* source,
                                          size_t         source_len,
                                          xml_span_t     span,
                                          char*          destination,
                                          size_t         capacity,
                                          size_t*        out_length);
 
#ifdef __cplusplus
} /* extern "C" */
#endif