psqlscan.h File Reference

#include "pqexpbuffer.h"

Include dependency graph for psqlscan.h:

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

Go to the source code of this file.

Data Structures
struct	PsqlScanCallbacks

Typedefs
typedef struct PsqlScanStateData *	PsqlScanState
typedef enum _promptStatus	promptStatus_t
typedef struct PsqlScanCallbacks	PsqlScanCallbacks

Enumerations
enum	PsqlScanResult { PSCAN_SEMICOLON , PSCAN_BACKSLASH , PSCAN_INCOMPLETE , PSCAN_EOL }
enum	_promptStatus {   PROMPT_READY , PROMPT_CONTINUE , PROMPT_COMMENT , PROMPT_SINGLEQUOTE ,   PROMPT_DOUBLEQUOTE , PROMPT_DOLLARQUOTE , PROMPT_PAREN , PROMPT_COPY }
enum	PsqlScanQuoteType { PQUOTE_PLAIN , PQUOTE_SQL_LITERAL , PQUOTE_SQL_IDENT , PQUOTE_SHELL_ARG }

Functions
PsqlScanState	psql_scan_create (const PsqlScanCallbacks *callbacks)
void	psql_scan_destroy (PsqlScanState state)
void	psql_scan_set_passthrough (PsqlScanState state, void *passthrough)
void	psql_scan_setup (PsqlScanState state, const char *line, int line_len, int encoding, bool std_strings)
void	psql_scan_finish (PsqlScanState state)
PsqlScanResult	psql_scan (PsqlScanState state, PQExpBuffer query_buf, promptStatus_t *prompt)
void	psql_scan_reset (PsqlScanState state)
void	psql_scan_reselect_sql_lexer (PsqlScanState state)
bool	psql_scan_in_quote (PsqlScanState state)
void	psql_scan_get_location (PsqlScanState state, int *lineno, int *offset)

Typedef Documentation

promptStatus_t

typedef enum _promptStatus promptStatus_t

PsqlScanCallbacks

typedef struct PsqlScanCallbacks PsqlScanCallbacks

PsqlScanState

typedef struct PsqlScanStateData* PsqlScanState

Definition at line 27 of file psqlscan.h.

Enumeration Type Documentation

_promptStatus

enum _promptStatus

Enumerator
PROMPT_READY
PROMPT_CONTINUE
PROMPT_COMMENT
PROMPT_SINGLEQUOTE
PROMPT_DOUBLEQUOTE
PROMPT_DOLLARQUOTE
PROMPT_PAREN
PROMPT_COPY

Definition at line 39 of file psqlscan.h.

{
    PROMPT_READY,
    PROMPT_CONTINUE,
    PROMPT_COMMENT,
    PROMPT_SINGLEQUOTE,
    PROMPT_DOUBLEQUOTE,
    PROMPT_DOLLARQUOTE,
    PROMPT_PAREN,
    PROMPT_COPY,
} promptStatus_t;

PsqlScanQuoteType

enum PsqlScanQuoteType

Enumerator
PQUOTE_PLAIN
PQUOTE_SQL_LITERAL
PQUOTE_SQL_IDENT
PQUOTE_SHELL_ARG

Definition at line 52 of file psqlscan.h.

{
    PQUOTE_PLAIN,               /* just return the actual value */
    PQUOTE_SQL_LITERAL,         /* add quotes to make a valid SQL literal */
    PQUOTE_SQL_IDENT,           /* quote if needed to make a SQL identifier */
    PQUOTE_SHELL_ARG,           /* quote if needed to be safe in a shell cmd */
} PsqlScanQuoteType;

PsqlScanResult

enum PsqlScanResult

Enumerator
PSCAN_SEMICOLON
PSCAN_BACKSLASH
PSCAN_INCOMPLETE
PSCAN_EOL

Definition at line 30 of file psqlscan.h.

{
    PSCAN_SEMICOLON,            /* found command-ending semicolon */
    PSCAN_BACKSLASH,            /* found backslash command */
    PSCAN_INCOMPLETE,           /* end of line, SQL statement incomplete */
    PSCAN_EOL,                  /* end of line, SQL possibly complete */
} PsqlScanResult;

Function Documentation

psql_scan()

PsqlScanResult psql_scan	(	PsqlScanState	state,
		PQExpBuffer	query_buf,
		promptStatus_t *	prompt
	)

Definition at line 1121 of file psqlscan.l.

