tk.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008 - 2020, Andy Bierman, All Rights Reserved.
 * Copyright (c) 2012 - 2021, YumaWorks, Inc., All Rights Reserved.
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
#ifndef _H_tk
#define _H_tk
 
/*  FILE: tk.h
*********************************************************************
*                                                                   *
*                        P U R P O S E                              *
*                                                                   *
*********************************************************************/
 
/*********************************************************************
*                                                                   *
*                  C H A N G E   H I S T O R Y                      *
*                                                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
12-nov-05    abb      Begun
 
*/
 
#include <xmlstring.h>
 
#ifndef _H_dlq
#include "dlq.h"
#endif
 
#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif
 
#ifndef _H_xmlns
#include "xmlns.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                                                   *
*                        C O N S T A N T S                          *
*                                                                   *
*********************************************************************/
 
#define TK_BUFF_SIZE                0xffff
 
 
 
    /******************** tk_token_t macros ******************/
 
/* macros for quick processing of token chains
 * All these macros take 1 parameter
 * INPUTS:
 *   T == pointer to the tk_chain_t in progress
 */
 
#define TK_NEXT(T) ((tk_token_t *)dlq_nextEntry(T))
 
#define TK_TYP(T) ((T)->typ)
 
#define TK_ID(T) ((T)->typ==TK_TT_TSTRING || (T)->typ==TK_TT_MSTRING)
 
#define TK_VAL(T) (T)->val
 
#define TK_NSID(T) (T)->nsid
 
#define TK_MOD(T) (T)->mod
 
#define TK_ADV(T) \
    ((T)->cur ? (((T)->cur = (tk_token_t *)dlq_nextEntry((T)->cur)) \
                 ? NO_ERR : ERR_NCX_EOF) : ERR_NCX_EOF)
 
#define TK_BKUP(T) \
    if (!  ((T)->cur = (tk_token_t *)dlq_prevEntry((T)->cur)))  \
        (T)->cur = (tk_token_t *)(&((T)->tkQ))
 
 
 
    /******************** tk_chain_t macros ******************/
 
 
#define TK_CUR(T) ((T)->cur)
 
#define TK_CUR_TYP(T) ((T)->cur->typ)
 
#define TK_CUR_VAL(T) ((T)->cur->val)
 
#define TK_CUR_LEN(T) ((T)->cur->len)
 
#define TK_CUR_MOD(T) (T)->cur->mod
 
#define TK_CUR_MODLEN(T) ((T)->cur->modlen)
 
#define TK_CUR_STR(T) ((T)->cur->typ >= TK_TT_STRING && \
                       (T)->cur->typ <= TK_TT_SQSTRING)
 
#define TK_TYP_STR(T) ((T) >= TK_TT_STRING && (T) <= TK_TT_SQSTRING)
 
#define TK_CUR_NOWSTR(T) ((T)->cur->typ >= TK_TT_STRING && \
                          (T)->cur->typ <= TK_TT_SQSTRING)
 
#define TK_CUR_NUM(T) ((T)->cur->typ==TK_TT_DNUM || \
                       (T)->cur->typ==TK_TT_HNUM ||  \
                       (T)->cur->typ==TK_TT_RNUM)
 
 
#define TK_TYP_NUM(T) (((T) >= TK_TT_DNUM) && ((T) <= TK_TT_RNUM))
 
 
#define TK_CUR_INUM(T) ((T)->cur->typ==TK_TT_DNUM || \
                        (T)->cur->typ==TK_TT_HNUM)
 
#define TK_CUR_IQUAL(T) ((T)->cur->typ==TK_TT_QMARK || \
                         (T)->cur->typ==TK_TT_STAR ||  \
                         (T)->cur->typ==TK_TT_PLUS)
 
 
#define TK_CUR_ID(T) ((T)->cur->typ==TK_TT_TSTRING || \
                      (T)->cur->typ==TK_TT_MSTRING)
 
