3 * mh.h -- main header file for all of nmh
13 #define NOTOK (-1) /* syscall()s return this on error */
14 #define OK 0 /* ditto on success */
15 #define DONE 1 /* trinary logic */
17 #define Nbby 8 /* number of bits/byte */
19 #define MAXARGS 1000 /* max arguments to exec */
20 #define NFOLDERS 1000 /* max folder arguments on command line */
21 #define DMAXFOLDER 4 /* typical number of digits */
22 #define MAXFOLDER 1000 /* message increment */
30 typedef unsigned char boolean; /* not int so we can pack in a structure */
32 /* If we're using gcc then give it some information about
33 * functions that abort.
36 #define NORETURN __attribute__((__noreturn__))
42 * user context/profile structure
45 char *n_name; /* key */
46 char *n_field; /* value */
47 char n_context; /* context, not profile */
48 struct node *n_next; /* next entry */
54 #define AMBIGSW (-2) /* from smatch() on ambiguous switch */
55 #define UNKWNSW (-1) /* from smatch() on unknown switch */
60 /* The minchars field is apparently used like this:
62 -# : Switch can be abbreviated to # characters; switch hidden in -help.
63 0 : Switch can't be abbreviated; switch shown in -help.
64 # : Switch can be abbreviated to # characters; switch shown in -help. */
68 extern struct swit anoyes[]; /* standard yes/no switches */
70 #define ATTACHFORMATS 3 /* Number of send attach formats. */
73 * general folder attributes
75 #define READONLY (1<<0) /* No write access to folder */
76 #define SEQMOD (1<<1) /* folder's sequences modifed */
77 #define ALLOW_NEW (1<<2) /* allow the "new" sequence */
78 #define OTHERS (1<<3) /* folder has other files */
79 #define MODIFIED (1<<4) /* msh in-core folder modified */
81 #define FBITS "\020\01READONLY\02SEQMOD\03ALLOW_NEW\04OTHERS\05MODIFIED"
84 * type for holding the sequence set of a message
86 typedef unsigned int seqset_t;
89 * Determine the number of user defined sequences we
90 * can have. The first 5 sequence flags are for
91 * internal nmh message flags.
93 #define NUMATTRS ((sizeof(seqset_t) * Nbby) - 5)
96 * first free slot for user defined sequences
102 * internal messages attributes (sequences)
104 #define EXISTS (1<<0) /* exists */
105 #define DELETED (1<<1) /* deleted */
106 #define SELECTED (1<<2) /* selected for use */
107 #define SELECT_EMPTY (1<<3) /* "new" message */
108 #define SELECT_UNSEEN (1<<4) /* inc/show "unseen" */
110 #define MBITS "\020\01EXISTS\02DELETED\03SELECTED\04NEW\05UNSEEN"
113 * Primary structure of folder/message information
116 int lowmsg; /* Lowest msg number */
117 int hghmsg; /* Highest msg number */
118 int nummsg; /* Actual Number of msgs */
120 int lowsel; /* Lowest selected msg number */
121 int hghsel; /* Highest selected msg number */
122 int numsel; /* Number of msgs selected */
124 int curmsg; /* Number of current msg if any */
126 int msgflags; /* Folder attributes (READONLY, etc) */
127 char *foldpath; /* Pathname of folder */
130 * Name of sequences in this folder. We add an
131 * extra slot, so we can NULL terminate the list.
133 char *msgattrs[NUMATTRS + 1];
136 * bit flags for whether sequence
137 * is public (0), or private (1)
142 * These represent the lowest and highest possible
143 * message numbers we can put in the message status
144 * area, without calling folder_realloc().
150 * This is an array of seqset_t which we allocate dynamically.
151 * Each seqset_t is a set of bits flags for a particular message.
152 * These bit flags represent general attributes such as
153 * EXISTS, SELECTED, etc. as well as track if message is
154 * in a particular sequence.
156 seqset_t *msgstats; /* msg status */
160 * Amount of space to allocate for msgstats. Allocate
161 * the array to have space for messages numbers lo to hi.
163 #define MSGSTATSIZE(mp,lo,hi) ((size_t) (((hi) - (lo) + 1) * sizeof(*(mp)->msgstats)))
166 * macros for message and sequence manipulation
168 #define clear_msg_flags(mp,msgnum) ((mp)->msgstats[(msgnum) - mp->lowoff] = 0)
169 #define copy_msg_flags(mp,i,j) \
170 ((mp)->msgstats[(i) - mp->lowoff] = (mp)->msgstats[(j) - mp->lowoff])
171 #define get_msg_flags(mp,ptr,msgnum) (*(ptr) = (mp)->msgstats[(msgnum) - mp->lowoff])
172 #define set_msg_flags(mp,ptr,msgnum) ((mp)->msgstats[(msgnum) - mp->lowoff] = *(ptr))
174 #define does_exist(mp,msgnum) ((mp)->msgstats[(msgnum) - mp->lowoff] & EXISTS)
175 #define unset_exists(mp,msgnum) ((mp)->msgstats[(msgnum) - mp->lowoff] &= ~EXISTS)
176 #define set_exists(mp,msgnum) ((mp)->msgstats[(msgnum) - mp->lowoff] |= EXISTS)
178 #define is_selected(mp,msgnum) ((mp)->msgstats[(msgnum) - mp->lowoff] & SELECTED)
179 #define unset_selected(mp,msgnum) ((mp)->msgstats[(msgnum) - mp->lowoff] &= ~SELECTED)
180 #define set_selected(mp,msgnum) ((mp)->msgstats[(msgnum) - mp->lowoff] |= SELECTED)
182 #define is_select_empty(mp,msgnum) ((mp)->msgstats[(msgnum) - mp->lowoff] & SELECT_EMPTY)
183 #define set_select_empty(mp,msgnum) \
184 ((mp)->msgstats[(msgnum) - mp->lowoff] |= SELECT_EMPTY)
186 #define is_unseen(mp,msgnum) ((mp)->msgstats[(msgnum) - mp->lowoff] & SELECT_UNSEEN)
187 #define unset_unseen(mp,msgnum) ((mp)->msgstats[(msgnum) - mp->lowoff] &= ~SELECT_UNSEEN)
188 #define set_unseen(mp,msgnum) ((mp)->msgstats[(msgnum) - mp->lowoff] |= SELECT_UNSEEN)
191 #define set_deleted(mp,msgnum) ((mp)->msgstats[(msgnum) - mp->lowoff] |= DELETED)
193 #define in_sequence(mp,seqnum,msgnum) \
194 ((mp)->msgstats[(msgnum) - mp->lowoff] & (1 << (FFATTRSLOT + seqnum)))
195 #define clear_sequence(mp,seqnum,msgnum) \
196 ((mp)->msgstats[(msgnum) - mp->lowoff] &= ~(1 << (FFATTRSLOT + seqnum)))
197 #define add_sequence(mp,seqnum,msgnum) \
198 ((mp)->msgstats[(msgnum) - mp->lowoff] |= (1 << (FFATTRSLOT + seqnum)))
200 #define is_seq_private(mp,seqnum) \
201 ((mp)->attrstats & (1 << (FFATTRSLOT + seqnum)))
202 #define make_seq_public(mp,seqnum) \
203 ((mp)->attrstats &= ~(1 << (FFATTRSLOT + seqnum)))
204 #define make_seq_private(mp,seqnum) \
205 ((mp)->attrstats |= (1 << (FFATTRSLOT + seqnum)))
206 #define make_all_public(mp) \
207 ((mp)->attrstats = 0)
210 * macros for folder attributes
212 #define clear_folder_flags(mp) ((mp)->msgflags = 0)
214 #define is_readonly(mp) ((mp)->msgflags & READONLY)
215 #define set_readonly(mp) ((mp)->msgflags |= READONLY)
217 #define other_files(mp) ((mp)->msgflags & OTHERS)
218 #define set_other_files(mp) ((mp)->msgflags |= OTHERS)
220 #define NULLMP ((struct msgs *) 0)
223 * m_getfld() message parsing
226 #define NAMESZ 128 /* Limit on component name size */
228 #define LENERR (-2) /* Name too long error from getfld */
229 #define FMTERR (-3) /* Message Format error */
230 #define FLD 0 /* Field returned */
231 #define FLDPLUS 1 /* Field returned with more to come */
232 #define FLDEOF 2 /* Field returned ending at eom */
233 #define BODY 3 /* Body returned with more to come */
234 #define BODYEOF 4 /* Body returned ending at eom */
235 #define FILEEOF 5 /* Reached end of input file */
240 #define MS_DEFAULT 0 /* default (one msg per file) */
241 #define MS_UNKNOWN 1 /* type not known yet */
242 #define MS_MBOX 2 /* Unix-style "from" lines */
243 #define MS_MMDF 3 /* string mmdlm2 */
244 #define MS_MSH 4 /* whacko msh */
246 extern int msg_count; /* m_getfld() indicators */
247 extern int msg_style; /* .. */
248 extern char *msg_delim; /* .. */
250 #define NOUSE 0 /* draft being re-used */
252 #define TFOLDER 0 /* path() given a +folder */
253 #define TFILE 1 /* path() given a file */
254 #define TSUBCWF 2 /* path() given a @folder */
256 #define OUTPUTLINELEN 72 /* default line length for headers */
259 * miscellaneous macros
261 #define pidXwait(pid,cp) pidstatus (pidwait (pid, NOTOK), stdout, cp)
264 # define max(a,b) ((a) > (b) ? (a) : (b))
268 # define min(a,b) ((a) < (b) ? (a) : (b))
272 # define abs(a) ((a) > 0 ? (a) : -(a))
278 #define CTXMOD 0x01 /* context information modified */
279 #define DBITS "\020\01CTXMOD"
280 extern char ctxflags;
282 extern char *invo_name; /* command invocation name */
283 extern char *mypath; /* user's $HOME */
284 extern char *defpath; /* pathname of user's profile */
285 extern char *ctxpath; /* pathname of user's context */
286 extern struct node *m_defs; /* list of profile/context entries */
289 * These standard strings are defined in config.c. They are the
290 * only system-dependent parameters in nmh, and thus by redefining
291 * their values and reloading the various modules, nmh will run
294 extern char *buildmimeproc;
295 extern char *catproc;
296 extern char *components;
297 extern char *context;
298 extern char *current;
299 extern char *defaulteditor;
300 extern char *defaultfolder;
301 extern char *digestcomps;
302 extern char *distcomps;
304 extern char *faceproc;
305 extern char *fileproc;
306 extern char *foldprot;
307 extern char *forwcomps;
309 extern char *incproc;
310 extern char *installproc;
312 extern char *mailproc;
313 extern char *mh_defaults;
314 extern char *mh_profile;
316 extern char *mhlformat;
317 extern char *mhlforward;
318 extern char *mhlproc;
319 extern char *mhlreply;
320 extern char *moreproc;
321 extern char *msgprot;
322 extern char *mshproc;
323 extern char *nmhaccessftp;
324 extern char *nmhstorage;
325 extern char *nmhcache;
326 extern char *nmhprivcache;
327 extern char *nsequence;
328 extern char *packproc;
329 extern char *postproc;
330 extern char *pfolder;
331 extern char *psequence;
332 extern char *rcvdistcomps;
333 extern char *rcvstoreproc;
334 extern char *replcomps;
335 extern char *replgroupcomps;
336 extern char *rmfproc;
337 extern char *rmmproc;
338 extern char *sendproc;
339 extern char *showmimeproc;
340 extern char *showproc;
341 extern char *usequence;
342 extern char *version_num;
343 extern char *version_str;
344 extern char *vmhproc;
345 extern char *whatnowproc;
346 extern char *whomproc;
348 extern void (*done) (int) NORETURN;
350 #include <h/prototypes.h>