psqlscanslash.h File Reference

#include "fe_utils/psqlscan.h"

Include dependency graph for psqlscanslash.h:

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

Go to the source code of this file.

Enumerations
enum	slash_option_type {   OT_NORMAL , OT_SQLID , OT_SQLIDHACK , OT_FILEPIPE ,   OT_WHOLE_LINE }

Functions
char *	psql_scan_slash_command (PsqlScanState state)
char *	psql_scan_slash_option (PsqlScanState state, enum slash_option_type type, char *quote, bool semicolon)
void	psql_scan_slash_command_end (PsqlScanState state)
int	psql_scan_get_paren_depth (PsqlScanState state)
void	psql_scan_set_paren_depth (PsqlScanState state, int depth)
void	dequote_downcase_identifier (char *str, bool downcase, int encoding)

Enumeration Type Documentation

slash_option_type

enum slash_option_type

Enumerator
OT_NORMAL
OT_SQLID
OT_SQLIDHACK
OT_FILEPIPE
OT_WHOLE_LINE

Definition at line 15 of file psqlscanslash.h.

{
    OT_NORMAL,                  /* normal case */
    OT_SQLID,                   /* treat as SQL identifier */
    OT_SQLIDHACK,               /* SQL identifier, but don't downcase */
    OT_FILEPIPE,                /* it's a filename or pipe */
    OT_WHOLE_LINE,              /* just snarf the rest of the line */
};

Function Documentation

dequote_downcase_identifier()

void dequote_downcase_identifier	(	char *	str,
		bool	downcase,
		int	encoding
	)

Definition at line 743 of file psqlscanslash.l.

{
    bool        inquotes = false;
    char       *cp = str;
 
    while (*cp)
    {
        if (*cp == '"')
        {
            if (inquotes && cp[1] == '"')
            {
                /* Keep the first quote, remove the second */
                cp++;
            }
            else
                inquotes = !inquotes;
            /* Collapse out quote at *cp */
            memmove(cp, cp + 1, strlen(cp));
            /* do not advance cp */
        }
        else
        {
            if (downcase && !inquotes)
                *cp = pg_tolower((unsigned char) *cp);
            cp += PQmblenBounded(cp, encoding);
        }
    }
}

References encoding, pg_tolower(), PQmblenBounded(), and str.

Referenced by indexOfColumn(), and psql_scan_slash_option().

psql_scan_get_paren_depth()

int psql_scan_get_paren_depth

(

PsqlScanState

state

)

Definition at line 711 of file psqlscanslash.l.

{
    return state->paren_depth;
}

Referenced by save_query_text_state().

psql_scan_set_paren_depth()

void psql_scan_set_paren_depth	(	PsqlScanState	state,
		int	depth
	)

Definition at line 720 of file psqlscanslash.l.

{
    Assert(depth >= 0);
    state->paren_depth = depth;
}

References Assert().

Referenced by discard_query_text().

psql_scan_slash_command()

char * psql_scan_slash_command

(

PsqlScanState

state

)

Definition at line 480 of file psqlscanslash.l.

{
    PQExpBufferData mybuf;
 
    /* Must be scanning already */
    Assert(state->scanbufhandle != NULL);
 
    /* Build a local buffer that we'll return the data of */
    initPQExpBuffer(&mybuf);
 
    /* Set current output target */
    state->output_buf = &mybuf;
 
    /* 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);
 
    /*
     * Set lexer start state.  Note that this is sufficient to switch
     * state->scanner over to using the tables in this lexer file.
     */
    state->start_state = xslashcmd;
 
    /* And lex. */
    yylex(NULL, state->scanner);
 
    /* There are no possible errors in this lex state... */
 
    /*
     * In case the caller returns to using the regular SQL lexer, reselect the
     * appropriate initial state.
     */
    psql_scan_reselect_sql_lexer(state);
 
    return mybuf.data;
}

References Assert(), PQExpBufferData::data, initPQExpBuffer(), psql_scan_reselect_sql_lexer(), and yylex().

Referenced by HandleSlashCmds().

psql_scan_slash_command_end()

void psql_scan_slash_command_end

(

PsqlScanState

state

)

Definition at line 678 of file psqlscanslash.l.

{
    /* Must be scanning already */
    Assert(state->scanbufhandle != NULL);
 
    /* Set current output target */
    state->output_buf = NULL;   /* we won't output anything */
 
    /* 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);
 
    /* Set lexer start state */
    state->start_state = xslashend;
 
    /* And lex. */
    yylex(NULL, state->scanner);
 
    /* There are no possible errors in this lex state... */
 
    /*
     * We expect the caller to return to using the regular SQL lexer, so
     * reselect the appropriate initial state.
     */
    psql_scan_reselect_sql_lexer(state);
}

References Assert(), psql_scan_reselect_sql_lexer(), and yylex().

Referenced by HandleSlashCmds().

psql_scan_slash_option()

char * psql_scan_slash_option	(	PsqlScanState	state,
		enum slash_option_type	type,
		char *	quote,
		bool	semicolon
	)

Definition at line 539 of file psqlscanslash.l.

