1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
|
/* Licensed under GPLv2+ - see LICENSE file for details */
#include <ccan/opt/opt.h>
#if HAVE_SYS_TERMIOS_H
#include <sys/ioctl.h>
#include <sys/termios.h> /* Required on Solaris for struct winsize */
#endif
#include <sys/unistd.h> /* Required on Solaris for ioctl */
#include <string.h>
#include <stdlib.h>
#include <stdio.h>
#include <stdint.h>
#include <stdarg.h>
#include "private.h"
/* We only use this for pointer comparisons. */
const char opt_hidden[1];
#define MIN_DESC_WIDTH 40
#define MIN_TOTAL_WIDTH 50
static unsigned int get_columns(void)
{
int ws_col = 0;
const char *env = getenv("COLUMNS");
if (env)
ws_col = atoi(env);
#ifdef TIOCGWINSZ
if (!ws_col)
{
struct winsize w;
if (ioctl(0, TIOCGWINSZ, &w) != -1)
ws_col = w.ws_col;
}
#endif
if (!ws_col)
ws_col = 80;
return ws_col;
}
/* Return number of chars of words to put on this line.
* Prefix is set to number to skip at start, maxlen is max width, returns
* length (after prefix) to put on this line.
* start is set if we start a new line in the source description. */
static size_t consume_words(const char *words, size_t maxlen, size_t *prefix,
bool *start)
{
size_t oldlen, len;
/* Always swollow leading whitespace. */
*prefix = strspn(words, " \n");
words += *prefix;
/* Leading whitespace at start of line means literal. */
if (*start && *prefix) {
oldlen = strcspn(words, "\n");
} else {
/* Use at least one word, even if it takes us over maxlen. */
oldlen = len = strcspn(words, " ");
while (len <= maxlen) {
oldlen = len;
len += strspn(words+len, " ");
if (words[len] == '\n')
break;
len += strcspn(words+len, " \n");
if (len == oldlen)
break;
}
}
*start = (words[oldlen - 1] == '\n');
return oldlen;
}
static char *add_str_len(char *base, size_t *len, size_t *max,
const char *str, size_t slen)
{
if (slen >= *max - *len)
base = opt_alloc.realloc(base, *max = (*max * 2 + slen + 1));
memcpy(base + *len, str, slen);
*len += slen;
return base;
}
static char *add_str(char *base, size_t *len, size_t *max, const char *str)
{
return add_str_len(base, len, max, str, strlen(str));
}
static char *add_indent(char *base, size_t *len, size_t *max, size_t indent)
{
if (indent >= *max - *len)
base = opt_alloc.realloc(base, *max = (*max * 2 + indent + 1));
memset(base + *len, ' ', indent);
*len += indent;
return base;
}
static char *add_desc(char *base, size_t *len, size_t *max,
unsigned int indent, unsigned int width,
const struct opt_table *opt)
{
size_t off, prefix, l;
const char *p;
bool same_line = false, start = true;
base = add_str(base, len, max, opt->names);
off = strlen(opt->names);
if (opt->type == OPT_HASARG
&& !strchr(opt->names, ' ')
&& !strchr(opt->names, '=')) {
base = add_str(base, len, max, " <arg>");
off += strlen(" <arg>");
}
/* Do we start description on next line? */
if (off + 2 > indent) {
base = add_str(base, len, max, "\n");
off = 0;
} else {
base = add_indent(base, len, max, indent - off);
off = indent;
same_line = true;
}
/* Indent description. */
p = opt->desc;
while ((l = consume_words(p, width - indent, &prefix, &start)) != 0) {
if (!same_line)
base = add_indent(base, len, max, indent);
p += prefix;
base = add_str_len(base, len, max, p, l);
base = add_str(base, len, max, "\n");
off = indent + l;
p += l;
same_line = false;
}
/* Empty description? Make it match normal case. */
if (same_line)
base = add_str(base, len, max, "\n");
if (opt->show) {
char buf[OPT_SHOW_LEN + sizeof("...")];
strcpy(buf + OPT_SHOW_LEN, "...");
opt->show(buf, opt->u.arg);
/* If it doesn't fit on this line, indent. */
if (off + strlen(" (default: ") + strlen(buf) + strlen(")")
> width) {
base = add_indent(base, len, max, indent);
} else {
/* Remove \n. */
(*len)--;
}
base = add_str(base, len, max, " (default: ");
base = add_str(base, len, max, buf);
base = add_str(base, len, max, ")\n");
}
return base;
}
char *opt_usage(const char *argv0, const char *extra)
{
unsigned int i;
size_t max, len, width, indent;
char *ret;
width = get_columns();
if (width < MIN_TOTAL_WIDTH)
width = MIN_TOTAL_WIDTH;
/* Figure out longest option. */
indent = 0;
for (i = 0; i < opt_count; i++) {
size_t l;
if (opt_table[i].desc == opt_hidden)
continue;
if (opt_table[i].type == OPT_SUBTABLE)
continue;
l = strlen(opt_table[i].names);
if (opt_table[i].type == OPT_HASARG
&& !strchr(opt_table[i].names, ' ')
&& !strchr(opt_table[i].names, '='))
l += strlen(" <arg>");
if (l + 2 > indent)
indent = l + 2;
}
/* Now we know how much to indent */
if (indent + MIN_DESC_WIDTH > width)
indent = width - MIN_DESC_WIDTH;
len = max = 0;
ret = NULL;
ret = add_str(ret, &len, &max, "Usage: ");
ret = add_str(ret, &len, &max, argv0);
/* Find usage message from among registered options if necessary. */
if (!extra) {
extra = "";
for (i = 0; i < opt_count; i++) {
if (opt_table[i].cb == (void *)opt_usage_and_exit
&& opt_table[i].u.carg) {
extra = opt_table[i].u.carg;
break;
}
}
}
ret = add_str(ret, &len, &max, " ");
ret = add_str(ret, &len, &max, extra);
ret = add_str(ret, &len, &max, "\n");
for (i = 0; i < opt_count; i++) {
if (opt_table[i].desc == opt_hidden)
continue;
if (opt_table[i].type == OPT_SUBTABLE) {
ret = add_str(ret, &len, &max, opt_table[i].desc);
ret = add_str(ret, &len, &max, ":\n");
continue;
}
ret = add_desc(ret, &len, &max, indent, width, &opt_table[i]);
}
ret[len] = '\0';
return ret;
}
void opt_usage_exit_fail(const char *msg, ...)
{
va_list ap;
if (opt_argv0)
fprintf(stderr, "%s: ", opt_argv0);
va_start(ap, msg);
vfprintf(stderr, msg, ap);
va_end(ap);
fprintf(stderr, "\n%s",
opt_usage(opt_argv0 ? opt_argv0 : "<program>", NULL));
exit(1);
}
|