forked from clicon/cligen
-
Notifications
You must be signed in to change notification settings - Fork 0
/
cligen_io.c
464 lines (427 loc) · 11.6 KB
/
cligen_io.c
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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
/*
CLI generator input/output support functions.
***** BEGIN LICENSE BLOCK *****
Copyright (C) 2001-2021 Olof Hagsand
This file is part of CLIgen.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Alternatively, the contents of this file may be used under the terms of
the GNU General Public License Version 2 or later (the "GPL"),
in which case the provisions of the GPL are applicable instead
of those above. If you wish to allow use of your version of this file only
under the terms of the GPL, and not to allow others to
use your version of this file under the terms of Apache License version 2, indicate
your decision by deleting the provisions above and replace them with the
notice and other provisions required by the GPL. If you do not delete
the provisions above, a recipient may use your version of this file under
the terms of any one of the Apache License version 2 or the GPL.
* ***** END LICENSE BLOCK *****
*/
#include "cligen_config.h"
#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <sys/types.h>
#include <string.h>
#ifndef WIN32
#include <unistd.h>
#endif
#include <errno.h>
#include <signal.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <net/if.h>
#include "cligen_buf.h"
#include "cligen_cv.h"
#include "cligen_cvec.h"
#include "cligen_parsetree.h"
#include "cligen_pt_head.h"
#include "cligen_object.h"
#include "cligen_handle.h"
#include "cligen_read.h"
#include "cligen_print.h"
#include "cligen_io.h"
#include "cligen_getline.h"
/*
* Constants
*/
/* When doing query (?) how large left margin before first command.
* For example, the space before foo
* @code
* > set ?
* foo <--- number of spaces left of "foo"
* @endcode
*
*/
#define CLIGEN_HELP_LEFT_MARGIN 3
/*
* Local variables
*/
static int D_LINES=0; /* XXX: global */
/*! Reset cligen_output to initial state
* For new output or when 'q' is pressed that sets d_line to -1
*/
int
cli_output_reset(void)
{
D_LINES = 0;
return 0;
}
int
cli_output_status(void)
{
return D_LINES;
}
/*! CLIgen output function. All printf-style output should be made via this function.
*
* It deals with formatting, page breaks, etc.
* @param[in] f Open stdio FILE pointer
* @param[in] template... See man printf(3)
*
* @note: There has also been a discussion on the use of handles in this code (it relies on a
* global variable _terminalrows and D_LINES). However, the signature needs to be the same as
* fprintf in order to make compatible printing code.
*
* @note Related to the handle question is the use of the global variable D_LINES in order to
* handle multiple calls (such as in a loop) to cligen_output. However, this assumes D_LINES
* is reset before a new usage to D_LINES using the function cli_output_reset(). This therefore
* be done between invocations. Especially this applies to 'q'. Further, to react to quit, you need
* to poll cli_output_status() < 0.
*
* @note: There has been a debate whether this function is the right solution to the
* pageing problem of CLIgen or not.
* (1) On the one hand, a less/more like sub-process could be forked and stdout piped to this
* sub-process. This would handle all prints to stdout, instead of relying on all output
* functions using this function and not printf.
* (2) On the other hand, this gives a slim and simple solution with smaller footprint (no forked
* process), but all output functions need to pass though this code.
* For now (2) is used and extended also for clixon functions. However (1) could still be
* implemented as an option.
*/
int
cligen_output(FILE *f,
const char *template,
... )
{
int retval = -1;
va_list args;
char *buf = NULL;
char *start;
char *end;
char *bufend;
char c;
int term_rows;
int len;
term_rows = cligen_terminal_rows(NULL);
/* form a string in buf from all args */
va_start(args, template);
len = vsnprintf(NULL, 0, template, args);
va_end(args);
len++;
if ((buf = malloc(len)) == NULL){
fprintf(stderr, "%s: malloc: %s\n", __FUNCTION__, strerror(errno));
goto done;
}
va_start(args, template);
vsnprintf(buf, len, template, args);
va_end(args);
/* if writing to stdout, format output
*/
if ((term_rows) && (f == stdout)){
start = end = buf;
bufend = buf + strlen(buf);
while (end < bufend){
end = strstr(start, "\n");
if (end) /* got a NL */{
if (D_LINES >= 0)
D_LINES++;
*end = '\0';
if (D_LINES > -1)
fprintf(f, "%s\n", start);
if (end < bufend)
start = end+1;
if (D_LINES >= (term_rows -1)){
gl_char_init();
fprintf(f, "--More--");
c = fgetc(stdin);
if (c == '\n')
D_LINES--;
else if (c == ' ')
D_LINES = 0;
else if (c == 'q' || c == 3) /* ^c */
D_LINES = -1;
else if (c == '?')
fprintf(f, "Press CR for one more line, SPACE for next page, q to quit\n");
else
D_LINES = 0;
fprintf(f, " ");
gl_char_cleanup();
}
} /* NL */
else{
/* do only print if we have data */
if (D_LINES >=0 && *start != '\0')
fprintf(f, "%s", start);
end = start + strlen(start);
start = end;
}
}
}
else{
fprintf(f, "%s", buf);
}
fflush(f);
retval = 0;
done:
if (buf)
free(buf);
return retval;
}
#ifdef notyet
/*
* Yes/No question. Returns 1 for yes and 0 for no.
*/
int
cli_yesno(const char *fmt, ...)
{
va_list ap;
char buf[1024];
va_start(ap, fmt);
vsnprintf(buf, sizeof(buf)-1, fmt, ap);
va_end(ap);
printf("%s [yes/no]: ", buf);
if (cli_getln(buf, sizeof(buf)) == 0)
if (strlen(buf) && !strncasecmp(buf, "yes", strlen(buf)))
return 1;
return 0;
}
#endif
#if CLIGEN_REGFD
/* The following three callback functions are just wrappers in order to
not expose getline to external interface */
int
cligen_regfd(int fd, cligen_fd_cb_t *cb, void *arg)
{
return gl_regfd(fd, cb, arg);
}
int
cligen_unregfd(int fd)
{
return gl_unregfd(fd);
}
#endif /* CLIGEN_REGFD */
void
cligen_redraw(cligen_handle h)
{
gl_redraw(h);
}
/*! Register a suspend (^Z) function hook
*/
int
cligen_susp_hook(cligen_handle h,
cligen_susp_cb_t *fn)
{
gl_susp_hook = fn; /* XXX global */
return 0;
}
/*! Register an interrupt hook, called if read() interrupted with (some) SIG
*/
int
cligen_interrupt_hook(cligen_handle h,
cligen_interrupt_cb_t *fn)
{
gl_interrupt_hook = fn;
return 0;
}
/*! Register extra exit characters (in addition to ctrl-c)
*/
void
cligen_exitchar_add(cligen_handle h,
char c)
{
gl_exitchar_add(c); /* XXX global */
}
/*! Display multi help lines on query (?)
* Function handles multiple options on how to display help strings at query (?)
* This includes indentation, limit on lines, truncation, etc.
* @param[in] h Cligen handle
* @param[in] fout File to print to, eg stdout
* @param[in] column_width Space for first, command width
* @param[in] ch Help command and string struct
*/
static int
print_help_line(cligen_handle h,
FILE *fout,
int column_width,
struct cmd_help *ch)
{
int retval = -1;
cg_var *cv = NULL;
int w;
char *str;
char *str2;
int j;
int linesmax;
int termwidth;
int truncate;
/* First print command */
fprintf(fout, " %*s", -column_width, ch->ch_cmd);
/* Then print help */
if (ch->ch_helpvec && cvec_len(ch->ch_helpvec)){
linesmax = cligen_helpstring_lines(h);
truncate = cligen_helpstring_truncate(h);
termwidth = cligen_terminal_width(h);
j = 0;
while ((cv = cvec_each(ch->ch_helpvec, cv)) != NULL &&
(linesmax==0 || j<linesmax)){
w = termwidth - column_width - CLIGEN_HELP_LEFT_MARGIN;
str = cv_string_get(cv);
if (j > 0) /* skip first line */
fprintf(fout, " %*s", -column_width, "");
if (truncate == 0 ||
strlen(str) < w){
fprintf(fout, " %*s", -w, str);
}
else {
if ((str2 = strdup(str)) == NULL)
goto done;
str2[w] = '\0';
fprintf(fout, " %*s", -w, str2);
free(str2);
str2 = NULL;
}
fprintf(fout, "\n");
j++;
}
}
else
fprintf(fout, "\n");
retval = 0;
done:
return retval;
}
/*! Print help lines for subset of a parsetree vector
* @param[in] fout File to print to, eg stdout
* @param[in] ptvec Cligen parse-node vector
* @param[in] matchvec Array of indexes into ptvec to match (the subset)
* @param[in] matchlen Length of matchvec
*/
int
print_help_lines(cligen_handle h,
FILE *fout,
parse_tree *ptmatch,
int *matchvec,
size_t matchlen)
{
int retval = -1;
cg_obj *co;
char *cmd;
int i;
cbuf *cb = NULL;
struct cmd_help *chvec = NULL;
struct cmd_help *ch;
int maxlen = 0;
char *prev = NULL;
int nrcmd = 0;
int column_width;
int vi;
if ((cb = cbuf_new()) == NULL){
fprintf(stderr, "cbuf_new: %s\n", strerror(errno));
return -1;
}
/* Go through match vector and collect commands and helps */
if ((chvec = calloc(matchlen, sizeof(struct cmd_help))) ==NULL){
perror("calloc");
goto done;
}
for (i=0; i<matchlen; i++){
vi = matchvec[i]; /* index into array, extra indirection */
co = pt_vec_i_get(ptmatch, vi);
if (co->co_command == NULL)
continue;
cmd = NULL;
switch(co->co_type){
case CO_VARIABLE:
cbuf_reset(cb);
cov2cbuf(cb, co, 1);
if ((cmd = strdup(cbuf_get(cb))) == NULL){
perror("strdup");
goto done;
}
break;
case CO_COMMAND:
if ((cmd = strdup(co->co_command)) == NULL){
perror("strdup");
goto done;
}
break;
default:
continue;
break;
}
if (prev && strcmp(cmd, prev)==0)
continue;
ch = &chvec[nrcmd++];
ch->ch_cmd = cmd;
ch->ch_helpvec = co->co_helpvec;
prev = cmd;
/* Compute longest command */
maxlen = strlen(cmd)>maxlen?strlen(cmd):maxlen;
}
maxlen++;
column_width = maxlen<COLUMN_MIN_WIDTH?COLUMN_MIN_WIDTH:maxlen;
/* Actually print */
for (i = 0; i<nrcmd; i++){
ch = &chvec[i];
if (print_help_line(h, fout, column_width, ch) < 0)
goto done;
}
fflush(fout);
retval = 0;
done:
if (chvec){
for (i=0; i<nrcmd; i++){
if (chvec[i].ch_cmd)
free(chvec[i].ch_cmd);
}
free(chvec);
}
if (cb)
cbuf_free(cb);
return retval;
}
/*! Print top-level help (all commands) of a parse-tree
* @param[in] fout File to print to, eg stdout
* @param[in] pt Cligen parse-tree
*/
int
cligen_help(cligen_handle h,
FILE *fout,
parse_tree *pt)
{
int retval = -1;
int i;
int *matchvec = NULL;
/* intermediate struct to fit into print_help_lines() parameters */
if ((matchvec = calloc(pt_len_get(pt), sizeof(int))) == NULL){
perror("calloc");
goto done;
}
for (i=0; i<pt_len_get(pt); i++)
matchvec[i] = i;
if (print_help_lines(h, fout, pt, matchvec, pt_len_get(pt)) < 0)
goto done;
retval = 0;
done:
if (matchvec)
free(matchvec);
return retval;
}