tokeniser.h

Go to the documentation of this file.

/*
 * This file is part of Hubbub.
 * Licensed under the MIT License,
 *                http://www.opensource.org/licenses/mit-license.php
 * Copyright 2007 John-Mark Bell <jmb@netsurf-browser.org>
 */
 
#ifndef hubbub_tokeniser_tokeniser_h_
#define hubbub_tokeniser_tokeniser_h_
 
#include <stdbool.h>
#include <inttypes.h>
 
#include <hubbub/errors.h>
#include <hubbub/functypes.h>
#include <hubbub/types.h>
 
#include <parserutils/input/inputstream.h>
 
typedef struct hubbub_tokeniser hubbub_tokeniser;
 
typedef enum hubbub_tokeniser_opttype {
    HUBBUB_TOKENISER_TOKEN_HANDLER,
    HUBBUB_TOKENISER_ERROR_HANDLER,
    HUBBUB_TOKENISER_CONTENT_MODEL,
    HUBBUB_TOKENISER_PROCESS_CDATA,
    HUBBUB_TOKENISER_PAUSE
} hubbub_tokeniser_opttype;
 
typedef union hubbub_tokeniser_optparams {
    struct {
        hubbub_token_handler handler;
        void *pw;
    } token_handler;        
    struct {
        hubbub_error_handler handler;
        void *pw;
    } error_handler;        
    struct {
        hubbub_content_model model;
    } content_model;        
    bool process_cdata;     
    bool pause_parse;       
} hubbub_tokeniser_optparams;
 
/* Create a hubbub tokeniser */
hubbub_error hubbub_tokeniser_create(parserutils_inputstream *input,
        hubbub_tokeniser **tokeniser);
/* Destroy a hubbub tokeniser */
hubbub_error hubbub_tokeniser_destroy(hubbub_tokeniser *tokeniser);
 
/* Configure a hubbub tokeniser */
hubbub_error hubbub_tokeniser_setopt(hubbub_tokeniser *tokeniser,
        hubbub_tokeniser_opttype type,
        hubbub_tokeniser_optparams *params);
 
/* Insert a chunk of data into the input stream */
hubbub_error hubbub_tokeniser_insert_chunk(hubbub_tokeniser *tokeniser,
        const uint8_t *data, size_t len);
 
/* Process remaining data in the input stream */
hubbub_error hubbub_tokeniser_run(hubbub_tokeniser *tokeniser);
 
#endif