#include <signal.h>
#include "libpq-fe.h"

Include dependency graph for print.h:

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

Data Structures
struct	printTextLineFormat

struct	printTextFormat

struct	separator

struct	printTableOpt

struct	printTableFooter

struct	printTableContent

struct	printQueryOpt

Macros
#define	DEFAULT_PAGER "more"

Typedefs
typedef struct printTextLineFormat	printTextLineFormat

typedef enum printTextRule	printTextRule

typedef enum printTextLineWrap	printTextLineWrap

typedef enum printXheaderWidthType	printXheaderWidthType

typedef struct printTextFormat	printTextFormat

typedef enum unicode_linestyle	unicode_linestyle

typedef struct printTableOpt	printTableOpt

typedef struct printTableFooter	printTableFooter

typedef struct printTableContent	printTableContent

typedef struct printQueryOpt	printQueryOpt

Enumerations
enum	printFormat { PRINT_NOTHING = 0 , PRINT_ALIGNED , PRINT_ASCIIDOC , PRINT_CSV , PRINT_HTML , PRINT_LATEX , PRINT_LATEX_LONGTABLE , PRINT_TROFF_MS , PRINT_UNALIGNED , PRINT_WRAPPED }

enum	printTextRule { PRINT_RULE_TOP , PRINT_RULE_MIDDLE , PRINT_RULE_BOTTOM , PRINT_RULE_DATA }

enum	printTextLineWrap { PRINT_LINE_WRAP_NONE , PRINT_LINE_WRAP_WRAP , PRINT_LINE_WRAP_NEWLINE }

enum	printXheaderWidthType { PRINT_XHEADER_FULL , PRINT_XHEADER_COLUMN , PRINT_XHEADER_PAGE , PRINT_XHEADER_EXACT_WIDTH }

enum	unicode_linestyle { UNICODE_LINESTYLE_SINGLE = 0 , UNICODE_LINESTYLE_DOUBLE }

Functions
void	disable_sigpipe_trap (void)

void	restore_sigpipe_trap (void)

void	set_sigpipe_trap_state (bool ignore)

FILE *	PageOutput (int lines, const printTableOpt *topt)

void	ClosePager (FILE *pagerpipe)

void	html_escaped_print (const char in, FILE fout)

void	printTableInit (printTableContent const content, const printTableOpt opt, const char *title, const int ncolumns, const int nrows)

void	printTableAddHeader (printTableContent const content, char header, const bool translate, const char align)

void	printTableAddCell (printTableContent const content, char cell, const bool translate, const bool mustfree)

void	printTableAddFooter (printTableContent const content, const char footer)

void	printTableSetFooter (printTableContent const content, const char footer)

void	printTableCleanup (printTableContent *const content)

void	printTable (const printTableContent cont, FILE fout, bool is_pager, FILE *flog)

void	printQuery (const PGresult result, const printQueryOpt opt, FILE fout, bool is_pager, FILE flog)

char	column_type_alignment (Oid)

void	setDecimalLocale (void)

const printTextFormat *	get_line_style (const printTableOpt *opt)

void	refresh_utf8format (const printTableOpt *opt)

Variables
PGDLLIMPORT volatile sig_atomic_t	cancel_pressed

PGDLLIMPORT const printTextFormat	pg_asciiformat

PGDLLIMPORT const printTextFormat	pg_asciiformat_old

PGDLLIMPORT printTextFormat	pg_utf8format

Macro Definition Documentation

◆ DEFAULT_PAGER

#define DEFAULT_PAGER "more"

Definition at line 23 of file print.h.

Typedef Documentation

◆ printQueryOpt

typedef struct printQueryOpt printQueryOpt

◆ printTableContent

typedef struct printTableContent printTableContent

◆ printTableFooter

typedef struct printTableFooter printTableFooter

◆ printTableOpt

typedef struct printTableOpt printTableOpt

◆ printTextFormat

typedef struct printTextFormat printTextFormat

◆ printTextLineFormat

typedef struct printTextLineFormat printTextLineFormat

◆ printTextLineWrap

typedef enum printTextLineWrap printTextLineWrap

◆ printTextRule

typedef enum printTextRule printTextRule

◆ printXheaderWidthType

typedef enum printXheaderWidthType printXheaderWidthType

◆ unicode_linestyle

typedef enum unicode_linestyle unicode_linestyle

Enumeration Type Documentation

