Skip to content

Commit 95d2af1

Browse files
peterepetere
committed
Add psql expanded auto mode
This adds the "auto" option to the \x command, which switches to the expanded mode when the normal output would be wider than the screen. reviewed by Noah Misch
1 parent aa3299f commit 95d2af1

File tree

5 files changed

+73
-37
lines changed

5 files changed

+73
-37
lines changed

‎doc/src/sgml/ref/psql-ref.sgml

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1860,7 +1860,8 @@ lo_import 152801
18601860
<para>
18611861
Sets the target width for the <literal>wrapped</> format, and also
18621862
the width limit for determining whether output is wide enough to
1863-
require the pager.
1863+
require the pager or switch to the vertical display in expanded auto
1864+
mode.
18641865
Zero (the default) causes the target width to be controlled by the
18651866
environment variable <envar>COLUMNS</>, or the detected screen width
18661867
if <envar>COLUMNS</> is not set.
@@ -1876,15 +1877,19 @@ lo_import 152801
18761877
<term><literal>expanded</literal> (or <literal>x</literal>)</term>
18771878
<listitem>
18781879
<para>
1879-
If <replaceable class="parameter">value</replaceable> is specified
1880-
it must be either <literal>on</literal> or <literal>off</literal>
1881-
which will enable or disable expanded mode. If <replaceable
1882-
class="parameter">value</replaceable> is omitted the command toggles
1883-
between regular and expanded mode.
1884-
When expanded mode is enabled, query results
1885-
are displayed in two columns, with the column name on the left and
1886-
the data on the right. This mode is useful if the data wouldn't fit
1887-
on the screen in the normal <quote>horizontal</quote> mode.
1880+
If <replaceable class="parameter">value</replaceable> is specified it
1881+
must be either <literal>on</literal> or <literal>off</literal>, which
1882+
will enable or disable expanded mode, or <literal>auto</literal>.
1883+
If <replaceable class="parameter">value</replaceable> is omitted the
1884+
command toggles between the on and off settings. When expanded mode
1885+
is enabled, query results are displayed in two columns, with the
1886+
column name on the left and the data on the right. This mode is
1887+
useful if the data wouldn't fit on the screen in the
1888+
normal <quote>horizontal</quote> mode. In the auto setting, the
1889+
expanded mode is used whenever the query output is wider than the
1890+
screen, otherwise the regular mode is used. The auto setting is only
1891+
effective in the aligned and wrapped formats. In other formats, it
1892+
always behaves as if the expanded mode is off.
18881893
</para>
18891894
</listitem>
18901895
</varlistentry>
@@ -2326,10 +2331,10 @@ lo_import 152801
23262331

23272332

23282333
<varlistentry>
2329-
<term><literal>\x</literal></term>
2334+
<term><literal>\x [ <replaceable class="parameter">on</replaceable> | <replaceable class="parameter">off</replaceable> | <replaceable class="parameter">auto</replaceable> ]</literal></term>
23302335
<listitem>
23312336
<para>
2332-
Toggles expanded table formatting mode. As such it is equivalent to
2337+
Sets or toggles expanded table formatting mode. As such it is equivalent to
23332338
<literal>\pset expanded</literal>.
23342339
</para>
23352340
</listitem>
@@ -3197,7 +3202,8 @@ $endif
31973202
<para>
31983203
If <literal>\pset columns</> is zero, controls the
31993204
width for the <literal>wrapped</> format and width for determining
3200-
if wide output requires the pager.
3205+
if wide output requires the pager or should be switched to the
3206+
vertical format in expanded auto mode.
32013207
</para>
32023208
</listitem>
32033209
</varlistentry>

‎src/bin/psql/command.c

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1355,7 +1355,7 @@ exec_command(const char *cmd,
13551355
free(fname);
13561356
}
13571357

