git.marmaro.de Git - mmh/blob - 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 #define ATTACHFORMATS 3        /* Number of send attach formats. */
  69
  70 /*
  71 ** general folder attributes
  72 */
  73 #define READONLY      (1<<0)    /* No write access to folder    */
  74 #define SEQMOD        (1<<1)    /* folder's sequences modifed   */
  75 #define ALLOW_BEYOND  (1<<2)    /* allow the beyond sequence    */
  76 #define OTHERS        (1<<3)    /* folder has other files       */
  77
  78 #define FBITS  "\020\01READONLY\02SEQMOD\03ALLOW_BEYOND\04OTHERS"
  79
  80 /*
  81 ** type for holding the sequence set of a message
  82 */
  83 typedef unsigned int seqset_t;
  84
  85 /*
  86 ** internal messages attributes (sequences)
  87 */
  88 #define EXISTS        (1<<0)    /* exists            */
  89 #define SELECTED      (1<<1)    /* selected for use  */
  90 #define SELECT_EMPTY  (1<<2)    /* "new" message     */
  91 #define SELECT_UNSEEN (1<<3)    /* inc/show "unseen" */
  92
  93 #define MBITS "\020\01EXISTS\02SELECTED\03NEW\04UNSEEN"
  94
  95 /*
  96 ** first free slot for user-defined sequences
  97 */
  98 #define FFATTRSLOT  4
  99
 100 /*
 101 ** Determine the number of user defined sequences we
 102 ** can have.  The first few sequence flags are for
 103 ** internal nmh message flags.
 104 */
 105 #define NUMATTRS  ((sizeof(seqset_t) * Nbby) - FFATTRSLOT)
 106
 107 /*
 108 ** Primary structure of folder/message information
 109 */
 110 struct msgs {
 111         int lowmsg;        /* Lowest msg number                 */
 112         int hghmsg;        /* Highest msg number                */
 113         int nummsg;        /* Actual Number of msgs             */
 114
 115         int lowsel;        /* Lowest selected msg number        */
 116         int hghsel;        /* Highest selected msg number       */
 117         int numsel;        /* Number of msgs selected           */
 118
 119         int curmsg;        /* Number of current msg if any      */
 120
 121         int msgflags;      /* Folder attributes (READONLY, etc) */
 122         char *foldpath;    /* Pathname of folder                */
 123
 124         /*
 125         ** Name of sequences in this folder.  We add an
 126         ** extra slot, so we can NULL terminate the list.
 127         */
 128         char *msgattrs[NUMATTRS + 1];
 129
 130         /*
 131         ** bit flags for whether sequence
 132         ** is public (0), or private (1)
 133         */
 134         seqset_t attrstats;
 135
 136         /*
 137         ** These represent the lowest and highest possible
 138         ** message numbers we can put in the message status
 139         ** area, without calling folder_realloc().
 140         */
 141         int    lowoff;
 142         int    hghoff;
 143
 144         /*
 145         ** This is an array of seqset_t which we allocate dynamically.
 146         ** Each seqset_t is a set of bits flags for a particular message.
 147         ** These bit flags represent general attributes such as
 148         ** EXISTS, SELECTED, etc. as well as track if message is
 149         ** in a particular sequence.
 150         */
 151         seqset_t *msgstats;        /* msg status */
 152 };
 153
 154 /*
 155 ** Amount of space to allocate for msgstats.  Allocate
 156 ** the array to have space for messages numbers lo to hi.
 157 */
 158 #define MSGSTATSIZE(mp,lo,hi) ((size_t) (((hi) - (lo) + 1) * sizeof(*(mp)->msgstats)))
 159
 160 /*
 161 ** macros for message and sequence manipulation
 162 */
 163 #define clear_msg_flags(mp,msgnum) ((mp)->msgstats[(msgnum) - mp->lowoff] = 0)
 164 #define copy_msg_flags(mp,i,j) \
 165     ((mp)->msgstats[(i) - mp->lowoff] = (mp)->msgstats[(j) - mp->lowoff])
 166 #define get_msg_flags(mp,ptr,msgnum)  (*(ptr) = (mp)->msgstats[(msgnum) - mp->lowoff])
 167 #define set_msg_flags(mp,ptr,msgnum)  ((mp)->msgstats[(msgnum) - mp->lowoff] = *(ptr))
 168
 169 #define does_exist(mp,msgnum)  ((mp)->msgstats[(msgnum) - mp->lowoff] & EXISTS)
 170 #define unset_exists(mp,msgnum)  ((mp)->msgstats[(msgnum) - mp->lowoff] &= ~EXISTS)
 171 #define set_exists(mp,msgnum)  ((mp)->msgstats[(msgnum) - mp->lowoff] |= EXISTS)
 172
 173 #define is_selected(mp,msgnum)  ((mp)->msgstats[(msgnum) - mp->lowoff] & SELECTED)
 174 #define unset_selected(mp,msgnum)  ((mp)->msgstats[(msgnum) - mp->lowoff] &= ~SELECTED)
 175 #define set_selected(mp,msgnum)  ((mp)->msgstats[(msgnum) - mp->lowoff] |= SELECTED)
 176
 177 #define is_select_empty(mp,msgnum)  ((mp)->msgstats[(msgnum) - mp->lowoff] & SELECT_EMPTY)
 178 #define set_select_empty(mp,msgnum)  ((mp)->msgstats[(msgnum) - mp->lowoff] |= SELECT_EMPTY)
 179
 180 #define is_unseen(mp,msgnum)  ((mp)->msgstats[(msgnum) - mp->lowoff] & SELECT_UNSEEN)
 181 #define unset_unseen(mp,msgnum)  ((mp)->msgstats[(msgnum) - mp->lowoff] &= ~SELECT_UNSEEN)
 182 #define set_unseen(mp,msgnum)  ((mp)->msgstats[(msgnum) - mp->lowoff] |= SELECT_UNSEEN)
 183
 184
 185 #define in_sequence(mp,seqnum,msgnum) \
 186            ((mp)->msgstats[(msgnum) - mp->lowoff] & (1 << (FFATTRSLOT + seqnum)))
 187 #define clear_sequence(mp,seqnum,msgnum) \
 188            ((mp)->msgstats[(msgnum) - mp->lowoff] &= ~(1 << (FFATTRSLOT + seqnum)))
 189 #define add_sequence(mp,seqnum,msgnum) \
 190            ((mp)->msgstats[(msgnum) - mp->lowoff] |= (1 << (FFATTRSLOT + seqnum)))
 191
 192 #define is_seq_private(mp,seqnum) \
 193            ((mp)->attrstats & (1 << (FFATTRSLOT + seqnum)))
 194 #define make_seq_public(mp,seqnum) \
 195            ((mp)->attrstats &= ~(1 << (FFATTRSLOT + seqnum)))
 196 #define make_seq_private(mp,seqnum) \
 197            ((mp)->attrstats |= (1 << (FFATTRSLOT + seqnum)))
 198 #define make_all_public(mp) \
 199            ((mp)->attrstats = 0)
 200
 201 /*
 202 ** macros for folder attributes
 203 */
 204 #define clear_folder_flags(mp) ((mp)->msgflags = 0)
 205
 206 #define is_readonly(mp)  ((mp)->msgflags & READONLY)
 207 #define set_readonly(mp)  ((mp)->msgflags |= READONLY)
 208
 209 #define other_files(mp)  ((mp)->msgflags & OTHERS)
 210 #define set_other_files(mp)  ((mp)->msgflags |= OTHERS)
 211
 212 #define NULLMP  ((struct msgs *) 0)
 213
 214 /*
 215 ** m_getfld() message parsing
 216 */
 217
 218 #define NAMESZ  999        /*
 219                            ** Limit on component name size.
 220                            ** RFC 2822 limits line lengths to
 221                            ** 998 characters, so a header name
 222                            ** can be at most that long.
 223                            ** m_getfld limits header names to 2
 224                            ** less than NAMESZ, which is fine,
 225                            ** because header names must be
 226                            ** followed by a colon. Add one for
 227                            ** terminating NULL.
 228                            */
 229
 230 #define LENERR   (-2)      /* Name too long error from getfld  */
 231 #define FMTERR   (-3)      /* Message Format error             */
 232 #define FLD      0         /* Field returned                   */
 233 #define FLDPLUS  1         /* Field returned with more to come */
 234 #define FLDEOF   2         /* Field returned ending at eom     */
 235 #define BODY     3         /* Body  returned with more to come */
 236 #define BODYEOF  4         /* Body  returned ending at eom     */
 237 #define FILEEOF  5         /* Reached end of input file        */
 238
 239 /*
 240 ** Maildrop styles
 241 */
 242 #define MS_DEFAULT  0    /* default (one msg per file) */
 243 #define MS_UNKNOWN  1    /* type not known yet         */
 244 #define MS_MBOX     2    /* Unix-style "from" lines    */
 245 #define MS_MMDF     3    /* string mmdlm2              */
 246
 247 extern int msg_count;        /* m_getfld() indicators */
 248 extern int msg_style;        /*  .. */
 249 extern char *msg_delim;      /*  .. */
 250
 251 #define NOUSE    0        /* draft being re-used */
 252
 253 #define OUTPUTLINELEN  72    /* default line length for headers */
 254
 255 /*
 256 ** miscellaneous macros
 257 */
 258
 259 #define pidXwait(pid,cp) pidstatus(pidwait(pid, NOTOK), stdout, cp)
 260
 261 #ifndef max
 262 # define max(a,b) ((a) > (b) ? (a) : (b))
 263 #endif
 264
 265 #ifndef min
 266 # define min(a,b) ((a) < (b) ? (a) : (b))
 267 #endif
 268
 269 #ifndef abs
 270 # define abs(a) ((a) > 0 ? (a) : -(a))
 271 #endif
 272
 273 /*
 274 ** GLOBAL VARIABLES
 275 */
 276 #define CTXMOD  0x01        /* context information modified */
 277 #define DBITS  "\020\01CTXMOD"
 278 extern char ctxflags;
 279
 280 extern char *invo_name;      /* command invocation name         */
 281 extern char *mypath;         /* user's $HOME                    */
 282 extern char *mmhdir;
 283 extern char *mmhpath;
 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 */
 287 extern char *mailstore;      /* name of mail storage directory  */
 288
 289 /*
 290 ** These standard strings are defined in config.c.  They are the
 291 ** only system-dependent parameters in nmh, and thus by redefining
 292 ** their values and reloading the various modules, nmh will run
 293 ** on any system.
 294 */
 295 extern char *buildmimeproc;
 296 extern char *backup_prefix;
 297 extern char *altmsglink;
 298 extern char *catproc;
 299 extern char *components;
 300 extern char *context;
 301 extern char *curfolder;
 302 extern char *defaulteditor;
 303 extern char *defaultfolder;
 304 extern char *digestcomps;
 305 extern char *distcomps;
 306 extern char *draftfolder;
 307 extern char *fileproc;
 308 extern char *foldprot;
 309 extern char *forwcomps;
 310 extern char *inbox;
 311 extern char *incproc;
 312 extern char *lproc;
 313 extern char *mhetcdir;
 314 extern char *mailproc;
 315 extern char *mh_seq;
 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 *nmhaccessftp;
 323 extern char *nmhstorage;
 324 extern char *nmhcache;
 325 extern char *nmhprivcache;
 326 extern char *nsequence;
 327 extern char *postproc;
 328 extern char *profile;
 329 extern char *psequence;
 330 extern char *rcvdistcomps;
 331 extern char *rcvstoreproc;
 332 extern char *replcomps;
 333 extern char *replgroupcomps;
 334 extern char *rmmproc;
 335 extern char *sendmail;
 336 extern char *sendproc;
 337 extern char *seq_all;
 338 extern char *seq_beyond;
 339 extern char *seq_cur;
 340 extern char *seq_first;
 341 extern char *seq_last;
 342 extern char *seq_next;
 343 extern char *seq_prev;
 344 extern char *seq_unseen;
 345 extern char *seq_neg;
 346 extern char *showmimeproc;
 347 extern char *showproc;
 348 extern char *usequence;
 349 extern char *version_num;
 350 extern char *version_str;
 351 extern char *whatnowproc;
 352
 353 extern void (*done) (int) NORETURN;
 354
 355 #include <h/prototypes.h>