◆ printFormat

enum printFormat

Enumerator
PRINT_NOTHING
PRINT_ALIGNED
PRINT_ASCIIDOC
PRINT_CSV
PRINT_HTML
PRINT_LATEX
PRINT_LATEX_LONGTABLE
PRINT_TROFF_MS
PRINT_UNALIGNED
PRINT_WRAPPED

Definition at line 28 of file print.h.

{
    PRINT_NOTHING = 0,          /* to make sure someone initializes this */
    PRINT_ALIGNED,
    PRINT_ASCIIDOC,
    PRINT_CSV,
    PRINT_HTML,
    PRINT_LATEX,
    PRINT_LATEX_LONGTABLE,
    PRINT_TROFF_MS,
    PRINT_UNALIGNED,
    PRINT_WRAPPED,
    /* add your favourite output format here ... */
};

◆ printTextLineWrap

enum printTextLineWrap

Enumerator
PRINT_LINE_WRAP_NONE
PRINT_LINE_WRAP_WRAP
PRINT_LINE_WRAP_NEWLINE

Definition at line 61 of file print.h.

{
    /* Line wrapping conditions */
    PRINT_LINE_WRAP_NONE,       /* No wrapping */
    PRINT_LINE_WRAP_WRAP,       /* Wraparound due to overlength line */
    PRINT_LINE_WRAP_NEWLINE,    /* Newline in data */
} printTextLineWrap;

◆ printTextRule

enum printTextRule

Enumerator
PRINT_RULE_TOP
PRINT_RULE_MIDDLE
PRINT_RULE_BOTTOM
PRINT_RULE_DATA

Definition at line 52 of file print.h.

{
    /* Additional context for selecting line drawing characters */
    PRINT_RULE_TOP,             /* top horizontal line */
    PRINT_RULE_MIDDLE,          /* intra-data horizontal line */
    PRINT_RULE_BOTTOM,          /* bottom horizontal line */
    PRINT_RULE_DATA,            /* data line (hrule is unused here) */
} printTextRule;

◆ printXheaderWidthType

enum printXheaderWidthType

Enumerator
PRINT_XHEADER_FULL
PRINT_XHEADER_COLUMN
PRINT_XHEADER_PAGE
PRINT_XHEADER_EXACT_WIDTH

Definition at line 69 of file print.h.

{
    /* Expanded header line width variants */
    PRINT_XHEADER_FULL,         /* do not truncate header line (this is the
                                 * default) */
    PRINT_XHEADER_COLUMN,       /* only print header line above the first
                                 * column */
    PRINT_XHEADER_PAGE,         /* header line must not be longer than
                                 * terminal width */
    PRINT_XHEADER_EXACT_WIDTH,  /* explicitly specified width */
} printXheaderWidthType;

◆ unicode_linestyle

enum unicode_linestyle

Enumerator
UNICODE_LINESTYLE_SINGLE
UNICODE_LINESTYLE_DOUBLE

Definition at line 99 of file print.h.

{
    UNICODE_LINESTYLE_SINGLE = 0,
    UNICODE_LINESTYLE_DOUBLE,
} unicode_linestyle;

Function Documentation

◆ ClosePager()

void ClosePager ( FILE * pagerpipe )

Definition at line 3141 of file print.c.

{
    if (pagerpipe && pagerpipe != stdout)
    {
        /*
         * If printing was canceled midstream, warn about it.
         *
         * Some pagers like less use Ctrl-C as part of their command set. Even
         * so, we abort our processing and warn the user what we did.  If the
         * pager quit as a result of the SIGINT, this message won't go
         * anywhere ...
         */
        if (cancel_pressed)
            fprintf(pagerpipe, _("Interrupted\n"));
 
        pclose(pagerpipe);
        restore_sigpipe_trap();
    }
}

References _, cancel_pressed, fprintf, restore_sigpipe_trap(), and generate_unaccent_rules::stdout.

Referenced by exec_command_sf_sv(), ExecQueryAndProcessResults(), helpSQL(), helpVariables(), print_aligned_text(), print_aligned_vertical(), printHistory(), printTable(), slashUsage(), and usage().

◆ column_type_alignment()

char column_type_alignment ( Oid ftype )

Definition at line 3614 of file print.c.