1358-
/* \x -- toggle expanded table representation */
1358+
/* \x -- set or toggle expanded table representation */
13591359
else if (strcmp(cmd, "x") == 0)
13601360
{
13611361
char *opt = psql_scan_slash_option(scan_state,
@@ -2189,14 +2189,21 @@ do_pset(const char *param, const char *value, printQueryOpt *popt, bool quiet)
21892189
/* set expanded/vertical mode */
21902190
else if (strcmp(param, "x") == 0 || strcmp(param, "expanded") == 0 || strcmp(param, "vertical") == 0)
21912191
{
2192-
if (value)
2192+
if (value && pg_strcasecmp(value, "auto") == 0)
2193+
popt->topt.expanded = 2;
2194+
else if (value)
21932195
popt->topt.expanded = ParseVariableBool(value);
21942196
else
21952197
popt->topt.expanded = !popt->topt.expanded;
21962198
if (!quiet)
2197-
printf(popt->topt.expanded
2198-
? _("Expanded display is on.\n")
2199-
: _("Expanded display is off.\n"));
2199+
{
2200+
if (popt->topt.expanded == 1)
2201+
printf(_("Expanded display is on.\n"));
2202+
else if (popt->topt.expanded == 2)
2203+
printf(_("Expanded display is used automatically.\n"));
2204+
else
2205+
printf(_("Expanded display is off.\n"));
2206+
}
22002207
}
22012208

22022209
/* locale-aware numeric output */
@@ -2356,7 +2363,7 @@ do_pset(const char *param, const char *value, printQueryOpt *popt, bool quiet)
23562363
popt->topt.columns = atoi(value);
23572364

23582365
if (!quiet)
2359-
printf(_("Target width for \"wrapped\" format is %d.\n"), popt->topt.columns);
2366+
printf(_("Target width is %d.\n"), popt->topt.columns);
23602367
}
23612368

23622369
else

‎src/bin/psql/help.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -242,8 +242,8 @@ slashUsage(unsigned short int pager)
242242
fprintf(output, _(" \\t [on|off] show only rows (currently %s)\n"),
243243
ON(pset.popt.topt.tuples_only));
244244
fprintf(output, _(" \\T [STRING] set HTML <table> tag attributes, or unset if none\n"));
245-
fprintf(output, _(" \\x [on|off] toggle expanded output (currently %s)\n"),
246-
ON(pset.popt.topt.expanded));
245+
fprintf(output, _(" \\x [on|off|auto] toggle expanded output (currently %s)\n"),
246+
pset.popt.topt.expanded == 2 ? "auto" : ON(pset.popt.topt.expanded));
247247
fprintf(output, "\n");
248248

249249
fprintf(output, _("Connection\n"));

‎src/bin/psql/print.c

Lines changed: 37 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -122,9 +122,11 @@ const printTextFormat pg_utf8format =
122122

123123
/* Local functions */
124124
static int strlen_max_width(unsigned char *str, int *target_width, int encoding);
125-
static void IsPagerNeeded(const printTableContent *cont, const int extra_lines,
125+
static void IsPagerNeeded(const printTableContent *cont, const int extra_lines, bool expanded,
126126
FILE **fout, bool *is_pager);
127127

128+
static void print_aligned_vertical(const printTableContent *cont, FILE *fout);
129+
128130

129131
static void *
130132
pg_local_malloc(size_t size)
@@ -713,6 +715,17 @@ print_aligned_text(const printTableContent *cont, FILE *fout)
713715
}
714716
}
715717

718+
/*
719+
* If in expanded auto mode, we have now calculated the expected width, so
720+
* we can now escape to vertical mode if necessary.
721+
*/
722+
if (cont->opt->expanded == 2 && output_columns > 0 &&
723+
(output_columns < total_header_width || output_columns < width_total))
724+
{
725+
print_aligned_vertical(cont, fout);
726+
return;
727+
}
728+
716729
/* If we wrapped beyond the display width, use the pager */
717730
if (!is_pager && fout == stdout && output_columns > 0 &&
718731
(output_columns < total_header_width || output_columns < width_total))
@@ -756,7 +769,7 @@ print_aligned_text(const printTableContent *cont, FILE *fout)
756769
extra_row_output_lines = 0;
757770
}
758771
}
759-
IsPagerNeeded(cont, extra_output_lines, &fout, &is_pager);
772+
IsPagerNeeded(cont, extra_output_lines, false, &fout, &is_pager);
760773
}
761774

762775
/* time to output */
@@ -1125,6 +1138,7 @@ print_aligned_vertical(const printTableContent *cont, FILE *fout)
11251138
dformatsize = 0;
11261139
struct lineptr *hlineptr,
11271140
*dlineptr;
1141+
bool is_pager = false;
11281142

11291143
if (cancel_pressed)
11301144
return;
@@ -1139,6 +1153,13 @@ print_aligned_vertical(const printTableContent *cont, FILE *fout)
11391153
return;
11401154
}
11411155

