string.h File Reference

#include <signal.h>

Include dependency graph for string.h:

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

Go to the source code of this file.

Data Structures
struct	PromptInterruptContext

Typedefs
typedef struct StringInfoData *	StringInfo
typedef struct PromptInterruptContext	PromptInterruptContext

Functions
bool	pg_str_endswith (const char *str, const char *end)
int	strtoint (const char *pg_restrict str, char **pg_restrict endptr, int base)
char *	pg_clean_ascii (const char *str, int alloc_flags)
int	pg_strip_crlf (char *str)
bool	pg_is_ascii (const char *str)
char *	pg_get_line (FILE *stream, PromptInterruptContext *prompt_ctx)
bool	pg_get_line_buf (FILE *stream, StringInfo buf)
bool	pg_get_line_append (FILE *stream, StringInfo buf, PromptInterruptContext *prompt_ctx)
char *	simple_prompt (const char *prompt, bool echo)
char *	simple_prompt_extended (const char *prompt, bool echo, PromptInterruptContext *prompt_ctx)

Typedef Documentation

PromptInterruptContext

typedef struct PromptInterruptContext PromptInterruptContext

StringInfo

typedef struct StringInfoData* StringInfo

Definition at line 15 of file string.h.

Function Documentation

pg_clean_ascii()

char * pg_clean_ascii	(	const char *	str,
		int	alloc_flags
	)

Definition at line 85 of file string.c.

{
    size_t      dstlen;
    char       *dst;
    const char *p;
    size_t      i = 0;
 
    /* Worst case, each byte can become four bytes, plus a null terminator. */
    dstlen = strlen(str) * 4 + 1;
 
#ifdef FRONTEND
    dst = malloc(dstlen);
#else
    dst = palloc_extended(dstlen, alloc_flags);
#endif
 
    if (!dst)
        return NULL;
 
    for (p = str; *p != '\0'; p++)
    {
 
        /* Only allow clean ASCII chars in the string */
        if (*p < 32 || *p > 126)
        {
            Assert(i < (dstlen - 3));
            snprintf(&dst[i], dstlen - i, "\\x%02x", (unsigned char) *p);
            i += 4;
        }
        else
        {
            Assert(i < dstlen);
            dst[i] = *p;
            i++;
        }
    }
 
    Assert(i < dstlen);
    dst[i] = '\0';
    return dst;
}

References Assert(), i, malloc, palloc_extended(), snprintf, and str.

Referenced by check_application_name(), check_cluster_name(), prepare_cert_name(), and ProcessStartupPacket().

pg_get_line()

char * pg_get_line	(	FILE *	stream,
		PromptInterruptContext *	prompt_ctx
	)

Definition at line 59 of file pg_get_line.c.

{
    StringInfoData buf;
 
    initStringInfo(&buf);
 
    if (!pg_get_line_append(stream, &buf, prompt_ctx))
    {
        /* ensure that free() doesn't mess up errno */
        int         save_errno = errno;
 
        pfree(buf.data);
        errno = save_errno;
        return NULL;
    }
 
    return buf.data;
}

References buf, initStringInfo(), pfree(), and pg_get_line_append().

Referenced by get_su_pwd(), pipe_read_line(), and simple_prompt_extended().

pg_get_line_append()

bool pg_get_line_append	(	FILE *	stream,
		StringInfo	buf,
		PromptInterruptContext *	prompt_ctx
	)

Definition at line 124 of file pg_get_line.c.

{
    int         orig_len = buf->len;
 
    if (prompt_ctx && sigsetjmp(*((sigjmp_buf *) prompt_ctx->jmpbuf), 1) != 0)
    {
        /* Got here with longjmp */
        prompt_ctx->canceled = true;
        /* Discard any data we collected before detecting error */
        buf->len = orig_len;
        buf->data[orig_len] = '\0';
        return false;
    }
 
    /* Loop until newline or EOF/error */
    for (;;)
    {
        char       *res;
 
        /* Enable longjmp while waiting for input */
        if (prompt_ctx)
            *(prompt_ctx->enabled) = true;
 
        /* Read some data, appending it to whatever we already have */
        res = fgets(buf->data + buf->len, buf->maxlen - buf->len, stream);
 
        /* Disable longjmp again, then break if fgets failed */
        if (prompt_ctx)
            *(prompt_ctx->enabled) = false;
 
        if (res == NULL)
            break;
 
        /* Got data, so update buf->len */
        buf->len += strlen(buf->data + buf->len);
 
        /* Done if we have collected a newline */
        if (buf->len > orig_len && buf->data[buf->len - 1] == '\n')
            return true;
 
        /* Make some more room in the buffer, and loop to read more data */
        enlargeStringInfo(buf, 128);
    }
 
    /* Check for I/O errors and EOF */
    if (ferror(stream) || buf->len == orig_len)
    {
        /* Discard any data we collected before detecting error */
        buf->len = orig_len;
        buf->data[orig_len] = '\0';
        return false;
    }
 
    /* No newline at EOF, but we did collect some data */
    return true;
}