{
    char        align;
 
    switch (ftype)
    {
        case INT2OID:
        case INT4OID:
        case INT8OID:
        case FLOAT4OID:
        case FLOAT8OID:
        case NUMERICOID:
        case OIDOID:
        case XIDOID:
        case XID8OID:
        case CIDOID:
        case MONEYOID:
            align = 'r';
            break;
        default:
            align = 'l';
            break;
    }
    return align;
}

Referenced by printCrosstab(), and printQuery().

◆ disable_sigpipe_trap()

void disable_sigpipe_trap ( void )

Definition at line 3039 of file print.c.

{
#ifndef WIN32
    pqsignal(SIGPIPE, SIG_IGN);
#endif
}

References pqsignal, and SIGPIPE.

Referenced by do_copy(), do_watch(), exec_command_write(), PageOutput(), and SetupGOutput().

◆ get_line_style()

const printTextFormat * get_line_style ( const printTableOpt * opt )

Definition at line 3677 of file print.c.

{
    /*
     * Note: this function mainly exists to preserve the convention that a
     * printTableOpt struct can be initialized to zeroes to get default
     * behavior.
     */
    if (opt->line_style != NULL)
        return opt->line_style;
    else
        return &pg_asciiformat;
}

References printTableOpt::line_style, and pg_asciiformat.

Referenced by print_aligned_text(), print_aligned_vertical(), print_aligned_vertical_line(), printPsetInfo(), and pset_value_string().

◆ html_escaped_print()

void html_escaped_print	(	const char *	in,
		FILE *	fout
	)

Definition at line 1952 of file print.c.

{
    const char *p;
    bool        leading_space = true;
 
    for (p = in; *p; p++)
    {
        switch (*p)
        {
            case '&':
                fputs("&amp;", fout);
                break;
            case '<':
                fputs("&lt;", fout);
                break;
            case '>':
                fputs("&gt;", fout);
                break;
            case '\n':
                fputs("<br />\n", fout);
                break;
            case '"':
                fputs("&quot;", fout);
                break;
            case ' ':
                /* protect leading space, for EXPLAIN output */
                if (leading_space)
                    fputs("&nbsp;", fout);
                else
                    fputs(" ", fout);
                break;
            default:
                fputc(*p, fout);
        }
        if (*p != ' ')
            leading_space = false;
    }
}

Referenced by print_html_text(), print_html_vertical(), and PrintQueryStatus().

◆ PageOutput()

FILE * PageOutput	(	int	lines,
		const printTableOpt *	topt
	)

Definition at line 3089 of file print.c.

{
    /* check whether we need / can / are supposed to use pager */
    if (topt && topt->pager && isatty(fileno(stdin)) && isatty(fileno(stdout)))
    {
#ifdef TIOCGWINSZ
        unsigned short int pager = topt->pager;
        int         min_lines = topt->pager_min_lines;
        int         result;
        struct winsize screen_size;
 
        result = ioctl(fileno(stdout), TIOCGWINSZ, &screen_size);
 
        /* >= accounts for a one-line prompt */
        if (result == -1
            || (lines >= screen_size.ws_row && lines >= min_lines)
            || pager > 1)
#endif
        {
            const char *pagerprog;
            FILE       *pagerpipe;
 
            pagerprog = getenv("PSQL_PAGER");
            if (!pagerprog)
                pagerprog = getenv("PAGER");
            if (!pagerprog)
                pagerprog = DEFAULT_PAGER;
            else
            {
                /* if PAGER is empty or all-white-space, don't use pager */
                if (strspn(pagerprog, " \t\r\n") == strlen(pagerprog))
                    return stdout;
            }
            fflush(NULL);
            disable_sigpipe_trap();
            pagerpipe = popen(pagerprog, "w");
            if (pagerpipe)
                return pagerpipe;
            /* if popen fails, silently proceed without pager */
            restore_sigpipe_trap();
        }
    }
 
    return stdout;
}

References DEFAULT_PAGER, disable_sigpipe_trap(), printTableOpt::pager, printTableOpt::pager_min_lines, restore_sigpipe_trap(), and generate_unaccent_rules::stdout.

Referenced by exec_command_sf_sv(), ExecQueryAndProcessResults(), helpSQL(), helpVariables(), IsPagerNeeded(), print_aligned_text(), printHistory(), slashUsage(), and usage().

◆ printQuery()

void printQuery	(	const PGresult *	result,
		const printQueryOpt *	opt,
		FILE *	fout,
		bool	is_pager,
		FILE *	flog
	)