1156+
/*
1157+
* Deal with the pager here instead of in printTable(), because we could
1158+
* get here via print_aligned_text() in expanded auto mode, and so we have
1159+
* to recalcuate the pager requirement based on vertical output.
1160+
*/
1161+
IsPagerNeeded(cont, 0, true, &fout, &is_pager);
1162+
11421163
/* Find the maximum dimensions for the headers */
11431164
for (i = 0; i < cont->ncolumns; i++)
11441165
{
@@ -1295,6 +1316,9 @@ print_aligned_vertical(const printTableContent *cont, FILE *fout)
12951316
free(dlineptr->ptr);
12961317
free(hlineptr);
12971318
free(dlineptr);
1319+
1320+
if (is_pager)
1321+
ClosePager(fout);
12981322
}
12991323

13001324

@@ -2265,14 +2289,14 @@ printTableCleanup(printTableContent *const content)
22652289
* Setup pager if required
22662290
*/
22672291
static void
2268-
IsPagerNeeded(const printTableContent *cont, const int extra_lines, FILE **fout,
2292+
IsPagerNeeded(const printTableContent *cont, const int extra_lines, bool expanded, FILE **fout,
22692293
bool *is_pager)
22702294
{
22712295
if (*fout == stdout)
22722296
{
22732297
int lines;
22742298

2275-
if (cont->opt->expanded)
2299+
if (expanded)
22762300
lines = (cont->ncolumns + 1) * cont->nrows;
22772301
else
22782302
lines = cont->nrows + 1;
@@ -2310,11 +2334,10 @@ printTable(const printTableContent *cont, FILE *fout, FILE *flog)
23102334
if (cont->opt->format == PRINT_NOTHING)
23112335
return;
23122336

2313-
/* print_aligned_text() handles the pager itself */
2314-
if ((cont->opt->format != PRINT_ALIGNED &&
2315-
cont->opt->format != PRINT_WRAPPED) ||
2316-
cont->opt->expanded)
2317-
IsPagerNeeded(cont, 0, &fout, &is_pager);
2337+
/* print_aligned_*() handles the pager themselves */
2338+
if (cont->opt->format != PRINT_ALIGNED &&
2339+
cont->opt->format != PRINT_WRAPPED)
2340+
IsPagerNeeded(cont, 0, (cont->opt->expanded == 1), &fout, &is_pager);
23182341

23192342
/* print the stuff */
23202343

@@ -2324,32 +2347,32 @@ printTable(const printTableContent *cont, FILE *fout, FILE *flog)
23242347
switch (cont->opt->format)
23252348
{
23262349
case PRINT_UNALIGNED:
2327-
if (cont->opt->expanded)
2350+
if (cont->opt->expanded == 1)
23282351
print_unaligned_vertical(cont, fout);
23292352
else
23302353
print_unaligned_text(cont, fout);
23312354
break;
23322355
case PRINT_ALIGNED:
23332356
case PRINT_WRAPPED:
2334-
if (cont->opt->expanded)
2357+
if (cont->opt->expanded == 1)
23352358
print_aligned_vertical(cont, fout);
23362359
else
23372360
print_aligned_text(cont, fout);
23382361
break;
23392362
case PRINT_HTML:
2340-
if (cont->opt->expanded)
2363+
if (cont->opt->expanded == 1)
23412364
print_html_vertical(cont, fout);
23422365
else
23432366
print_html_text(cont, fout);
23442367
break;
23452368
case PRINT_LATEX:
2346-
if (cont->opt->expanded)
2369+
if (cont->opt->expanded == 1)
23472370
print_latex_vertical(cont, fout);
23482371
else
23492372
print_latex_text(cont, fout);
23502373
break;
23512374
case PRINT_TROFF_MS:
2352-
if (cont->opt->expanded)
2375+
if (cont->opt->expanded == 1)
23532376
print_troff_ms_vertical(cont, fout);
23542377
else
23552378
print_troff_ms_text(cont, fout);

‎src/bin/psql/print.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,8 @@ typedef struct printTextFormat
7070
typedef struct printTableOpt
7171
{
7272
enum printFormat format; /* see enum above */
73-
bool expanded; /* expanded/vertical output (if supported by
74-
* output format) */
73+
unsigned short int expanded;/* expanded/vertical output (if supported by
74+
* output format); 0=no, 1=yes, 2=auto */
7575
unsigned short int border; /* Print a border around the table. 0=none,
7676
* 1=dividing lines, 2=full */
7777
unsigned short int pager; /* use pager for output (if to stdout and

0 commit comments

Comments
 (0)