diplodocus.org Git - nmh/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 #define NMH_UNUSED(i) (void) i
  36 #else
  37 #define NORETURN
  38 #define NMH_UNUSED(i) i
  39 #endif
  40
  41 /*
  42  * user context/profile structure
  43  */
  44 struct node {
  45     char *n_name;               /* key                  */
  46     char *n_field;              /* value                */
  47     char  n_context;            /* context, not profile */
  48     struct node *n_next;        /* next entry           */
  49 };
  50
  51 /*
  52  * switches structure
  53  */
  54 #define AMBIGSW  (-2)   /* from smatch() on ambiguous switch */
  55 #define UNKWNSW  (-1)   /* from smatch() on unknown switch   */
  56
  57 struct swit {
  58
  59     /*
  60      * Switch name
  61      */
  62
  63     char *sw;
  64
  65     /* The minchars field is apparently used like this:
  66
  67        -# : Switch can be abbreviated to # characters; switch hidden in -help.
  68        0  : Switch can't be abbreviated;               switch shown in -help.
  69        #  : Switch can be abbreviated to # characters; switch shown in -help. */
  70     int minchars;
  71
  72     /*
  73      * If we pick this switch, return this value from smatch
  74      */
  75
  76     int swret;
  77 };
  78
  79 /*
  80  * Macros to use when declaring struct swit arrays.
  81  *
  82  * These macros use a technique known as X-Macros.  In your source code you
  83  * use them like this:
  84  *
  85  * #define FOO_SWITCHES \
  86  *    X("switch1", 0, SWITCHSW) \
  87  *    X("switch2", 0, SWITCH2SW) \
  88  *    X("thirdswitch", 2, SWITCH3SW) \
  89  *
  90  * The argument to each entry in FOO_SWITCHES are the switch name (sw),
  91  * the minchars field (see above) and the return value for this switch.
  92  * Note that the last entry in the above definition must either omit the
  93  * continuation backslash, or be followed by a blank line.  In the nmh
  94  * code the style is to have every line include a backslash and follow
  95  * the SWITCHES macro definition by a blank line.
  96  *
  97  * After you define FOO_SWITCHES, you instantiate it as follows:
  98  *
  99  * #define X(sw, minchars, id) id,
 100  * DEFINE_SWITCH_ENUM(FOO);
 101  * #undef X
 102  *
 103  * #define X(sw, minchars, id) { sw, minchars, id },
 104  * DEFINE_SWITCH_ARRAY(FOO);
 105  * #undef X
 106  *
 107  * DEFINE_SWITCH_ENUM defines an extra enum at the end of the list called
 108  * LEN_FOO.
 109  */
 110
 111 #define DEFINE_SWITCH_ENUM(name) \
 112     enum { \
 113         name ## _SWITCHES \
 114         LEN_ ## name \
 115     }
 116
 117 #define DEFINE_SWITCH_ARRAY(name, array) \
 118     static struct swit array[] = { \
 119         name ## _SWITCHES \
 120         { NULL, 0, 0 } \
 121     }
 122
 123 extern struct swit anoyes[];    /* standard yes/no switches */
 124
 125 #define ATTACHFORMATS 3         /* Number of send attach formats. */
 126
 127 /*
 128  * general folder attributes
 129  */
 130 #define READONLY   (1<<0)       /* No write access to folder    */
 131 #define SEQMOD     (1<<1)       /* folder's sequences modifed   */
 132 #define ALLOW_NEW  (1<<2)       /* allow the "new" sequence     */
 133 #define OTHERS     (1<<3)       /* folder has other files       */
 134 #define MODIFIED   (1<<4)       /* msh in-core folder modified  */
 135
 136 #define FBITS "\020\01READONLY\02SEQMOD\03ALLOW_NEW\04OTHERS\05MODIFIED"
 137
 138 /*
 139  * first free slot for user defined sequences
 140  * and attributes
 141  */
 142 #define FFATTRSLOT  5
 143
 144 /*
 145  * internal messages attributes (sequences)
 146  */
 147 #define EXISTS        (0)       /* exists            */
 148 #define DELETED       (1)       /* deleted           */
 149 #define SELECTED      (2)       /* selected for use  */
 150 #define SELECT_EMPTY  (3)       /* "new" message     */
 151 #define SELECT_UNSEEN (4)       /* inc/show "unseen" */
 152
 153 #define MBITS "\020\01EXISTS\02DELETED\03SELECTED\04NEW\05UNSEEN"
 154
 155 /*
 156  * type for holding the sequence set of a message
 157  */
 158 typedef struct bvector *bvector_t;
 159
 160 bvector_t bvector_create (size_t /* initial size in bits, can be 0 */);
 161 void bvector_copy (bvector_t, bvector_t);
 162 void bvector_free (bvector_t);
 163 void bvector_clear (bvector_t, size_t);
 164 void bvector_clear_all (bvector_t);
 165 void bvector_set (bvector_t, size_t);
 166 unsigned int bvector_at (bvector_t, size_t);
 167 const unsigned long *bvector_bits (bvector_t);
 168 size_t bvector_maxsize (bvector_t);
 169
 170 struct svector;
 171 typedef struct svector *svector_t;
 172
 173 svector_t svector_create (size_t);
 174 void svector_free (svector_t);
 175 char *svector_push_back (svector_t, char *);
 176 char *svector_at (svector_t, size_t);
 177 char **svector_strs (svector_t);
 178 size_t svector_size (svector_t);
 179
 180 struct ivector;
 181 typedef struct ivector *ivector_t;
 182
 183 ivector_t ivector_create (size_t);
 184 void ivector_free (ivector_t);
 185 int ivector_push_back (ivector_t, int);
 186 int ivector_at (ivector_t, size_t);
 187 int *ivector_atp (ivector_t, size_t);
 188 size_t ivector_size (ivector_t);
 189
 190 /*
 191  * Primary structure of folder/message information
 192  */
 193 struct msgs {
 194     int lowmsg;         /* Lowest msg number                 */
 195     int hghmsg;         /* Highest msg number                */
 196     int nummsg;         /* Actual Number of msgs             */
 197
 198     int lowsel;         /* Lowest selected msg number        */
 199     int hghsel;         /* Highest selected msg number       */
 200     int numsel;         /* Number of msgs selected           */
 201
 202     int curmsg;         /* Number of current msg if any      */
 203
 204     int msgflags;       /* Folder attributes (READONLY, etc) */
 205     char *foldpath;     /* Pathname of folder                */
 206
 207     /*
 208      * Name of sequences in this folder.
 209      */
 210     svector_t msgattrs;
 211
 212     /*
 213      * bit flags for whether sequence
 214      * is public (0), or private (1)
 215      */
 216     bvector_t attrstats;
 217
 218     /*
 219      * These represent the lowest and highest possible
 220      * message numbers we can put in the message status
 221      * area, without calling folder_realloc().
 222      */
 223     int lowoff;
 224     int hghoff;
 225
 226     /*
 227      * This is an array of bvector_t which we allocate dynamically.
 228      * Each bvector_t is a set of bits flags for a particular message.
 229      * These bit flags represent general attributes such as
 230      * EXISTS, SELECTED, etc. as well as track if message is
 231      * in a particular sequence.
 232      */
 233     size_t num_msgstats;
 234     bvector_t *msgstats;        /* msg status */
 235
 236     /*
 237      * A FILE handle containing an open filehandle for the sequence file
 238      * for this folder.  If non-NULL, use it when the sequence file is
 239      * written.
 240      */
 241     FILE *seqhandle;
 242
 243     /*
 244      * The name of the public sequence file; required by lkfclose()
 245      */
 246     char *seqname;
 247 };
 248
 249 /*
 250  * Amount of space to allocate for msgstats.  Allocate
 251  * the array to have space for messages numbered lo to hi.
 252  * Use MSGSTATNUM to load mp->num_msgstats first.
 253  */
 254 #define MSGSTATNUM(lo, hi) ((size_t) ((hi) - (lo) + 1))
 255 #define MSGSTATSIZE(mp) ((mp)->num_msgstats * sizeof *(mp)->msgstats)
 256
 257 /*
 258  * macros for message and sequence manipulation
 259  */
 260 #define msgstat(mp,n) (mp)->msgstats[(n) - mp->lowoff]
 261 #define clear_msg_flags(mp,msgnum)   bvector_clear_all (msgstat(mp, msgnum))
 262 #define copy_msg_flags(mp,i,j)       bvector_copy (msgstat(mp,i), msgstat(mp,j))
 263 #define get_msg_flags(mp,ptr,msgnum) bvector_copy (ptr, msgstat(mp, msgnum))
 264 #define set_msg_flags(mp,ptr,msgnum) bvector_copy (msgstat(mp, msgnum), ptr)
 265
 266 #define does_exist(mp,msgnum)     bvector_at (msgstat(mp, msgnum), EXISTS)
 267 #define unset_exists(mp,msgnum)   bvector_clear (msgstat(mp, msgnum), EXISTS)
 268 #define set_exists(mp,msgnum)     bvector_set (msgstat(mp, msgnum), EXISTS)
 269
 270 #define is_selected(mp,msgnum)    bvector_at (msgstat(mp, msgnum), SELECTED)
 271 #define unset_selected(mp,msgnum) bvector_clear (msgstat(mp, msgnum), SELECTED)
 272 #define set_selected(mp,msgnum)   bvector_set (msgstat(mp, msgnum), SELECTED)
 273
 274 #define is_select_empty(mp,msgnum)  \
 275         bvector_at (msgstat(mp, msgnum), SELECT_EMPTY)
 276 #define set_select_empty(mp,msgnum) \
 277         bvector_set (msgstat(mp, msgnum), SELECT_EMPTY)
 278
 279 #define is_unseen(mp,msgnum) \
 280         bvector_at (msgstat(mp, msgnum), SELECT_UNSEEN)
 281 #define unset_unseen(mp,msgnum) \
 282         bvector_clear (msgstat(mp, msgnum), SELECT_UNSEEN)
 283 #define set_unseen(mp,msgnum) \
 284         bvector_set (msgstat(mp, msgnum), SELECT_UNSEEN)
 285
 286 /* for msh only */
 287 #define set_deleted(mp,msgnum)     bvector_set (msgstat(mp, msgnum), DELETED)
 288
 289 #define in_sequence(mp,seqnum,msgnum) \
 290         bvector_at (msgstat(mp, msgnum), FFATTRSLOT + seqnum)
 291 #define clear_sequence(mp,seqnum,msgnum) \
 292         bvector_clear (msgstat(mp, msgnum), FFATTRSLOT + seqnum)
 293 #define add_sequence(mp,seqnum,msgnum) \
 294         bvector_set (msgstat(mp, msgnum), FFATTRSLOT + seqnum)
 295
 296 #define is_seq_private(mp,seqnum) \
 297         bvector_at (mp->attrstats, FFATTRSLOT + seqnum)
 298 #define make_seq_public(mp,seqnum) \
 299         bvector_clear (mp->attrstats, FFATTRSLOT + seqnum)
 300 #define make_seq_private(mp,seqnum) \
 301         bvector_set (mp->attrstats, FFATTRSLOT + seqnum)
 302 #define make_all_public(mp) \
 303         mp->attrstats = bvector_create(0); bvector_clear_all (mp->attrstats)
 304
 305 /*
 306  * macros for folder attributes
 307  */
 308 #define clear_folder_flags(mp) ((mp)->msgflags = 0)
 309
 310 #define is_readonly(mp)     ((mp)->msgflags & READONLY)
 311 #define set_readonly(mp)    ((mp)->msgflags |= READONLY)
 312
 313 #define other_files(mp)     ((mp)->msgflags & OTHERS)
 314 #define set_other_files(mp) ((mp)->msgflags |= OTHERS)
 315
 316 #define NULLMP  ((struct msgs *) 0)
 317
 318 /*
 319  * m_getfld() message parsing
 320  */
 321
 322 #define NAMESZ  999             /* Limit on component name size.
 323                                    RFC 2822 limits line lengths to
 324                                    998 characters, so a header name
 325                                    can be at most that long.
 326                                    m_getfld limits header names to 2
 327                                    less than NAMESZ, which is fine,
 328                                    because header names must be
 329                                    followed by a colon.  Add one for
 330                                    terminating NULL. */
 331
 332 #define LENERR  (-2)            /* Name too long error from getfld  */
 333 #define FMTERR  (-3)            /* Message Format error             */
 334 #define FLD      0              /* Field returned                   */
 335 #define FLDPLUS  1              /* Field returned with more to come */
 336 #define BODY     3              /* Body  returned with more to come */
 337 #define FILEEOF  5              /* Reached end of input file        */
 338
 339 struct m_getfld_state;
 340 typedef struct m_getfld_state *m_getfld_state_t;
 341
 342 /*
 343  * Maildrop styles
 344  */
 345 #define MS_DEFAULT      0       /* default (one msg per file) */
 346 #define MS_UNKNOWN      1       /* type not known yet         */
 347 #define MS_MBOX         2       /* Unix-style "from" lines    */
 348 #define MS_MMDF         3       /* string mmdlm2              */
 349 #define MS_MSH          4       /* whacko msh                 */
 350
 351 #define NOUSE   0               /* draft being re-used */
 352
 353 #define TFOLDER 0               /* path() given a +folder */
 354 #define TFILE   1               /* path() given a file    */
 355 #define TSUBCWF 2               /* path() given a @folder */
 356
 357 #define OUTPUTLINELEN   72      /* default line length for headers */
 358
 359 #define LINK    "@"             /* Name of link to file to which you are */
 360                                 /* replying. */
 361
 362 #define NMH_ATTACH_HEADER "Nmh-Attachment"  /* Default header for -attach */
 363
 364 /*
 365  * credentials management
 366  */
 367 struct nmh_creds {
 368     char *host;
 369     char *user;
 370     char *password;
 371 };
 372
 373 typedef struct nmh_creds *nmh_creds_t;
 374
 375 /*
 376  * miscellaneous macros
 377  */
 378 #define pidXwait(pid,cp) pidstatus (pidwait (pid, NOTOK), stdout, cp)
 379
 380 #ifndef max
 381 # define max(a,b) ((a) > (b) ? (a) : (b))
 382 #endif
 383
 384 #ifndef min
 385 # define min(a,b) ((a) < (b) ? (a) : (b))
 386 #endif
 387
 388 #ifndef abs
 389 # define abs(a) ((a) > 0 ? (a) : -(a))
 390 #endif
 391
 392 /*
 393  * GLOBAL VARIABLES
 394  */
 395 #define CTXMOD  0x01            /* context information modified */
 396 #define DBITS   "\020\01CTXMOD"
 397 extern char ctxflags;
 398
 399 extern char *invo_name;         /* command invocation name         */
 400 extern char *mypath;            /* user's $HOME                    */
 401 extern char *defpath;           /* pathname of user's profile      */
 402 extern char *ctxpath;           /* pathname of user's context      */
 403 extern struct node *m_defs;     /* list of profile/context entries */
 404
 405 /* What style to use for generated Message-ID and Content-ID header
 406    fields.  The localname style is pid.time@localname, where time is
 407    in seconds.  The random style replaces the localname with some
 408    (pseudo)random bytes and uses microsecond-resolution time. */
 409 int save_message_id_style (const char *);
 410 char *message_id (time_t, int);
 411
 412 /*
 413  * These standard strings are defined in config.c.  They are the
 414  * only system-dependent parameters in nmh, and thus by redefining
 415  * their values and reloading the various modules, nmh will run
 416  * on any system.
 417  */
 418 extern char *buildmimeproc;
 419 extern char *catproc;
 420 extern char *components;
 421 extern char *context;
 422 extern char *current;
 423 extern char *credentials_file;
 424 extern char *defaultfolder;
 425 extern char *digestcomps;
 426 extern char *distcomps;
 427 extern char *draft;
 428 extern char *fileproc;
 429 extern char *foldprot;
 430 extern char *formatproc;
 431 extern char *forwcomps;
 432 extern char *inbox;
 433 extern char *incproc;
 434 extern char *lproc;
 435 extern char *mailproc;
 436 extern char *mh_defaults;
 437 extern char *mh_profile;
 438 extern char *mh_seq;
 439 extern char *mhlformat;
 440 extern char *mhlforward;
 441 extern char *mhlproc;
 442 extern char *mhlreply;
 443 extern char *moreproc;
 444 extern char *msgprot;
 445 extern char *mshproc;
 446 extern char *nmhaccessftp;
 447 extern char *nmhaccessurl;
 448 extern char *nmhstorage;
 449 extern char *nmhcache;
 450 extern char *nmhprivcache;
 451 extern char *nsequence;
 452 extern char *packproc;
 453 extern char *postproc;
 454 extern char *pfolder;
 455 extern char *psequence;
 456 extern char *rcvdistcomps;
 457 extern char *rcvstoreproc;
 458 extern char *replcomps;
 459 extern char *replgroupcomps;
 460 extern char *rmmproc;
 461 extern char *sendproc;
 462 extern char *showmimeproc;
 463 extern char *showproc;
 464 extern char *usequence;
 465 extern char *version_num;
 466 extern char *version_str;
 467 extern char *vmhproc;
 468 extern char *whatnowproc;
 469 extern char *whomproc;
 470
 471 extern void (*done) (int) NORETURN;
 472
 473 #include <h/prototypes.h>
 474