Definition at line 3549 of file print.c.

{
    printTableContent cont;
    int         i,
                r,
                c;
 
    if (cancel_pressed)
        return;
 
    printTableInit(&cont, &opt->topt, opt->title,
                   PQnfields(result), PQntuples(result));
 
    /* Assert caller supplied enough translate_columns[] entries */
    Assert(opt->translate_columns == NULL ||
           opt->n_translate_columns >= cont.ncolumns);
 
    for (i = 0; i < cont.ncolumns; i++)
    {
        printTableAddHeader(&cont, PQfname(result, i),
                            opt->translate_header,
                            column_type_alignment(PQftype(result, i)));
    }
 
    /* set cells */
    for (r = 0; r < cont.nrows; r++)
    {
        for (c = 0; c < cont.ncolumns; c++)
        {
            char       *cell;
            bool        mustfree = false;
            bool        translate;
 
            if (PQgetisnull(result, r, c))
                cell = opt->nullPrint ? opt->nullPrint : "";
            else
            {
                cell = PQgetvalue(result, r, c);
                if (cont.aligns[c] == 'r' && opt->topt.numericLocale)
                {
                    cell = format_numeric_locale(cell);
                    mustfree = true;
                }
            }
 
            translate = (opt->translate_columns && opt->translate_columns[c]);
            printTableAddCell(&cont, cell, translate, mustfree);
        }
    }
 
    /* set footers */
    if (opt->footers)
    {
        char      **footer;
 
        for (footer = opt->footers; *footer; footer++)
            printTableAddFooter(&cont, *footer);
    }
 
    printTable(&cont, fout, is_pager, flog);
    printTableCleanup(&cont);
}

References printTableContent::aligns, Assert(), cancel_pressed, column_type_alignment(), printQueryOpt::footers, format_numeric_locale(), i, printQueryOpt::n_translate_columns, printTableContent::ncolumns, printTableContent::nrows, printQueryOpt::nullPrint, printTableOpt::numericLocale, PQfname(), PQftype(), PQgetisnull(), PQgetvalue(), PQnfields(), PQntuples(), printTable(), printTableAddCell(), printTableAddFooter(), printTableAddHeader(), printTableCleanup(), printTableInit(), printQueryOpt::title, printQueryOpt::topt, translate(), printQueryOpt::translate_columns, and printQueryOpt::translate_header.

Referenced by describeAccessMethods(), describeAggregates(), describeConfigurationParameters(), describeFunctions(), describeOneTableDetails(), describeOneTSConfig(), describeOneTSParser(), describeOperators(), describeRoleGrants(), describeSubscriptions(), describeTablespaces(), describeTypes(), ExecQueryAndProcessResults(), listAllDbs(), listCasts(), listCollations(), listConversions(), listDbRoleSettings(), listDefaultACLs(), listDomains(), listEventTriggers(), listExtendedStats(), listExtensions(), listForeignDataWrappers(), listForeignServers(), listForeignTables(), listLanguages(), listLargeObjects(), listOneExtensionContents(), listOperatorClasses(), listOperatorFamilies(), listOpFamilyFunctions(), listOpFamilyOperators(), listPartitionedTables(), listPublications(), listSchemas(), listTables(), listTSConfigs(), listTSDictionaries(), listTSParsers(), listTSTemplates(), listUserMappings(), objectDescription(), permissionsList(), and PrintQueryTuples().

◆ printTable()

void printTable	(	const printTableContent *	cont,
		FILE *	fout,
		bool	is_pager,
		FILE *	flog
	)

Definition at line 3443 of file print.c.