#define TK_CUR_SID(T) ((T)->cur->typ==TK_TT_SSTRING || \
                       (T)->cur->typ==TK_TT_MSSTRING)
 
#define TK_CUR_LNUM(T) ((T)->cur->linenum)
 
#define TK_CUR_LPOS(T) ((T)->cur->linepos)
 
#define TK_CUR_TEXT(T) (((T)->cur->typ == TK_TT_STRING) || \
                        ((T)->cur->typ >= TK_TT_SSTRING && \
                         (T)->cur->typ <= TK_TT_RNUM))
 
 
#define TK_CUR_NSID(T) (T)->cur->nsid
 
#define TK_DOCMODE(TKC)  ((TKC)->flags & TK_FL_DOCMODE)
 
#define TK_HAS_ORIGTK(TK) (((TK)->typ == TK_TT_QSTRING ||   \
                            (TK)->typ == TK_TT_SQSTRING) && \
                           (TK)->origval != NULL)
 
#define TK_SET_ESCERR(TK) (TK)->flags |= TK_FL_ESCSTR_ERR
 
#define TK_GET_ESCERR(TK) ((TK)->flags & TK_FL_ESCSTR_ERR)
 
 
#define TK_FL_REDO        bit0
 
#define TK_FL_MALLOC      bit1
 
#define TK_FL_DOCMODE     bit2
 
 
#define TK_FL_BINARYMODE  bit3
 
 
#define TK_FL_ESCSTR_ERR  bit4
 
 
 
#define TK_FL_VAL_MALLOC  bit0
 
 
#define TK_FL_ORIGVAL_MALLOC  bit1
 
 
#define TK_VALBUFF_LEN 8
 
 
/********************************************************************
*                                                                   *
*                            T Y P E S                              *
*                                                                   *
*********************************************************************/
 
typedef enum tk_type_t_ {
    TK_TT_NONE,
    /* PUT ALL 1-CHAR TOKENS FIRST */
    TK_TT_LBRACE,               
    TK_TT_RBRACE,               
    TK_TT_SEMICOL,              
    TK_TT_LPAREN,               
    TK_TT_RPAREN,               
    TK_TT_LBRACK,               
    TK_TT_RBRACK,               
    TK_TT_COMMA,                
    TK_TT_EQUAL,                
    TK_TT_BAR,                  
    TK_TT_STAR,                 
    TK_TT_ATSIGN,               
    TK_TT_PLUS,                 
    TK_TT_COLON,                
    TK_TT_PERIOD,               
    TK_TT_FSLASH,               
    TK_TT_MINUS,                
    TK_TT_LT,                   
    TK_TT_GT,                   
    /* PUT ALL 2-CHAR TOKENS SECOND */
    TK_TT_RANGESEP,             
    TK_TT_DBLCOLON,             
    TK_TT_DBLFSLASH,            
    TK_TT_NOTEQUAL,             
    TK_TT_LEQUAL,               
    TK_TT_GEQUAL,               
    /* PUT ALL STRING CLASSIFICATION TOKENS THIRD */
    TK_TT_STRING,               
    TK_TT_LINE,                 
    TK_TT_SSTRING,              
    TK_TT_TSTRING,              
    TK_TT_MSTRING,              
    TK_TT_MSSTRING,             
    TK_TT_QSTRING,              
    TK_TT_SQSTRING,             
    TK_TT_VARBIND,              
    TK_TT_QVARBIND,             
    TK_TT_NCNAME_STAR,         
    /* PUT ALL NUMBER CLASSIFICATION TOKENS FOURTH */
    TK_TT_DNUM,                 
    TK_TT_HNUM,                 
    TK_TT_RNUM,                 
    /* PUT ALL SPECIAL CASE TOKENS LAST */
    TK_TT_NEWLINE               
} tk_type_t;
 
 
typedef enum tk_source_t_ {
    TK_SOURCE_CONF,          
    TK_SOURCE_YANG,          
    TK_SOURCE_XPATH,         
    TK_SOURCE_REDO,          
    TK_SOURCE_JSON,          
    TK_SOURCE_FIELDS,        
    TK_SOURCE_FEATURE,       
    TK_SOURCE_CLI
} tk_source_t;
 
 
typedef enum tk_origstr_typ_t_ {
    TK_ORIGSTR_NONE,
    TK_ORIGSTR_DQUOTE,      
    TK_ORIGSTR_DQUOTE_NL,   
    TK_ORIGSTR_SQUOTE,      
    TK_ORIGSTR_SQUOTE_NL    
} tk_origstr_typ_t;
 
 
typedef struct tk_origstr_t_ {
    dlq_hdr_t          qhdr;      
    tk_origstr_typ_t   origtyp;   
    xmlChar           *str;       
} tk_origstr_t;
 
 
typedef struct tk_token_t_ {
    dlq_hdr_t   qhdr;               
    tk_type_t   typ;                
    xmlChar    *mod;                  
    uint32      modlen;          
    xmlChar    *val;  
    xmlChar    *origval;           
    uint32      len;               
    uint32      linenum;          
    uint32      linepos;         
    xmlns_id_t  nsid;        
    dlq_hdr_t   origstrQ;  
    xmlChar     valbuff[TK_VALBUFF_LEN];  
    uint8       flags;   
} tk_token_t;
 
 
typedef struct tk_token_ptr_t_ {
    dlq_hdr_t       qhdr;        
    tk_token_t     *tk;          
    const void     *field;       
} tk_token_ptr_t;
 
 
typedef status_t
    (*tk_getline_fn_t) (xmlChar *fillbuff,
                        uint32 fillbuffsize,
                        void *cookie);
 
 
 
