scanner.h

Go to the documentation of this file.

/* 
 * Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
 * Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 
 */
#ifndef __PJ_SCANNER_H__
#define __PJ_SCANNER_H__
 
#include <pjlib-util/types.h>
 
PJ_BEGIN_DECL
 
#if defined(PJ_SCANNER_USE_BITWISE) && PJ_SCANNER_USE_BITWISE != 0
#  include <pjlib-util/scanner_cis_bitwise.h>
#else
#  include <pjlib-util/scanner_cis_uint.h>
#endif
 
PJ_DECL(void) pj_cis_buf_init(pj_cis_buf_t *cs_buf);
 
PJ_DECL(pj_status_t) pj_cis_init(pj_cis_buf_t *cs_buf, pj_cis_t *cis);
 
PJ_DECL(pj_status_t) pj_cis_dup(pj_cis_t *new_cis, pj_cis_t *existing);
 
PJ_DECL(void) pj_cis_add_range( pj_cis_t *cis, int cstart, int cend);
 
PJ_DECL(void) pj_cis_add_alpha( pj_cis_t *cis);
 
PJ_DECL(void) pj_cis_add_num( pj_cis_t *cis);
 
PJ_DECL(void) pj_cis_add_str( pj_cis_t *cis, const char *str);
 
PJ_DECL(void) pj_cis_add_cis( pj_cis_t *cis, const pj_cis_t *rhs);
 
PJ_DECL(void) pj_cis_del_range( pj_cis_t *cis, int cstart, int cend);
 
PJ_DECL(void) pj_cis_del_str( pj_cis_t *cis, const char *str);
 
PJ_DECL(void) pj_cis_invert( pj_cis_t *cis );
 
PJ_INLINE(int) pj_cis_match( const pj_cis_t *cis, pj_uint8_t c )
{
    return PJ_CIS_ISSET(cis, c);
}
 
 
enum
{
    PJ_SCAN_AUTOSKIP_WS = 1,
 
    PJ_SCAN_AUTOSKIP_WS_HEADER = 3,
 
    PJ_SCAN_AUTOSKIP_NEWLINE = 4
};
 
 
/* Forward decl. */
struct pj_scanner;
 
 
typedef void (*pj_syn_err_func_ptr)(struct pj_scanner *scanner);
 
 
typedef struct pj_scanner
{
    char *begin;        
    char *end;          
    char *curptr;       
    int   line;         
    char *start_line;   
    int   skip_ws;      
    pj_syn_err_func_ptr callback;   
} pj_scanner;
 
 
typedef struct pj_scan_state
{
    char *curptr;       
    int   line;         
    char *start_line;   
} pj_scan_state;
 
 
PJ_DECL(void) pj_scan_init( pj_scanner *scanner, char *bufstart, 
                            pj_size_t buflen, 
                            unsigned options,
                            pj_syn_err_func_ptr callback );
 
 
PJ_DECL(void) pj_scan_fini( pj_scanner *scanner );
 
 
PJ_INLINE(int) pj_scan_is_eof( const pj_scanner *scanner)
{
    return scanner->curptr >= scanner->end;
}
 
 
PJ_DECL(int) pj_scan_peek( pj_scanner *scanner,
                           const pj_cis_t *spec, pj_str_t *out);
 
 
PJ_DECL(int) pj_scan_peek_n( pj_scanner *scanner,
                             pj_size_t len, pj_str_t *out);
 
 
PJ_DECL(int) pj_scan_peek_until( pj_scanner *scanner,
                                 const pj_cis_t *spec, 
                                 pj_str_t *out);
 
 
PJ_DECL(void) pj_scan_get( pj_scanner *scanner,
                           const pj_cis_t *spec, pj_str_t *out);
 
 
PJ_DECL(void) pj_scan_get_unescape( pj_scanner *scanner,
                                    const pj_cis_t *spec, pj_str_t *out);
 
 
PJ_DECL(void) pj_scan_get_quote( pj_scanner *scanner,
                                 int begin_quote, int end_quote, 
                                 pj_str_t *out);
 
PJ_DECL(void) pj_scan_get_quotes(pj_scanner *scanner,
                                 const char *begin_quotes,
                                 const char *end_quotes, int qsize,
                                 pj_str_t *out);
 
 
PJ_DECL(void) pj_scan_get_n( pj_scanner *scanner,
                             unsigned N, pj_str_t *out);
 
 
PJ_DECL(int) pj_scan_get_char( pj_scanner *scanner );
 
 
PJ_DECL(void) pj_scan_get_until( pj_scanner *scanner,
                                 const pj_cis_t *spec, pj_str_t *out);
 
 
PJ_DECL(void) pj_scan_get_until_ch( pj_scanner *scanner, 
                                    int until_char, pj_str_t *out);
 
 
PJ_DECL(void) pj_scan_get_until_chr( pj_scanner *scanner,
                                     const char *until_spec, pj_str_t *out);
 
PJ_DECL(void) pj_scan_advance_n( pj_scanner *scanner,
                                 unsigned N, pj_bool_t skip);
 
 
PJ_DECL(int) pj_scan_strcmp( pj_scanner *scanner, const char *s, int len);
 
 
PJ_DECL(int) pj_scan_stricmp( pj_scanner *scanner, const char *s, int len);
 
PJ_DECL(int) pj_scan_stricmp_alnum( pj_scanner *scanner, const char *s, 
                                    int len);
 
 
PJ_DECL(void) pj_scan_get_newline( pj_scanner *scanner );
 
 
PJ_DECL(void) pj_scan_skip_whitespace( pj_scanner *scanner );
 
 
PJ_DECL(void) pj_scan_skip_line( pj_scanner *scanner );
 
PJ_DECL(void) pj_scan_save_state( const pj_scanner *scanner, 
                                  pj_scan_state *state);
 
 
PJ_DECL(void) pj_scan_restore_state( pj_scanner *scanner, 
                                     pj_scan_state *state);
 
PJ_INLINE(int) pj_scan_get_col( const pj_scanner *scanner )
{
    return (int)(scanner->curptr - scanner->start_line);
}
 
PJ_END_DECL
 
#endif