18002d411SSowmini Varadhan /*
28002d411SSowmini Varadhan * CDDL HEADER START
38002d411SSowmini Varadhan *
48002d411SSowmini Varadhan * The contents of this file are subject to the terms of the
58002d411SSowmini Varadhan * Common Development and Distribution License (the "License").
68002d411SSowmini Varadhan * You may not use this file except in compliance with the License.
78002d411SSowmini Varadhan *
88002d411SSowmini Varadhan * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
98002d411SSowmini Varadhan * or http://www.opensolaris.org/os/licensing.
108002d411SSowmini Varadhan * See the License for the specific language governing permissions
118002d411SSowmini Varadhan * and limitations under the License.
128002d411SSowmini Varadhan *
138002d411SSowmini Varadhan * When distributing Covered Code, include this CDDL HEADER in each
148002d411SSowmini Varadhan * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
158002d411SSowmini Varadhan * If applicable, add the following below this CDDL HEADER, with the
168002d411SSowmini Varadhan * fields enclosed by brackets "[]" replaced with your own identifying
178002d411SSowmini Varadhan * information: Portions Copyright [yyyy] [name of copyright owner]
188002d411SSowmini Varadhan *
198002d411SSowmini Varadhan * CDDL HEADER END
208002d411SSowmini Varadhan */
218002d411SSowmini Varadhan
228002d411SSowmini Varadhan /*
230dc2366fSVenugopal Iyer * Copyright 2010 Sun Microsystems, Inc. All rights reserved.
248002d411SSowmini Varadhan * Use is subject to license terms.
258002d411SSowmini Varadhan */
26b2f26520SBryan Cantrill
27b2f26520SBryan Cantrill /*
28519cca71SSebastien Roy * Copyright (c) 2015 by Delphix. All rights reserved.
29b2f26520SBryan Cantrill * Copyright 2017 Joyent, Inc.
30b2f26520SBryan Cantrill */
31b2f26520SBryan Cantrill
328002d411SSowmini Varadhan #include <errno.h>
338002d411SSowmini Varadhan #include <sys/types.h>
348002d411SSowmini Varadhan #include <stdlib.h>
358002d411SSowmini Varadhan #include <string.h>
368002d411SSowmini Varadhan #include <strings.h>
378002d411SSowmini Varadhan #include <stdio.h>
388002d411SSowmini Varadhan #include <ofmt.h>
398002d411SSowmini Varadhan #include <sys/termios.h>
408002d411SSowmini Varadhan #include <unistd.h>
418002d411SSowmini Varadhan #include <sys/sysmacros.h>
428002d411SSowmini Varadhan #include <libintl.h>
43b2f26520SBryan Cantrill #include <assert.h>
448002d411SSowmini Varadhan
458002d411SSowmini Varadhan /*
468002d411SSowmini Varadhan * functions and structures to internally process a comma-separated string
478002d411SSowmini Varadhan * of fields selected for output.
488002d411SSowmini Varadhan */
498002d411SSowmini Varadhan typedef struct {
508002d411SSowmini Varadhan char *s_buf;
518002d411SSowmini Varadhan const char **s_fields; /* array of pointers to the fields in s_buf */
528002d411SSowmini Varadhan uint_t s_nfields; /* the number of fields in s_buf */
5325ec3e3dSEric Cheng uint_t s_currfield; /* the current field being processed */
548002d411SSowmini Varadhan } split_t;
55b2f26520SBryan Cantrill
568002d411SSowmini Varadhan static void splitfree(split_t *);
57519cca71SSebastien Roy static split_t *split_str(const char *, uint_t);
58519cca71SSebastien Roy static split_t *split_fields(const ofmt_field_t *, uint_t, uint_t);
598002d411SSowmini Varadhan
608002d411SSowmini Varadhan /*
618002d411SSowmini Varadhan * The state of the output is tracked in a ofmt_state_t structure.
628002d411SSowmini Varadhan * Each os_fields[i] entry points at an ofmt_field_t array for
638002d411SSowmini Varadhan * the sub-command whose contents are provided by the caller, with
648002d411SSowmini Varadhan * os_nfields set to the number of requested fields.
658002d411SSowmini Varadhan */
668002d411SSowmini Varadhan typedef struct ofmt_state_s {
67519cca71SSebastien Roy ofmt_field_t *os_fields;
688002d411SSowmini Varadhan uint_t os_nfields;
698002d411SSowmini Varadhan boolean_t os_lastfield;
708002d411SSowmini Varadhan uint_t os_overflow;
718002d411SSowmini Varadhan struct winsize os_winsize;
728002d411SSowmini Varadhan int os_nrow;
730dc2366fSVenugopal Iyer uint_t os_flags;
74*6fc1cd8dSToomas Soome uint_t os_nbad;
758002d411SSowmini Varadhan char **os_badfields;
76dbed73cbSSangeeta Misra int os_maxnamelen; /* longest name (f. multiline) */
77519cca71SSebastien Roy char os_fs; /* field seperator */
788002d411SSowmini Varadhan } ofmt_state_t;
798002d411SSowmini Varadhan /*
808002d411SSowmini Varadhan * A B_TRUE return value from the callback function will print out the contents
818002d411SSowmini Varadhan * of the output buffer, except when the buffer is returned with the empty
828002d411SSowmini Varadhan * string "", in which case the OFMT_VAL_UNDEF will be printed.
838002d411SSowmini Varadhan *
848002d411SSowmini Varadhan * If the callback function returns B_FALSE, the "?" string will be emitted.
858002d411SSowmini Varadhan */
868002d411SSowmini Varadhan #define OFMT_VAL_UNDEF "--"
878002d411SSowmini Varadhan #define OFMT_VAL_UNKNOWN "?"
8825ec3e3dSEric Cheng
89519cca71SSebastien Roy #define OFMT_DEFAULT_FS ':'
90519cca71SSebastien Roy
9125ec3e3dSEric Cheng /*
9225ec3e3dSEric Cheng * The maximum number of rows supported by the OFMT_WRAP option.
9325ec3e3dSEric Cheng */
9425ec3e3dSEric Cheng #define OFMT_MAX_ROWS 128
9525ec3e3dSEric Cheng
968002d411SSowmini Varadhan static void ofmt_print_field(ofmt_state_t *, ofmt_field_t *, const char *,
978002d411SSowmini Varadhan boolean_t);
988002d411SSowmini Varadhan
998002d411SSowmini Varadhan /*
1008002d411SSowmini Varadhan * Split `str' into at most `maxfields' fields, Return a pointer to a
1018002d411SSowmini Varadhan * split_t containing the split fields, or NULL on failure.
1028002d411SSowmini Varadhan */
1038002d411SSowmini Varadhan static split_t *
split_str(const char * str,uint_t maxfields)1048002d411SSowmini Varadhan split_str(const char *str, uint_t maxfields)
1058002d411SSowmini Varadhan {
1068002d411SSowmini Varadhan char *field, *token, *lasts = NULL;
1078002d411SSowmini Varadhan split_t *sp;
1088002d411SSowmini Varadhan
1098002d411SSowmini Varadhan if (*str == '\0' || maxfields == 0)
1108002d411SSowmini Varadhan return (NULL);
1118002d411SSowmini Varadhan
1128002d411SSowmini Varadhan sp = calloc(sizeof (split_t), 1);
1138002d411SSowmini Varadhan if (sp == NULL)
1148002d411SSowmini Varadhan return (NULL);
1158002d411SSowmini Varadhan
1168002d411SSowmini Varadhan sp->s_buf = strdup(str);
1178002d411SSowmini Varadhan sp->s_fields = malloc(sizeof (char *) * maxfields);
1188002d411SSowmini Varadhan if (sp->s_buf == NULL || sp->s_fields == NULL)
1198002d411SSowmini Varadhan goto fail;
1208002d411SSowmini Varadhan
1218002d411SSowmini Varadhan token = sp->s_buf;
1228002d411SSowmini Varadhan while ((field = strtok_r(token, ",", &lasts)) != NULL) {
1238002d411SSowmini Varadhan if (sp->s_nfields == maxfields)
1248002d411SSowmini Varadhan goto fail;
1258002d411SSowmini Varadhan token = NULL;
1268002d411SSowmini Varadhan sp->s_fields[sp->s_nfields++] = field;
1278002d411SSowmini Varadhan }
1288002d411SSowmini Varadhan return (sp);
1298002d411SSowmini Varadhan fail:
1308002d411SSowmini Varadhan splitfree(sp);
1318002d411SSowmini Varadhan return (NULL);
1328002d411SSowmini Varadhan }
1338002d411SSowmini Varadhan
1348002d411SSowmini Varadhan /*
135519cca71SSebastien Roy * Split `fields' into at most `maxfields' fields. Return a pointer to
136519cca71SSebastien Roy * a split_t containing the split fields, or NULL on failure. Invoked
137519cca71SSebastien Roy * when all fields are implicitly selected at handle creation by
138519cca71SSebastien Roy * passing in a NULL fields_str
1398002d411SSowmini Varadhan */
1408002d411SSowmini Varadhan static split_t *
split_fields(const ofmt_field_t * template,uint_t maxfields,uint_t maxcols)141519cca71SSebastien Roy split_fields(const ofmt_field_t *template, uint_t maxfields, uint_t maxcols)
1428002d411SSowmini Varadhan {
1438002d411SSowmini Varadhan split_t *sp;
144*6fc1cd8dSToomas Soome uint_t i, cols;
1458002d411SSowmini Varadhan
1468002d411SSowmini Varadhan sp = calloc(sizeof (split_t), 1);
1478002d411SSowmini Varadhan if (sp == NULL)
1488002d411SSowmini Varadhan return (NULL);
1498002d411SSowmini Varadhan
150519cca71SSebastien Roy sp->s_fields = malloc(sizeof (char *) * maxfields);
1518002d411SSowmini Varadhan if (sp->s_fields == NULL)
1528002d411SSowmini Varadhan goto fail;
1538002d411SSowmini Varadhan cols = 0;
154519cca71SSebastien Roy for (i = 0; i < maxfields; i++) {
1558002d411SSowmini Varadhan cols += template[i].of_width;
1568002d411SSowmini Varadhan /*
1578002d411SSowmini Varadhan * If all fields are implied without explicitly passing
1588002d411SSowmini Varadhan * in a fields_str, build a list of field names, stopping
1598002d411SSowmini Varadhan * when we run out of columns.
1608002d411SSowmini Varadhan */
1618002d411SSowmini Varadhan if (maxcols > 0 && cols > maxcols)
1628002d411SSowmini Varadhan break;
1638002d411SSowmini Varadhan sp->s_fields[sp->s_nfields++] = template[i].of_name;
1648002d411SSowmini Varadhan }
1658002d411SSowmini Varadhan return (sp);
1668002d411SSowmini Varadhan fail:
1678002d411SSowmini Varadhan splitfree(sp);
1688002d411SSowmini Varadhan return (NULL);
1698002d411SSowmini Varadhan }
1708002d411SSowmini Varadhan
1718002d411SSowmini Varadhan /*
1728002d411SSowmini Varadhan * Free the split_t structure pointed to by `sp'.
1738002d411SSowmini Varadhan */
1748002d411SSowmini Varadhan static void
splitfree(split_t * sp)1758002d411SSowmini Varadhan splitfree(split_t *sp)
1768002d411SSowmini Varadhan {
1778002d411SSowmini Varadhan if (sp == NULL)
1788002d411SSowmini Varadhan return;
1798002d411SSowmini Varadhan free(sp->s_buf);
1808002d411SSowmini Varadhan free(sp->s_fields);
1818002d411SSowmini Varadhan free(sp);
1828002d411SSowmini Varadhan }
1838002d411SSowmini Varadhan
1848002d411SSowmini Varadhan /*
1858002d411SSowmini Varadhan * Open a handle to be used for printing formatted output.
1868002d411SSowmini Varadhan */
1878002d411SSowmini Varadhan ofmt_status_t
ofmt_open(const char * str,const ofmt_field_t * template,uint_t flags,uint_t maxcols,ofmt_handle_t * ofmt)1882b24ab6bSSebastien Roy ofmt_open(const char *str, const ofmt_field_t *template, uint_t flags,
1898002d411SSowmini Varadhan uint_t maxcols, ofmt_handle_t *ofmt)
1908002d411SSowmini Varadhan {
1918002d411SSowmini Varadhan split_t *sp;
192519cca71SSebastien Roy uint_t i, j, of_index;
1932b24ab6bSSebastien Roy const ofmt_field_t *ofp;
1948002d411SSowmini Varadhan ofmt_field_t *of;
195e96f8419SYuri Pankov ofmt_state_t *os = NULL;
196519cca71SSebastien Roy uint_t nfields = 0;
197e96f8419SYuri Pankov ofmt_status_t error = OFMT_SUCCESS;
1980dc2366fSVenugopal Iyer boolean_t parsable = (flags & OFMT_PARSABLE);
1990dc2366fSVenugopal Iyer boolean_t wrap = (flags & OFMT_WRAP);
200dbed73cbSSangeeta Misra boolean_t multiline = (flags & OFMT_MULTILINE);
2018002d411SSowmini Varadhan
2028002d411SSowmini Varadhan *ofmt = NULL;
2038002d411SSowmini Varadhan if (parsable) {
204dbed73cbSSangeeta Misra if (multiline)
205dbed73cbSSangeeta Misra return (OFMT_EPARSEMULTI);
2068002d411SSowmini Varadhan /*
2078002d411SSowmini Varadhan * For parsable output mode, the caller always needs
2088002d411SSowmini Varadhan * to specify precisely which fields are to be selected,
2098002d411SSowmini Varadhan * since the set of fields may change over time.
2108002d411SSowmini Varadhan */
2118002d411SSowmini Varadhan if (str == NULL || str[0] == '\0')
2128002d411SSowmini Varadhan return (OFMT_EPARSENONE);
2137bbc5723SYuri Pankov if (strcasecmp(str, "all") == 0)
2148002d411SSowmini Varadhan return (OFMT_EPARSEALL);
21525ec3e3dSEric Cheng if (wrap)
21625ec3e3dSEric Cheng return (OFMT_EPARSEWRAP);
2178002d411SSowmini Varadhan }
2188002d411SSowmini Varadhan if (template == NULL)
2198002d411SSowmini Varadhan return (OFMT_ENOTEMPLATE);
220519cca71SSebastien Roy for (ofp = template; ofp->of_name != NULL; ofp++)
221519cca71SSebastien Roy nfields++;
2228002d411SSowmini Varadhan /*
2238002d411SSowmini Varadhan * split str into the columns selected, or construct the
2248002d411SSowmini Varadhan * full set of columns (equivalent to -o all).
2258002d411SSowmini Varadhan */
2267bbc5723SYuri Pankov if (str != NULL && strcasecmp(str, "all") != 0) {
2278002d411SSowmini Varadhan sp = split_str(str, nfields);
2288002d411SSowmini Varadhan } else {
2297bbc5723SYuri Pankov if (parsable || (str != NULL && strcasecmp(str, "all") == 0))
2308002d411SSowmini Varadhan maxcols = 0;
231519cca71SSebastien Roy sp = split_fields(template, nfields, maxcols);
2328002d411SSowmini Varadhan }
2338002d411SSowmini Varadhan if (sp == NULL)
2348002d411SSowmini Varadhan goto nomem;
2358002d411SSowmini Varadhan
2368002d411SSowmini Varadhan os = calloc(sizeof (ofmt_state_t) +
2378002d411SSowmini Varadhan sp->s_nfields * sizeof (ofmt_field_t), 1);
2388002d411SSowmini Varadhan if (os == NULL)
2398002d411SSowmini Varadhan goto nomem;
2408002d411SSowmini Varadhan *ofmt = os;
2418002d411SSowmini Varadhan os->os_fields = (ofmt_field_t *)&os[1];
2420dc2366fSVenugopal Iyer os->os_flags = flags;
243519cca71SSebastien Roy os->os_fs = OFMT_DEFAULT_FS;
24425ec3e3dSEric Cheng
2458002d411SSowmini Varadhan of = os->os_fields;
2468002d411SSowmini Varadhan of_index = 0;
2478002d411SSowmini Varadhan /*
2488002d411SSowmini Varadhan * sp->s_nfields is the number of fields requested in fields_str.
2498002d411SSowmini Varadhan * nfields is the number of fields in template.
2508002d411SSowmini Varadhan */
2518002d411SSowmini Varadhan for (i = 0; i < sp->s_nfields; i++) {
252519cca71SSebastien Roy for (j = 0; j < nfields; j++) {
253519cca71SSebastien Roy if (strcasecmp(sp->s_fields[i],
254519cca71SSebastien Roy template[j].of_name) == 0) {
2558002d411SSowmini Varadhan break;
256519cca71SSebastien Roy }
2578002d411SSowmini Varadhan }
258519cca71SSebastien Roy if (j == nfields) {
2598002d411SSowmini Varadhan int nbad = os->os_nbad++;
2608002d411SSowmini Varadhan
261e96f8419SYuri Pankov error = OFMT_EBADFIELDS;
2628002d411SSowmini Varadhan if (os->os_badfields == NULL) {
2638002d411SSowmini Varadhan os->os_badfields = malloc(sp->s_nfields *
2648002d411SSowmini Varadhan sizeof (char *));
2658002d411SSowmini Varadhan if (os->os_badfields == NULL)
2668002d411SSowmini Varadhan goto nomem;
2678002d411SSowmini Varadhan }
2688002d411SSowmini Varadhan os->os_badfields[nbad] = strdup(sp->s_fields[i]);
2698002d411SSowmini Varadhan if (os->os_badfields[nbad] == NULL)
2708002d411SSowmini Varadhan goto nomem;
2718002d411SSowmini Varadhan continue;
2728002d411SSowmini Varadhan }
273519cca71SSebastien Roy of[of_index].of_name = strdup(template[j].of_name);
2748002d411SSowmini Varadhan if (of[of_index].of_name == NULL)
2758002d411SSowmini Varadhan goto nomem;
276dbed73cbSSangeeta Misra if (multiline) {
277dbed73cbSSangeeta Misra int n = strlen(of[of_index].of_name);
278dbed73cbSSangeeta Misra
279dbed73cbSSangeeta Misra os->os_maxnamelen = MAX(n, os->os_maxnamelen);
280dbed73cbSSangeeta Misra }
281519cca71SSebastien Roy of[of_index].of_width = template[j].of_width;
282519cca71SSebastien Roy of[of_index].of_id = template[j].of_id;
283519cca71SSebastien Roy of[of_index].of_cb = template[j].of_cb;
2848002d411SSowmini Varadhan of_index++;
2858002d411SSowmini Varadhan }
2868002d411SSowmini Varadhan splitfree(sp);
2878002d411SSowmini Varadhan if (of_index == 0) /* all values in str are bogus */
2888002d411SSowmini Varadhan return (OFMT_ENOFIELDS);
2898002d411SSowmini Varadhan os->os_nfields = of_index; /* actual number of fields printed */
2908002d411SSowmini Varadhan ofmt_update_winsize(*ofmt);
291e96f8419SYuri Pankov return (error);
2928002d411SSowmini Varadhan nomem:
293e96f8419SYuri Pankov error = OFMT_ENOMEM;
2948002d411SSowmini Varadhan if (os != NULL)
2958002d411SSowmini Varadhan ofmt_close(os);
2968002d411SSowmini Varadhan *ofmt = NULL;
2978002d411SSowmini Varadhan splitfree(sp);
298e96f8419SYuri Pankov return (error);
2998002d411SSowmini Varadhan }
3008002d411SSowmini Varadhan
301519cca71SSebastien Roy void
ofmt_set_fs(ofmt_handle_t ofmt,char fs)302519cca71SSebastien Roy ofmt_set_fs(ofmt_handle_t ofmt, char fs)
303519cca71SSebastien Roy {
304519cca71SSebastien Roy ((ofmt_state_t *)ofmt)->os_fs = fs;
305519cca71SSebastien Roy }
306519cca71SSebastien Roy
3078002d411SSowmini Varadhan /*
3088002d411SSowmini Varadhan * free resources associated with the ofmt_handle_t
3098002d411SSowmini Varadhan */
3108002d411SSowmini Varadhan void
ofmt_close(ofmt_handle_t ofmt)3118002d411SSowmini Varadhan ofmt_close(ofmt_handle_t ofmt)
3128002d411SSowmini Varadhan {
3138002d411SSowmini Varadhan ofmt_state_t *os = ofmt;
314*6fc1cd8dSToomas Soome uint_t i;
3158002d411SSowmini Varadhan
3168002d411SSowmini Varadhan if (os == NULL)
3178002d411SSowmini Varadhan return;
3188002d411SSowmini Varadhan for (i = 0; i < os->os_nfields; i++)
3198002d411SSowmini Varadhan free(os->os_fields[i].of_name);
3208002d411SSowmini Varadhan for (i = 0; i < os->os_nbad; i++)
3218002d411SSowmini Varadhan free(os->os_badfields[i]);
3228002d411SSowmini Varadhan free(os->os_badfields);
3238002d411SSowmini Varadhan free(os);
3248002d411SSowmini Varadhan }
3258002d411SSowmini Varadhan
3268002d411SSowmini Varadhan /*
3278002d411SSowmini Varadhan * Print the value for the selected field by calling the callback-function
3288002d411SSowmini Varadhan * registered for the field.
3298002d411SSowmini Varadhan */
3308002d411SSowmini Varadhan static void
ofmt_print_field(ofmt_state_t * os,ofmt_field_t * ofp,const char * value,boolean_t escsep)3318002d411SSowmini Varadhan ofmt_print_field(ofmt_state_t *os, ofmt_field_t *ofp, const char *value,
3328002d411SSowmini Varadhan boolean_t escsep)
3338002d411SSowmini Varadhan {
3348002d411SSowmini Varadhan uint_t width = ofp->of_width;
3358002d411SSowmini Varadhan uint_t valwidth;
3368002d411SSowmini Varadhan uint_t compress;
3370dc2366fSVenugopal Iyer boolean_t parsable = (os->os_flags & OFMT_PARSABLE);
3380dc2366fSVenugopal Iyer boolean_t multiline = (os->os_flags & OFMT_MULTILINE);
3390dc2366fSVenugopal Iyer boolean_t rightjust = (os->os_flags & OFMT_RIGHTJUST);
3408002d411SSowmini Varadhan char c;
3418002d411SSowmini Varadhan
3428002d411SSowmini Varadhan /*
343519cca71SSebastien Roy * Parsable fields are separated by os_fs. os_fs and '\' are escaped
344519cca71SSebastien Roy * (prefixed by a) '\'.
3458002d411SSowmini Varadhan */
3460dc2366fSVenugopal Iyer if (parsable) {
3478002d411SSowmini Varadhan if (os->os_nfields == 1) {
3488002d411SSowmini Varadhan (void) printf("%s", value);
3498002d411SSowmini Varadhan return;
3508002d411SSowmini Varadhan }
3518002d411SSowmini Varadhan while ((c = *value++) != '\0') {
352519cca71SSebastien Roy if (escsep && ((c == os->os_fs || c == '\\')))
3538002d411SSowmini Varadhan (void) putchar('\\');
3548002d411SSowmini Varadhan (void) putchar(c);
3558002d411SSowmini Varadhan }
3568002d411SSowmini Varadhan if (!os->os_lastfield)
357519cca71SSebastien Roy (void) putchar(os->os_fs);
3580dc2366fSVenugopal Iyer } else if (multiline) {
359dbed73cbSSangeeta Misra if (value[0] == '\0')
360dbed73cbSSangeeta Misra value = OFMT_VAL_UNDEF;
361dbed73cbSSangeeta Misra (void) printf("%*.*s: %s", os->os_maxnamelen,
362dbed73cbSSangeeta Misra os->os_maxnamelen, ofp->of_name, value);
363dbed73cbSSangeeta Misra if (!os->os_lastfield)
364dbed73cbSSangeeta Misra (void) putchar('\n');
3658002d411SSowmini Varadhan } else {
3668002d411SSowmini Varadhan if (os->os_lastfield) {
3670dc2366fSVenugopal Iyer if (rightjust)
3680dc2366fSVenugopal Iyer (void) printf("%*s", width, value);
3690dc2366fSVenugopal Iyer else
3700dc2366fSVenugopal Iyer (void) printf("%s", value);
3718002d411SSowmini Varadhan os->os_overflow = 0;
3728002d411SSowmini Varadhan return;
3738002d411SSowmini Varadhan }
3748002d411SSowmini Varadhan
3758002d411SSowmini Varadhan valwidth = strlen(value);
3768002d411SSowmini Varadhan if (valwidth + os->os_overflow >= width) {
3778002d411SSowmini Varadhan os->os_overflow += valwidth - width + 1;
3780dc2366fSVenugopal Iyer if (rightjust)
3790dc2366fSVenugopal Iyer (void) printf("%*s ", width, value);
3800dc2366fSVenugopal Iyer else
3810dc2366fSVenugopal Iyer (void) printf("%s ", value);
3828002d411SSowmini Varadhan return;
3838002d411SSowmini Varadhan }
3848002d411SSowmini Varadhan
3858002d411SSowmini Varadhan if (os->os_overflow > 0) {
3868002d411SSowmini Varadhan compress = MIN(os->os_overflow, width - valwidth);
3878002d411SSowmini Varadhan os->os_overflow -= compress;
3888002d411SSowmini Varadhan width -= compress;
3898002d411SSowmini Varadhan }
3900dc2366fSVenugopal Iyer if (rightjust)
3910dc2366fSVenugopal Iyer (void) printf("%*s ", width, value);
3920dc2366fSVenugopal Iyer else
3930dc2366fSVenugopal Iyer (void) printf("%-*s", width, value);
3948002d411SSowmini Varadhan }
3958002d411SSowmini Varadhan }
3968002d411SSowmini Varadhan
3978002d411SSowmini Varadhan /*
39825ec3e3dSEric Cheng * Print enough to fit the field width.
39925ec3e3dSEric Cheng */
40025ec3e3dSEric Cheng static void
ofmt_fit_width(split_t ** spp,uint_t width,char * value,uint_t bufsize)40125ec3e3dSEric Cheng ofmt_fit_width(split_t **spp, uint_t width, char *value, uint_t bufsize)
40225ec3e3dSEric Cheng {
40325ec3e3dSEric Cheng split_t *sp = *spp;
40425ec3e3dSEric Cheng char *ptr = value, *lim = ptr + bufsize;
405*6fc1cd8dSToomas Soome uint_t i, nextlen;
40625ec3e3dSEric Cheng
40725ec3e3dSEric Cheng if (sp == NULL) {
40825ec3e3dSEric Cheng sp = split_str(value, OFMT_MAX_ROWS);
40925ec3e3dSEric Cheng if (sp == NULL)
41025ec3e3dSEric Cheng return;
41125ec3e3dSEric Cheng
41225ec3e3dSEric Cheng *spp = sp;
41325ec3e3dSEric Cheng }
41425ec3e3dSEric Cheng for (i = sp->s_currfield; i < sp->s_nfields; i++) {
41525ec3e3dSEric Cheng ptr += snprintf(ptr, lim - ptr, "%s,", sp->s_fields[i]);
41625ec3e3dSEric Cheng if (i + 1 == sp->s_nfields) {
41725ec3e3dSEric Cheng nextlen = 0;
41825ec3e3dSEric Cheng if (ptr > value)
41925ec3e3dSEric Cheng ptr[-1] = '\0';
42025ec3e3dSEric Cheng } else {
42125ec3e3dSEric Cheng nextlen = strlen(sp->s_fields[i + 1]);
42225ec3e3dSEric Cheng }
42325ec3e3dSEric Cheng
42425ec3e3dSEric Cheng if (strlen(value) + nextlen > width || ptr >= lim) {
42525ec3e3dSEric Cheng i++;
42625ec3e3dSEric Cheng break;
42725ec3e3dSEric Cheng }
42825ec3e3dSEric Cheng }
42925ec3e3dSEric Cheng sp->s_currfield = i;
43025ec3e3dSEric Cheng }
43125ec3e3dSEric Cheng
43225ec3e3dSEric Cheng /*
43325ec3e3dSEric Cheng * Print one or more rows of output values for the selected columns.
4348002d411SSowmini Varadhan */
4358002d411SSowmini Varadhan void
ofmt_print(ofmt_handle_t ofmt,void * arg)4368002d411SSowmini Varadhan ofmt_print(ofmt_handle_t ofmt, void *arg)
4378002d411SSowmini Varadhan {
4388002d411SSowmini Varadhan ofmt_state_t *os = ofmt;
439*6fc1cd8dSToomas Soome uint_t i;
4408002d411SSowmini Varadhan char value[1024];
4418002d411SSowmini Varadhan ofmt_field_t *of;
44225ec3e3dSEric Cheng boolean_t escsep, more_rows;
4438002d411SSowmini Varadhan ofmt_arg_t ofarg;
44425ec3e3dSEric Cheng split_t **sp = NULL;
4450dc2366fSVenugopal Iyer boolean_t parsable = (os->os_flags & OFMT_PARSABLE);
4460dc2366fSVenugopal Iyer boolean_t multiline = (os->os_flags & OFMT_MULTILINE);
4470dc2366fSVenugopal Iyer boolean_t wrap = (os->os_flags & OFMT_WRAP);
44825ec3e3dSEric Cheng
4490dc2366fSVenugopal Iyer if (wrap) {
45025ec3e3dSEric Cheng sp = calloc(sizeof (split_t *), os->os_nfields);
45125ec3e3dSEric Cheng if (sp == NULL)
45225ec3e3dSEric Cheng return;
45325ec3e3dSEric Cheng }
4548002d411SSowmini Varadhan
4550dc2366fSVenugopal Iyer if ((os->os_nrow++ % os->os_winsize.ws_row) == 0 &&
4560dc2366fSVenugopal Iyer !parsable && !multiline) {
457519cca71SSebastien Roy if (!(os->os_flags & OFMT_NOHEADER))
458519cca71SSebastien Roy ofmt_print_header(os);
4598002d411SSowmini Varadhan os->os_nrow++;
4608002d411SSowmini Varadhan }
4618002d411SSowmini Varadhan
4620dc2366fSVenugopal Iyer if (multiline && os->os_nrow > 1)
463dbed73cbSSangeeta Misra (void) putchar('\n');
464dbed73cbSSangeeta Misra
4658002d411SSowmini Varadhan of = os->os_fields;
4668002d411SSowmini Varadhan escsep = (os->os_nfields > 1);
46725ec3e3dSEric Cheng more_rows = B_FALSE;
4688002d411SSowmini Varadhan for (i = 0; i < os->os_nfields; i++) {
4698002d411SSowmini Varadhan os->os_lastfield = (i + 1 == os->os_nfields);
4708002d411SSowmini Varadhan value[0] = '\0';
4718002d411SSowmini Varadhan ofarg.ofmt_id = of[i].of_id;
4728002d411SSowmini Varadhan ofarg.ofmt_cbarg = arg;
47325ec3e3dSEric Cheng
47425ec3e3dSEric Cheng if ((*of[i].of_cb)(&ofarg, value, sizeof (value))) {
4750dc2366fSVenugopal Iyer if (wrap) {
47625ec3e3dSEric Cheng /*
47725ec3e3dSEric Cheng * 'value' will be split at comma boundaries
47825ec3e3dSEric Cheng * and stored into sp[i].
47925ec3e3dSEric Cheng */
48025ec3e3dSEric Cheng ofmt_fit_width(&sp[i], of[i].of_width, value,
48125ec3e3dSEric Cheng sizeof (value));
48225ec3e3dSEric Cheng if (sp[i] != NULL &&
48325ec3e3dSEric Cheng sp[i]->s_currfield < sp[i]->s_nfields)
48425ec3e3dSEric Cheng more_rows = B_TRUE;
48525ec3e3dSEric Cheng }
4860dc2366fSVenugopal Iyer
48725ec3e3dSEric Cheng ofmt_print_field(os, &of[i],
4880dc2366fSVenugopal Iyer (*value == '\0' && !parsable) ?
48925ec3e3dSEric Cheng OFMT_VAL_UNDEF : value, escsep);
49025ec3e3dSEric Cheng } else {
4918002d411SSowmini Varadhan ofmt_print_field(os, &of[i], OFMT_VAL_UNKNOWN, escsep);
49225ec3e3dSEric Cheng }
4938002d411SSowmini Varadhan }
4948002d411SSowmini Varadhan (void) putchar('\n');
49525ec3e3dSEric Cheng
49625ec3e3dSEric Cheng while (more_rows) {
49725ec3e3dSEric Cheng more_rows = B_FALSE;
49825ec3e3dSEric Cheng for (i = 0; i < os->os_nfields; i++) {
49925ec3e3dSEric Cheng os->os_lastfield = (i + 1 == os->os_nfields);
50025ec3e3dSEric Cheng value[0] = '\0';
50125ec3e3dSEric Cheng
50225ec3e3dSEric Cheng ofmt_fit_width(&sp[i], of[i].of_width,
50325ec3e3dSEric Cheng value, sizeof (value));
50425ec3e3dSEric Cheng if (sp[i] != NULL &&
50525ec3e3dSEric Cheng sp[i]->s_currfield < sp[i]->s_nfields)
50625ec3e3dSEric Cheng more_rows = B_TRUE;
50725ec3e3dSEric Cheng
50825ec3e3dSEric Cheng ofmt_print_field(os, &of[i], value, escsep);
50925ec3e3dSEric Cheng }
51025ec3e3dSEric Cheng (void) putchar('\n');
51125ec3e3dSEric Cheng }
5128002d411SSowmini Varadhan (void) fflush(stdout);
51325ec3e3dSEric Cheng
51425ec3e3dSEric Cheng if (sp != NULL) {
51525ec3e3dSEric Cheng for (i = 0; i < os->os_nfields; i++)
51625ec3e3dSEric Cheng splitfree(sp[i]);
51725ec3e3dSEric Cheng free(sp);
51825ec3e3dSEric Cheng }
5198002d411SSowmini Varadhan }
5208002d411SSowmini Varadhan
5218002d411SSowmini Varadhan /*
5228002d411SSowmini Varadhan * Print the field headers
5238002d411SSowmini Varadhan */
524519cca71SSebastien Roy void
ofmt_print_header(ofmt_handle_t ofmt)525519cca71SSebastien Roy ofmt_print_header(ofmt_handle_t ofmt)
5268002d411SSowmini Varadhan {
527519cca71SSebastien Roy ofmt_state_t *os = ofmt;
528*6fc1cd8dSToomas Soome uint_t i;
5298002d411SSowmini Varadhan ofmt_field_t *of = os->os_fields;
5308002d411SSowmini Varadhan boolean_t escsep = (os->os_nfields > 1);
5318002d411SSowmini Varadhan
5328002d411SSowmini Varadhan for (i = 0; i < os->os_nfields; i++) {
5338002d411SSowmini Varadhan os->os_lastfield = (i + 1 == os->os_nfields);
5348002d411SSowmini Varadhan ofmt_print_field(os, &of[i], of[i].of_name, escsep);
5358002d411SSowmini Varadhan }
5368002d411SSowmini Varadhan (void) putchar('\n');
5378002d411SSowmini Varadhan }
5388002d411SSowmini Varadhan
5398002d411SSowmini Varadhan /*
5408002d411SSowmini Varadhan * Update the current window size.
5418002d411SSowmini Varadhan */
5428002d411SSowmini Varadhan void
ofmt_update_winsize(ofmt_handle_t ofmt)5438002d411SSowmini Varadhan ofmt_update_winsize(ofmt_handle_t ofmt)
5448002d411SSowmini Varadhan {
5458002d411SSowmini Varadhan ofmt_state_t *os = ofmt;
5468002d411SSowmini Varadhan struct winsize *winsize = &os->os_winsize;
5478002d411SSowmini Varadhan
5488002d411SSowmini Varadhan if (ioctl(1, TIOCGWINSZ, winsize) == -1 ||
5498002d411SSowmini Varadhan winsize->ws_col == 0 || winsize->ws_row == 0) {
5508002d411SSowmini Varadhan winsize->ws_col = 80;
5518002d411SSowmini Varadhan winsize->ws_row = 24;
5528002d411SSowmini Varadhan }
5538002d411SSowmini Varadhan }
5548002d411SSowmini Varadhan
5558002d411SSowmini Varadhan /*
5568002d411SSowmini Varadhan * Return error diagnostics using the information in the ofmt_handle_t
5578002d411SSowmini Varadhan */
5588002d411SSowmini Varadhan char *
ofmt_strerror(ofmt_handle_t ofmt,ofmt_status_t error,char * buf,uint_t bufsize)559e96f8419SYuri Pankov ofmt_strerror(ofmt_handle_t ofmt, ofmt_status_t error, char *buf,
560e96f8419SYuri Pankov uint_t bufsize)
5618002d411SSowmini Varadhan {
5628002d411SSowmini Varadhan ofmt_state_t *os = ofmt;
563*6fc1cd8dSToomas Soome uint_t i;
5648002d411SSowmini Varadhan const char *s;
5658002d411SSowmini Varadhan char ebuf[OFMT_BUFSIZE];
5660dc2366fSVenugopal Iyer boolean_t parsable;
5678002d411SSowmini Varadhan
5688002d411SSowmini Varadhan /*
5698002d411SSowmini Varadhan * ebuf is intended for optional error-specific data to be appended
5708002d411SSowmini Varadhan * after the internationalized error string for an error code.
5718002d411SSowmini Varadhan */
5728002d411SSowmini Varadhan ebuf[0] = '\0';
5738002d411SSowmini Varadhan
574e96f8419SYuri Pankov switch (error) {
5758002d411SSowmini Varadhan case OFMT_SUCCESS:
5768002d411SSowmini Varadhan s = "success";
5778002d411SSowmini Varadhan break;
5788002d411SSowmini Varadhan case OFMT_EBADFIELDS:
5798002d411SSowmini Varadhan /*
5808002d411SSowmini Varadhan * Enumerate the singular/plural version of the warning
5818002d411SSowmini Varadhan * and error to simplify and improve localization.
5828002d411SSowmini Varadhan */
5830dc2366fSVenugopal Iyer parsable = (os->os_flags & OFMT_PARSABLE);
5840dc2366fSVenugopal Iyer if (!parsable) {
5858002d411SSowmini Varadhan if (os->os_nbad > 1)
5868002d411SSowmini Varadhan s = "ignoring unknown output fields:";
5878002d411SSowmini Varadhan else
5888002d411SSowmini Varadhan s = "ignoring unknown output field:";
5898002d411SSowmini Varadhan } else {
5908002d411SSowmini Varadhan if (os->os_nbad > 1)
5918002d411SSowmini Varadhan s = "unknown output fields:";
5928002d411SSowmini Varadhan else
5938002d411SSowmini Varadhan s = "unknown output field:";
5948002d411SSowmini Varadhan }
5958002d411SSowmini Varadhan /* set up the bad fields in ebuf */
5968002d411SSowmini Varadhan for (i = 0; i < os->os_nbad; i++) {
5978002d411SSowmini Varadhan (void) strlcat(ebuf, " `", sizeof (ebuf));
5988002d411SSowmini Varadhan (void) strlcat(ebuf, os->os_badfields[i],
5998002d411SSowmini Varadhan sizeof (ebuf));
6008002d411SSowmini Varadhan (void) strlcat(ebuf, "'", sizeof (ebuf));
6018002d411SSowmini Varadhan }
6028002d411SSowmini Varadhan break;
6038002d411SSowmini Varadhan case OFMT_ENOFIELDS:
6048002d411SSowmini Varadhan s = "no valid output fields";
6058002d411SSowmini Varadhan break;
606dbed73cbSSangeeta Misra case OFMT_EPARSEMULTI:
607dbed73cbSSangeeta Misra s = "multiline mode incompatible with parsable mode";
608dbed73cbSSangeeta Misra break;
6098002d411SSowmini Varadhan case OFMT_EPARSEALL:
6108002d411SSowmini Varadhan s = "output field `all' invalid in parsable mode";
6118002d411SSowmini Varadhan break;
6128002d411SSowmini Varadhan case OFMT_EPARSENONE:
6138002d411SSowmini Varadhan s = "output fields must be specified in parsable mode";
6148002d411SSowmini Varadhan break;
61525ec3e3dSEric Cheng case OFMT_EPARSEWRAP:
61625ec3e3dSEric Cheng s = "parsable mode is incompatible with wrap mode";
61725ec3e3dSEric Cheng break;
6188002d411SSowmini Varadhan case OFMT_ENOTEMPLATE:
6198002d411SSowmini Varadhan s = "no template provided for fields";
6208002d411SSowmini Varadhan break;
6218002d411SSowmini Varadhan case OFMT_ENOMEM:
6228002d411SSowmini Varadhan s = strerror(ENOMEM);
6238002d411SSowmini Varadhan break;
6248002d411SSowmini Varadhan default:
6258002d411SSowmini Varadhan (void) snprintf(buf, bufsize,
6268002d411SSowmini Varadhan dgettext(TEXT_DOMAIN, "unknown ofmt error (%d)"),
627e96f8419SYuri Pankov error);
6288002d411SSowmini Varadhan return (buf);
6298002d411SSowmini Varadhan }
6308002d411SSowmini Varadhan (void) snprintf(buf, bufsize, dgettext(TEXT_DOMAIN, s));
6318002d411SSowmini Varadhan (void) strlcat(buf, ebuf, bufsize);
6328002d411SSowmini Varadhan return (buf);
6338002d411SSowmini Varadhan }
634b2f26520SBryan Cantrill
635b2f26520SBryan Cantrill void
ofmt_check(ofmt_status_t oferr,boolean_t parsable,ofmt_handle_t ofmt,void (* die)(const char *,...),void (* warn)(const char *,...))636b2f26520SBryan Cantrill ofmt_check(ofmt_status_t oferr, boolean_t parsable, ofmt_handle_t ofmt,
637b2f26520SBryan Cantrill void (*die)(const char *, ...), void (*warn)(const char *, ...))
638b2f26520SBryan Cantrill {
639b2f26520SBryan Cantrill char buf[OFMT_BUFSIZE];
640b2f26520SBryan Cantrill
641b2f26520SBryan Cantrill assert(die != NULL);
642b2f26520SBryan Cantrill assert(warn != NULL);
643b2f26520SBryan Cantrill
644b2f26520SBryan Cantrill if (oferr == OFMT_SUCCESS)
645b2f26520SBryan Cantrill return;
646b2f26520SBryan Cantrill
647b2f26520SBryan Cantrill (void) ofmt_strerror(ofmt, oferr, buf, sizeof (buf));
648b2f26520SBryan Cantrill
649b2f26520SBryan Cantrill /*
650b2f26520SBryan Cantrill * All errors are considered fatal in parsable mode. OFMT_ENOMEM and
651519cca71SSebastien Roy * OFMT_ENOFIELDS errors are always fatal, regardless of mode. For
652b2f26520SBryan Cantrill * other errors, we print diagnostics in human-readable mode and
653b2f26520SBryan Cantrill * processs what we can.
654b2f26520SBryan Cantrill */
655b2f26520SBryan Cantrill if (parsable || oferr == OFMT_ENOFIELDS || oferr == OFMT_ENOMEM) {
656b2f26520SBryan Cantrill ofmt_close(ofmt);
657b2f26520SBryan Cantrill die(buf);
658b2f26520SBryan Cantrill } else {
659b2f26520SBryan Cantrill warn(buf);
660b2f26520SBryan Cantrill }
661b2f26520SBryan Cantrill }
662