{
    bool        is_local_pager = false;
 
    if (cancel_pressed)
        return;
 
    if (cont->opt->format == PRINT_NOTHING)
        return;
 
    /* print_aligned_*() handle the pager themselves */
    if (!is_pager &&
        cont->opt->format != PRINT_ALIGNED &&
        cont->opt->format != PRINT_WRAPPED)
    {
        IsPagerNeeded(cont, 0, (cont->opt->expanded == 1), &fout, &is_pager);
        is_local_pager = is_pager;
    }
 
    /* clear any pre-existing error indication on the output stream */
    clearerr(fout);
 
    /* print the stuff */
 
    if (flog)
        print_aligned_text(cont, flog, false);
 
    switch (cont->opt->format)
    {
        case PRINT_UNALIGNED:
            if (cont->opt->expanded == 1)
                print_unaligned_vertical(cont, fout);
            else
                print_unaligned_text(cont, fout);
            break;
        case PRINT_ALIGNED:
        case PRINT_WRAPPED:
 
            /*
             * In expanded-auto mode, force vertical if a pager is passed in;
             * else we may make different decisions for different hunks of the
             * query result.
             */
            if (cont->opt->expanded == 1 ||
                (cont->opt->expanded == 2 && is_pager))
                print_aligned_vertical(cont, fout, is_pager);
            else
                print_aligned_text(cont, fout, is_pager);
            break;
        case PRINT_CSV:
            if (cont->opt->expanded == 1)
                print_csv_vertical(cont, fout);
            else
                print_csv_text(cont, fout);
            break;
        case PRINT_HTML:
            if (cont->opt->expanded == 1)
                print_html_vertical(cont, fout);
            else
                print_html_text(cont, fout);
            break;
        case PRINT_ASCIIDOC:
            if (cont->opt->expanded == 1)
                print_asciidoc_vertical(cont, fout);
            else
                print_asciidoc_text(cont, fout);
            break;
        case PRINT_LATEX:
            if (cont->opt->expanded == 1)
                print_latex_vertical(cont, fout);
            else
                print_latex_text(cont, fout);
            break;
        case PRINT_LATEX_LONGTABLE:
            if (cont->opt->expanded == 1)
                print_latex_vertical(cont, fout);
            else
                print_latex_longtable_text(cont, fout);
            break;
        case PRINT_TROFF_MS:
            if (cont->opt->expanded == 1)
                print_troff_ms_vertical(cont, fout);
            else
                print_troff_ms_text(cont, fout);
            break;
        default:
            fprintf(stderr, _("invalid output format (internal error): %d"),
                    cont->opt->format);
            exit(EXIT_FAILURE);
    }
 
    if (is_local_pager)
        ClosePager(fout);
}

References _, cancel_pressed, ClosePager(), EXIT_FAILURE, printTableOpt::expanded, printTableOpt::format, fprintf, IsPagerNeeded(), printTableContent::opt, PRINT_ALIGNED, print_aligned_text(), print_aligned_vertical(), PRINT_ASCIIDOC, print_asciidoc_text(), print_asciidoc_vertical(), PRINT_CSV, print_csv_text(), print_csv_vertical(), PRINT_HTML, print_html_text(), print_html_vertical(), PRINT_LATEX, PRINT_LATEX_LONGTABLE, print_latex_longtable_text(), print_latex_text(), print_latex_vertical(), PRINT_NOTHING, PRINT_TROFF_MS, print_troff_ms_text(), print_troff_ms_vertical(), PRINT_UNALIGNED, print_unaligned_text(), print_unaligned_vertical(), and PRINT_WRAPPED.

Referenced by describeOneTableDetails(), describePublications(), describeRoles(), exec_command_conninfo(), printCrosstab(), and printQuery().

◆ printTableAddCell()

void printTableAddCell	(	printTableContent *const	content,
		char *	cell,
		const bool	translate,
		const bool	mustfree
	)

Definition at line 3260 of file print.c.

{
    uint64      total_cells;
 
#ifndef ENABLE_NLS
    (void) translate;           /* unused parameter */
#endif
 
    total_cells = (uint64) content->ncolumns * content->nrows;
    if (content->cellsadded >= total_cells)
    {
        fprintf(stderr, _("Cannot add cell to table content: total cell count of %lld exceeded.\n"),
                (long long int) total_cells);
        exit(EXIT_FAILURE);
    }
 
    *content->cell = (char *) mbvalidate((unsigned char *) cell,
                                         content->opt->encoding);
 
#ifdef ENABLE_NLS
    if (translate)
        *content->cell = _(*content->cell);
#endif
 
    if (mustfree)
    {
        if (content->cellmustfree == NULL)
            content->cellmustfree =
                pg_malloc0((total_cells + 1) * sizeof(bool));
 
        content->cellmustfree[content->cellsadded] = true;
    }
    content->cell++;
    content->cellsadded++;
}

References _, printTableContent::cell, printTableContent::cellmustfree, printTableContent::cellsadded, printTableOpt::encoding, EXIT_FAILURE, fprintf, if(), mbvalidate(), printTableContent::ncolumns, printTableContent::nrows, printTableContent::opt, pg_malloc0(), and translate().

