git.marmaro.de Git - mmh/blob - h/mh.h

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