{
    PQExpBufferData mybuf;
    int         lexresult PG_USED_FOR_ASSERTS_ONLY;
    int         final_state;
    char        local_quote;
 
    /* Must be scanning already */
    Assert(state->scanbufhandle != NULL);
 
    if (quote == NULL)
        quote = &local_quote;
    *quote = 0;
 
    /* Build a local buffer that we'll return the data of */
    initPQExpBuffer(&mybuf);
 
    /* Set up static variables that will be used by yylex */
    option_type = type;
    option_quote = quote;
    unquoted_option_chars = 0;
 
    /* Set current output target */
    state->output_buf = &mybuf;
 
    /* 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);
 
    /* Set lexer start state */
    if (type == OT_WHOLE_LINE)
        state->start_state = xslashwholeline;
    else
        state->start_state = xslashargstart;
 
    /* And lex. */
    lexresult = yylex(NULL, state->scanner);
 
    /* Save final state for a moment... */
    final_state = state->start_state;
 
    /*
     * In case the caller returns to using the regular SQL lexer, reselect the
     * appropriate initial state.
     */
    psql_scan_reselect_sql_lexer(state);
 
    /*
     * Check the lex result: we should have gotten back either LEXRES_OK or
     * LEXRES_EOL (the latter indicating end of string).  If we were inside a
     * quoted string, as indicated by final_state, EOL is an error.
     */
    Assert(lexresult == LEXRES_EOL || lexresult == LEXRES_OK);
 
    switch (final_state)
    {
        case xslashargstart:
            /* empty arg */
            break;
        case xslasharg:
            /* Strip any unquoted trailing semicolons if requested */
            if (semicolon)
            {
                while (unquoted_option_chars-- > 0 &&
                       mybuf.len > 0 &&
                       mybuf.data[mybuf.len - 1] == ';')
                {
                    mybuf.data[--mybuf.len] = '\0';
                }
            }
 
            /*
             * If SQL identifier processing was requested, then we strip out
             * excess double quotes and optionally downcase unquoted letters.
             */
            if (type == OT_SQLID || type == OT_SQLIDHACK)
            {
                dequote_downcase_identifier(mybuf.data,
                                            (type != OT_SQLIDHACK),
                                            state->encoding);
                /* update mybuf.len for possible shortening */
                mybuf.len = strlen(mybuf.data);
            }
            break;
        case xslashquote:
        case xslashbackquote:
        case xslashdquote:
            /* must have hit EOL inside quotes */
            pg_log_error("unterminated quoted string");
            termPQExpBuffer(&mybuf);
            return NULL;
        case xslashwholeline:
 
            /*
             * In whole-line mode, we interpret semicolon = true as stripping
             * trailing whitespace as well as semicolons; this gives the
             * nearest equivalent to what semicolon = true does in normal
             * mode.  Note there's no concept of quoting in this mode.
             */
            if (semicolon)
            {
                while (mybuf.len > 0 &&
                       (mybuf.data[mybuf.len - 1] == ';' ||
                        (isascii((unsigned char) mybuf.data[mybuf.len - 1]) &&
                         isspace((unsigned char) mybuf.data[mybuf.len - 1]))))
                {
                    mybuf.data[--mybuf.len] = '\0';
                }
            }
            break;
        default:
            /* can't get here */
            fprintf(stderr, "invalid YY_START\n");
            exit(1);
    }
 
    /*
     * An unquoted empty argument isn't possible unless we are at end of
     * command.  Return NULL instead.
     */
    if (mybuf.len == 0 && *quote == 0)
    {
        termPQExpBuffer(&mybuf);
        return NULL;
    }
 
    /* Else return the completed string. */
    return mybuf.data;
}

References Assert(), PQExpBufferData::data, dequote_downcase_identifier(), fprintf, initPQExpBuffer(), PQExpBufferData::len, LEXRES_EOL, LEXRES_OK, option_quote, option_type, OT_SQLID, OT_SQLIDHACK, OT_WHOLE_LINE, pg_log_error, PG_USED_FOR_ASSERTS_ONLY, psql_scan_reselect_sql_lexer(), semicolon, termPQExpBuffer(), type, unquoted_option_chars, and yylex().

Referenced by exec_command_bind(), exec_command_bind_named(), exec_command_C(), exec_command_cd(), exec_command_close(), exec_command_copy(), exec_command_crosstabview(), exec_command_d(), exec_command_dfo(), exec_command_echo(), exec_command_edit(), exec_command_ef_ev(), exec_command_encoding(), exec_command_f(), exec_command_g(), exec_command_getenv(), exec_command_getresults(), exec_command_gset(), exec_command_help(), exec_command_include(), exec_command_list(), exec_command_lo(), exec_command_out(), exec_command_parse(), exec_command_password(), exec_command_prompt(), exec_command_pset(), exec_command_s(), exec_command_set(), exec_command_setenv(), exec_command_sf_sv(), exec_command_shell_escape(), exec_command_slash_command_help(), exec_command_t(), exec_command_T(), exec_command_timing(), exec_command_unset(), exec_command_watch(), exec_command_write(), exec_command_x(), exec_command_z(), gather_boolean_expression(), HandleSlashCmds(), ignore_slash_filepipe(), ignore_slash_options(), ignore_slash_whole_line(), process_command_g_options(), and read_connect_arg().