Sync usage with man page.
[netbsd-mini2440.git] / dist / nvi / common / msg.h
blob40debe5c1cd6d0d430e371faf2ce90208303752a
1 /* $NetBSD$ */
3 /*-
4 * Copyright (c) 1993, 1994
5 * The Regents of the University of California. All rights reserved.
6 * Copyright (c) 1993, 1994, 1995, 1996
7 * Keith Bostic. All rights reserved.
9 * See the LICENSE file for redistribution information.
11 * Id: msg.h,v 10.11 2000/04/21 21:26:19 skimo Exp (Berkeley) Date: 2000/04/21 21:26:19
15 * Common messages (continuation or confirmation).
17 typedef enum {
18 CMSG_CONF, CMSG_CONT, CMSG_CONT_EX,
19 CMSG_CONT_R, CMSG_CONT_S, CMSG_CONT_Q } cmsg_t;
22 * Message types.
24 * !!!
25 * In historical vi, O_VERBOSE didn't exist, and O_TERSE made the error
26 * messages shorter. In this implementation, O_TERSE has no effect and
27 * O_VERBOSE results in informational displays about common errors, for
28 * naive users.
30 * M_NONE Display to the user, no reformatting, no nothing.
32 * M_BERR Error: M_ERR if O_VERBOSE, else bell.
33 * M_ERR Error: Display in inverse video.
34 * M_INFO Info: Display in normal video.
35 * M_SYSERR Error: M_ERR, using strerror(3) message.
36 * M_VINFO Info: M_INFO if O_VERBOSE, else ignore.
38 * The underlying message display routines only need to know about M_NONE,
39 * M_ERR and M_INFO -- all the other message types are converted into one
40 * of them by the message routines.
42 typedef enum {
43 M_NONE = 1, M_BERR, M_ERR, M_INFO, M_SYSERR, M_VINFO, M_DBERR } mtype_t;
46 * There are major problems with error messages being generated by routines
47 * preparing the screen to display error messages. It's possible for the
48 * editor to generate messages before we have a screen in which to display
49 * them, or during the transition between ex (and vi startup) and a true vi.
50 * There's a queue in the global area to hold them.
52 * If SC_EX/SC_VI is set, that's the mode that the editor is in. If the flag
53 * S_SCREEN_READY is set, that means that the screen is prepared to display
54 * messages.
56 typedef struct _msgh MSGH; /* MSGS list head structure. */
57 LIST_HEAD(_msgh, _msg);
58 struct _msg {
59 LIST_ENTRY(_msg) q; /* Linked list of messages. */
60 mtype_t mtype; /* Message type: M_NONE, M_ERR, M_INFO. */
61 char *buf; /* Message buffer. */
62 size_t len; /* Message length. */
65 /* Flags to msgq_status(). */
66 #define MSTAT_SHOWLAST 0x01 /* Show the line number of the last line. */
67 #define MSTAT_TRUNCATE 0x02 /* Truncate the file name if it's too long. */