Annotation of src/usr.bin/mail/def.h, Revision 1.10
1.10 ! millert 1: /* $OpenBSD: def.h,v 1.9 2001/11/21 15:26:39 millert Exp $ */
1.5 millert 2: /* $NetBSD: def.h,v 1.9 1996/12/28 07:11:00 tls Exp $ */
1.9 millert 3:
1.1 deraadt 4: /*
5: * Copyright (c) 1980, 1993
6: * The Regents of the University of California. All rights reserved.
7: *
8: * Redistribution and use in source and binary forms, with or without
9: * modification, are permitted provided that the following conditions
10: * are met:
11: * 1. Redistributions of source code must retain the above copyright
12: * notice, this list of conditions and the following disclaimer.
13: * 2. Redistributions in binary form must reproduce the above copyright
14: * notice, this list of conditions and the following disclaimer in the
15: * documentation and/or other materials provided with the distribution.
16: * 3. All advertising materials mentioning features or use of this software
17: * must display the following acknowledgement:
18: * This product includes software developed by the University of
19: * California, Berkeley and its contributors.
20: * 4. Neither the name of the University nor the names of its contributors
21: * may be used to endorse or promote products derived from this software
22: * without specific prior written permission.
23: *
24: * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25: * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27: * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30: * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32: * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33: * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34: * SUCH DAMAGE.
35: *
1.5 millert 36: * @(#)def.h 8.4 (Berkeley) 4/20/95
1.10 ! millert 37: * $OpenBSD: def.h,v 1.9 2001/11/21 15:26:39 millert Exp $
1.1 deraadt 38: */
39:
40: /*
41: * Mail -- a mail program
42: *
43: * Author: Kurt Shoens (UCB) March 25, 1978
44: */
45:
1.7 millert 46: #ifndef MAIL_DEF_H
47: #define MAIL_DEF_H
48:
1.1 deraadt 49: #include <sys/param.h>
50: #include <sys/stat.h>
51: #include <sys/time.h>
52:
1.5 millert 53: #include <ctype.h>
54: #include <err.h>
1.1 deraadt 55: #include <signal.h>
1.5 millert 56: #include <stdio.h>
57: #include <stdlib.h>
58: #include <string.h>
1.1 deraadt 59: #include <termios.h>
60: #include <unistd.h>
61: #include "pathnames.h"
62:
63: #define APPEND /* New mail goes to end of mailbox */
64:
65: #define ESCAPE '~' /* Default escape for sending */
66: #define NMLSIZE 1024 /* max names in a message list */
67: #define PATHSIZE MAXPATHLEN /* Size of pathnames throughout */
68: #define HSHSIZE 59 /* Hash size for aliases and vars */
69: #define LINESIZE BUFSIZ /* max readable line width */
70: #define STRINGSIZE ((unsigned) 128)/* Dynamic allocation units */
71: #define MAXARGC 1024 /* Maximum list of raw strings */
72: #define MAXEXP 25 /* Maximum expansion of aliases */
73:
74: #define equal(a, b) (strcmp(a,b)==0)/* A nice function to string compare */
75:
76: struct message {
77: short m_flag; /* flags, see below */
1.5 millert 78: int m_offset; /* offset in block of message */
1.4 millert 79: int m_block; /* block number of this message */
80: int m_size; /* Bytes in the message */
81: int m_lines; /* Lines in the message */
1.1 deraadt 82: };
83:
84: /*
85: * flag bits.
86: */
87: #define MUSED (1<<0) /* entry is used, but this bit isn't */
88: #define MDELETED (1<<1) /* entry has been deleted */
89: #define MSAVED (1<<2) /* entry has been saved */
90: #define MTOUCH (1<<3) /* entry has been noticed */
91: #define MPRESERVE (1<<4) /* keep entry in sys mailbox */
92: #define MMARK (1<<5) /* message is marked! */
93: #define MODIFY (1<<6) /* message has been modified */
94: #define MNEW (1<<7) /* message has never been seen */
95: #define MREAD (1<<8) /* message has been read sometime. */
96: #define MSTATUS (1<<9) /* message status has changed */
97: #define MBOX (1<<10) /* Send this to mbox, regardless */
98:
99: /*
100: * Given a file address, determine the block number it represents.
101: */
102: #define blockof(off) ((int) ((off) / 4096))
103: #define offsetof(off) ((int) ((off) % 4096))
104: #define positionof(block, offset) ((off_t)(block) * 4096 + (offset))
105:
106: /*
107: * Format of the command description table.
108: * The actual table is declared and initialized
109: * in lex.c
110: */
111: struct cmd {
112: char *c_name; /* Name of command */
1.7 millert 113: union {
114: int (*c_func0)();
1.10 ! millert 115: int (*c_func1)(void *);
! 116: int (*c_func2)(void *, void *);
1.7 millert 117: } cfunc; /* Implementor of the command */
118: #define c_func cfunc.c_func1
119: #define c_func2 cfunc.c_func2
1.1 deraadt 120: short c_argtype; /* Type of arglist (see below) */
121: short c_msgflag; /* Required flags of messages */
122: short c_msgmask; /* Relevant flags of messages */
123: };
124:
125: /* Yechh, can't initialize unions */
126: #define c_minargs c_msgflag /* Minimum argcount for RAWLIST */
127: #define c_maxargs c_msgmask /* Max argcount for RAWLIST */
128:
129: /*
130: * Argument types.
131: */
1.7 millert 132: #define MSGLIST 0x0001 /* Message list type */
133: #define STRLIST 0x0002 /* A pure string */
134: #define RAWLIST 0x0004 /* Shell string list */
135: #define NOLIST 0x0008 /* Just plain 0 */
136: #define NDMLIST 0x0010 /* Message list, no defaults */
137:
138: #define P 0x0020 /* Autoprint dot after command */
139: #define I 0x0040 /* Interactive command bit */
140: #define M 0x0080 /* Legal from send mode bit */
141: #define W 0x0100 /* Illegal when read only bit */
142: #define F 0x0200 /* Is a conditional command */
143: #define T 0x0400 /* Is a transparent command */
144: #define R 0x0800 /* Cannot be called from collect */
1.1 deraadt 145:
146: /*
147: * Oft-used mask values
148: */
149: #define MMNORM (MDELETED|MSAVED)/* Look at both save and delete bits */
150: #define MMNDEL MDELETED /* Look only at deleted bit */
151:
152: /*
153: * Structure used to return a break down of a head
154: * line (hats off to Bill Joy!)
155: */
156: struct headline {
157: char *l_from; /* The name of the sender */
158: char *l_tty; /* His tty string (if any) */
159: char *l_date; /* The entire date string */
160: };
161:
162: #define GTO 1 /* Grab To: line */
163: #define GSUBJECT 2 /* Likewise, Subject: line */
164: #define GCC 4 /* And the Cc: line */
165: #define GBCC 8 /* And also the Bcc: line */
166: #define GMASK (GTO|GSUBJECT|GCC|GBCC)
167: /* Mask of places from whence */
168:
169: #define GNL 16 /* Print blank line after */
170: #define GDEL 32 /* Entity removed from list */
171: #define GCOMMA 64 /* detract puts in commas */
172:
173: /*
174: * Structure used to pass about the current
175: * state of the user-typed message header.
176: */
177: struct header {
178: struct name *h_to; /* Dynamic "To:" string */
179: char *h_subject; /* Subject string */
180: struct name *h_cc; /* Carbon copies string */
181: struct name *h_bcc; /* Blind carbon copies */
182: struct name *h_smopts; /* Sendmail options */
183: };
184:
185: /*
186: * Structure of namelist nodes used in processing
187: * the recipients of mail and aliases and all that
188: * kind of stuff.
189: */
190: struct name {
191: struct name *n_flink; /* Forward link in list. */
192: struct name *n_blink; /* Backward list link */
193: short n_type; /* From which list it came */
194: char *n_name; /* This fella's name */
195: };
196:
197: /*
198: * Structure of a variable node. All variables are
199: * kept on a singly-linked list of these, rooted by
200: * "variables"
201: */
202:
203: struct var {
204: struct var *v_link; /* Forward link to next variable */
205: char *v_name; /* The variable's name */
206: char *v_value; /* And it's current value */
207: };
208:
209: struct group {
210: struct group *ge_link; /* Next person in this group */
211: char *ge_name; /* This person's user name */
212: };
213:
214: struct grouphead {
215: struct grouphead *g_link; /* Next grouphead in list */
216: char *g_name; /* Name of this group */
217: struct group *g_list; /* Users in group. */
218: };
219:
220: /*
221: * Structure of the hash table of ignored header fields
222: */
223: struct ignoretab {
224: int i_count; /* Number of entries */
225: struct ignore {
226: struct ignore *i_link; /* Next ignored field in bucket */
227: char *i_field; /* This ignored field */
228: } *i_head[HSHSIZE];
229: };
230:
231: /*
232: * Token values returned by the scanner used for argument lists.
233: * Also, sizes of scanner-related things.
234: */
235: #define TEOL 0 /* End of the command line */
236: #define TNUMBER 1 /* A message number */
237: #define TDASH 2 /* A simple dash */
238: #define TSTRING 3 /* A string (possibly containing -) */
239: #define TDOT 4 /* A "." */
240: #define TUP 5 /* An "^" */
241: #define TDOLLAR 6 /* A "$" */
242: #define TSTAR 7 /* A "*" */
243: #define TOPEN 8 /* An '(' */
244: #define TCLOSE 9 /* A ')' */
245: #define TPLUS 10 /* A '+' */
246: #define TERROR 11 /* A lexical error */
247:
248: #define REGDEP 2 /* Maximum regret depth. */
249: #define STRINGLEN 1024 /* Maximum length of string token */
250:
251: /*
1.9 millert 252: * Constants for conditional commands.
253: * These describe whether we should be executing stuff or not.
1.1 deraadt 254: */
255: #define CANY 0 /* Execute in send or receive mode */
256: #define CRCV 1 /* Execute in receive mode only */
257: #define CSEND 2 /* Execute in send mode only */
258:
259: /*
260: * Truncate a file to the last character written. This is
261: * useful just before closing an old file that was opened
262: * for read/write.
263: */
1.9 millert 264: #define trunc(stream) do { \
1.1 deraadt 265: (void)fflush(stream); \
266: (void)ftruncate(fileno(stream), (off_t)ftell(stream)); \
1.9 millert 267: } while(0)
1.7 millert 268:
269: #endif /* MAIL_DEF_H */