{
    PsqlScanResult result;
    int         lexresult;
 
    /* Must be scanning already */
    Assert(state->scanbufhandle != NULL);
 
    /* Set current output target */
    state->output_buf = query_buf;
 
    /* Set input source */
    if (state->buffer_stack != NULL)
        yy_switch_to_buffer(state->buffer_stack->buf, state->scanner);
    else
        yy_switch_to_buffer(state->scanbufhandle, state->scanner);
 
    /* And lex. */
    lexresult = yylex(NULL, state->scanner);
 
    /* Notify psql_scan_get_location() that a yylex call has been made. */
    if (state->cur_line_no == 0)
        state->cur_line_no = 1;
 
    /*
     * Check termination state and return appropriate result info.
     */
    switch (lexresult)
    {
        case LEXRES_EOL:        /* end of input */
            switch (state->start_state)
            {
                case INITIAL:
                case xqs:       /* we treat this like INITIAL */
                    if (state->paren_depth > 0)
                    {
                        result = PSCAN_INCOMPLETE;
                        *prompt = PROMPT_PAREN;
                    }
                    else if (state->begin_depth > 0)
                    {
                        result = PSCAN_INCOMPLETE;
                        *prompt = PROMPT_CONTINUE;
                    }
                    else if (query_buf->len > 0)
                    {
                        result = PSCAN_EOL;
                        *prompt = PROMPT_CONTINUE;
                    }
                    else
                    {
                        /* never bother to send an empty buffer */
                        result = PSCAN_INCOMPLETE;
                        *prompt = PROMPT_READY;
                    }
                    break;
                case xb:
                    result = PSCAN_INCOMPLETE;
                    *prompt = PROMPT_SINGLEQUOTE;
                    break;
                case xc:
                    result = PSCAN_INCOMPLETE;
                    *prompt = PROMPT_COMMENT;
                    break;
                case xd:
                    result = PSCAN_INCOMPLETE;
                    *prompt = PROMPT_DOUBLEQUOTE;
                    break;
                case xh:
                    result = PSCAN_INCOMPLETE;
                    *prompt = PROMPT_SINGLEQUOTE;
                    break;
                case xe:
                    result = PSCAN_INCOMPLETE;
                    *prompt = PROMPT_SINGLEQUOTE;
                    break;
                case xq:
                    result = PSCAN_INCOMPLETE;
                    *prompt = PROMPT_SINGLEQUOTE;
                    break;
                case xdolq:
                    result = PSCAN_INCOMPLETE;
                    *prompt = PROMPT_DOLLARQUOTE;
                    break;
                case xui:
                    result = PSCAN_INCOMPLETE;
                    *prompt = PROMPT_DOUBLEQUOTE;
                    break;
                case xus:
                    result = PSCAN_INCOMPLETE;
                    *prompt = PROMPT_SINGLEQUOTE;
                    break;
                default:
                    /* can't get here */
                    fprintf(stderr, "invalid YY_START\n");
                    exit(1);
            }
            break;
        case LEXRES_SEMI:       /* semicolon */
            result = PSCAN_SEMICOLON;
            *prompt = PROMPT_READY;
            break;
        case LEXRES_BACKSLASH:  /* backslash */
            result = PSCAN_BACKSLASH;
            *prompt = PROMPT_READY;
            break;
        default:
            /* can't get here */
            fprintf(stderr, "invalid yylex result\n");
            exit(1);
    }
 
    return result;
}

References Assert(), fprintf, PQExpBufferData::len, LEXRES_BACKSLASH, LEXRES_EOL, LEXRES_SEMI, PROMPT_COMMENT, PROMPT_CONTINUE, PROMPT_DOLLARQUOTE, PROMPT_DOUBLEQUOTE, PROMPT_PAREN, PROMPT_READY, PROMPT_SINGLEQUOTE, PSCAN_BACKSLASH, PSCAN_EOL, PSCAN_INCOMPLETE, PSCAN_SEMICOLON, and yylex().

Referenced by MainLoop(), ParseScript(), and test_psql_parse().

psql_scan_create()

PsqlScanState psql_scan_create

(

const PsqlScanCallbacks *

callbacks

)

Definition at line 1001 of file psqlscan.l.

{
    PsqlScanState state;
 
    state = (PsqlScanStateData *) pg_malloc0(sizeof(PsqlScanStateData));
 
    state->callbacks = callbacks;
 
    yylex_init(&state->scanner);
 
    yyset_extra(state, state->scanner);
 
    psql_scan_reset(state);
 
    return state;
}

References pg_malloc0(), and psql_scan_reset().

Referenced by main(), MainLoop(), ParseScript(), and test_psql_parse().

psql_scan_destroy()

void psql_scan_destroy

(

PsqlScanState

state

)

Definition at line 1022 of file psqlscan.l.

{
    psql_scan_finish(state);
 
    psql_scan_reset(state);
 
    yylex_destroy(state->scanner);
 
    free(state);
}

References free, psql_scan_finish(), and psql_scan_reset().

Referenced by main(), MainLoop(), ParseScript(), and test_psql_parse().

