BSD 4_4_Lite2 release
[unix-history] / usr / src / contrib / nvi.1.43 / ex / excmd.h.stub
/*-
* Copyright (c) 1992, 1993, 1994
* The Regents of the University of California. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed by the University of
* California, Berkeley and its contributors.
* 4. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* @(#)excmd.h.stub 9.6 (Berkeley) 12/1/94
*/
#define PROMPTCHAR ':' /* Prompt character. */
/* Ex command structure. */
typedef struct _excmdlist {
char *name; /* Command name. */
/* Underlying function. */
int (*fn) __P((SCR *, EXCMDARG *));
#define E_ADDR1 0x0000001 /* One address. */
#define E_ADDR2 0x0000002 /* Two address. */
#define E_ADDR2_ALL 0x0000004 /* Zero/two addresses; zero == all. */
#define E_ADDR2_NONE 0x0000008 /* Zero/two addresses; zero == none. */
#define E_ADDRDEF 0x0000010 /* Default addresses used. */
#define E_AUTOPRINT 0x0000020 /* Command always sets autoprint. */
#define E_BUFFER 0x0000040 /* Buffer name supplied. */
#define E_COUNT 0x0000080 /* Count supplied. */
#define E_COUNT_NEG 0x0000100 /* Count was signed negative. */
#define E_COUNT_POS 0x0000200 /* Count was signed positive. */
#define E_FORCE 0x0000400 /* ! */
#define E_F_CARAT 0x0000800 /* ^ flag. */
#define E_F_DASH 0x0001000 /* - flag. */
#define E_F_DOT 0x0002000 /* . flag. */
#define E_F_EQUAL 0x0004000 /* = flag. */
#define E_F_HASH 0x0008000 /* # flag. */
#define E_F_LIST 0x0010000 /* l flag. */
#define E_F_PLUS 0x0020000 /* + flag. */
#define E_F_PRINT 0x0040000 /* p flag. */
#define E_F_PRCLEAR 0x0080000 /* Clear the print (#, l, p) flags. */
#define E_MODIFY 0x0100000 /* File name expansion modified arg. */
#define E_NOGLOBAL 0x0200000 /* Not in a global. */
#define E_NOPERM 0x0400000 /* Permission denied for now. */
#define E_ZERO 0x0800000 /* 0 is a legal addr1. */
#define E_ZERODEF 0x1000000 /* 0 is default addr1 of empty files. */
u_int32_t flags;
char *syntax; /* Syntax script. */
char *usage; /* Usage line. */
char *help; /* Help line. */
} EXCMDLIST;
#define MAXCMDNAMELEN 12 /* Longest command name. */
extern EXCMDLIST const cmds[]; /* List of ex commands. */
/*
* File state must be checked for each command -- any ex command may be entered
* at any time, and most of them won't work well if a file hasn't yet been read
* in. Historic vi generally took the easy way out and dropped core.
*/
#define NEEDFILE(sp, cmdp) { \
if ((sp)->ep == NULL) { \
ex_message(sp, cmdp, EXM_NORC); \
return (1); \
} \
}
/*
* Structure passed around to functions implementing ex commands.
* There are several commands in vi that build one of these and
* call ex directly. See vi/v_ex.c for details.
*/
struct _excmdarg {
EXCMDLIST const *cmd; /* Command entry in command table. */
CHAR_T buffer; /* Named buffer. */
recno_t lineno; /* Line number. */
long count; /* Signed, specified count. */
long flagoff; /* Signed, flag offset parsed by command. */
int addrcnt; /* Number of addresses (0, 1 or 2). */
MARK addr1; /* 1st address. */
MARK addr2; /* 2nd address. */
ARGS **argv; /* Array of arguments. */
int argc; /* Count of arguments. */
u_int32_t flags; /* Selected flags from EXCMDLIST. */
};
/* Global ranges. */
typedef struct _range RANGE;
struct _range {
CIRCLEQ_ENTRY(_range) q; /* Linked list of ranges. */
recno_t start, stop; /* Start/stop of the range. */
};
/* Cd paths. */
typedef struct _cdpath CDPATH;
struct _cdpath {
TAILQ_ENTRY(_cdpath) q; /* Linked list of cd paths. */
char *path; /* Path. */
};
/* Ex private, per-screen memory. */
typedef struct _ex_private {
ARGS **args; /* Arguments. */
int argscnt; /* Argument count. */
int argsoff; /* Offset into arguments. */
CHAR_T at_lbuf; /* Last executed at buffer's name. */
int at_lbuf_set; /* If at_lbuf is set. */
char *ibp; /* Line input buffer. */
size_t ibp_len; /* Line input buffer length. */
u_int32_t fdef; /* Default command flags. */
CHAR_T *lastbcomm; /* Last bang command. */
/* XXX: Should be struct timespec's, but time_t is more portable. */
time_t leave_atime; /* ex_[sr]leave old access time. */
time_t leave_mtime; /* ex_[sr]leave old mod time. */
struct termios leave_term; /* ex_[sr]leave tty state. */
TAILQ_HEAD(_tagh, _tag) tagq; /* Tag list (stack). */
TAILQ_HEAD(_tagfh, _tagf) tagfq;/* Tag file list. */
char *tlast; /* Saved last tag. */
TAILQ_HEAD(_cdh, _cdpath) cdq; /* Cd path list. */
/* Linked list of ranges. */
CIRCLEQ_HEAD(_rangeh, _range) rangeq;
recno_t range_lno; /* Range set line number. */
#define EX_ABSMARK 0x01 /* Set the absolute mark. */
#define EX_AUTOPRINT 0x02 /* Autoprint flag. */
#define EX_VLITONLY 0x04 /* ^V quoting only. */
u_int8_t flags;
} EX_PRIVATE;
#define EXP(sp) ((EX_PRIVATE *)((sp)->ex_private))
/*
* !!!
* QUOTING NOTE:
*
* Historically, .exrc files and EXINIT variables could only use ^V
* as an escape character, neither ^Q or a user specified character
* worked. We enforce that here, just in case someone depends on it.
*/
#define IS_ESCAPE(sp, ch) \
(F_ISSET(EXP(sp), EX_VLITONLY) ? \
(ch) == CH_LITERAL : KEY_VAL(sp, ch) == K_VLNEXT)
/*
* Filter actions:
*
* FILTER Filter text through the utility.
* FILTER_READ Read from the utility into the file.
* FILTER_WRITE Write to the utility, display its output.
*/
enum filtertype { FILTER, FILTER_READ, FILTER_WRITE };
int filtercmd __P((SCR *, MARK *, MARK *, MARK *, char *, enum filtertype));
/* Argument expansion routines. */
int argv_init __P((SCR *, EXCMDARG *));
int argv_exp0 __P((SCR *, EXCMDARG *, char *, size_t));
int argv_exp1 __P((SCR *, EXCMDARG *, char *, size_t, int));
int argv_exp2 __P((SCR *, EXCMDARG *, char *, size_t));
int argv_exp3 __P((SCR *, EXCMDARG *, char *, size_t));
int argv_free __P((SCR *));
/* Ex common messages. */
enum exmtype { EXM_INTERRUPTED, EXM_NOPREVRE, EXM_NORC, EXM_USAGE };
void ex_message __P((SCR *, const EXCMDLIST *, enum exmtype));
/* Ex parser function prototypes. */
#define EXPAR_BLIGNORE 0x01 /* Ignore blank lines. */
#define EXPAR_NEEDSEP 0x02 /* Need ex output separator. */
#define EXPAR_NOAUTO 0x04 /* Don't do autoprint output. */
#define EXPAR_NOPRDEF 0x08 /* Don't print as default. */
#define EXPAR_VLITONLY 0x10 /* ^V quoting only. */
int ex_cfile __P((SCR *, char *, u_int));
int ex_cmd __P((SCR *, char *, size_t, u_int));
int ex_icmd __P((SCR *, char *, size_t, u_int));
/* Ex address errors. */
enum badaddr {A_COMBO, A_EMPTY, A_EOF, A_NOTSET, A_ZERO };
void ex_badaddr __P((SCR *, EXCMDLIST const *, enum badaddr, enum nresult));
/* Ex function prototypes. */
int ex __P((SCR *));
void ex_cbuild __P((EXCMDARG *,
int, int, recno_t, recno_t, int, ARGS *[], ARGS *, char *));
int ex_cdalloc __P((SCR *, char *));
int ex_cdfree __P((SCR *));
int ex_comment __P((SCR *));
int ex_end __P((SCR *));
int ex_exec_proc __P((SCR *, char *, char *, char *));
int ex_gb __P((SCR *, TEXTH *, int, u_int));
int ex_getline __P((SCR *, FILE *, size_t *));
int ex_init __P((SCR *));
int ex_is_abbrev __P((char *, size_t));
int ex_is_unmap __P((char *, size_t));
int ex_ldisplay __P((SCR *, const char *, size_t, size_t, u_int));
int ex_line __P((SCR *, MARK *, char **, size_t *, int *, int *));
int ex_ncheck __P((SCR *, int));
int ex_print __P((SCR *, MARK *, MARK *, int));
int ex_readfp __P((SCR *, char *, FILE *, MARK *, recno_t *, int));
void ex_refresh __P((SCR *));
void ex_rleave __P((SCR *));
int ex_scprint __P((SCR *, MARK *, MARK *));
int ex_screen_copy __P((SCR *, SCR *));
int ex_screen_end __P((SCR *));
int ex_sdisplay __P((SCR *));
int ex_sleave __P((SCR *));
int ex_suspend __P((SCR *));
int ex_tdisplay __P((SCR *));
int ex_tload __P((SCR *));
int ex_writefp __P((SCR *,
char *, FILE *, MARK *, MARK *, u_long *, u_long *));
void global_insdel __P((SCR *, enum operation, recno_t));
int proc_wait __P((SCR *, long, const char *, int));
int sscr_end __P((SCR *));
int sscr_exec __P((SCR *, recno_t));
int sscr_input __P((SCR *));
int abbr_save __P((SCR *, FILE *));
int map_save __P((SCR *, FILE *));
#define EXPROTO(name) int name __P((SCR *, EXCMDARG *))
EXPROTO(ex_abbr);
EXPROTO(ex_append);
EXPROTO(ex_args);
EXPROTO(ex_at);
EXPROTO(ex_bang);
EXPROTO(ex_bg);
EXPROTO(ex_cd);
EXPROTO(ex_change);
EXPROTO(ex_color);
EXPROTO(ex_copy);
EXPROTO(ex_debug);
EXPROTO(ex_delete);
EXPROTO(ex_digraph);
EXPROTO(ex_display);
EXPROTO(ex_edit);
EXPROTO(ex_equal);
EXPROTO(ex_fg);
EXPROTO(ex_file);
EXPROTO(ex_global);
EXPROTO(ex_help);
EXPROTO(ex_insert);
EXPROTO(ex_join);
EXPROTO(ex_list);
EXPROTO(ex_map);
EXPROTO(ex_mark);
EXPROTO(ex_mkexrc);
EXPROTO(ex_move);
EXPROTO(ex_next);
EXPROTO(ex_number);
EXPROTO(ex_open);
EXPROTO(ex_pr);
EXPROTO(ex_preserve);
EXPROTO(ex_prev);
EXPROTO(ex_put);
EXPROTO(ex_quit);
EXPROTO(ex_read);
EXPROTO(ex_recover);
EXPROTO(ex_resize);
EXPROTO(ex_rew);
EXPROTO(ex_s);
EXPROTO(ex_script);
EXPROTO(ex_set);
EXPROTO(ex_shell);
EXPROTO(ex_shiftl);
EXPROTO(ex_shiftr);
EXPROTO(ex_source);
EXPROTO(ex_split);
EXPROTO(ex_stop);
EXPROTO(ex_subagain);
EXPROTO(ex_subtilde);
EXPROTO(ex_tagpop);
EXPROTO(ex_tagpush);
EXPROTO(ex_tagtop);
EXPROTO(ex_unabbr);
EXPROTO(ex_undo);
EXPROTO(ex_unmap);
EXPROTO(ex_usage);
EXPROTO(ex_v);
EXPROTO(ex_validate);
EXPROTO(ex_version);
EXPROTO(ex_visual);
EXPROTO(ex_viusage);
EXPROTO(ex_wn);
EXPROTO(ex_wq);
EXPROTO(ex_write);
EXPROTO(ex_xit);
EXPROTO(ex_yank);
EXPROTO(ex_z);