input.c File Reference

#include "postgres_fe.h"
#include <unistd.h>
#include <fcntl.h>
#include <limits.h>
#include "common.h"
#include "common/logging.h"
#include "input.h"
#include "settings.h"
#include "tab-complete.h"

Include dependency graph for input.c:

Go to the source code of this file.

Macros
#define	PSQLHISTORY   ".psql_history"

Functions
static void	finishInput (void)
char *	gets_interactive (const char *prompt, PQExpBuffer query_buf)
void	pg_append_history (const char *s, PQExpBuffer history_buf)
void	pg_send_history (PQExpBuffer history_buf)
char *	gets_fromFile (FILE *source)
void	initializeInput (int flags)
bool	printHistory (const char *fname, unsigned short int pager)

Macro Definition Documentation

PSQLHISTORY

#define PSQLHISTORY   ".psql_history"

Definition at line 23 of file input.c.

Function Documentation

finishInput()

static void finishInput ( void  )

static

Definition at line 541 of file input.c.

{
#ifdef USE_READLINE
    if (useHistory && psql_history)
    {
        (void) saveHistory(psql_history, pset.histsize);
        free(psql_history);
        psql_history = NULL;
    }
#endif
}

References free, _psqlSettings::histsize, and pset.

Referenced by initializeInput().

gets_fromFile()

char* gets_fromFile

(

FILE *

source

)

Definition at line 187 of file input.c.

{
    static PQExpBuffer buffer = NULL;
 
    char        line[1024];
 
    if (buffer == NULL)         /* first time through? */
        buffer = createPQExpBuffer();
    else
        resetPQExpBuffer(buffer);
 
    for (;;)
    {
        char       *result;
 
        /* Enable SIGINT to longjmp to sigint_interrupt_jmp */
        sigint_interrupt_enabled = true;
 
        /* Get some data */
        result = fgets(line, sizeof(line), source);
 
        /* Disable SIGINT again */
        sigint_interrupt_enabled = false;
 
        /* EOF or error? */
        if (result == NULL)
        {
            if (ferror(source))
            {
                pg_log_error("could not read from input file: %m");
                return NULL;
            }
            break;
        }
 
        appendPQExpBufferStr(buffer, line);
 
        if (PQExpBufferBroken(buffer))
        {
            pg_log_error("out of memory");
            return NULL;
        }
 
        /* EOL? */
        if (buffer->len > 0 && buffer->data[buffer->len - 1] == '\n')
        {
            buffer->data[buffer->len - 1] = '\0';
            return pg_strdup(buffer->data);
        }
    }
 
    if (buffer->len > 0)        /* EOF after reading some bufferload(s) */
        return pg_strdup(buffer->data);
 
    /* EOF, so return null */
    return NULL;
}

References appendPQExpBufferStr(), createPQExpBuffer(), PQExpBufferData::data, PQExpBufferData::len, pg_log_error, pg_strdup(), PQExpBufferBroken, resetPQExpBuffer(), sigint_interrupt_enabled, and source.

Referenced by exec_command_prompt(), gets_interactive(), and MainLoop().

gets_interactive()

char* gets_interactive	(	const char *	prompt,
		PQExpBuffer	query_buf
	)

Definition at line 67 of file input.c.

{
#ifdef USE_READLINE
    if (useReadline)
    {
        char       *result;
 
        /*
         * Some versions of readline don't notice SIGWINCH signals that arrive
         * when not actively reading input.  The simplest fix is to always
         * re-read the terminal size.  This leaves a window for SIGWINCH to be
         * missed between here and where readline() enables libreadline's
         * signal handler, but that's probably short enough to be ignored.
         */
#ifdef HAVE_RL_RESET_SCREEN_SIZE
        rl_reset_screen_size();
#endif
 
        /* Make current query_buf available to tab completion callback */
        tab_completion_query_buf = query_buf;
 
        /* Enable SIGINT to longjmp to sigint_interrupt_jmp */
        sigint_interrupt_enabled = true;
 
        /* On some platforms, readline is declared as readline(char *) */
        result = readline((char *) prompt);
 
        /* Disable SIGINT again */
        sigint_interrupt_enabled = false;
 
        /* Pure neatnik-ism */
        tab_completion_query_buf = NULL;
 
        return result;
    }
#endif
 
    fputs(prompt, stdout);
    fflush(stdout);
    return gets_fromFile(stdin);
}

References fflush(), gets_fromFile(), sigint_interrupt_enabled, generate_unaccent_rules::stdout, and tab_completion_query_buf.

Referenced by MainLoop().

initializeInput()

void initializeInput

(

int

flags

)