psql_scan_finish()

void psql_scan_finish

(

PsqlScanState

state

)

Definition at line 1248 of file psqlscan.l.

{
    /* Drop any incomplete variable expansions. */
    while (state->buffer_stack != NULL)
        psqlscan_pop_buffer_stack(state);
 
    /* Done with the outer scan buffer, too */
    if (state->scanbufhandle)
        yy_delete_buffer(state->scanbufhandle, state->scanner);
    state->scanbufhandle = NULL;
    if (state->scanbuf)
        free(state->scanbuf);
    state->scanbuf = NULL;
}

References free, and psqlscan_pop_buffer_stack().

Referenced by MainLoop(), ParseScript(), and psql_scan_destroy().

psql_scan_get_location()

void psql_scan_get_location	(	PsqlScanState	state,
		int *	lineno,
		int *	offset
	)

Definition at line 1335 of file psqlscan.l.

{
    const char *line_end;
 
    /*
     * We rely on flex's having stored a NUL after the current token in
     * scanbuf.  Therefore we must specially handle the state before yylex()
     * has been called, when obviously that won't have happened yet.
     */
    if (state->cur_line_no == 0)
    {
        *lineno = 1;
        *offset = 0;
        return;
    }
 
    /*
     * Advance cur_line_no/cur_line_ptr past whatever has been lexed so far.
     * Doing this prevents repeated calls from being O(N^2) for long inputs.
     */
    while ((line_end = strchr(state->cur_line_ptr, '\n')) != NULL)
    {
        state->cur_line_no++;
        state->cur_line_ptr = line_end + 1;
    }
    state->cur_line_ptr += strlen(state->cur_line_ptr);
 
    /* Report current location. */
    *lineno = state->cur_line_no;
    *offset = state->cur_line_ptr - state->scanbuf;
}

Referenced by expr_lex_one_word(), expr_yyerror_more(), and ParseScript().

psql_scan_in_quote()

bool psql_scan_in_quote

(

PsqlScanState

state

)

Definition at line 1316 of file psqlscan.l.

{
    return state->start_state != INITIAL &&
        state->start_state != xqs;
}

Referenced by MainLoop().

psql_scan_reselect_sql_lexer()

void psql_scan_reselect_sql_lexer

(

PsqlScanState

state

)

Definition at line 1303 of file psqlscan.l.

{
    state->start_state = INITIAL;
}

Referenced by expr_lex_one_word(), expr_scanner_finish(), psql_scan_slash_command(), psql_scan_slash_command_end(), and psql_scan_slash_option().

psql_scan_reset()

void psql_scan_reset

(

PsqlScanState

state

)

Definition at line 1275 of file psqlscan.l.

{
    state->start_state = INITIAL;
    state->paren_depth = 0;
    state->xcdepth = 0;         /* not really necessary */
    if (state->dolqstart)
        free(state->dolqstart);
    state->dolqstart = NULL;
    state->identifier_count = 0;
    state->begin_depth = 0;
}

References free.

Referenced by exec_command_reset(), exec_command_watch(), MainLoop(), psql_scan_create(), and psql_scan_destroy().

psql_scan_set_passthrough()

void psql_scan_set_passthrough	(	PsqlScanState	state,
		void *	passthrough
	)

Definition at line 1041 of file psqlscan.l.

{
    state->cb_passthrough = passthrough;
}

Referenced by main(), and MainLoop().

psql_scan_setup()

void psql_scan_setup	(	PsqlScanState	state,
		const char *	line,
		int	line_len,
		int	encoding,
		bool	std_strings
	)

Definition at line 1059 of file psqlscan.l.

{
    /* Mustn't be scanning already */
    Assert(state->scanbufhandle == NULL);
    Assert(state->buffer_stack == NULL);
 
    /* Do we need to hack the character set encoding? */
    state->encoding = encoding;
    state->safe_encoding = pg_valid_server_encoding_id(encoding);
 
    /* Save standard-strings flag as well */
    state->std_strings = std_strings;
 
    /* Set up flex input buffer with appropriate translation and padding */
    state->scanbufhandle = psqlscan_prepare_buffer(state, line, line_len,
                                                   &state->scanbuf);
    state->scanline = line;
 
    /* Set lookaside data in case we have to map unsafe encoding */
    state->curline = state->scanbuf;
    state->refline = state->scanline;
 
    /* Initialize state for psql_scan_get_location() */
    state->cur_line_no = 0;     /* yylex not called yet */
    state->cur_line_ptr = state->scanbuf;
}

References Assert(), encoding, pg_valid_server_encoding_id, and psqlscan_prepare_buffer().

Referenced by main(), MainLoop(), ParseScript(), and test_psql_parse().