pith/help.h

   1 /*
   2  * $Id: help.h 900 2008-01-05 01:13:26Z hubert@u.washington.edu $
   3  *
   4  * ========================================================================
   5  * Copyright 2006-2008 University of Washington
   6  * Copyright 2013-2016 Eduardo Chappa
   7  *
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *     http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * ========================================================================
  15  */
  16
  17 #ifndef PITH_HELP_INCLUDED
  18 #define PITH_HELP_INCLUDED
  19
  20
  21 #include "../pith/state.h"
  22 #include "../pith/filttype.h"
  23 #include "../pith/helptext.h"
  24
  25
  26 #define RMMSGLEN 120
  27 #define RMTIMLEN 15
  28 #define RMJLEN   500
  29 #define RMLLEN   2000
  30 #define RMHLEN   2000
  31
  32 typedef struct _rev_msg {
  33     unsigned long    seq;
  34     short            level;     /* -1 for journal, debuglevel for dprint */
  35     unsigned         continuation:1;
  36     char             message[RMMSGLEN+1];
  37     char             timestamp[RMTIMLEN+1];
  38 } REV_MSG_S;
  39
  40
  41 typedef enum {No, Jo, Lo, Hi} RMCat;
  42
  43 extern REV_MSG_S rmjoarray[RMJLEN];     /* For regular journal */
  44 extern REV_MSG_S rmloarray[RMLLEN];     /* debug 0-4 */
  45 extern REV_MSG_S rmhiarray[RMHLEN];     /* debug 5-9 */
  46 extern int       rmjofirst, rmjolast;
  47 extern int       rmlofirst, rmlolast;
  48 extern int       rmhifirst, rmhilast;
  49 extern int       rm_not_right_now;
  50
  51
  52 /* exported protoypes */
  53 HelpType    help_name2section(char *, int);
  54 void        debugjournal_to_file(FILE *);
  55 void        add_review_message(char *, int);
  56 int         gripe_gripe_to(char *);
  57 char       *get_alpine_revision_string(char *, size_t);
  58 char       *get_alpine_revision_number(char *, size_t);
  59
  60
  61 #endif /* PITH_HELP_INCLUDED */