Merge remote-tracking branch 'origin/vendor/LIBEDIT'
[dragonfly.git] / contrib / libedit / src / el.c
1 /*      $NetBSD: el.c,v 1.92 2016/05/22 19:44:26 christos Exp $ */
2
3 /*-
4  * Copyright (c) 1992, 1993
5  *      The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * Christos Zoulas of Cornell University.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  */
34
35 #include "config.h"
36 #if !defined(lint) && !defined(SCCSID)
37 #if 0
38 static char sccsid[] = "@(#)el.c        8.2 (Berkeley) 1/3/94";
39 #else
40 __RCSID("$NetBSD: el.c,v 1.92 2016/05/22 19:44:26 christos Exp $");
41 #endif
42 #endif /* not lint && not SCCSID */
43
44 /*
45  * el.c: EditLine interface functions
46  */
47 #include <sys/types.h>
48 #include <sys/param.h>
49 #include <ctype.h>
50 #include <langinfo.h>
51 #include <locale.h>
52 #include <stdarg.h>
53 #include <stdlib.h>
54 #include <string.h>
55
56 #include "el.h"
57 #include "parse.h"
58 #include "read.h"
59
60 #ifndef HAVE_SECURE_GETENV
61 #       ifdef HAVE___SECURE_GETENV
62 #               define secure_getenv __secure_getenv
63 #               define HAVE_SECURE_GETENV 1
64 #       else
65 #               ifdef HAVE_ISSETUGID
66 #                       include <unistd.h>
67 #               else
68 #                       undef issetugid
69 #                       define issetugid() 1
70 #               endif
71 #       endif
72 #endif
73
74 #ifndef HAVE_SECURE_GETENV
75 char *secure_getenv(char const *name)
76 {
77         if (issetugid())
78                 return 0;
79         return getenv(name);
80 }
81 #endif
82
83 /* el_init():
84  *      Initialize editline and set default parameters.
85  */
86 EditLine *
87 el_init(const char *prog, FILE *fin, FILE *fout, FILE *ferr)
88 {
89     return el_init_fd(prog, fin, fout, ferr, fileno(fin), fileno(fout),
90         fileno(ferr));
91 }
92
93 EditLine *
94 el_init_fd(const char *prog, FILE *fin, FILE *fout, FILE *ferr,
95     int fdin, int fdout, int fderr)
96 {
97         EditLine *el = el_malloc(sizeof(*el));
98
99         if (el == NULL)
100                 return NULL;
101
102         memset(el, 0, sizeof(EditLine));
103
104         el->el_infile = fin;
105         el->el_outfile = fout;
106         el->el_errfile = ferr;
107
108         el->el_infd = fdin;
109         el->el_outfd = fdout;
110         el->el_errfd = fderr;
111
112         el->el_prog = wcsdup(ct_decode_string(prog, &el->el_scratch));
113         if (el->el_prog == NULL) {
114                 el_free(el);
115                 return NULL;
116         }
117
118         /*
119          * Initialize all the modules. Order is important!!!
120          */
121         el->el_flags = 0;
122         if (setlocale(LC_CTYPE, NULL) != NULL){
123                 if (strcmp(nl_langinfo(CODESET), "UTF-8") == 0)
124                         el->el_flags |= CHARSET_IS_UTF8;
125         }
126
127         if (terminal_init(el) == -1) {
128                 el_free(el->el_prog);
129                 el_free(el);
130                 return NULL;
131         }
132         (void) keymacro_init(el);
133         (void) map_init(el);
134         if (tty_init(el) == -1)
135                 el->el_flags |= NO_TTY;
136         (void) ch_init(el);
137         (void) search_init(el);
138         (void) hist_init(el);
139         (void) prompt_init(el);
140         (void) sig_init(el);
141         if (read_init(el) == -1) {
142                 el_end(el);
143                 return NULL;
144         }
145         return el;
146 }
147
148
149 /* el_end():
150  *      Clean up.
151  */
152 void
153 el_end(EditLine *el)
154 {
155
156         if (el == NULL)
157                 return;
158
159         el_reset(el);
160
161         terminal_end(el);
162         keymacro_end(el);
163         map_end(el);
164         if (!(el->el_flags & NO_TTY))
165                 tty_end(el);
166         ch_end(el);
167         read_end(el->el_read);
168         search_end(el);
169         hist_end(el);
170         prompt_end(el);
171         sig_end(el);
172
173         el_free(el->el_prog);
174         el_free(el->el_visual.cbuff);
175         el_free(el->el_visual.wbuff);
176         el_free(el->el_scratch.cbuff);
177         el_free(el->el_scratch.wbuff);
178         el_free(el->el_lgcyconv.cbuff);
179         el_free(el->el_lgcyconv.wbuff);
180         el_free(el);
181 }
182
183
184 /* el_reset():
185  *      Reset the tty and the parser
186  */
187 void
188 el_reset(EditLine *el)
189 {
190
191         tty_cookedmode(el);
192         ch_reset(el);           /* XXX: Do we want that? */
193 }
194
195
196 /* el_set():
197  *      set the editline parameters
198  */
199 int
200 el_wset(EditLine *el, int op, ...)
201 {
202         va_list ap;
203         int rv = 0;
204
205         if (el == NULL)
206                 return -1;
207         va_start(ap, op);
208
209         switch (op) {
210         case EL_PROMPT:
211         case EL_RPROMPT: {
212                 el_pfunc_t p = va_arg(ap, el_pfunc_t);
213
214                 rv = prompt_set(el, p, 0, op, 1);
215                 break;
216         }
217
218         case EL_RESIZE: {
219                 el_zfunc_t p = va_arg(ap, el_zfunc_t);
220                 void *arg = va_arg(ap, void *);
221                 rv = ch_resizefun(el, p, arg);
222                 break;
223         }
224
225         case EL_ALIAS_TEXT: {
226                 el_afunc_t p = va_arg(ap, el_afunc_t);
227                 void *arg = va_arg(ap, void *);
228                 rv = ch_aliasfun(el, p, arg);
229                 break;
230         }
231
232         case EL_PROMPT_ESC:
233         case EL_RPROMPT_ESC: {
234                 el_pfunc_t p = va_arg(ap, el_pfunc_t);
235                 int c = va_arg(ap, int);
236
237                 rv = prompt_set(el, p, (wchar_t)c, op, 1);
238                 break;
239         }
240
241         case EL_TERMINAL:
242                 rv = terminal_set(el, va_arg(ap, char *));
243                 break;
244
245         case EL_EDITOR:
246                 rv = map_set_editor(el, va_arg(ap, wchar_t *));
247                 break;
248
249         case EL_SIGNAL:
250                 if (va_arg(ap, int))
251                         el->el_flags |= HANDLE_SIGNALS;
252                 else
253                         el->el_flags &= ~HANDLE_SIGNALS;
254                 break;
255
256         case EL_BIND:
257         case EL_TELLTC:
258         case EL_SETTC:
259         case EL_ECHOTC:
260         case EL_SETTY:
261         {
262                 const wchar_t *argv[20];
263                 int i;
264
265                 for (i = 1; i < (int)__arraycount(argv); i++)
266                         if ((argv[i] = va_arg(ap, wchar_t *)) == NULL)
267                                 break;
268
269                 switch (op) {
270                 case EL_BIND:
271                         argv[0] = L"bind";
272                         rv = map_bind(el, i, argv);
273                         break;
274
275                 case EL_TELLTC:
276                         argv[0] = L"telltc";
277                         rv = terminal_telltc(el, i, argv);
278                         break;
279
280                 case EL_SETTC:
281                         argv[0] = L"settc";
282                         rv = terminal_settc(el, i, argv);
283                         break;
284
285                 case EL_ECHOTC:
286                         argv[0] = L"echotc";
287                         rv = terminal_echotc(el, i, argv);
288                         break;
289
290                 case EL_SETTY:
291                         argv[0] = L"setty";
292                         rv = tty_stty(el, i, argv);
293                         break;
294
295                 default:
296                         rv = -1;
297                         EL_ABORT((el->el_errfile, "Bad op %d\n", op));
298                         break;
299                 }
300                 break;
301         }
302
303         case EL_ADDFN:
304         {
305                 wchar_t *name = va_arg(ap, wchar_t *);
306                 wchar_t *help = va_arg(ap, wchar_t *);
307                 el_func_t func = va_arg(ap, el_func_t);
308
309                 rv = map_addfunc(el, name, help, func);
310                 break;
311         }
312
313         case EL_HIST:
314         {
315                 hist_fun_t func = va_arg(ap, hist_fun_t);
316                 void *ptr = va_arg(ap, void *);
317
318                 rv = hist_set(el, func, ptr);
319                 if (!(el->el_flags & CHARSET_IS_UTF8))
320                         el->el_flags &= ~NARROW_HISTORY;
321                 break;
322         }
323
324         case EL_EDITMODE:
325                 if (va_arg(ap, int))
326                         el->el_flags &= ~EDIT_DISABLED;
327                 else
328                         el->el_flags |= EDIT_DISABLED;
329                 rv = 0;
330                 break;
331
332         case EL_GETCFN:
333         {
334                 el_rfunc_t rc = va_arg(ap, el_rfunc_t);
335                 rv = el_read_setfn(el->el_read, rc);
336                 break;
337         }
338
339         case EL_CLIENTDATA:
340                 el->el_data = va_arg(ap, void *);
341                 break;
342
343         case EL_UNBUFFERED:
344                 rv = va_arg(ap, int);
345                 if (rv && !(el->el_flags & UNBUFFERED)) {
346                         el->el_flags |= UNBUFFERED;
347                         read_prepare(el);
348                 } else if (!rv && (el->el_flags & UNBUFFERED)) {
349                         el->el_flags &= ~UNBUFFERED;
350                         read_finish(el);
351                 }
352                 rv = 0;
353                 break;
354
355         case EL_PREP_TERM:
356                 rv = va_arg(ap, int);
357                 if (rv)
358                         (void) tty_rawmode(el);
359                 else
360                         (void) tty_cookedmode(el);
361                 rv = 0;
362                 break;
363
364         case EL_SETFP:
365         {
366                 FILE *fp;
367                 int what;
368
369                 what = va_arg(ap, int);
370                 fp = va_arg(ap, FILE *);
371
372                 rv = 0;
373                 switch (what) {
374                 case 0:
375                         el->el_infile = fp;
376                         el->el_infd = fileno(fp);
377                         break;
378                 case 1:
379                         el->el_outfile = fp;
380                         el->el_outfd = fileno(fp);
381                         break;
382                 case 2:
383                         el->el_errfile = fp;
384                         el->el_errfd = fileno(fp);
385                         break;
386                 default:
387                         rv = -1;
388                         break;
389                 }
390                 break;
391         }
392
393         case EL_REFRESH:
394                 re_clear_display(el);
395                 re_refresh(el);
396                 terminal__flush(el);
397                 break;
398
399         default:
400                 rv = -1;
401                 break;
402         }
403
404         va_end(ap);
405         return rv;
406 }
407
408
409 /* el_get():
410  *      retrieve the editline parameters
411  */
412 int
413 el_wget(EditLine *el, int op, ...)
414 {
415         va_list ap;
416         int rv;
417
418         if (el == NULL)
419                 return -1;
420
421         va_start(ap, op);
422
423         switch (op) {
424         case EL_PROMPT:
425         case EL_RPROMPT: {
426                 el_pfunc_t *p = va_arg(ap, el_pfunc_t *);
427                 rv = prompt_get(el, p, 0, op);
428                 break;
429         }
430         case EL_PROMPT_ESC:
431         case EL_RPROMPT_ESC: {
432                 el_pfunc_t *p = va_arg(ap, el_pfunc_t *);
433                 wchar_t *c = va_arg(ap, wchar_t *);
434
435                 rv = prompt_get(el, p, c, op);
436                 break;
437         }
438
439         case EL_EDITOR:
440                 rv = map_get_editor(el, va_arg(ap, const wchar_t **));
441                 break;
442
443         case EL_SIGNAL:
444                 *va_arg(ap, int *) = (el->el_flags & HANDLE_SIGNALS);
445                 rv = 0;
446                 break;
447
448         case EL_EDITMODE:
449                 *va_arg(ap, int *) = !(el->el_flags & EDIT_DISABLED);
450                 rv = 0;
451                 break;
452
453         case EL_TERMINAL:
454                 terminal_get(el, va_arg(ap, const char **));
455                 rv = 0;
456                 break;
457
458         case EL_GETTC:
459         {
460                 static char name[] = "gettc";
461                 char *argv[20];
462                 int i;
463
464                 for (i = 1; i < (int)__arraycount(argv); i++)
465                         if ((argv[i] = va_arg(ap, char *)) == NULL)
466                                 break;
467
468                 argv[0] = name;
469                 rv = terminal_gettc(el, i, argv);
470                 break;
471         }
472
473         case EL_GETCFN:
474                 *va_arg(ap, el_rfunc_t *) = el_read_getfn(el->el_read);
475                 rv = 0;
476                 break;
477
478         case EL_CLIENTDATA:
479                 *va_arg(ap, void **) = el->el_data;
480                 rv = 0;
481                 break;
482
483         case EL_UNBUFFERED:
484                 *va_arg(ap, int *) = (el->el_flags & UNBUFFERED) != 0;
485                 rv = 0;
486                 break;
487
488         case EL_GETFP:
489         {
490                 int what;
491                 FILE **fpp;
492
493                 what = va_arg(ap, int);
494                 fpp = va_arg(ap, FILE **);
495                 rv = 0;
496                 switch (what) {
497                 case 0:
498                         *fpp = el->el_infile;
499                         break;
500                 case 1:
501                         *fpp = el->el_outfile;
502                         break;
503                 case 2:
504                         *fpp = el->el_errfile;
505                         break;
506                 default:
507                         rv = -1;
508                         break;
509                 }
510                 break;
511         }
512         default:
513                 rv = -1;
514                 break;
515         }
516         va_end(ap);
517
518         return rv;
519 }
520
521
522 /* el_line():
523  *      Return editing info
524  */
525 const LineInfoW *
526 el_wline(EditLine *el)
527 {
528
529         return (const LineInfoW *)(void *)&el->el_line;
530 }
531
532
533 /* el_source():
534  *      Source a file
535  */
536 int
537 el_source(EditLine *el, const char *fname)
538 {
539         FILE *fp;
540         size_t len;
541         ssize_t slen;
542         char *ptr;
543         char *path = NULL;
544         const wchar_t *dptr;
545         int error = 0;
546
547         fp = NULL;
548         if (fname == NULL) {
549                 static const char elpath[] = "/.editrc";
550                 size_t plen = sizeof(elpath);
551
552                 if ((ptr = secure_getenv("HOME")) == NULL)
553                         return -1;
554                 plen += strlen(ptr);
555                 if ((path = el_malloc(plen * sizeof(*path))) == NULL)
556                         return -1;
557                 (void)snprintf(path, plen, "%s%s", ptr, elpath);
558                 fname = path;
559         }
560         if (fp == NULL)
561                 fp = fopen(fname, "r");
562         if (fp == NULL) {
563                 el_free(path);
564                 return -1;
565         }
566
567         ptr = NULL;
568         len = 0;
569         while ((slen = getline(&ptr, &len, fp)) != -1) {
570                 if (*ptr == '\n')
571                         continue;       /* Empty line. */
572                 if (slen > 0 && ptr[--slen] == '\n')
573                         ptr[slen] = '\0';
574
575                 dptr = ct_decode_string(ptr, &el->el_scratch);
576                 if (!dptr)
577                         continue;
578                 /* loop until first non-space char or EOL */
579                 while (*dptr != '\0' && iswspace(*dptr))
580                         dptr++;
581                 if (*dptr == '#')
582                         continue;   /* ignore, this is a comment line */
583                 if ((error = parse_line(el, dptr)) == -1)
584                         break;
585         }
586         free(ptr);
587
588         el_free(path);
589         (void) fclose(fp);
590         return error;
591 }
592
593
594 /* el_resize():
595  *      Called from program when terminal is resized
596  */
597 void
598 el_resize(EditLine *el)
599 {
600         int lins, cols;
601         sigset_t oset, nset;
602
603         (void) sigemptyset(&nset);
604         (void) sigaddset(&nset, SIGWINCH);
605         (void) sigprocmask(SIG_BLOCK, &nset, &oset);
606
607         /* get the correct window size */
608         if (terminal_get_size(el, &lins, &cols))
609                 terminal_change_size(el, lins, cols);
610
611         (void) sigprocmask(SIG_SETMASK, &oset, NULL);
612 }
613
614
615 /* el_beep():
616  *      Called from the program to beep
617  */
618 void
619 el_beep(EditLine *el)
620 {
621
622         terminal_beep(el);
623 }
624
625
626 /* el_editmode()
627  *      Set the state of EDIT_DISABLED from the `edit' command.
628  */
629 libedit_private int
630 /*ARGSUSED*/
631 el_editmode(EditLine *el, int argc, const wchar_t **argv)
632 {
633         const wchar_t *how;
634
635         if (argv == NULL || argc != 2 || argv[1] == NULL)
636                 return -1;
637
638         how = argv[1];
639         if (wcscmp(how, L"on") == 0) {
640                 el->el_flags &= ~EDIT_DISABLED;
641                 tty_rawmode(el);
642         } else if (wcscmp(how, L"off") == 0) {
643                 tty_cookedmode(el);
644                 el->el_flags |= EDIT_DISABLED;
645         }
646         else {
647                 (void) fprintf(el->el_errfile, "edit: Bad value `%ls'.\n",
648                     how);
649                 return -1;
650         }
651         return 0;
652 }