diplodocus.org Git - nmh/blob - h/prototypes.h

   1 /* prototypes.h -- various prototypes
   2  *
   3  * If you modify functions here, please document their current behavior
   4  * as much as practical.
   5  */
   6
   7 /*
   8  * prototype from config.h
   9  */
  10 char *etcpath(char *) NONNULL(1);
  11
  12 /*
  13  * prototypes from the nmh subroutine library
  14  */
  15
  16 struct msgs_array;
  17
  18 void add_profile_entry (const char *, const char *);
  19
  20 /*
  21  * Check to see if we can display a given character set natively.
  22  * Arguments include:
  23  *
  24  * str  - Name of character set to check against
  25  * len  - Length of "str"
  26  *
  27  * Returns 1 if the specified character set can be displayed natively,
  28  * 0 otherwise.
  29  */
  30
  31 int check_charset (char *, int);
  32 int client(char *, char *, char *, int, int);
  33 void closefds(int);
  34 char *concat (const char *, ...) ENDNULL;
  35 int context_del (char *);
  36 char *context_find (const char *) PURE;
  37 char *context_find_by_type (const char *, const char *, const char *);
  38 int context_find_prefix(const char *) PURE;
  39 int context_foil (char *);
  40 void context_read (void);
  41 void context_replace (char *, char *);
  42 void context_save (void);
  43 char **copyip (char **, char **, int);
  44 void cpydata (int, int, const char *, const char *);
  45 void cpydgst (int, int, char *, char *);
  46 char *cpytrim (const char *);
  47 char *rtrim (char *);
  48 int decode_rfc2047 (char *, char *, size_t);
  49 void discard (FILE *);
  50
  51 /*
  52  * Decode two characters into their quoted-printable representation.
  53  *
  54  * Arguments are:
  55  *
  56  * byte1        - First character of Q-P representation
  57  * byte2        - Second character of Q-P representation
  58  *
  59  * Returns the decoded value, -1 if the conversion failed.
  60  */
  61 int decode_qp(unsigned char byte1, unsigned char byte2) CONST;
  62
  63 /*
  64  * Encode a message header using RFC 2047 encoding.  If the message contains
  65  * no non-ASCII characters, then leave the header as-is.
  66  *
  67  * Arguments include:
  68  *
  69  * name         - Message header name
  70  * value        - Message header content; must point to allocated memory
  71  *                (may be changed if encoding is necessary)
  72  * encoding     - Encoding type.  May be one of CE_UNKNOWN (function chooses
  73  *                the encoding), CE_BASE64 or CE_QUOTED
  74  * charset      - Charset used for encoding.  If NULL, obtain from system
  75  *                locale.
  76  *
  77  * Returns 0 on success, any other value on failure.
  78  */
  79
  80 int encode_rfc2047(const char *name, char **value, int encoding,
  81                    const char *charset);
  82
  83 void escape_display_name (char *, size_t);
  84 void escape_local_part (char *, size_t);
  85 int ext_hook(char *, char *, char *);
  86 int fdcompare (int, int);
  87 int folder_addmsg (struct msgs **, char *, int, int, int, int, char *);
  88 int folder_delmsgs (struct msgs *, int, int);
  89 void folder_free (struct msgs *);
  90 int folder_pack (struct msgs **, int);
  91
  92 /*
  93  * Read a MH folder structure and return an allocated "struct msgs"
  94  * corresponding to the contents of the folder.
  95  *
  96  * Arguments include:
  97  *
  98  * name         - Name of folder
  99  * lockflag     - If true, write-lock (and keep open) metadata files.
 100  *                See comments for seq_read() for more information.
 101  */
 102 struct msgs *folder_read (char *name, int lockflag);
 103
 104 struct msgs *folder_realloc (struct msgs *, int, int);
 105
 106 /*
 107  * Print null-terminated PROMPT to and flush standard output.  Read answers from
 108  * standard input until one matches an entry in SWITCHES.  When one matches,
 109  * return its swret field.  Return 0 on EOF.
 110  */
 111 int read_switch(const char *PROMPT, const struct swit *SWITCHES);
 112
 113 /*
 114  * If standard input is not a tty, return 1 without printing anything.  Else,
 115  * print null-terminated PROMPT to and flush standard output.  Read answers from
 116  * standard input until one is "yes" or "no", returning 1 for "yes" and 0 for
 117  * "no".  Also return 0 on EOF.
 118  */
 119 int read_yes_or_no_if_tty(const char *PROMPT);
 120
 121 /*
 122  * Print null-terminated PROMPT to and flush standard output.  Read multi-word
 123  * answers from standard input until a first word matches an entry in SWITCHES.
 124  * When one matches, return a pointer to an array of pointers to the words.
 125  * Return NULL on EOF, interrupt, or other error.
 126  */
 127 char **read_switch_multiword(const char *PROMPT, const struct swit *SWITCHES);
 128
 129 /*
 130  * Same as read_switch_multiword but using readline(3) for input.
 131  */
 132 #ifdef READLINE_SUPPORT
 133 char **read_switch_multiword_via_readline (char *, struct swit *);
 134 #endif /* READLINE_SUPPORT */
 135
 136 char **getarguments (char *, int, char **, int);
 137
 138 /*
 139  * Returns the MIME character set indicated by the current locale setting.
 140  * Should be used by routines that want to convert to/from the local
 141  * character set, or if you want to check to see if you can display content
 142  * in the local character set.
 143  */
 144 char *get_charset(void);
 145
 146 /* Return malloc'd copy of str, or of "" if NULL, exit on failure. */
 147 char *getcpy(const char *str);
 148
 149 char *get_default_editor(void);
 150 char *getfolder(int) PURE;
 151
 152 int m_atoi (char *) PURE;
 153 char *m_backup (const char *);
 154 int m_convert (struct msgs *, char *);
 155 char *m_draft (char *, char *, int, int *);
 156
 157 m_getfld_state_t m_getfld_state_init(FILE *iob);
 158 void m_getfld_state_reset (m_getfld_state_t *);
 159 void m_getfld_state_destroy (m_getfld_state_t *);
 160 void m_getfld_track_filepos (m_getfld_state_t *, FILE *);
 161 void m_getfld_track_filepos2(m_getfld_state_t *);
 162 int m_getfld (m_getfld_state_t *, char[NAMESZ], char *, int *, FILE *);
 163 int m_getfld2(m_getfld_state_t *, char[NAMESZ], char *, int *);
 164 int m_gmprot (void) PURE;
 165 char *m_name (int);
 166
 167 void m_unknown(m_getfld_state_t *, FILE *);
 168 void m_unknown2(m_getfld_state_t *);
 169
 170 char *nmh_getpass(const char *);
 171 int pidwait (pid_t, int);
 172 char *r1bindex(char *, int) PURE;
 173 void readconfig (struct node **, FILE *, const char *, int);
 174 int refile (char **, char *);
 175
 176 /*
 177  * Read our credentials file and (optionally) ask the user for anything
 178  * missing.
 179  *
 180  * Arguments:
 181  *
 182  * host         - Hostname (to scan credentials file)
 183  * aname        - Pointer to filled-in username
 184  * apass        - Pointer to filled-in password
 185  * flags        - One or more of RUSERPASS_NO_PROMPT_USER,
 186  *                RUSERPASS_NO_PROMPT_PASSWORD
 187  */
 188 void ruserpass (const char *host, char **aname, char **apass, int flags);
 189 #define RUSERPASS_NO_PROMPT_USER        0x01
 190 #define RUSERPASS_NO_PROMPT_PASSWORD    0x02
 191
 192 int remdir (char *);
 193 void scan_detect_mbox_style (FILE *);
 194 void scan_finished(void);
 195
 196 /*
 197  * Read the sequence files for the folder referenced in the given
 198  * struct msgs and populate the sequence entries in the struct msgs.
 199  *
 200  * Arguments:
 201  *
 202  * mp           - Folder structure to add sequence entries to
 203  * lockflag     - If true, obtain a write lock on the sequence file.
 204  *                Additionally, the sequence file will remain open
 205  *                and a pointer to the filehandle will be stored in
 206  *                folder structure, where it will later be used by
 207  *                seq_save().
 208  *
 209  * Return values:
 210  *     OK       - successfully read the sequence files, or they don't exist
 211  *     NOTOK    - failed to lock sequence file
 212  */
 213 int seq_read (struct msgs * mp, int lockflag);
 214 void seq_save (struct msgs *);
 215 void seq_setcur (struct msgs *, int);
 216 void seq_setprev (struct msgs *);
 217 void seq_setunseen (struct msgs *, int);
 218 int showfile (char **, char *);
 219 int smatch(const char *, const struct swit *) PURE;
 220
 221 /*
 222  * Convert a set of bit flags to printable format.
 223  *
 224  * Arguments:
 225  *
 226  * buffer       - Buffer to output string to.
 227  * size         - Size of buffer in bytes.  Buffer is always NUL terminated.
 228  * flags        - Binary flags to output
 229  * bitfield     - Textual representation of bits to output.  This string
 230  *                is in the following format:
 231  *
 232  *      Option byte 0x01 STRING1 0x02 STRING2 ....
 233  *
 234  * The first byte is an option byte to snprintb().  Currently the only option
 235  * supported is 0x08, which indicates that the flags should be output in
 236  * octal format; if the option byte is any other value, the flags will be
 237  * output in hexadecimal.
 238  *
 239  * After the option bytes are series of text strings, prefixed by the number
 240  * of the bit they correspond to.  For example, the bitfield string:
 241  *
 242  *      "\020\01FLAG1\02FLAG2\03FLAG3\04FLAG4"
 243  *
 244  * will output the following string if "flags" is set to 0x09:
 245  *
 246  *      0x2<FLAG1,FLAG4>
 247  *
 248  * You don't have to use octal in the bitfield string, that's just the
 249  * convention currently used by the nmh code.  The order of flags in the
 250  * bitfield string is not significant, but again, general convention is
 251  * from least significant bit to most significant.
 252  */
 253 char *snprintb (char *buffer, size_t size, unsigned flags, char *bitfield);
 254 int ssequal (const char *, const char *) PURE;
 255 int stringdex (char *, char *) PURE;
 256 char *trimcpy (char *);
 257
 258 int uprf (const char *, const char *) PURE;
 259 int vfgets (FILE *, char **);
 260
 261 /*
 262  * Output the local character set name, but make sure it is suitable for
 263  * 8-bit characters.
 264  */
 265 char *write_charset_8bit (void);
 266
 267
 268 /*
 269  * prototypes for some routines in uip
 270  */
 271 int annotate (char *, char *, char *, bool, bool, int, bool);
 272 void annolist(char *, char *, char *, int);
 273 void annopreserve(int);
 274 int mhl(int, char **);
 275 int mhlsbr(int, char **, FILE *(*)(char *));
 276 int distout (char *, char *, char *);
 277 int sendsbr (char **, int, char *, char *, struct stat *, int, const char *);
 278 int what_now (char *, int, int, char *, char *,
 279         int, struct msgs *, char *, int, char *, int);
 280 int WhatNow(int, char **) NORETURN;
 281
 282 /*
 283  * credentials management
 284  */
 285 void init_credentials_file(void);
 286
 287 /*
 288  * Allocate and return a credentials structure.  The credentials structure
 289  * is now opaque; you need to use accessors to get inside of it.  The
 290  * accessors will only prompt the user for missing fields if they are
 291  * needed.
 292  *
 293  * Arguments:
 294  *
 295  * host - Hostname we're connecting to (used to search credentials file)
 296  * user - Username we are logging in as; can be NULL.
 297  *
 298  * Returns NULL on error, otherwise an allocated nmh_creds structure.
 299  */
 300 nmh_creds_t nmh_get_credentials (const char *host, const char *user);
 301
 302 /*
 303  * Retrieve the user from a nmh_creds structure.  May prompt the user
 304  * if one is not defined.
 305  *
 306  * Arguments:
 307  *
 308  * creds        - Structure from previous nmh_get_credentials() call
 309  *
 310  * Returns NULL on error, otherwise a NUL-terminated string containing
 311  * the username.  Points to allocated memory in the credentials structure
 312  * that is free()d by nmh_free_credentials().
 313  */
 314 const char *nmh_cred_get_user(nmh_creds_t creds);
 315
 316 /*
 317  * Retrieve the password from an nmh_creds structure.  Otherwise identical
 318  * to nmh_cred_get_user().
 319  */
 320 const char *nmh_cred_get_password(nmh_creds_t creds);
 321
 322 /*
 323  * Free an allocated nmh_creds structure.
 324  */
 325 void nmh_credentials_free(nmh_creds_t creds);