Fix a few warnings.

[nmh] / h / prototypes.h

diff --git a/h/prototypes.h b/h/prototypes.h
index 94be46afbabe258406e93a5ea80586b7e92a9161..3797fecce3d5ce19b5fcf1b263bf332ad352f0dc 100644 (file)
--- a/h/prototypes.h
+++ b/h/prototypes.h
@@ -29,6 +29,7 @@ char *etcpath(char *);
 
 struct msgs_array;
 
 
 struct msgs_array;
 

+void add_profile_entry (const char *, const char *);

 void adios (char *, char *, ...) NORETURN;
 void admonish (char *, char *, ...);
 void advertise (char *, char *, char *, va_list);
 void adios (char *, char *, ...) NORETURN;
 void admonish (char *, char *, ...);
 void advertise (char *, char *, char *, va_list);


@@ -58,6 +59,27 @@ char *cpytrim (const char *);
 int decode_rfc2047 (char *, char *, size_t);
 void discard (FILE *);
 int default_done (int);
 int decode_rfc2047 (char *, char *, size_t);
 void discard (FILE *);
 int default_done (int);

+
+/*
+ * Encode a message header using RFC 2047 encoding.  If the message contains
+ * no non-ASCII characters, then leave the header as-is.
+ *
+ * Arguments include:
+ *
+ * name                - Message header name
+ * value       - Message header content; must point to allocated memory
+ *               (may be changed if encoding is necessary)
+ * encoding    - Encoding type.  May be one of CE_UNKNOWN (function chooses
+ *               the encoding), CE_BASE64 or CE_QUOTED
+ * charset     - Charset used for encoding.  If NULL, obtain from system
+ *               locale.
+ *
+ * Returns 0 on success, any other value on failure.
+ */
+
+int encode_rfc2047(const char *name, char **value, int encoding,
+                  const char *charset);
+

 void escape_display_name (char *, size_t);
 void escape_local_part (char *, size_t);
 int ext_hook(char *, char *, char *);
 void escape_display_name (char *, size_t);
 void escape_local_part (char *, size_t);
 int ext_hook(char *, char *, char *);


@@ -88,7 +110,7 @@ char **getans_via_readline (char *, struct swit *);
 int getanswer (char *);
 char **getarguments (char *, int, char **, int);
 char *get_charset(void);
 int getanswer (char *);
 char **getarguments (char *, int, char **, int);
 char *get_charset(void);

-char *getcpy (char *);
+char *getcpy (const char *);

 char *get_default_editor(void);
 char *getfolder(int);
 /*
 char *get_default_editor(void);
 char *getfolder(int);
 /*


@@ -185,11 +207,61 @@ void seq_setprev (struct msgs *);
 void seq_setunseen (struct msgs *, int);
 int showfile (char **, char *);
 int smatch(char *, struct swit *);
 void seq_setunseen (struct msgs *, int);
 int showfile (char **, char *);
 int smatch(char *, struct swit *);

-char *snprintb (char *, size_t, unsigned, char *);
+
+/*
+ * Convert a set of bit flags to printable format.
+ *
+ * Arguments:
+ *
+ * buffer      - Buffer to output string to.
+ * size                - Size of buffer in bytes.  Buffer is always NUL terminated.
+ * flags       - Binary flags to output
+ * bitfield    - Textual representation of bits to output.  This string
+ *               is in the following format:
+ *
+ *     Option byte 0x01 STRING1 0x02 STRING2 ....
+ *
+ * The first byte is an option byte to snprintb().  Currently the only option
+ * supported is 0x08, which indicates that the flags should be output in
+ * octal format; if the option byte is any other value, the flags will be
+ * output in hexadecimal.
+ *
+ * After the option bytes are series of text strings, prefixed by the number
+ * of the bit they correspond to.  For example, the bitfield string:
+ *
+ *     "\020\01FLAG1\02FLAG2\03FLAG3\04FLAG4"
+ *
+ * will output the following string if "flags" is set to 0x09:
+ *
+ *     0x2<FLAG1,FLAG4>
+ *
+ * You don't have to use octal in the bitfield string, that's just the
+ * convention currently used by the nmh code.  The order of flags in the
+ * bitfield string is not significant, but again, general convention is
+ * from least significant bit to most significant.
+ */
+char *snprintb (char *buffer, size_t size, unsigned flags, char *bitfield);

 int ssequal (char *, char *);
 int stringdex (char *, char *);
 char *trimcpy (char *);
 int unputenv (char *);
 int ssequal (char *, char *);
 int stringdex (char *, char *);
 char *trimcpy (char *);
 int unputenv (char *);

+
+/*
+ * Remove quotes and quoted-pair sequences from RFC-5322 atoms.
+ *
+ * Currently the actual algorithm is simpler than it technically should
+ * be: any quotes are simply eaten, unless they're preceded by the escape
+ * character (\).  This seems to be sufficient for our needs for now.
+ *
+ * Arguments:
+ *
+ * input       - The input string
+ * output      - The output string; is assumed to have at least as much
+ *               room as the input string.  At worst the output string will
+ *               be the same size as the input string; it might be smaller.
+ *
+ */
+void unquote_string(const char *input, char *output);

 int uprf (char *, char *);
 int vfgets (FILE *, char **);
 char *write_charset_8bit (void);
 int uprf (char *, char *);
 int vfgets (FILE *, char **);
 char *write_charset_8bit (void);


@@ -228,6 +300,7 @@ int what_now (char *, int, int, char *, char *,
 int WhatNow(int, char **);
 int writeBase64aux(FILE *, FILE *);
 int writeBase64 (unsigned char *, size_t, unsigned char *);
 int WhatNow(int, char **);
 int writeBase64aux(FILE *, FILE *);
 int writeBase64 (unsigned char *, size_t, unsigned char *);

+int writeBase64raw (unsigned char *, size_t, unsigned char *);

 
 /*
  * credentials management
 
 /*
  * credentials management