Referenced by describeOneTableDetails(), describePublications(), describeRoles(), exec_command_conninfo(), and printQuery().

◆ printTableAddFooter()

void printTableAddFooter	(	printTableContent *const	content,
		const char *	footer
	)

Definition at line 3310 of file print.c.

{
    printTableFooter *f;
 
    f = pg_malloc0(sizeof(*f));
    f->data = pg_strdup(footer);
 
    if (content->footers == NULL)
        content->footers = f;
    else
        content->footer->next = f;
 
    content->footer = f;
}

References printTableFooter::data, printTableContent::footer, printTableContent::footers, printTableFooter::next, pg_malloc0(), and pg_strdup().

Referenced by add_tablespace_footer(), addFooterToPublicationDesc(), describeOneTableDetails(), printQuery(), and printTableSetFooter().

◆ printTableAddHeader()

void printTableAddHeader	(	printTableContent *const	content,
		char *	header,
		const bool	translate,
		const char	align
	)

Definition at line 3220 of file print.c.

{
#ifndef ENABLE_NLS
    (void) translate;           /* unused parameter */
#endif
 
    if (content->header >= content->headers + content->ncolumns)
    {
        fprintf(stderr, _("Cannot add header to table content: "
                          "column count of %d exceeded.\n"),
                content->ncolumns);
        exit(EXIT_FAILURE);
    }
 
    *content->header = (char *) mbvalidate((unsigned char *) header,
                                           content->opt->encoding);
#ifdef ENABLE_NLS
    if (translate)
        *content->header = _(*content->header);
#endif
    content->header++;
 
    *content->align = align;
    content->align++;
}

References _, printTableContent::align, printTableOpt::encoding, EXIT_FAILURE, fprintf, printTableContent::header, printTableContent::headers, mbvalidate(), printTableContent::ncolumns, printTableContent::opt, and translate().

Referenced by describeOneTableDetails(), describePublications(), describeRoles(), exec_command_conninfo(), printCrosstab(), and printQuery().

◆ printTableCleanup()

void printTableCleanup ( printTableContent *const content )

Definition at line 3353 of file print.c.

{
    if (content->cellmustfree)
    {
        uint64      total_cells;
 
        total_cells = (uint64) content->ncolumns * content->nrows;
        for (uint64 i = 0; i < total_cells; i++)
        {
            if (content->cellmustfree[i])
                free(unconstify(char *, content->cells[i]));
        }
        free(content->cellmustfree);
        content->cellmustfree = NULL;
    }
    free(content->headers);
    free(content->cells);
    free(content->aligns);
 
    content->opt = NULL;
    content->title = NULL;
    content->headers = NULL;
    content->cells = NULL;
    content->aligns = NULL;
    content->header = NULL;
    content->cell = NULL;
    content->align = NULL;
 
    if (content->footers)
    {
        for (content->footer = content->footers; content->footer;)
        {
            printTableFooter *f;
 
            f = content->footer;
            content->footer = f->next;
            free(f->data);
            free(f);
        }
    }
    content->footers = NULL;
    content->footer = NULL;
}

References printTableContent::align, printTableContent::aligns, printTableContent::cell, printTableContent::cellmustfree, printTableContent::cells, printTableFooter::data, printTableContent::footer, printTableContent::footers, for(), free, printTableContent::header, printTableContent::headers, i, printTableContent::ncolumns, printTableFooter::next, printTableContent::nrows, printTableContent::opt, printTableContent::title, and unconstify.

Referenced by describeOneTableDetails(), describePublications(), describeRoles(), exec_command_conninfo(), printCrosstab(), and printQuery().

◆ printTableInit()

void printTableInit	(	printTableContent *const	content,
		const printTableOpt *	opt,
		const char *	title,
		const int	ncolumns,
		const int	nrows
	)

Definition at line 3172 of file print.c.