References buf, PromptInterruptContext::canceled, PromptInterruptContext::enabled, enlargeStringInfo(), and PromptInterruptContext::jmpbuf.

Referenced by pg_get_line(), pg_get_line_buf(), and tokenize_auth_file().

pg_get_line_buf()

bool pg_get_line_buf	(	FILE *	stream,
		StringInfo	buf
	)

Definition at line 95 of file pg_get_line.c.

{
    /* We just need to drop any data from the previous call */
    resetStringInfo(buf);
    return pg_get_line_append(stream, buf, NULL);
}

References buf, pg_get_line_append(), and resetStringInfo().

Referenced by ecpg_filter_source(), ecpg_filter_stderr(), filter_read_item(), read_quoted_string(), readfile(), SortTocFromFile(), and tsearch_readline().

pg_is_ascii()

bool pg_is_ascii

(

const char *

str

)

Definition at line 132 of file string.c.

{
    while (*str)
    {
        if (IS_HIGHBIT_SET(*str))
            return false;
        str++;
    }
    return true;
}

References IS_HIGHBIT_SET, and str.

Referenced by check_locale(), check_locale_name(), parse_key_value_arrays(), pg_import_system_collations(), and pg_saslprep().

pg_str_endswith()

bool pg_str_endswith	(	const char *	str,
		const char *	end
	)

Definition at line 31 of file string.c.

{
    size_t      slen = strlen(str);
    size_t      elen = strlen(end);
 
    /* can't be a postfix if longer */
    if (elen > slen)
        return false;
 
    /* compare the end of the strings */
    str += slen - elen;
    return strcmp(str, end) == 0;
}

References str.

Referenced by decide_file_action(), and StartupReplicationSlots().

pg_strip_crlf()

int pg_strip_crlf

(

char *

str

)

Definition at line 154 of file string.c.

{
    int         len = strlen(str);
 
    while (len > 0 && (str[len - 1] == '\n' ||
                       str[len - 1] == '\r'))
        str[--len] = '\0';
 
    return len;
}

References len, and str.

Referenced by adjust_data_dir(), check_exec(), CheckDataVersion(), get_control_data(), get_prompt(), get_sock_dir(), get_su_pwd(), getRestoreCommand(), passwordFromFile(), run_ssl_passphrase_command(), simple_prompt_extended(), and tokenize_auth_file().

simple_prompt()

char * simple_prompt	(	const char *	prompt,
		bool	echo
	)

Definition at line 38 of file sprompt.c.

{
    return simple_prompt_extended(prompt, echo, NULL);
}

References simple_prompt_extended().

Referenced by ConnectDatabase(), connectDatabase(), ConnectDatabaseAhx(), doConnect(), get_su_pwd(), GetConnection(), main(), sql_conn(), vacuumlo(), and yesno_prompt().

simple_prompt_extended()

char * simple_prompt_extended	(	const char *	prompt,
		bool	echo,
		PromptInterruptContext *	prompt_ctx
	)

Definition at line 53 of file sprompt.c.

