include/isc/lex.h

18 /* $Id: lex.h,v 1.37 2008/05/30 23:47:01 tbox Exp $ */
27 /*! \file isc/lex.h
28  * \brief The "lex" module provides a lightweight tokenizer.  It can operate
178 isc_lex_getcomments(isc_lex_t *lex);
183  *\li	'lex' is a valid lexer.
190 isc_lex_setcomments(isc_lex_t *lex, unsigned int comments);
195  *\li	'lex' is a valid lexer.
201 isc_lex_getspecials(isc_lex_t *lex, isc_lexspecials_t specials);
206  *\li	'lex' is a valid lexer.
210 isc_lex_setspecials(isc_lex_t *lex, isc_lexspecials_t specials);
220  *\li	'lex' is a valid lexer.
224 isc_lex_openfile(isc_lex_t *lex, const char *filename);
226  * Open 'filename' and make it the current input source for 'lex'.
229  *\li	'lex' is a valid lexer.
243 isc_lex_openstream(isc_lex_t *lex, FILE *stream);
245  * Make 'stream' the current input source for 'lex'.
248  *\li	'lex' is a valid lexer.
258 isc_lex_openbuffer(isc_lex_t *lex, isc_buffer_t *buffer);
260  * Make 'buffer' the current input source for 'lex'.
263  *\li	'lex' is a valid lexer.
273 isc_lex_close(isc_lex_t *lex);
283 isc_lex_gettoken(isc_lex_t *lex, unsigned int options, isc_token_t *tokenp);
288  *\li	'lex' is a valid lexer.
290  *\li	'lex' has an input source.
309 isc_lex_getmastertoken(isc_lex_t *lex, isc_token_t *token,
318  *\li	'lex' is a valid lexer.
328 isc_lex_getoctaltoken(isc_lex_t *lex, isc_token_t *token, isc_boolean_t eol);
335  *\li	'lex' is a valid lexer.
345 isc_lex_ungettoken(isc_lex_t *lex, isc_token_t *tokenp);
350  *\li	'lex' is a valid lexer.
352  *\li	'lex' has an input source.
360 isc_lex_getlasttokentext(isc_lex_t *lex, isc_token_t *tokenp, isc_region_t *r);
365  *\li	'lex' is a valid lexer.
367  *\li	'lex' has an input source.
375 isc_lex_getsourcename(isc_lex_t *lex);
380  *\li	'lex' is a valid lexer.
389 isc_lex_getsourceline(isc_lex_t *lex);
394  *\li	'lex' is a valid lexer.
401 isc_lex_setsourcename(isc_lex_t *lex, const char *name);
407  * \li	'lex' is a valid lexer.
416 isc_lex_isfile(isc_lex_t *lex);
421  *\li	'lex' is a valid lexer.