{
    uint64      total_cells;
 
    content->opt = opt;
    content->title = title;
    content->ncolumns = ncolumns;
    content->nrows = nrows;
 
    content->headers = pg_malloc0((ncolumns + 1) * sizeof(*content->headers));
 
    total_cells = (uint64) ncolumns * nrows;
    /* Catch possible overflow.  Using >= here allows adding 1 below */
    if (total_cells >= SIZE_MAX / sizeof(*content->cells))
    {
        fprintf(stderr, _("Cannot print table contents: number of cells %lld is equal to or exceeds maximum %lld.\n"),
                (long long int) total_cells,
                (long long int) (SIZE_MAX / sizeof(*content->cells)));
        exit(EXIT_FAILURE);
    }
    content->cells = pg_malloc0((total_cells + 1) * sizeof(*content->cells));
 
    content->cellmustfree = NULL;
    content->footers = NULL;
 
    content->aligns = pg_malloc0((ncolumns + 1) * sizeof(*content->align));
 
    content->header = content->headers;
    content->cell = content->cells;
    content->footer = content->footers;
    content->align = content->aligns;
    content->cellsadded = 0;
}

References _, printTableContent::align, printTableContent::aligns, printTableContent::cell, printTableContent::cellmustfree, printTableContent::cells, printTableContent::cellsadded, EXIT_FAILURE, printTableContent::footer, printTableContent::footers, fprintf, printTableContent::header, printTableContent::headers, printTableContent::ncolumns, printTableContent::nrows, printTableContent::opt, pg_malloc0(), and printTableContent::title.

Referenced by describeOneTableDetails(), describePublications(), describeRoles(), exec_command_conninfo(), printCrosstab(), and printQuery().

◆ printTableSetFooter()

void printTableSetFooter	(	printTableContent *const	content,
		const char *	footer
	)

Definition at line 3335 of file print.c.

{
    if (content->footers != NULL)
    {
        free(content->footer->data);
        content->footer->data = pg_strdup(footer);
    }
    else
        printTableAddFooter(content, footer);
}

References printTableFooter::data, printTableContent::footer, printTableContent::footers, free, pg_strdup(), and printTableAddFooter().

Referenced by add_tablespace_footer().

◆ refresh_utf8format()

void refresh_utf8format ( const printTableOpt * opt )

Definition at line 3691 of file print.c.

{
    printTextFormat *popt = &pg_utf8format;
 
    const unicodeStyleBorderFormat *border;
    const unicodeStyleRowFormat *header;
    const unicodeStyleColumnFormat *column;
 
    popt->name = "unicode";
 
    border = &unicode_style.border_style[opt->unicode_border_linestyle];
    header = &unicode_style.row_style[opt->unicode_header_linestyle];
    column = &unicode_style.column_style[opt->unicode_column_linestyle];
 
    popt->lrule[PRINT_RULE_TOP].hrule = border->horizontal;
    popt->lrule[PRINT_RULE_TOP].leftvrule = border->down_and_right;
    popt->lrule[PRINT_RULE_TOP].midvrule = column->down_and_horizontal[opt->unicode_border_linestyle];
    popt->lrule[PRINT_RULE_TOP].rightvrule = border->down_and_left;
 
    popt->lrule[PRINT_RULE_MIDDLE].hrule = header->horizontal;
    popt->lrule[PRINT_RULE_MIDDLE].leftvrule = header->vertical_and_right[opt->unicode_border_linestyle];
    popt->lrule[PRINT_RULE_MIDDLE].midvrule = column->vertical_and_horizontal[opt->unicode_header_linestyle];
    popt->lrule[PRINT_RULE_MIDDLE].rightvrule = header->vertical_and_left[opt->unicode_border_linestyle];
 
    popt->lrule[PRINT_RULE_BOTTOM].hrule = border->horizontal;
    popt->lrule[PRINT_RULE_BOTTOM].leftvrule = border->up_and_right;
    popt->lrule[PRINT_RULE_BOTTOM].midvrule = column->up_and_horizontal[opt->unicode_border_linestyle];
    popt->lrule[PRINT_RULE_BOTTOM].rightvrule = border->left_and_right;
 
    /* N/A */
    popt->lrule[PRINT_RULE_DATA].hrule = "";
    popt->lrule[PRINT_RULE_DATA].leftvrule = border->vertical;
    popt->lrule[PRINT_RULE_DATA].midvrule = column->vertical;
    popt->lrule[PRINT_RULE_DATA].rightvrule = border->vertical;
 
    popt->midvrule_nl = column->vertical;
    popt->midvrule_wrap = column->vertical;
    popt->midvrule_blank = column->vertical;
 
    /* Same for all unicode today */
    popt->header_nl_left = unicode_style.header_nl_left;
    popt->header_nl_right = unicode_style.header_nl_right;
    popt->nl_left = unicode_style.nl_left;
    popt->nl_right = unicode_style.nl_right;
    popt->wrap_left = unicode_style.wrap_left;
    popt->wrap_right = unicode_style.wrap_right;
    popt->wrap_right_border = unicode_style.wrap_right_border;
}

