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