{
    char       *result;
    FILE       *termin,
               *termout;
#if defined(HAVE_TERMIOS_H)
    struct termios t_orig,
                t;
#elif defined(WIN32)
    HANDLE      t = NULL;
    DWORD       t_orig = 0;
#endif
 
#ifdef WIN32
 
    /*
     * A Windows console has an "input code page" and an "output code page";
     * these usually match each other, but they rarely match the "Windows ANSI
     * code page" defined at system boot and expected of "char *" arguments to
     * Windows API functions.  The Microsoft CRT write() implementation
     * automatically converts text between these code pages when writing to a
     * console.  To identify such file descriptors, it calls GetConsoleMode()
     * on the underlying HANDLE, which in turn requires GENERIC_READ access on
     * the HANDLE.  Opening termout in mode "w+" allows that detection to
     * succeed.  Otherwise, write() would not recognize the descriptor as a
     * console, and non-ASCII characters would display incorrectly.
     *
     * XXX fgets() still receives text in the console's input code page.  This
     * makes non-ASCII credentials unportable.
     *
     * Unintuitively, we also open termin in mode "w+", even though we only
     * read it; that's needed for SetConsoleMode() to succeed.
     */
    termin = fopen("CONIN$", "w+");
    termout = fopen("CONOUT$", "w+");
#else
 
    /*
     * Do not try to collapse these into one "w+" mode file. Doesn't work on
     * some platforms (eg, HPUX 10.20).
     */
    termin = fopen("/dev/tty", "r");
    termout = fopen("/dev/tty", "w");
#endif
    if (!termin || !termout
#ifdef WIN32
 
    /*
     * Direct console I/O does not work from the MSYS 1.0.10 console.  Writes
     * reach nowhere user-visible; reads block indefinitely.  XXX This affects
     * most Windows terminal environments, including rxvt, mintty, Cygwin
     * xterm, Cygwin sshd, and PowerShell ISE.  Switch to a more-generic test.
     */
        || (getenv("OSTYPE") && strcmp(getenv("OSTYPE"), "msys") == 0)
#endif
        )
    {
        if (termin)
            fclose(termin);
        if (termout)
            fclose(termout);
        termin = stdin;
        termout = stderr;
    }
 
    if (!echo)
    {
#if defined(HAVE_TERMIOS_H)
        /* disable echo via tcgetattr/tcsetattr */
        tcgetattr(fileno(termin), &t);
        t_orig = t;
        t.c_lflag &= ~ECHO;
        tcsetattr(fileno(termin), TCSAFLUSH, &t);
#elif defined(WIN32)
        /* need the file's HANDLE to turn echo off */
        t = (HANDLE) _get_osfhandle(_fileno(termin));
 
        /* save the old configuration first */
        GetConsoleMode(t, &t_orig);
 
        /* set to the new mode */
        SetConsoleMode(t, ENABLE_LINE_INPUT | ENABLE_PROCESSED_INPUT);
#endif
    }
 
    if (prompt)
    {
        fputs(_(prompt), termout);
        fflush(termout);
    }
 
    result = pg_get_line(termin, prompt_ctx);
 
    /* If we failed to read anything, just return an empty string */
    if (result == NULL)
        result = pg_strdup("");
 
    /* strip trailing newline, including \r in case we're on Windows */
    (void) pg_strip_crlf(result);
 
    if (!echo)
    {
        /* restore previous echo behavior, then echo \n */
#if defined(HAVE_TERMIOS_H)
        tcsetattr(fileno(termin), TCSAFLUSH, &t_orig);
        fputs("\n", termout);
        fflush(termout);
#elif defined(WIN32)
        SetConsoleMode(t, t_orig);
        fputs("\n", termout);
        fflush(termout);
#endif
    }
    else if (prompt_ctx && prompt_ctx->canceled)
    {
        /* also echo \n if prompt was canceled */
        fputs("\n", termout);
        fflush(termout);
    }
 
    if (termin != stdin)
    {
        fclose(termin);
        fclose(termout);
    }
 
    return result;
}

References _, PromptInterruptContext::canceled, pg_get_line(), pg_strdup(), and pg_strip_crlf().

Referenced by exec_command_password(), exec_command_prompt(), prompt_for_password(), and simple_prompt().

strtoint()

int strtoint	(	const char *pg_restrict	str,
		char **pg_restrict	endptr,
		int	base
	)

Definition at line 50 of file string.c.

{
    long        val;
 
    val = strtol(str, endptr, base);
    if (val != (int) val)
        errno = ERANGE;
    return (int) val;
}

References str, and val.

Referenced by buildDefItem(), DecodeDateTime(), DecodeInterval(), DecodeNumber(), DecodeNumberField(), DecodeTime(), DecodeTimeCommon(), DecodeTimeOnly(), DecodeTimezone(), exec_command_watch(), get_path_all(), jsonb_get_element(), nodeTokenType(), option_parse_int(), process_integer_literal(), push_path(), px_crypt_shacrypt(), and setPathArray().