typedef struct tk_chain_t_ {
    dlq_hdr_t      qhdr;       
    dlq_hdr_t      tkQ;            
    dlq_hdr_t      tkptrQ;     
    tk_token_t    *cur;         
    tk_token_t    *escerr_tk;  
    ncx_error_t   *curerr;     
    const xmlChar *filename;   
    FILE          *fp;         
    xmlChar       *buff;       
    xmlChar       *bptr;       
    uint32         linenum;    
    uint32         linepos;    
    uint32         flags;      
    tk_source_t    source;     
    tk_getline_fn_t getline_fn;  
    void            *cookie;    
    xmlChar          escerr_ch;  
} tk_chain_t;
 
 
/********************************************************************
*                                                                   *
*                       F U N C T I O N S                           *
*                                                                   *
*********************************************************************/
 
 
extern tk_chain_t *
    tk_new_chain (void);
 
 
extern void
    tk_setup_chain_conf (tk_chain_t *tkc,
                         FILE *fp,
                         const xmlChar *filename);
 
 
extern void
    tk_setup_chain_cli (tk_chain_t *tkc,
                        xmlChar *line);
 
 
extern void
    tk_setup_chain_fields (tk_chain_t *tkc,
                           xmlChar *str);
 
extern void
    tk_setup_chain_feature (tk_chain_t *tkc,
                            xmlChar *str);
 
 
extern void
    tk_setup_chain_yang (tk_chain_t *tkc,
                         FILE *fp,
                         const xmlChar *filename);
 
 
extern void
    tk_setup_chain_yin (tk_chain_t *tkc,
                        const xmlChar *filename);
 
 
extern void
    tk_setup_chain_json_file (tk_chain_t *tkc,
                              FILE *fp,
                              const xmlChar *filename);
 
 
extern void
    tk_setup_chain_json_buffer (tk_chain_t *tkc,
                                xmlChar *buff);
 
 
extern void
    tk_setup_chain_json_buffs (tk_chain_t *tkc,
                               tk_getline_fn_t getline_fn,
                               void *cookie);
 
 