Referenced by do_pset(), and main().

◆ restore_sigpipe_trap()

void restore_sigpipe_trap ( void )

Definition at line 3062 of file print.c.

{
#ifndef WIN32
    pqsignal(SIGPIPE, always_ignore_sigpipe ? SIG_IGN : SIG_DFL);
#endif
}

References always_ignore_sigpipe, pqsignal, and SIGPIPE.

Referenced by CloseGOutput(), ClosePager(), do_copy(), do_watch(), exec_command_write(), PageOutput(), and setQFout().

◆ set_sigpipe_trap_state()

void set_sigpipe_trap_state ( bool ignore )

Definition at line 3075 of file print.c.

{
    always_ignore_sigpipe = ignore;
}

References always_ignore_sigpipe.

Referenced by setQFout().

◆ setDecimalLocale()

void setDecimalLocale ( void )

Definition at line 3641 of file print.c.

{
    struct lconv *extlconv;
 
    extlconv = localeconv();
 
    /* Don't accept an empty decimal_point string */
    if (*extlconv->decimal_point)
        decimal_point = pg_strdup(extlconv->decimal_point);
    else
        decimal_point = ".";    /* SQL output standard */
 
    /*
     * Although the Open Group standard allows locales to supply more than one
     * group width, we consider only the first one, and we ignore any attempt
     * to suppress grouping by specifying CHAR_MAX.  As in the backend's
     * cash.c, we must apply a range check to avoid being fooled by variant
     * CHAR_MAX values.
     */
    groupdigits = *extlconv->grouping;
    if (groupdigits <= 0 || groupdigits > 6)
        groupdigits = 3;        /* most common */
 
    /* Don't accept an empty thousands_sep string, either */
    /* similar code exists in formatting.c */
    if (*extlconv->thousands_sep)
        thousands_sep = pg_strdup(extlconv->thousands_sep);
    /* Make sure thousands separator doesn't match decimal point symbol. */
    else if (strcmp(decimal_point, ",") != 0)
        thousands_sep = ",";
    else
        thousands_sep = ".";
}

References decimal_point, groupdigits, pg_strdup(), and thousands_sep.

Referenced by main().

Variable Documentation

◆ cancel_pressed

PGDLLIMPORT volatile sig_atomic_t cancel_pressed

extern

◆ pg_asciiformat

PGDLLIMPORT const printTextFormat pg_asciiformat

extern

Definition at line 56 of file print.c.

Referenced by do_pset(), and get_line_style().

◆ pg_asciiformat_old

PGDLLIMPORT const printTextFormat pg_asciiformat_old

extern

Definition at line 77 of file print.c.

Referenced by do_pset(), and print_aligned_vertical().

◆ pg_utf8format

PGDLLIMPORT printTextFormat pg_utf8format

extern

Definition at line 99 of file print.c.

Referenced by do_pset(), and refresh_utf8format().

Data Structures

Macros

Typedefs

Enumerations

Functions

Variables

Macro Definition Documentation

◆ DEFAULT_PAGER

Typedef Documentation

◆ printQueryOpt

◆ printTableContent

◆ printTableFooter

◆ printTableOpt

◆ printTextFormat

◆ printTextLineFormat

◆ printTextLineWrap

◆ printTextRule

◆ printXheaderWidthType

◆ unicode_linestyle

Enumeration Type Documentation

◆ printFormat

◆ printTextLineWrap

◆ printTextRule

◆ printXheaderWidthType

◆ unicode_linestyle

Function Documentation

◆ ClosePager()

◆ column_type_alignment()

◆ disable_sigpipe_trap()

◆ get_line_style()

◆ html_escaped_print()

◆ PageOutput()

◆ printQuery()

◆ printTable()

◆ printTableAddCell()

◆ printTableAddFooter()

◆ printTableAddHeader()

◆ printTableCleanup()

◆ printTableInit()

◆ printTableSetFooter()

◆ refresh_utf8format()

◆ restore_sigpipe_trap()

◆ set_sigpipe_trap_state()

◆ setDecimalLocale()

Variable Documentation

◆ cancel_pressed

◆ pg_asciiformat

◆ pg_asciiformat_old

◆ pg_utf8format