Definition at line 345 of file input.c.

{
#ifdef USE_READLINE
    if (flags & 1)
    {
        const char *histfile;
        char        home[MAXPGPATH];
 
        useReadline = true;
 
        /* set appropriate values for Readline's global variables */
        initialize_readline();
 
#ifdef HAVE_RL_VARIABLE_BIND
        /* set comment-begin to a useful value for SQL */
        (void) rl_variable_bind("comment-begin", "-- ");
#endif
 
        /* this reads ~/.inputrc, so do it after rl_variable_bind */
        rl_initialize();
 
        useHistory = true;
        using_history();
        history_lines_added = 0;
 
        histfile = GetVariable(pset.vars, "HISTFILE");
 
        if (histfile == NULL)
        {
            char       *envhist;
 
            envhist = getenv("PSQL_HISTORY");
            if (envhist != NULL && strlen(envhist) > 0)
                histfile = envhist;
        }
 
        if (histfile == NULL)
        {
            if (get_home_path(home))
                psql_history = psprintf("%s/%s", home, PSQLHISTORY);
        }
        else
        {
            psql_history = pg_strdup(histfile);
            expand_tilde(&psql_history);
        }
 
        if (psql_history)
        {
            read_history(psql_history);
            decode_history();
        }
    }
#endif
 
    atexit(finishInput);
}

References expand_tilde(), finishInput(), get_home_path(), GetVariable(), initialize_readline(), MAXPGPATH, pg_strdup(), pset, psprintf(), PSQLHISTORY, and _psqlSettings::vars.

Referenced by main().

pg_append_history()

void pg_append_history	(	const char *	s,
		PQExpBuffer	history_buf
	)

Definition at line 114 of file input.c.

{
#ifdef USE_READLINE
    if (useHistory && s)
    {
        appendPQExpBufferStr(history_buf, s);
        if (!s[0] || s[strlen(s) - 1] != '\n')
            appendPQExpBufferChar(history_buf, '\n');
    }
#endif
}

References appendPQExpBufferChar(), and appendPQExpBufferStr().

Referenced by MainLoop().

pg_send_history()

void pg_send_history

(

PQExpBuffer

history_buf

)

Definition at line 136 of file input.c.

{
#ifdef USE_READLINE
    static char *prev_hist = NULL;
 
    char       *s = history_buf->data;
    int         i;
 
    /* Trim any trailing \n's (OK to scribble on history_buf) */
    for (i = strlen(s) - 1; i >= 0 && s[i] == '\n'; i--)
        ;
    s[i + 1] = '\0';
 
    if (useHistory && s[0])
    {
        if (((pset.histcontrol & hctl_ignorespace) &&
             s[0] == ' ') ||
            ((pset.histcontrol & hctl_ignoredups) &&
             prev_hist && strcmp(s, prev_hist) == 0))
        {
            /* Ignore this line as far as history is concerned */
        }
        else
        {
            /* Save each previous line for ignoredups processing */
            free(prev_hist);
            prev_hist = pg_strdup(s);
            /* And send it to readline */
            add_history(s);
            /* Count lines added to history for use later */
            history_lines_added++;
        }
    }
 
    resetPQExpBuffer(history_buf);
#endif
}

References PQExpBufferData::data, free, hctl_ignoredups, hctl_ignorespace, _psqlSettings::histcontrol, i, pg_strdup(), pset, and resetPQExpBuffer().

Referenced by MainLoop().

printHistory()

bool printHistory	(	const char *	fname,
		unsigned short int	pager
	)

Definition at line 495 of file input.c.

{
#ifdef USE_READLINE
    FILE       *output;
    bool        is_pager;
 
    if (!useHistory)
        return false;
 
    if (fname == NULL)
    {
        /* use pager, if enabled, when printing to console */
        output = PageOutput(INT_MAX, pager ? &(pset.popt.topt) : NULL);
        is_pager = true;
    }
    else
    {
        output = fopen(fname, "w");
        if (output == NULL)
        {
            pg_log_error("could not save history to file \"%s\": %m", fname);
            return false;
        }
        is_pager = false;
    }
 
    BEGIN_ITERATE_HISTORY(cur_hist);
    {
        fprintf(output, "%s\n", cur_hist->line);
    }
    END_ITERATE_HISTORY();
 
    if (is_pager)
        ClosePager(output);
    else
        fclose(output);
 
    return true;
#else
    pg_log_error("history is not supported by this installation");
    return false;
#endif
}

References ClosePager(), fprintf, output, PageOutput(), pg_log_error, _psqlSettings::popt, pset, and printQueryOpt::topt.

Referenced by exec_command_s().