extern void
    tk_setup_chain_docmode (tk_chain_t *tkc);
 
 
extern void
    tk_setup_chain_cli_line (tk_chain_t *tkc,
                             xmlChar *str);
 
 
extern void
    tk_free_chain (tk_chain_t *tkc);
 
 
extern ncx_btype_t
    tk_get_yang_btype_id (const xmlChar *buff,
                          uint32 len);
 
 
extern const char *
    tk_get_token_name (tk_type_t ttyp);
 
 
extern const char *
    tk_get_token_sym (tk_type_t ttyp);
 
 
extern const char *
    tk_get_btype_sym (ncx_btype_t btyp);
 
 
extern tk_type_t
    tk_next_typ (tk_chain_t *tkc);
 
 
extern tk_type_t
    tk_next_typ2 (tk_chain_t *tkc);
 
 
extern boolean
    tk_next_is_null (tk_chain_t *tkc);
 
 
extern const xmlChar *
    tk_next_val (tk_chain_t *tkc);
 
 
extern void
    tk_dump_token (const tk_token_t *tk);
 
 
extern void
    tk_dump_chain (const tk_chain_t *tkc);
 
 
extern boolean
    tk_is_wsp_string (const tk_token_t *tk);
 
 
extern status_t
    tk_tokenize_input (tk_chain_t *tkc,
                       ncx_module_t *mod);
 
 
extern status_t
    tk_retokenize_cur_string (tk_chain_t *tkc,
                              ncx_module_t *mod);
 
 
extern tk_chain_t *
    tk_tokenize_metadata_string (ncx_module_t *mod,
                                 xmlChar *str,
                                 status_t *res);
 
 
extern tk_chain_t *
    tk_tokenize_xpath_string (ncx_module_t *mod,
                              xmlChar *str,
                              uint32 curlinenum,
                              uint32 curlinepos,
                              status_t *res);
 
 
extern uint32
    tk_token_count (const tk_chain_t *tkc);
 
 
extern void
    tk_reset_chain (tk_chain_t *tkc);
 
 
extern tk_chain_t *
    tk_clone_chain (tk_chain_t *oldtkc);
 
 
extern status_t
    tk_add_id_token (tk_chain_t *tkc,
                     const xmlChar *valstr);
 
 
extern status_t
    tk_add_pid_token (tk_chain_t *tkc,
                      const xmlChar *prefix,
                      uint32 prefixlen,
                      const xmlChar *valstr);
 
 
extern status_t
    tk_add_string_token (tk_chain_t *tkc,
                         const xmlChar *valstr);
 
 
extern status_t
    tk_add_lbrace_token (tk_chain_t *tkc);
 
 
extern status_t
    tk_add_rbrace_token (tk_chain_t *tkc);
 
 
extern status_t
    tk_add_semicol_token (tk_chain_t *tkc);
 
 
extern status_t
    tk_check_save_origstr (tk_chain_t  *tkc,
                           tk_token_t *tk,
                           const void *field);
 
 
extern const xmlChar *
    tk_get_first_origstr (const tk_token_ptr_t  *tkptr,
                          boolean *dquote,
                          boolean *morestr);
 
 
extern const tk_origstr_t *
    tk_first_origstr_rec (const tk_token_ptr_t  *tkptr);
 
 
extern const tk_origstr_t *
    tk_next_origstr_rec (const tk_origstr_t  *origstr);
 
 
extern const xmlChar *
    tk_get_origstr_parts (const tk_origstr_t  *origstr,
                          boolean *dquote,
                          boolean *newline);
 
 
extern const tk_token_ptr_t *
    tk_find_tkptr (const tk_chain_t  *tkc,
                   const void *field);
 
 
extern uint32
    tk_tkptr_quotes (const tk_token_ptr_t  *tkptr);
 
 
extern boolean
    tk_cur_is_first (const tk_chain_t  *tkc);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_tk */