1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
2 *@ Command input, lexing and evaluation, resource file loading and `source'ing.
3 *@ TODO PS_ROBOT requires yet PS_SOURCING, which REALLY sucks.
4 *@ TODO Commands and ghosts deserve a hashmap. Or so.
6 * Copyright (c) 2000-2004 Gunnar Ritter, Freiburg i. Br., Germany.
7 * Copyright (c) 2012 - 2016 Steffen (Daode) Nurpmeso <steffen@sdaoden.eu>.
10 * Copyright (c) 1980, 1993
11 * The Regents of the University of California. All rights reserved.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 * 3. Neither the name of the University nor the names of its contributors
22 * may be used to endorse or promote products derived from this software
23 * without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 #define n_FILE lex_input
40 #ifndef HAVE_AMALGAMATION
44 enum a_lex_input_flags
{
46 a_LEX_FREE
= 1<<0, /* Structure was allocated, free() it */
47 a_LEX_PIPE
= 1<<1, /* Open on a pipe */
48 a_LEX_MACRO
= 1<<2, /* Running a macro */
49 a_LEX_MACRO_FREE_DATA
= 1<<3, /* Lines are allocated, free(3) once done */
50 a_LEX_MACRO_X_OPTION
= 1<<4, /* Macro indeed command line -X option */
51 a_LEX_MACRO_CMD
= 1<<5, /* Macro indeed single-line: ~:COMMAND */
53 a_LEX_SUPER_MACRO
= 1<<16 /* *Not* inheriting PS_SOURCING state */
57 char const *lc_name
; /* Name of command */
58 int (*lc_func
)(void*); /* Implementor of command */
59 enum argtype lc_argtype
; /* Arglist type (see below) */
60 si16_t lc_msgflag
; /* Required flags of msgs */
61 si16_t lc_msgmask
; /* Relevant flags of msgs */
62 #ifdef HAVE_DOCSTRINGS
63 char const *lc_doc
; /* One line doc for command */
66 /* Yechh, can't initialize unions */
67 #define lc_minargs lc_msgflag /* Minimum argcount for RAWLIST */
68 #define lc_maxargs lc_msgmask /* Max argcount for RAWLIST */
71 struct a_lex_ghost
*lg_next
;
72 struct str lg_cmd
; /* Data follows after .lg_name */
73 char lg_name
[VFIELD_SIZE(0)];
76 struct a_lex_eval_ctx
{
77 struct str le_line
; /* The terminated data to _evaluate() */
78 ui32_t le_line_size
; /* May be used to store line memory size */
79 bool_t le_is_recursive
; /* Evaluation in evaluation? (collect ~:) */
81 bool_t le_add_history
; /* Enter (final) command in history? */
82 char const *le_new_content
; /* History: reenter line, start with this */
85 struct a_lex_input_stack
{
86 struct a_lex_input_stack
*li_outer
;
87 FILE *li_file
; /* File we were in */
88 void *li_cond
; /* Saved state of conditional stack */
89 ui32_t li_flags
; /* enum a_lex_input_flags */
90 ui32_t li_loff
; /* Pseudo (macro): index in .li_lines */
91 char **li_lines
; /* Pseudo content, lines unfolded */
92 char li_name
[VFIELD_SIZE(0)]; /* Name of file or macro */
95 static sighandler_type a_lex_oldpipe
;
96 static struct a_lex_ghost
*a_lex_ghosts
;
97 /* a_lex_cmd_tab[] after fun protos */
100 static struct a_lex_input_stack
*a_lex_input
;
102 /* Isolate the command from the arguments */
103 static char *a_lex_isolate(char const *comm
);
105 /* Command ghost handling */
106 static int a_lex_c_ghost(void *v
);
107 static int a_lex_c_unghost(void *v
);
109 /* Print a list of all commands */
110 static int a_lex_c_list(void *v
);
112 static int a_lex__pcmd_cmp(void const *s1
, void const *s2
);
115 static int a_lex_c_quit(void *v
);
117 /* Print the binaries version number */
118 static int a_lex_c_version(void *v
);
120 static int a_lex__version_cmp(void const *s1
, void const *s2
);
122 /* PS_STATE_PENDMASK requires some actions */
123 static void a_lex_update_pstate(void);
125 /* Evaluate a single command.
126 * .le_add_history and .le_new_content will be updated upon success.
127 * Command functions return 0 for success, 1 for error, and -1 for abort.
128 * 1 or -1 aborts a load or source, a -1 aborts the interactive command loop */
129 static int a_lex_evaluate(struct a_lex_eval_ctx
*evp
);
131 /* Get first-fit, or NULL */
132 static struct a_lex_cmd
const *a_lex__firstfit(char const *comm
);
134 /* Branch here on hangup signal and simulate "exit" */
135 static void a_lex_hangup(int s
);
137 /* The following gets called on receipt of an interrupt. Close all open files
138 * except 0, 1, 2, and the temporary. Also, unstack all source files */
139 static void a_lex_onintr(int s
);
141 /* Pop the current input back to the previous level. Update the program state.
142 * If the argument is TRUM1 then we don't alert and error out if the stack
143 * doesn't exist at all */
144 static void a_lex_unstack(bool_t eval_error
);
146 /* `source' and `source_if' (if silent_error: no pipes allowed, then) */
147 static bool_t
a_lex_source_file(char const *file
, bool_t silent_error
);
149 /* System resource file load()ing or -X command line option array traversal */
150 static bool_t
a_lex_load(struct a_lex_input_stack
*lip
);
152 /* A simplified command loop for recursed state machines */
153 static bool_t
a_commands_recursive(enum n_lexinput_flags lif
);
155 /* List of all commands, and list of commands which are specially treated
156 * and deduced in _evaluate(), but we need a list for _c_list() and
157 * print_comm_docstr() */
158 #ifdef HAVE_DOCSTRINGS
163 static struct a_lex_cmd
const a_lex_cmd_tab
[] = {
166 a_lex_special_cmd_tab
[] = {
168 DS(N_("Comment command: ignore remaining (continuable) line")) },
170 DS(N_("Print out the preceding message")) }
175 a_lex_isolate(char const *comm
){
177 while(*comm
!= '\0' &&
178 strchr("~|? \t0123456789&%@$^.:/-+*'\",;(`", *comm
) == NULL
)
181 return UNCONST(comm
);
185 a_lex_c_ghost(void *v
){
186 struct a_lex_ghost
*lgp
, *gp
;
198 if((fp
= Ftmp(NULL
, "ghost", OF_RDWR
| OF_UNLINK
| OF_REGISTER
)) == NULL
)
201 for(i
= 0, gp
= a_lex_ghosts
; gp
!= NULL
; gp
= gp
->lg_next
)
202 fprintf(fp
, "wysh ghost %s %s\n",
203 gp
->lg_name
, n_shell_quote_cp(gp
->lg_cmd
.s
, TRU1
));
206 page_or_print(fp
, i
);
212 /* Verify the ghost name is a valid one */
213 if(*argv
[0] == '\0' || *a_lex_isolate(argv
[0]) != '\0'){
214 n_err(_("`ghost': can't canonicalize %s\n"),
215 n_shell_quote_cp(argv
[0], FAL0
));
220 /* Show command of single ghost? */
222 for(gp
= a_lex_ghosts
; gp
!= NULL
; gp
= gp
->lg_next
)
223 if(!strcmp(argv
[0], gp
->lg_name
)){
224 printf("wysh ghost %s %s\n",
225 gp
->lg_name
, n_shell_quote_cp(gp
->lg_cmd
.s
, TRU1
));
228 n_err(_("`ghost': no such alias: %s\n"), argv
[0]);
233 /* Define command for ghost: verify command content */
234 for(cl
= 0, i
= 1; (cp
= UNCONST(argv
[i
])) != NULL
; ++i
)
236 cl
+= strlen(cp
) +1; /* SP or NUL */
238 n_err(_("`ghost': empty command arguments after %s\n"), argv
[0]);
243 /* If the ghost already exists, recreate */
244 for(lgp
= NULL
, gp
= a_lex_ghosts
; gp
!= NULL
; lgp
= gp
, gp
= gp
->lg_next
)
245 if(!strcmp(gp
->lg_name
, argv
[0])){
247 lgp
->lg_next
= gp
->lg_next
;
249 a_lex_ghosts
= gp
->lg_next
;
254 nl
= strlen(argv
[0]) +1;
255 gp
= smalloc(sizeof(*gp
) - VFIELD_SIZEOF(struct a_lex_ghost
, lg_name
) +
257 gp
->lg_next
= a_lex_ghosts
;
259 memcpy(gp
->lg_name
, argv
[0], nl
);
260 cp
= gp
->lg_cmd
.s
= gp
->lg_name
+ nl
;
263 while(*++argv
!= NULL
)
264 if((i
= strlen(*argv
)) > 0){
265 memcpy(cp
, *argv
, i
);
276 a_lex_c_unghost(void *v
){
277 struct a_lex_ghost
*lgp
, *gp
;
278 char const **argv
, *cp
;
285 while((cp
= *argv
++) != NULL
){
286 if(cp
[0] == '*' && cp
[1] == '\0'){
287 while((gp
= a_lex_ghosts
) != NULL
){
288 a_lex_ghosts
= gp
->lg_next
;
292 for(lgp
= NULL
, gp
= a_lex_ghosts
; gp
!= NULL
;
293 lgp
= gp
, gp
= gp
->lg_next
)
294 if(!strcmp(gp
->lg_name
, cp
)){
296 lgp
->lg_next
= gp
->lg_next
;
298 a_lex_ghosts
= gp
->lg_next
;
302 n_err(_("`unghost': no such alias: %s\n"),
303 n_shell_quote_cp(cp
, FAL0
));
313 a_lex_c_list(void *v
){
315 struct a_lex_cmd
const **cpa
, *cp
, **cursor
;
319 i
= NELEM(a_lex_cmd_tab
) + NELEM(a_lex_special_cmd_tab
) +1;
320 cpa
= salloc(sizeof(cp
) * i
);
322 for(i
= 0; i
< NELEM(a_lex_cmd_tab
); ++i
)
323 cpa
[i
] = &a_lex_cmd_tab
[i
];
327 for(j
= 0; j
< NELEM(a_lex_special_cmd_tab
); ++i
, ++j
)
328 cpa
[i
] = &a_lex_special_cmd_tab
[j
];
336 qsort(cpa
, i
, sizeof(xcp
), &a_lex__pcmd_cmp
);
339 if((fp
= Ftmp(NULL
, "list", OF_RDWR
| OF_UNLINK
| OF_REGISTER
)) == NULL
)
342 fprintf(fp
, _("Commands are:\n"));
344 for(i
= 0, cursor
= cpa
; (cp
= *cursor
++) != NULL
;){
345 if(cp
->lc_func
== &c_cmdnotsupp
)
347 if(options
& OPT_D_V
){
350 switch(cp
->lc_argtype
& ARG_ARGMASK
){
351 case ARG_MSGLIST
: argt
= N_("message-list"); break;
352 case ARG_STRLIST
: argt
= N_("a \"string\""); break;
353 case ARG_RAWLIST
: argt
= N_("old-style quoting"); break;
354 case ARG_NOLIST
: argt
= N_("no arguments"); break;
355 case ARG_NDMLIST
: argt
= N_("message-list (without a default)"); break;
356 case ARG_WYSHLIST
: argt
= N_("sh(1)ell-style quoting"); break;
357 default: argt
= N_("`wysh' for sh(1)ell-style quoting"); break;
359 #ifdef HAVE_DOCSTRINGS
360 fprintf(fp
, _("`%s'. Argument type: %s.\n\t%s\n"),
361 cp
->lc_name
, V_(argt
), V_(cp
->lc_doc
));
364 fprintf(fp
, "`%s' (%s)\n", cp
->lc_name
, argt
);
368 size_t j
= strlen(cp
->lc_name
) + 2;
375 fprintf(fp
, (*cursor
!= NULL
? "%s, " : "%s\n"), cp
->lc_name
);
380 page_or_print(fp
, l
);
388 a_lex__pcmd_cmp(void const *s1
, void const *s2
){
389 struct a_lex_cmd
const * const *cp1
, * const *cp2
;
395 rv
= strcmp((*cp1
)->lc_name
, (*cp2
)->lc_name
);
401 a_lex_c_quit(void *v
){
405 /* If we are PS_SOURCING, then return 1 so _evaluate() can handle it.
406 * Otherwise return -1 to abort command loop */
413 a_lex_c_version(void *v
){
416 char const *cp
, **arr
;
421 printf(_("%s version %s\nFeatures included (+) or not (-)\n"),
422 uagent
, ok_vlook(version
));
424 /* *features* starts with dummy byte to avoid + -> *folder* expansions */
425 i
= strlen(cp
= &ok_vlook(features
)[1]);
426 i2
= strlen(&cp
[i
+ 1]) +1;
427 iop
= salloc(i
+ i2
);
429 memcpy(&iop
[i
], &cp
[++i
], i2
);
431 arr
= salloc(sizeof(cp
) * VAL_FEATURES_CNT
);
432 for(longest
= 0, i
= 0; (cp
= n_strsep(&iop
, ',', TRU1
)) != NULL
; ++i
){
435 longest
= MAX(longest
, (int)i2
);
437 qsort(arr
, i
, sizeof(cp
), &a_lex__version_cmp
);
439 for(++longest
, i2
= 0; i
-- > 0;){
441 printf("%-*s ", longest
, cp
);
443 if(UICMP(z
, ++i2
+ longest
, >=, scrnwidth
) || i
== 0){
449 if((rv
= ferror(stdout
) != 0))
456 a_lex__version_cmp(void const *s1
, void const *s2
){
457 char const * const *cp1
, * const *cp2
;
463 rv
= strcmp(&(*cp1
)[1], &(*cp2
)[1]);
469 a_lex_update_pstate(void){
472 if(pstate
& PS_SIGWINCH_PEND
){
475 snprintf(buf
, sizeof buf
, "%d", scrnwidth
);
476 ok_vset(COLUMNS
, buf
);
477 snprintf(buf
, sizeof buf
, "%d", scrnheight
);
481 pstate
&= ~PS_PSTATE_PENDMASK
;
486 a_lex_evaluate(struct a_lex_eval_ctx
*evp
){
487 /* xxx old style(9), but also old code */
489 char _wordbuf
[2], *arglist
[MAXARGC
], *cp
, *word
;
490 struct a_lex_ghost
*gp
;
491 struct a_lex_cmd
const *cmd
;
500 line
= evp
->le_line
; /* XXX don't change original (buffer pointer) */
501 assert(line
.s
[line
.l
] == '\0');
502 evp
->le_add_history
= FAL0
;
503 evp
->le_new_content
= NULL
;
505 /* Command ghosts that refer to shell commands or macro expansion restart */
508 /* Strip the white space away from end and beginning of command */
512 for(cp
= &line
.s
[i
-1]; spacechar(*cp
); --cp
)
516 for(cp
= line
.s
; spacechar(*cp
); ++cp
)
518 line
.l
-= PTR2SIZE(cp
- line
.s
);
520 /* Ignore null commands (comments) */
524 /* Handle ! differently to get the correct lexical conventions */
528 /* Isolate the actual command; since it may not necessarily be
529 * separated from the arguments (as in `p1') we need to duplicate it to
530 * be able to create a NUL terminated version.
531 * We must be aware of several special one letter commands here */
532 else if((cp
= a_lex_isolate(cp
)) == arglist
[0] &&
533 (*cp
== '|' || *cp
== '~' || *cp
== '?'))
535 c
= (int)PTR2SIZE(cp
- arglist
[0]);
537 word
= UICMP(z
, c
, <, sizeof _wordbuf
) ? _wordbuf
: salloc(c
+1);
538 memcpy(word
, arglist
[0], c
);
541 /* Look up the command; if not found, bitch.
542 * Normally, a blank command would map to the first command in the
543 * table; while PS_SOURCING, however, we ignore blank lines to eliminate
544 * confusion; act just the same for ghosts */
546 if((pstate
& PS_ROBOT
) || gp
!= NULL
)
548 cmd
= a_lex_cmd_tab
+ 0;
552 /* XXX It may be the argument parse adjuster */
553 if(!wysh
&& c
== sizeof("wysh") -1 && !asccasecmp(word
, "wysh")){
559 /* If this is the first evaluation, check command ghosts */
561 /* TODO relink list head, so it's sorted on usage over time?
562 * TODO in fact, there should be one hashmap over all commands and ghosts
563 * TODO so that the lookup could be made much more efficient than it is
564 * TODO now (two adjacent list searches! */
565 for(gp
= a_lex_ghosts
; gp
!= NULL
; gp
= gp
->lg_next
)
566 if(!strcmp(word
, gp
->lg_name
)){
571 line
.s
= salloc(i
+ line
.l
+1);
572 memcpy(line
.s
, gp
->lg_cmd
.s
, i
);
573 memcpy(line
.s
+ i
, cp
, line
.l
);
574 line
.s
[i
+= line
.l
] = '\0';
577 line
.s
= gp
->lg_cmd
.s
;
578 line
.l
= gp
->lg_cmd
.l
;
584 if((cmd
= a_lex__firstfit(word
)) == NULL
|| cmd
->lc_func
== &c_cmdnotsupp
){
587 if(!(s
= condstack_isskip()) || (options
& OPT_D_V
))
588 n_err(_("Unknown command%s: `%s'\n"),
589 (s
? _(" (ignored due to `if' condition)") : ""), word
);
599 /* See if we should execute the command -- if a conditional we always
600 * execute it, otherwise, check the state of cond */
602 if(!(cmd
->lc_argtype
& ARG_F
) && condstack_isskip())
605 /* Process the arguments to the command, depending on the type it expects */
606 if(!(cmd
->lc_argtype
& ARG_M
) && (options
& OPT_SENDMODE
)){
607 n_err(_("May not execute `%s' while sending\n"), cmd
->lc_name
);
610 if((cmd
->lc_argtype
& ARG_S
) && !(pstate
& PS_STARTED
)){
611 n_err(_("May not execute `%s' during startup\n"), cmd
->lc_name
);
614 if((cmd
->lc_argtype
& ARG_I
) &&
615 !(options
& (OPT_INTERACTIVE
| OPT_BATCH_FLAG
))){
616 n_err(_("May not execute `%s' unless interactive or in batch mode\n"),
620 if((cmd
->lc_argtype
& ARG_R
) && (pstate
& PS_RECURSED
)){
621 n_err(_("Cannot invoke `%s' when in recursed mode (e.g., composing)\n"),
626 if((cmd
->lc_argtype
& ARG_W
) && !(mb
.mb_perm
& MB_DELE
)){
627 n_err(_("May not execute `%s' -- message file is read only\n"),
631 if((cmd
->lc_argtype
& ARG_A
) && mb
.mb_type
== MB_VOID
){
632 n_err(_("Cannot execute `%s' without active mailbox\n"), cmd
->lc_name
);
636 if(cmd
->lc_argtype
& ARG_O
)
637 OBSOLETE2(_("this command will be removed"), cmd
->lc_name
);
638 if(cmd
->lc_argtype
& ARG_V
)
639 temporary_arg_v_store
= NULL
;
641 if(wysh
&& (cmd
->lc_argtype
& ARG_ARGMASK
) != ARG_WYRALIST
)
642 n_err(_("`wysh' prefix doesn't affect `%s'\n"), cmd
->lc_name
);
643 switch(cmd
->lc_argtype
& ARG_ARGMASK
){
645 /* Message list defaulting to nearest forward legal message */
648 if((c
= getmsglist(cp
, n_msgvec
, cmd
->lc_msgflag
)) < 0)
651 if((n_msgvec
[0] = first(cmd
->lc_msgflag
, cmd
->lc_msgmask
)) != 0)
654 if(n_msgvec
[0] == 0){
655 if(!(pstate
& PS_HOOK_MASK
))
656 printf(_("No applicable messages\n"));
659 e
= (*cmd
->lc_func
)(n_msgvec
);
663 /* Message list with no defaults, but no error if none exist */
664 if(n_msgvec
== NULL
){
666 n_err(_("Invalid use of message list\n"));
669 if((c
= getmsglist(cp
, n_msgvec
, cmd
->lc_msgflag
)) < 0)
671 e
= (*cmd
->lc_func
)(n_msgvec
);
675 /* Just the straight string, with leading blanks removed */
676 while(whitechar(*cp
))
678 e
= (*cmd
->lc_func
)(cp
);
693 if((c
= getrawlist((c
!= 0), arglist
, NELEM(arglist
), cp
, line
.l
)) < 0){
694 n_err(_("Invalid argument list\n"));
697 if(c
< cmd
->lc_minargs
){
698 n_err(_("`%s' requires at least %d arg(s)\n"),
699 cmd
->lc_name
, cmd
->lc_minargs
);
703 if(c
> cmd
->lc_maxargs
){
704 n_err(_("`%s' takes no more than %d arg(s)\n"),
705 cmd
->lc_name
, cmd
->lc_maxargs
);
709 e
= (*cmd
->lc_func
)(arglist
);
713 /* Just the constant zero, for exiting, eg. */
714 e
= (*cmd
->lc_func
)(0);
718 DBG( n_panic(_("Implementation error: unknown argument type: %d"),
719 cmd
->lc_argtype
& ARG_ARGMASK
); )
723 if(e
== 0 && (cmd
->lc_argtype
& ARG_V
) &&
724 (cp
= temporary_arg_v_store
) != NULL
){
725 temporary_arg_v_store
= NULL
;
726 evp
->le_new_content
= cp
;
729 if(!(cmd
->lc_argtype
& ARG_H
) && !(pstate
& PS_MSGLIST_SAW_NO
))
730 evp
->le_add_history
= TRU1
;
733 /* Exit the current source file on error TODO what a mess! */
735 pstate
&= ~PS_EVAL_ERROR
;
737 pstate
|= PS_EVAL_ERROR
;
738 if(e
< 0 || (pstate
& PS_ROBOT
)){ /* FIXME */
747 if((cmd
->lc_argtype
& ARG_P
) && ok_blook(autoprint
))
749 line
.s
= savestr("type");
750 line
.l
= sizeof("type") -1;
751 gp
= (struct a_lex_ghost
*)-1; /* Avoid `ghost' interpretation */
755 if(!(pstate
& (PS_SOURCING
| PS_HOOK_MASK
)) && !(cmd
->lc_argtype
& ARG_T
))
756 pstate
|= PS_SAW_COMMAND
;
758 pstate
&= ~PS_EVAL_ERROR
;
763 fprintf(stderr, "a_lex_evaluate returns %d for <%s>\n",e,line.s);
769 static struct a_lex_cmd
const *
770 a_lex__firstfit(char const *comm
){ /* TODO *hashtable*! linear list search!!! */
771 struct a_lex_cmd
const *cp
;
774 for(cp
= a_lex_cmd_tab
; PTRCMP(cp
, <, &a_lex_cmd_tab
[NELEM(a_lex_cmd_tab
)]);
776 if(*comm
== *cp
->lc_name
&& is_prefix(comm
, cp
->lc_name
))
786 NYD_X
; /* Signal handler */
794 NYD_X
; /* Signal handler */
796 safe_signal(SIGINT
, a_lex_onintr
);
798 a_lex_unstack(TRUM1
);
800 termios_state_reset();
801 close_all_files(); /* FIXME .. to outer level ONLU! */
808 n_err_sighdl(_("Interrupt\n"));
809 safe_signal(SIGPIPE
, a_lex_oldpipe
);
810 siglongjmp(srbuf
, 0); /* FIXME get rid */
814 a_lex_unstack(bool_t eval_error
){
815 struct a_lex_input_stack
*lip
;
818 if((lip
= a_lex_input
) == NULL
){
819 /* If called from a_lex_onintr(), be silent FIXME */
820 pstate
&= ~(PS_SOURCING
| PS_ROBOT
);
821 if(eval_error
== TRUM1
|| !(pstate
& PS_STARTED
))
826 if(lip
->li_flags
& a_LEX_MACRO
){
827 if(lip
->li_flags
& a_LEX_MACRO_FREE_DATA
){
830 while(*(lp
= &lip
->li_lines
[lip
->li_loff
]) != NULL
){
834 /* Part of lip's memory chunk, then */
835 if(!(lip
->li_flags
& a_LEX_MACRO_CMD
))
839 if(lip
->li_flags
& a_LEX_PIPE
)
840 /* XXX command manager should -TERM then -KILL instead of hoping
841 * XXX for exit of provider due to EPIPE / SIGPIPE */
842 Pclose(lip
->li_file
, TRU1
);
844 Fclose(lip
->li_file
);
847 if(!condstack_take(lip
->li_cond
)){
848 n_err(_("Unmatched `if' at end of %s %s\n"),
849 ((lip
->li_flags
& a_LEX_MACRO
850 ? (lip
->li_flags
& a_LEX_MACRO_CMD
? _("command") : _("macro"))
851 : _("`source'd file"))),
856 if((a_lex_input
= lip
->li_outer
) == NULL
){
857 pstate
&= ~(PS_SOURCING
| PS_ROBOT
);
859 if((a_lex_input
->li_flags
& (a_LEX_MACRO
| a_LEX_SUPER_MACRO
)) ==
860 (a_LEX_MACRO
| a_LEX_SUPER_MACRO
))
861 pstate
&= ~PS_SOURCING
;
862 assert(pstate
& PS_ROBOT
);
867 if(lip
->li_flags
& a_LEX_FREE
)
870 if(UNLIKELY(a_lex_input
!= NULL
&& eval_error
== TRUM1
))
871 a_lex_unstack(TRUM1
);
877 if(options
& OPT_D_V
)
878 n_alert(_("Stopped %s %s due to errors%s"),
880 ? (lip
->li_flags
& a_LEX_MACRO
881 ? (lip
->li_flags
& a_LEX_MACRO_CMD
882 ? _("evaluating command") : _("evaluating macro"))
883 : (lip
->li_flags
& a_LEX_PIPE
884 ? _("executing `source'd pipe")
885 : _("loading `source'd file")))
886 : (lip
->li_flags
& a_LEX_MACRO
887 ? (lip
->li_flags
& a_LEX_MACRO_X_OPTION
888 ? _("evaluating command line") : _("evaluating macro"))
889 : _("loading initialization resource"))),
891 (options
& OPT_DEBUG
? "" : _(" (enable *debug* for trace)")));
892 if(lip
->li_flags
& a_LEX_FREE
)
896 if(!(options
& OPT_INTERACTIVE
) && !(pstate
& PS_STARTED
)){
897 if(options
& OPT_D_V
)
898 n_alert(_("Non-interactive, bailing out due to errors "
899 "in startup load phase"));
906 a_lex_source_file(char const *file
, bool_t silent_error
){
907 struct a_lex_input_stack
*lip
;
916 /* Being a command argument file is space-trimmed */
917 if((ispipe
= (!silent_error
&& (nlen
= strlen(file
)) > 0 &&
918 file
[--nlen
] == '|'))){
919 if((fip
= Popen(nbuf
= savestrbuf(file
, nlen
), "r",
920 ok_vlook(SHELL
), NULL
, COMMAND_FD_NULL
)) == NULL
){
921 if(!silent_error
|| (options
& OPT_D_V
))
925 }else if((nbuf
= fexpand(file
, FEXP_LOCAL
)) == NULL
)
927 else if((fip
= Fopen(nbuf
, "r")) == NULL
){
928 if(!silent_error
|| (options
& OPT_D_V
))
933 lip
= smalloc(sizeof(*lip
) -
934 VFIELD_SIZEOF(struct a_lex_input_stack
, li_name
) +
935 (nlen
= strlen(nbuf
) +1));
936 lip
->li_outer
= a_lex_input
;
938 lip
->li_cond
= condstack_release();
939 lip
->li_flags
= (ispipe
? a_LEX_PIPE
: a_LEX_NONE
) |
940 (a_lex_input
!= NULL
&& (a_lex_input
->li_flags
& a_LEX_SUPER_MACRO
)
941 ? a_LEX_SUPER_MACRO
: 0);
942 memcpy(lip
->li_name
, nbuf
, nlen
);
944 pstate
|= PS_SOURCING
| PS_ROBOT
;
946 a_commands_recursive(n_LEXINPUT_NONE
| n_LEXINPUT_NL_ESC
);
947 /* FIXME return TRUM1 if file can't be opened, FAL0 on eval error */
950 return silent_error
? TRU1
: (fip
!= NULL
);
954 a_lex_load(struct a_lex_input_stack
*lip
){
958 assert(!(pstate
& PS_STARTED
));
959 assert(a_lex_input
== NULL
);
962 * Any errors in the start-up file shall either cause mailx to terminate
963 * with a diagnostic message and a non-zero status or to continue after
964 * writing a diagnostic message, ignoring the remainder of the lines in
965 * the start-up file. */
966 lip
->li_cond
= condstack_release();
968 /* FIXME won't work for now (PS_ROBOT needs PS_SOURCING anyway)
970 (lip->li_flags & a_LEX_MACRO_X_OPTION ? 0 : PS_SOURCING);
972 pstate
|= PS_ROBOT
| PS_SOURCING
;
973 if(options
& OPT_D_V
)
974 n_err(_("Loading %s\n"), n_shell_quote_cp(lip
->li_name
, FAL0
));
976 if(!(rv
= n_commands())){
977 if(!(options
& OPT_INTERACTIVE
)){
978 if(options
& OPT_D_V
)
979 n_alert(_("Non-interactive program mode, forced exit"));
983 /* PS_EXIT handled by callers */
989 a_commands_recursive(enum n_lexinput_flags lif
){
990 struct a_lex_eval_ctx ev
;
994 memset(&ev
, 0, sizeof ev
);
996 /* FIXME sigkondom */
997 n_COLOUR( n_colour_env_push(); )
1002 /* Read a line of commands and handle end of file specially */
1003 ev
.le_line
.l
= ev
.le_line_size
;
1004 n
= n_lex_input(lif
, NULL
, &ev
.le_line
.s
, &ev
.le_line
.l
,
1006 ev
.le_line_size
= (ui32_t
)ev
.le_line
.l
;
1007 ev
.le_line
.l
= (ui32_t
)n
;
1012 if(a_lex_evaluate(&ev
)){
1017 if((options
& OPT_BATCH_FLAG
) && ok_blook(batch_exit_on_error
)){
1018 if(exit_status
!= EXIT_OK
)
1023 n_COLOUR( n_colour_env_pop(FAL0
); )
1025 if(ev
.le_line
.s
!= NULL
)
1031 #ifdef HAVE_DOCSTRINGS
1033 n_print_comm_docstr(char const *comm
){
1034 struct a_lex_ghost
const *gp
;
1035 struct a_lex_cmd
const *cp
, *cpmax
;
1039 /* Ghosts take precedence */
1040 for(gp
= a_lex_ghosts
; gp
!= NULL
; gp
= gp
->lg_next
)
1041 if(!strcmp(comm
, gp
->lg_name
)){
1042 printf("%s -> ", comm
);
1043 comm
= gp
->lg_cmd
.s
;
1047 cpmax
= &(cp
= a_lex_cmd_tab
)[NELEM(a_lex_cmd_tab
)];
1049 for(; PTRCMP(cp
, <, cpmax
); ++cp
){
1050 if(!strcmp(comm
, cp
->lc_name
))
1051 printf("%s: %s\n", comm
, V_(cp
->lc_doc
));
1052 else if(is_prefix(comm
, cp
->lc_name
))
1053 printf("%s (%s): %s\n", comm
, cp
->lc_name
, V_(cp
->lc_doc
));
1059 if(!rv
&& PTRCMP(cpmax
, ==, &a_lex_cmd_tab
[NELEM(a_lex_cmd_tab
)])){
1060 cpmax
= &(cp
= a_lex_special_cmd_tab
)[NELEM(a_lex_special_cmd_tab
)];
1064 if(!rv
&& gp
!= NULL
){
1065 printf("%s\n", n_shell_quote_cp(comm
, TRU1
));
1071 #endif /* HAVE_DOCSTRINGS */
1074 n_commands(void){ /* FIXME */
1075 struct a_lex_eval_ctx ev
;
1077 bool_t
volatile rv
= TRU1
;
1080 if (!(pstate
& PS_SOURCING
)) {
1081 if (safe_signal(SIGINT
, SIG_IGN
) != SIG_IGN
)
1082 safe_signal(SIGINT
, &a_lex_onintr
);
1083 if (safe_signal(SIGHUP
, SIG_IGN
) != SIG_IGN
)
1084 safe_signal(SIGHUP
, &a_lex_hangup
);
1086 a_lex_oldpipe
= safe_signal(SIGPIPE
, SIG_IGN
);
1087 safe_signal(SIGPIPE
, a_lex_oldpipe
);
1089 memset(&ev
, 0, sizeof ev
);
1091 (void)sigsetjmp(srbuf
, 1); /* FIXME get rid */
1093 char *temporary_orig_line
; /* XXX eval_ctx.le_line not yet constant */
1095 n_COLOUR( n_colour_env_pop(TRU1
); )
1097 /* TODO Unless we have our signal manager (or however we do it) child
1098 * TODO processes may have time slots where their execution isn't
1099 * TODO protected by signal handlers (in between start and setup
1100 * TODO completed). close_all_files() is only called from onintr()
1101 * TODO so those may linger possibly forever */
1102 if(!(pstate
& PS_SOURCING
))
1107 temporary_localopts_free(); /* XXX intermediate hack */
1108 sreset((pstate
& PS_SOURCING
) != 0);
1109 if (!(pstate
& PS_SOURCING
)) {
1112 /* TODO Note: this buffer may contain a password. We should redefine
1113 * TODO the code flow which has to do that */
1114 if ((cp
= termios_state
.ts_linebuf
) != NULL
) {
1115 termios_state
.ts_linebuf
= NULL
;
1116 termios_state
.ts_linesize
= 0;
1117 free(cp
); /* TODO pool give-back */
1119 /* TODO Due to expand-on-tab of NCL the buffer may grow */
1120 if (ev
.le_line
.l
> LINESIZE
* 3) {
1121 free(ev
.le_line
.s
); /* TODO pool! but what? */
1122 ev
.le_line
.s
= NULL
;
1123 ev
.le_line
.l
= ev
.le_line_size
= 0;
1127 if (!(pstate
& PS_SOURCING
) && (options
& OPT_INTERACTIVE
)) {
1130 cp
= ok_vlook(newmail
);
1131 if ((options
& OPT_TTYIN
) && cp
!= NULL
) {
1134 /* FIXME TEST WITH NOPOLL ETC. !!! */
1135 n
= (cp
!= NULL
&& strcmp(cp
, "nopoll"));
1136 if ((mb
.mb_type
== MB_FILE
&& !stat(mailname
, &st
) &&
1137 st
.st_size
> mailsize
) ||
1138 (mb
.mb_type
== MB_MAILDIR
&& n
!= 0)) {
1139 size_t odot
= PTR2SIZE(dot
- message
);
1140 ui32_t odid
= (pstate
& PS_DID_PRINT_DOT
);
1142 if (setfile(mailname
,
1144 ((mb
.mb_perm
& MB_DELE
) ? 0 : FEDIT_RDONLY
)) < 0) {
1145 exit_status
|= EXIT_ERR
;
1149 dot
= message
+ odot
;
1154 exit_status
= EXIT_OK
;
1157 /* Read a line of commands and handle end of file specially */
1159 ev
.le_line
.l
= ev
.le_line_size
;
1160 n
= n_lex_input(n_LEXINPUT_CTX_BASE
| n_LEXINPUT_NL_ESC
, NULL
,
1161 &ev
.le_line
.s
, &ev
.le_line
.l
, ev
.le_new_content
);
1162 ev
.le_line_size
= (ui32_t
)ev
.le_line
.l
;
1163 ev
.le_line
.l
= (ui32_t
)n
;
1166 /* FIXME did unstack() when PS_SOURCING, only break with PS_LOADING*/
1167 if (!(pstate
& PS_ROBOT
) &&
1168 (options
& OPT_INTERACTIVE
) && ok_blook(ignoreeof
)) {
1169 printf(_("*ignoreeof* set, use `quit' to quit.\n"));
1170 n_msleep(500, FAL0
);
1176 temporary_orig_line
= ((pstate
& PS_SOURCING
) ||
1177 !(options
& OPT_INTERACTIVE
)) ? NULL
1178 : savestrbuf(ev
.le_line
.s
, ev
.le_line
.l
);
1179 pstate
&= ~PS_HOOK_MASK
;
1180 if (a_lex_evaluate(&ev
)) {
1181 if (!(pstate
& PS_STARTED
)) /* TODO mess; join PS_EVAL_ERROR.. */
1186 if ((options
& OPT_BATCH_FLAG
) && ok_blook(batch_exit_on_error
)) {
1187 if (exit_status
!= EXIT_OK
)
1189 if ((pstate
& (PS_SOURCING
| PS_EVAL_ERROR
)) == PS_EVAL_ERROR
) {
1190 exit_status
= EXIT_ERR
;
1194 if (!(pstate
& PS_SOURCING
) && (options
& OPT_INTERACTIVE
)) {
1195 if (ev
.le_new_content
!= NULL
)
1197 /* *Can* happen since _evaluate() n_unstack()s on error! XXX no more */
1198 if (temporary_orig_line
!= NULL
)
1199 n_tty_addhist(temporary_orig_line
, !ev
.le_add_history
);
1202 if(pstate
& PS_EXIT
)
1207 if (ev
.le_line
.s
!= NULL
)
1209 if (pstate
& PS_SOURCING
)
1216 (n_lex_input
)(enum n_lexinput_flags lif
, char const *prompt
, char **linebuf
,
1217 size_t *linesize
, char const *string SMALLOC_DEBUG_ARGS
){
1218 /* TODO readline: linebuf pool! */
1220 bool_t doprompt
, dotty
;
1225 /* Special case macro mode: never need to prompt, lines have always been
1226 * unfolded already */
1227 if(a_lex_input
!= NULL
&& (a_lex_input
->li_flags
& a_LEX_MACRO
)){
1228 char **lp
= &a_lex_input
->li_lines
[a_lex_input
->li_loff
];
1230 if(*linebuf
!= NULL
)
1233 if((*linebuf
= *lp
) == NULL
){
1239 ++a_lex_input
->li_loff
;
1240 *linesize
= strlen(*linebuf
);
1241 if(!(a_lex_input
->li_flags
& a_LEX_MACRO_FREE_DATA
))
1242 *linebuf
= sbufdup(*linebuf
, *linesize
);
1243 pstate
|= PS_READLINE_NL
;
1245 iftype
= (a_lex_input
->li_flags
& a_LEX_MACRO_X_OPTION
)
1246 ? "-X OPTION" : "MACRO";
1249 pstate
&= ~PS_READLINE_NL
;
1251 iftype
= (!(pstate
& PS_STARTED
) ? "LOAD"
1252 : (pstate
& PS_SOURCING
) ? "SOURCE" : "READ");
1253 doprompt
= ((pstate
& (PS_STARTED
| PS_ROBOT
)) == PS_STARTED
&&
1254 (options
& OPT_INTERACTIVE
));
1255 dotty
= (doprompt
&& !ok_blook(line_editor_disable
));
1258 else if(prompt
== NULL
)
1259 prompt
= getprompt();
1261 /* Ensure stdout is flushed first anyway */
1262 if(!dotty
&& prompt
== NULL
)
1265 ifile
= (a_lex_input
!= NULL
) ? a_lex_input
->li_file
: stdin
;
1266 assert(ifile
!= NULL
);
1268 for(nold
= n
= 0;;){
1270 assert(ifile
== stdin
);
1271 if(string
!= NULL
&& (n
= (int)strlen(string
)) > 0){
1275 *linesize
= (size_t)n
+ LINESIZE
+1;
1276 *linebuf
= (srealloc
)(*linebuf
, *linesize SMALLOC_DEBUG_ARGSCALL
);
1277 memcpy(*linebuf
, string
, (size_t)n
+1);
1280 /* TODO if nold>0, don't redisplay the entire line!
1281 * TODO needs complete redesign ... */
1282 n
= (n_tty_readline
)(lif
, prompt
, linebuf
, linesize
, n
1283 SMALLOC_DEBUG_ARGSCALL
);
1285 if(prompt
!= NULL
) {
1287 fputs(prompt
, stdout
);
1291 n
= (readline_restart
)(ifile
, linebuf
, linesize
, n
1292 SMALLOC_DEBUG_ARGSCALL
);
1294 if(n
> 0 && nold
> 0){
1296 char const *cp
= *linebuf
+ nold
;
1298 while(blankspacechar(*cp
) && nold
+ i
< n
)
1301 memmove(*linebuf
+ nold
, cp
, n
- nold
- i
);
1303 (*linebuf
)[n
] = '\0';
1312 * An unquoted <backslash> at the end of a command line shall
1313 * be discarded and the next line shall continue the command */
1314 if(!(lif
& n_LEXINPUT_NL_ESC
) || (*linebuf
)[n
- 1] != '\\'){
1316 pstate
|= PS_READLINE_NL
;
1319 /* Definitely outside of quotes, thus the quoting rules are so that an
1320 * uneven number of successive backslashs at EOL is a continuation */
1324 for(j
= 1, i
= (size_t)n
- 1; i
-- > 0; ++j
)
1325 if((*linebuf
)[i
] != '\\')
1330 (*linebuf
)[nold
= --n
] = '\0';
1331 if(prompt
!= NULL
&& *prompt
!= '\0')
1332 prompt
= ".. "; /* XXX PS2 .. */
1337 (*linebuf
)[*linesize
= n
] = '\0';
1341 if(lif
& n_LEXINPUT_DROP_TRAIL_SPC
){
1345 for(cp
= &(*linebuf
)[i
= *linesize
];; --i
){
1347 if(!blankspacechar(c
))
1350 (*linebuf
)[*linesize
= i
] = '\0';
1353 if(lif
& n_LEXINPUT_DROP_LEAD_SPC
){
1357 for(cp
= &(*linebuf
)[0], j
= *linesize
, i
= 0; i
< j
; ++i
){
1359 if(!blankspacechar(c
))
1363 memcpy(&(*linebuf
)[0], &(*linebuf
)[i
], j
-= i
);
1364 (*linebuf
)[*linesize
= j
] = '\0';
1367 #endif /* 0 (notyet - must take care for backslash escaped space) */
1369 if(options
& OPT_D_VV
)
1370 n_err(_("%s %" PRIuZ
" bytes <%s>\n"), iftype
, *linesize
, *linebuf
);
1371 n
= (int)*linesize
; /* XXX si64_t */
1373 if (pstate
& PS_PSTATE_PENDMASK
)
1374 a_lex_update_pstate();
1380 n_lex_input_cp(enum n_lexinput_flags lif
, char const *prompt
,
1381 char const *string
){
1382 /* FIXME n_lex_input_cp_addhist(): leaks on sigjmp without linepool */
1392 n
= n_lex_input(lif
, prompt
, &linebuf
, &linesize
, string
);
1393 if(n
> 0 && *(rv
= savestrbuf(linebuf
, (size_t)n
)) != '\0' &&
1394 (lif
& n_LEXINPUT_HIST_ADD
) && (options
& OPT_INTERACTIVE
))
1395 n_tty_addhist(rv
, ((lif
& n_LEXINPUT_HIST_GABBY
) != 0));
1404 n_load(char const *name
){
1405 struct a_lex_input_stack
*lip
;
1410 if(name
== NULL
|| *name
== '\0' || (fip
= Fopen(name
, "r")) == NULL
)
1413 i
= strlen(name
) +1;
1414 lip
= scalloc(1, sizeof(*lip
) -
1415 VFIELD_SIZEOF(struct a_lex_input_stack
, li_name
) + i
);
1417 lip
->li_flags
= a_LEX_FREE
;
1418 memcpy(lip
->li_name
, name
, i
);
1427 n_load_Xargs(char const **lines
){
1428 static char const name
[] = "-X";
1430 ui8_t buf
[sizeof(struct a_lex_input_stack
) + sizeof name
];
1431 struct a_lex_input_stack
*lip
;
1434 memset(buf
, 0, sizeof buf
);
1436 lip
->li_flags
= a_LEX_MACRO
| a_LEX_MACRO_X_OPTION
| a_LEX_SUPER_MACRO
;
1437 lip
->li_lines
= UNCONST(lines
);
1438 memcpy(lip
->li_name
, name
, sizeof name
);
1441 if(pstate
& PS_EXIT
)
1451 rv
= (a_lex_source_file(*(char**)v
, FAL0
) == TRU1
) ? 0 : 1;
1457 c_source_if(void *v
){ /* XXX obsolete?, support file tests in `if' etc.! */
1461 rv
= (a_lex_source_file(*(char**)v
, TRU1
) != FAL0
) ? 0 : 1;
1467 n_source_macro(enum n_lexinput_flags lif
, char const *name
, char **lines
){
1468 struct a_lex_input_stack
*lip
;
1473 lip
= smalloc(sizeof(*lip
) -
1474 VFIELD_SIZEOF(struct a_lex_input_stack
, li_name
) +
1475 (i
= strlen(name
) +1));
1476 lip
->li_outer
= a_lex_input
;
1477 lip
->li_file
= NULL
;
1478 lip
->li_cond
= condstack_release();
1479 lip
->li_flags
= a_LEX_FREE
| a_LEX_MACRO
| a_LEX_MACRO_FREE_DATA
|
1480 (a_lex_input
== NULL
|| (a_lex_input
->li_flags
& a_LEX_SUPER_MACRO
)
1481 ? a_LEX_SUPER_MACRO
: 0);
1483 lip
->li_lines
= lines
;
1484 memcpy(lip
->li_name
, name
, i
);
1488 rv
= a_commands_recursive(lif
);
1494 n_source_command(enum n_lexinput_flags lif
, char const *cmd
){
1495 struct a_lex_input_stack
*lip
;
1501 cmd
= sbufdup(cmd
, i
++);
1504 lip
= smalloc(sizeof(*lip
) -
1505 VFIELD_SIZEOF(struct a_lex_input_stack
, li_name
) +
1506 ial
+ 2*sizeof(char*));
1507 lip
->li_outer
= a_lex_input
;
1508 lip
->li_file
= NULL
;
1509 lip
->li_cond
= condstack_release();
1510 lip
->li_flags
= a_LEX_FREE
| a_LEX_MACRO
| a_LEX_MACRO_FREE_DATA
|
1512 (a_lex_input
== NULL
|| (a_lex_input
->li_flags
& a_LEX_SUPER_MACRO
)
1513 ? a_LEX_SUPER_MACRO
: 0);
1515 lip
->li_lines
= (void*)(lip
->li_name
+ ial
);
1516 lip
->li_lines
[0] = UNCONST(cmd
); /* dup'ed above */
1517 lip
->li_lines
[1] = NULL
;
1518 memcpy(lip
->li_name
, cmd
, i
);
1522 rv
= a_commands_recursive(lif
);
1528 n_source_may_yield_control(void){
1529 return ((options
& OPT_INTERACTIVE
) &&
1530 (pstate
& PS_STARTED
) &&
1531 (!(pstate
& PS_ROBOT
) || (pstate
& PS_RECURSED
)) && /* Ok for ~: */
1532 (a_lex_input
== NULL
|| a_lex_input
->li_outer
== NULL
));