/*
WARNING: This file was generated by dkct.
Changes you make here will be lost if dkct is run again!
You should modify the original source and run dkct on it.
Original source: dk3bom.ctr
*/
/*
Copyright (C) 2015-2017, Dirk Krause
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above opyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the author nor the names of contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef DK3BOM_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK3BOM_H_INCLUDED 1
#line 9 "dk3bom.ctr"
#include "dk3conf.h"
#include "dk3types.h"
/** @file dk3bom.h Byte order marker detection.
The functions in this module check for a byte order marker at the
start of a data stream.
First use dk3bom_detect_init() to initialize a detector structure.
Use dk3bom_detect_add() to add the first byte to the dectector.
As long as the result is DK3_STM_ACCEPT, continue adding bytes.
On DK3_STM_FINISHED use dk3bom_detect_results() to retrieve the
detected encoding and the array of rejected bytes.
Process the rejected bytes before processing the remaining bytes
from the data stream.
*/
/** State machine to detect a BOM (byte order marker) at
the start of a data stream.
*/
typedef struct {
int defenc;
int found;
int state;
size_t rjb;
unsigned char rj[4];
} dk3_bom_detector_t;
#ifdef __cplusplus
extern "C" {
#endif
/** Initialize detector structure.
@param ptr Detector structure to initialize.
*/
void
dk3bom_detect_init(dk3_bom_detector_t *ptr, int de);
/** Add one byte to detector.
@param ptr Detector structure.
@param b Byte to add.
@return
DK3_STM_ACCEPT if there is no result yet,
DK3_STM_FINISHED if a result was found or
DK3_STM_ERROR on attempts to add further bytes
after a result was found.
*/
int
dk3bom_detect_add(dk3_bom_detector_t *ptr, unsigned char b);
/** Retrieve results from detector structure.
@param enc Pointer to variable receiving encoding.
@param rjptr Address of pointer receiving address of rejected bytes
array.
@param rjsz Pointer to variable receiving size of rejected bytes
array.
@param ptr Detector structure (data source).
*/
void
dk3bom_detect_results(
int *enc, const unsigned char **rjptr, size_t *rjsz, dk3_bom_detector_t *ptr
);
#ifdef __cplusplus
}
#endif
#endif