byte_source.h

Go to the documentation of this file.

/*
  Copyright 2011-2020 David Robillard <d@drobilla.net>
 
  Permission to use, copy, modify, and/or distribute this software for any
  purpose with or without fee is hereby granted, provided that the above
  copyright notice and this permission notice appear in all copies.
 
  THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
 
#ifndef SERD_BYTE_SOURCE_H
#define SERD_BYTE_SOURCE_H
 
#include "serd/serd.h"
 
#include <assert.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <stdio.h>
 
typedef struct {
  const uint8_t* filename;
  unsigned       line;
  unsigned       col;
} Cursor;
 
typedef struct {
  SerdSource          read_func;   
  SerdStreamErrorFunc error_func;  
  void*               stream;      
  size_t              page_size;   
  size_t              buf_size;    
  Cursor              cur;         
  uint8_t*            file_buf;    
  const uint8_t*      read_buf;    
  size_t              read_head;   
  uint8_t             read_byte;   
  bool                from_stream; 
  bool                prepared;    
  bool                eof;         
} SerdByteSource;
 
SerdStatus
serd_byte_source_open_file(SerdByteSource* source, FILE* file, bool bulk);
 
SerdStatus
serd_byte_source_open_string(SerdByteSource* source, const uint8_t* utf8);
 
SerdStatus
serd_byte_source_open_source(SerdByteSource*     source,
                             SerdSource          read_func,
                             SerdStreamErrorFunc error_func,
                             void*               stream,
                             const uint8_t*      name,
                             size_t              page_size);
 
SerdStatus
serd_byte_source_close(SerdByteSource* source);
 
SerdStatus
serd_byte_source_prepare(SerdByteSource* source);
 
SerdStatus
serd_byte_source_page(SerdByteSource* source);
 
static inline SERD_PURE_FUNC uint8_t
serd_byte_source_peek(SerdByteSource* source)
{
  assert(source->prepared);
  return source->read_buf[source->read_head];
}
 
static inline SerdStatus
serd_byte_source_advance(SerdByteSource* source)
{
  SerdStatus st = SERD_SUCCESS;
 
  switch (serd_byte_source_peek(source)) {
  case '\n':
    ++source->cur.line;
    source->cur.col = 0;
    break;
  default:
    ++source->cur.col;
  }
 
  const bool was_eof = source->eof;
  if (source->from_stream) {
    source->eof = false;
    if (source->page_size > 1) {
      if (++source->read_head == source->page_size) {
        st = serd_byte_source_page(source);
      } else if (source->read_head == source->buf_size) {
        source->eof = true;
      }
    } else {
      if (!source->read_func(&source->read_byte, 1, 1, source->stream)) {
        source->eof = true;
        st =
          source->error_func(source->stream) ? SERD_ERR_UNKNOWN : SERD_FAILURE;
      }
    }
  } else if (!source->eof) {
    ++source->read_head; // Move to next character in string
    if (source->read_buf[source->read_head] == '\0') {
      source->eof = true;
    }
  }
 
  return (was_eof && source->eof) ? SERD_FAILURE : st;
}
 
#endif // SERD_BYTE_SOURCE_H