scanner.h File Reference

#include "common/keywords.h"

Include dependency graph for scanner.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
union	core_YYSTYPE
struct	core_yy_extra_type
struct	ScannerCallbackState

Macros
#define	YYLTYPE   int

Typedefs
typedef union core_YYSTYPE	core_YYSTYPE
typedef struct core_yy_extra_type	core_yy_extra_type
typedef void *	core_yyscan_t
typedef struct ScannerCallbackState	ScannerCallbackState

Functions
core_yyscan_t	scanner_init (const char *str, core_yy_extra_type *yyext, const ScanKeywordList *keywordlist, const uint16 *keyword_tokens)
void	scanner_finish (core_yyscan_t yyscanner)
int	core_yylex (core_YYSTYPE *yylval_param, YYLTYPE *yylloc_param, core_yyscan_t yyscanner)
int	scanner_errposition (int location, core_yyscan_t yyscanner)
void	setup_scanner_errposition_callback (ScannerCallbackState *scbstate, core_yyscan_t yyscanner, int location)
void	cancel_scanner_errposition_callback (ScannerCallbackState *scbstate)
pg_noreturn void	scanner_yyerror (const char *message, core_yyscan_t yyscanner)

Variables
PGDLLIMPORT const uint16	ScanKeywordTokens []

Macro Definition Documentation

YYLTYPE

#define YYLTYPE   int

Definition at line 44 of file scanner.h.

Typedef Documentation

core_yy_extra_type

typedef struct core_yy_extra_type core_yy_extra_type

core_yyscan_t

typedef void* core_yyscan_t

Definition at line 118 of file scanner.h.

core_YYSTYPE

typedef union core_YYSTYPE core_YYSTYPE

ScannerCallbackState

typedef struct ScannerCallbackState ScannerCallbackState

Function Documentation

cancel_scanner_errposition_callback()

void cancel_scanner_errposition_callback ( ScannerCallbackState *  scbstate )

extern

Definition at line 1187 of file scan.l.

{
    /* Pop the error context stack */
    error_context_stack = scbstate->errcallback.previous;
}

References error_context_stack, fb(), and ErrorContextCallback::previous.

Referenced by addunicode(), and str_udeescape().

core_yylex()

int core_yylex ( core_YYSTYPE *  yylval_param, YYLTYPE *  yylloc_param, core_yyscan_t  yyscanner  )

extern

Referenced by base_yylex(), fill_in_constant_lengths(), and internal_yylex().

scanner_errposition()

int scanner_errposition ( int  location, core_yyscan_t  yyscanner  )

extern

Definition at line 1124 of file scan.l.

{
    int         pos;
 
    if (location < 0)
        return 0;               /* no-op if location is unknown */
 
    /* Convert byte offset to character number */
    pos = pg_mbstrlen_with_len(yyextra->scanbuf, location) + 1;
    /* And pass it to the ereport mechanism */
    return errposition(pos);
}

References errposition(), pg_mbstrlen_with_len(), and yyextra.

Referenced by scb_error_callback(), and str_udeescape().

scanner_finish()

void scanner_finish ( core_yyscan_t  yyscanner )

extern

Definition at line 1273 of file scan.l.

{
    /*
     * We don't bother to call yylex_destroy(), because all it would do is
     * pfree a small amount of control storage.  It's cheaper to leak the
     * storage until the parsing context is destroyed.  The amount of space
     * involved is usually negligible compared to the output parse tree
     * anyway.
     *
     * We do bother to pfree the scanbuf and literal buffer, but only if they
     * represent a nontrivial amount of space.  The 8K cutoff is arbitrary.
     */
    if (yyextra->scanbuflen >= 8192)
        pfree(yyextra->scanbuf);
    if (yyextra->literalalloc >= 8192)
        pfree(yyextra->literalbuf);
}

References pfree(), and yyextra.

Referenced by fill_in_constant_lengths(), plpgsql_scanner_finish(), and raw_parser().

scanner_init()

core_yyscan_t scanner_init ( const char *  str, core_yy_extra_type *  yyext, const ScanKeywordList *  keywordlist, const uint16 *  keyword_tokens  )

extern

Definition at line 1233 of file scan.l.

{
    Size        slen = strlen(str);
    yyscan_t    scanner;
 
    if (yylex_init(&scanner) != 0)
        elog(ERROR, "yylex_init() failed: %m");
 
    core_yyset_extra(yyext, scanner);
 
    yyext->keywordlist = keywordlist;
    yyext->keyword_tokens = keyword_tokens;
 
    yyext->backslash_quote = backslash_quote;
 
    /*
     * Make a scan buffer with special termination needed by flex.
     */
    yyext->scanbuf = (char *) palloc(slen + 2);
    yyext->scanbuflen = slen;
    memcpy(yyext->scanbuf, str, slen);
    yyext->scanbuf[slen] = yyext->scanbuf[slen + 1] = YY_END_OF_BUFFER_CHAR;
    yy_scan_buffer(yyext->scanbuf, slen + 2, scanner);
 
    /* initialize literal buffer to a reasonable but expansible size */
    yyext->literalalloc = 1024;
    yyext->literalbuf = (char *) palloc(yyext->literalalloc);
    yyext->literallen = 0;
 
    return scanner;
}

References backslash_quote, elog, ERROR, fb(), palloc(), and str.

Referenced by fill_in_constant_lengths(), plpgsql_scanner_init(), and raw_parser().

scanner_yyerror()

pg_noreturn void scanner_yyerror ( const char *  message, core_yyscan_t  yyscanner  )

extern

Definition at line 1206 of file scan.l.

{
    const char *loc = yyextra->scanbuf + *yylloc;
 
    if (*loc == YY_END_OF_BUFFER_CHAR)
    {
        ereport(ERROR,
                (errcode(ERRCODE_SYNTAX_ERROR),
        /* translator: %s is typically the translation of "syntax error" */
                 errmsg("%s at end of input", _(message)),
                 lexer_errposition()));
    }
    else
    {
        ereport(ERROR,
                (errcode(ERRCODE_SYNTAX_ERROR),
        /* translator: first %s is typically the translation of "syntax error" */
                 errmsg("%s at or near \"%s\"", _(message), loc),
                 lexer_errposition()));
    }
}

References _, ereport, errcode(), errmsg, ERROR, fb(), lexer_errposition, yyextra, and yylloc.

Referenced by base_yylex().

setup_scanner_errposition_callback()

void setup_scanner_errposition_callback ( ScannerCallbackState *  scbstate, core_yyscan_t  yyscanner, int  location  )

extern

Definition at line 1170 of file scan.l.

{
    /* Setup error traceback support for ereport() */
    scbstate->yyscanner = yyscanner;
    scbstate->location = location;
    scbstate->errcallback.callback = scb_error_callback;
    scbstate->errcallback.arg = scbstate;
    scbstate->errcallback.previous = error_context_stack;
    error_context_stack = &scbstate->errcallback;
}

References error_context_stack, fb(), and scb_error_callback().

Referenced by addunicode(), and str_udeescape().

Variable Documentation

ScanKeywordTokens

PGDLLIMPORT const uint16 ScanKeywordTokens[]

extern

Definition at line 80 of file scan.l.

                                   {
#include "parser/kwlist.h"
};

Referenced by fill_in_constant_lengths(), and raw_parser().