Improved the patch for send(1) to handle absolute path name arguments.
[mmh] / h / mh.h
1 /*
2 ** mh.h -- main header file for all of nmh
3 */
4
5 #include <h/nmh.h>
6
7 /*
8 ** Well-used constants
9 */
10 #define NOTOK       (-1)    /* syscall()s return this on error */
11 #define OK             0    /*  ditto on success               */
12 #define DONE           1    /* trinary logic                   */
13 #define ALL           ""
14 #define Nbby           8    /* number of bits/byte */
15
16 #define MAXARGS     1000    /* max arguments to exec                */
17 #define NFOLDERS    1000    /* max folder arguments on command line */
18 #define DMAXFOLDER     4    /* typical number of digits             */
19 #define MAXFOLDER   1000    /* message increment                    */
20
21 #ifndef FALSE
22 # define FALSE 0
23 #endif
24 #ifndef TRUE
25 # define TRUE 1
26 #endif
27 typedef unsigned char  boolean;  /* not int so we can pack in a structure */
28
29 /* If we're using gcc then give it some information about
30 ** functions that abort.
31 */
32 #if __GNUC__ > 2
33 # define NORETURN __attribute__((__noreturn__))
34 #else
35 # define NORETURN
36 #endif
37
38 /*
39 ** user context/profile structure
40 */
41 struct node {
42         char *n_name;         /* key                  */
43         char *n_field;        /* value                */
44         char n_context;       /* context, not profile */
45         struct node *n_next;  /* next entry           */
46 };
47
48 /*
49 ** switches structure
50 */
51 #define AMBIGSW  (-2)    /* from smatch() on ambiguous switch */
52 #define UNKWNSW  (-1)    /* from smatch() on unknown switch   */
53
54 struct swit {
55         char *sw;
56         /*
57         ** The minchars field is apparently used like this:
58         **
59         ** -# : Switch can be abbreviated to # chars; switch hidden in -help.
60         ** 0  : Switch can't be abbreviated;          switch shown in -help.
61         ** #  : Switch can be abbreviated to # chars; switch shown in -help.
62         */
63         int minchars;
64 };
65
66 extern struct swit anoyes[];   /* standard yes/no switches */
67
68 /*
69 ** general folder attributes
70 */
71 #define READONLY      (1<<0)    /* No write access to folder    */
72 #define SEQMOD        (1<<1)    /* folder's sequences modifed   */
73 #define ALLOW_BEYOND  (1<<2)    /* allow the beyond sequence    */
74 #define OTHERS        (1<<3)    /* folder has other files       */
75
76 #define FBITS  "\020\01READONLY\02SEQMOD\03ALLOW_BEYOND\04OTHERS"
77
78 /*
79 ** type for holding the sequence set of a message
80 */
81 typedef unsigned int seqset_t;
82
83 /*
84 ** internal messages attributes (sequences)
85 */
86 #define EXISTS        (1<<0)    /* exists            */
87 #define SELECTED      (1<<1)    /* selected for use  */
88 #define SELECT_UNSEEN (1<<2)    /* inc/show "unseen" */
89
90 #define MBITS "\020\01EXISTS\02SELECTED\03UNSEEN"
91
92 /*
93 ** first free slot for user-defined sequences
94 */
95 #define FFATTRSLOT  3
96
97 /*
98 ** Determine the number of user defined sequences we
99 ** can have.  The first few sequence flags are for
100 ** internal nmh message flags.
101 */
102 #define NUMATTRS  ((sizeof(seqset_t) * Nbby) - FFATTRSLOT)
103
104 /*
105 ** Primary structure of folder/message information
106 */
107 struct msgs {
108         int lowmsg;        /* Lowest msg number                 */
109         int hghmsg;        /* Highest msg number                */
110         int nummsg;        /* Actual Number of msgs             */
111
112         int lowsel;        /* Lowest selected msg number        */
113         int hghsel;        /* Highest selected msg number       */
114         int numsel;        /* Number of msgs selected           */
115
116         int curmsg;        /* Number of current msg if any      */
117
118         int msgflags;      /* Folder attributes (READONLY, etc) */
119         char *foldpath;    /* Pathname of folder                */
120
121         /*
122         ** Name of sequences in this folder.  We add an
123         ** extra slot, so we can NULL terminate the list.
124         */
125         char *msgattrs[NUMATTRS + 1];
126
127         /*
128         ** bit flags for whether sequence
129         ** is public (0), or private (1)
130         */
131         seqset_t attrstats;
132
133         /*
134         ** These represent the lowest and highest possible
135         ** message numbers we can put in the message status
136         ** area, without calling folder_realloc().
137         */
138         int    lowoff;
139         int    hghoff;
140
141         /*
142         ** This is an array of seqset_t which we allocate dynamically.
143         ** Each seqset_t is a set of bits flags for a particular message.
144         ** These bit flags represent general attributes such as
145         ** EXISTS, SELECTED, etc. as well as track if message is
146         ** in a particular sequence.
147         */
148         seqset_t *msgstats;        /* msg status */
149 };
150
151 /*
152 ** Amount of space to allocate for msgstats.  Allocate
153 ** the array to have space for messages numbers lo to hi.
154 */
155 #define MSGSTATSIZE(mp,lo,hi) ((size_t) (((hi) - (lo) + 1) * sizeof(*(mp)->msgstats)))
156
157 /*
158 ** macros for message and sequence manipulation
159 */
160 #define clear_msg_flags(mp,msgnum) ((mp)->msgstats[(msgnum) - mp->lowoff] = 0)
161 #define copy_msg_flags(mp,i,j) \
162     ((mp)->msgstats[(i) - mp->lowoff] = (mp)->msgstats[(j) - mp->lowoff])
163 #define get_msg_flags(mp,ptr,msgnum)  (*(ptr) = (mp)->msgstats[(msgnum) - mp->lowoff])
164 #define set_msg_flags(mp,ptr,msgnum)  ((mp)->msgstats[(msgnum) - mp->lowoff] = *(ptr))
165
166 #define does_exist(mp,msgnum)  ((mp)->msgstats[(msgnum) - mp->lowoff] & EXISTS)
167 #define unset_exists(mp,msgnum)  ((mp)->msgstats[(msgnum) - mp->lowoff] &= ~EXISTS)
168 #define set_exists(mp,msgnum)  ((mp)->msgstats[(msgnum) - mp->lowoff] |= EXISTS)
169
170 #define is_selected(mp,msgnum)  ((mp)->msgstats[(msgnum) - mp->lowoff] & SELECTED)
171 #define unset_selected(mp,msgnum)  ((mp)->msgstats[(msgnum) - mp->lowoff] &= ~SELECTED)
172 #define set_selected(mp,msgnum)  ((mp)->msgstats[(msgnum) - mp->lowoff] |= SELECTED)
173
174 #define is_unseen(mp,msgnum)  ((mp)->msgstats[(msgnum) - mp->lowoff] & SELECT_UNSEEN)
175 #define unset_unseen(mp,msgnum)  ((mp)->msgstats[(msgnum) - mp->lowoff] &= ~SELECT_UNSEEN)
176 #define set_unseen(mp,msgnum)  ((mp)->msgstats[(msgnum) - mp->lowoff] |= SELECT_UNSEEN)
177
178
179 #define in_sequence(mp,seqnum,msgnum) \
180            ((mp)->msgstats[(msgnum) - mp->lowoff] & (1 << (FFATTRSLOT + seqnum)))
181 #define clear_sequence(mp,seqnum,msgnum) \
182            ((mp)->msgstats[(msgnum) - mp->lowoff] &= ~(1 << (FFATTRSLOT + seqnum)))
183 #define add_sequence(mp,seqnum,msgnum) \
184            ((mp)->msgstats[(msgnum) - mp->lowoff] |= (1 << (FFATTRSLOT + seqnum)))
185
186 #define is_seq_private(mp,seqnum) \
187            ((mp)->attrstats & (1 << (FFATTRSLOT + seqnum)))
188 #define make_seq_public(mp,seqnum) \
189            ((mp)->attrstats &= ~(1 << (FFATTRSLOT + seqnum)))
190 #define make_seq_private(mp,seqnum) \
191            ((mp)->attrstats |= (1 << (FFATTRSLOT + seqnum)))
192 #define make_all_public(mp) \
193            ((mp)->attrstats = 0)
194
195 /*
196 ** macros for folder attributes
197 */
198 #define clear_folder_flags(mp) ((mp)->msgflags = 0)
199
200 #define is_readonly(mp)  ((mp)->msgflags & READONLY)
201 #define set_readonly(mp)  ((mp)->msgflags |= READONLY)
202
203 #define other_files(mp)  ((mp)->msgflags & OTHERS)
204 #define set_other_files(mp)  ((mp)->msgflags |= OTHERS)
205
206 #define NULLMP  ((struct msgs *) 0)
207
208 /*
209 ** m_getfld() message parsing
210 */
211
212 #define NAMESZ  999        /*
213                            ** Limit on component name size.
214                            ** RFC 2822 limits line lengths to
215                            ** 998 characters, so a header name
216                            ** can be at most that long.
217                            ** m_getfld limits header names to 2
218                            ** less than NAMESZ, which is fine,
219                            ** because header names must be
220                            ** followed by a colon. Add one for
221                            ** terminating NULL.
222                            */
223
224 #define LENERR   (-2)      /* Name too long error from getfld  */
225 #define FMTERR   (-3)      /* Message Format error             */
226 #define FLD      0         /* Field returned                   */
227 #define FLDPLUS  1         /* Field returned with more to come */
228 #define FLDEOF   2         /* Field returned ending at eom     */
229 #define BODY     3         /* Body  returned with more to come */
230 #define BODYEOF  4         /* Body  returned ending at eom     */
231 #define FILEEOF  5         /* Reached end of input file        */
232
233 /*
234 ** Maildrop styles
235 */
236 #define MS_DEFAULT  0    /* default (one msg per file) */
237 #define MS_UNKNOWN  1    /* type not known yet         */
238 #define MS_MBOX     2    /* Unix-style "from" lines    */
239
240 extern int msg_count;        /* m_getfld() indicators */
241 extern int msg_style;        /*  .. */
242 extern char *msg_delim;      /*  .. */
243
244 #define NOUSE    0        /* draft being re-used */
245
246 #define OUTPUTLINELEN  72    /* default line length for headers */
247
248 /*
249 ** miscellaneous macros
250 */
251
252 #define pidXwait(pid,cp) pidstatus(pidwait(pid, NOTOK), stdout, cp)
253
254 #ifndef max
255 # define max(a,b) ((a) > (b) ? (a) : (b))
256 #endif
257
258 #ifndef min
259 # define min(a,b) ((a) < (b) ? (a) : (b))
260 #endif
261
262 #ifndef abs
263 # define abs(a) ((a) > 0 ? (a) : -(a))
264 #endif
265
266 /*
267 ** GLOBAL VARIABLES
268 */
269 #define CTXMOD  0x01        /* context information modified */
270 #define DBITS  "\020\01CTXMOD"
271 extern char ctxflags;
272
273 extern char *invo_name;      /* command invocation name         */
274 extern char *mypath;         /* user's $HOME                    */
275 extern char *mmhdir;
276 extern char *mmhpath;
277 extern char *defpath;        /* pathname of user's profile      */
278 extern char *ctxpath;        /* pathname of user's context      */
279 extern struct node *m_defs;  /* list of profile/context entries */
280 extern char *mailstore;      /* name of mail storage directory  */
281
282 /*
283 ** These standard strings are defined in config.c.  They are the
284 ** only system-dependent parameters in nmh, and thus by redefining
285 ** their values and reloading the various modules, nmh will run
286 ** on any system.
287 */
288 extern char *attach_hdr;
289 extern char *buildmimeproc;
290 extern char *backup_prefix;
291 extern char *altmsglink;
292 extern char *catproc;
293 extern char *components;
294 extern char *context;
295 extern char *curfolder;
296 extern char *defaulteditor;
297 extern char *defaultfolder;
298 extern char *digestcomps;
299 extern char *distcomps;
300 extern char *draftfolder;
301 extern char *fileproc;
302 extern char *foldprot;
303 extern char *forwcomps;
304 extern char *inbox;
305 extern char *incproc;
306 extern char *lproc;
307 extern char *mhetcdir;
308 extern char *mailproc;
309 extern char *mailspool;
310 extern char *mh_seq;
311 extern char *mhlformat;
312 extern char *mhlforward;
313 extern char *mhlproc;
314 extern char *mhlreply;
315 extern char *mimetypequery;
316 extern char *mimetypequeryproc;
317 extern char *moreproc;
318 extern char *msgprot;
319 extern char *nmhaccessftp;
320 extern char *nmhstorage;
321 extern char *nmhcache;
322 extern char *nmhprivcache;
323 extern char *nsequence;
324 extern char *postproc;
325 extern char *profile;
326 extern char *psequence;
327 extern char *rcvdistcomps;
328 extern char *rcvstoreproc;
329 extern char *replcomps;
330 extern char *replgroupcomps;
331 extern char *rmmproc;
332 extern char *sendmail;
333 extern char *sendproc;
334 extern char *seq_all;
335 extern char *seq_beyond;
336 extern char *seq_cur;
337 extern char *seq_first;
338 extern char *seq_last;
339 extern char *seq_next;
340 extern char *seq_prev;
341 extern char *seq_unseen;
342 extern char *seq_neg;
343 extern char *showmimeproc;
344 extern char *showproc;
345 extern char *usequence;
346 extern char *version_num;
347 extern char *version_str;
348 extern char *whatnowproc;
349
350 extern void (*done) (int) NORETURN;
351
352 #include <h/prototypes.h>