]> diplodocus.org Git - nmh/blobdiff - h/prototypes.h
Document and distribute mhshow.marker
[nmh] / h / prototypes.h
index b1a53cde469dbd21708daa508cc0142bd50038f4..7a4f8a382ed9bfa91cb4950a77d8df55cd99dfaf 100644 (file)
@@ -6,18 +6,6 @@
  * as much as practical.
  */
 
-/*
- * missing system prototypes
- */
-#if ! defined(HAVE_TERMCAP_H) && ! defined (HAVE_NCURSES_TERMCAP_H)
-  extern int tgetent (char *bp, char *name);
-  extern int tgetnum (char *id);
-  extern int tgetflag (char *id);
-  extern char *tgetstr (char *id, char **area);
-  extern char *tgoto (char *cm, int destcol, int destline);
-  extern int tputs (char *cp, int affcnt, int (*outc) (int));
-#endif
-
 /*
  * prototype from config.h
  */
@@ -58,7 +46,42 @@ void cpydgst (int, int, char *, char *);
 char *cpytrim (const char *);
 int decode_rfc2047 (char *, char *, size_t);
 void discard (FILE *);
+char *upcase (const char *);
+
+/*
+ * Decode two characters into their quoted-printable representation.
+ *
+ * Arguments are:
+ *
+ * byte1       - First character of Q-P representation
+ * byte2       - Second character of Q-P representation
+ *
+ * Returns the decoded value, -1 if the conversion failed.
+ */
+int decode_qp(unsigned char byte1, unsigned char byte2);
+
 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 *);
@@ -92,6 +115,58 @@ char *get_charset(void);
 char *getcpy (const char *);
 char *get_default_editor(void);
 char *getfolder(int);
+
+/*
+ * Get a string from the terminfo database for the current terminal.
+ *
+ * Retrieve the specified terminfo capability and return a string that
+ * can be output to the terminal.  The string returned has already been
+ * processed by tputs(), so it is safe to output directly.  The return
+ * value of this function is valid until the next call.
+ *
+ * Arguments:
+ *
+ * capability  - The name of the terminfo capability (see terminfo(5)).
+ *
+ * Returns a tputs-processed string, or NULL if terminal initialization failed
+ * or the capability wasn't found.
+ */
+char *get_term_stringcap(char *capability);
+
+/*
+ * Get a parameterized string from the terminfo database for the current
+ * terminal.
+ *
+ * We don't yet have a standardized tparm() that will take a stdarg
+ * argument.  Right now we don't want many parameters, so we only
+ * take two.  Everything gets passed to tparm() as-is.  If we need
+ * a capability with more arguments, we'll just add more later.
+ *
+ * Arguments:
+ *
+ * capability  - The name of the terminfo capability (see terminfo(5)).
+ * arg1..argN  - Arguments 1-N.
+ *
+ * Returns a tparm and tputs-processed string, or NULL if there was a problem
+ * initializating the terminal or retrieving the capability.
+ */
+char *get_term_stringparm(char *capability, long arg1, long arg2);
+
+/*
+ * Get a number from the terminfo database for the current terminal.
+ *
+ * Retrieve the specified terminfo capability and return the numeric
+ * value of that capability from the terminfo database.
+ *
+ * Arguments:
+ *
+ * capability  - The name of the terminfo capability (see terminfo(5)).
+ *
+ * Returns the output of tigetnum() for that capability, or -1 if it was
+ * unable to initialize the terminfo database.
+ */
+int get_term_numcap(char *capability);
+
 /*
  * Lock open/close routines.
  *
@@ -130,9 +205,53 @@ int m_putenv (char *, char *);
 int m_rand (unsigned char *, size_t);
 char *m_mktemp(const char *, int *, FILE **);
 char *m_mktemp2(const char *, const char *, int *, FILE **);
+char *m_mktemps(const char *pfx, const char *suffix, int *, FILE **);
+char *get_temp_dir();
+
+/*
+ * Create a subprocess and redirect our standard output to it.
+ *
+ * Arguments are:
+ *
+ * name                - Name of process to create
+ * savestdout  - If true, will save the current stdout file descriptor and
+ *               m_pclose() will close it at the appropriate time.
+ */
+void m_popen(char *name, int savestdout);
+
+/*
+ * Wait for the last process opened by m_popen().
+ */
+void m_pclose(void);
+
 void m_unknown(m_getfld_state_t *, FILE *);
 int makedir (char *);
 char *message_id (time_t, int);
+
+/*
+ * Return a MIME content-type string for the specified file.
+ *
+ * If the system supports it, will use the "file" command to determine
+ * the appropriate content-type.  Otherwise it will try to determine the
+ * content-type from the suffix.  If that fails, the file will be scanned
+ * and either assigned a MIME type of text/plain or application/octet-stream
+ * depending if binary content is present.
+ *
+ * Arguments:
+ *
+ * filename    - The name of the file to determine the MIME type of.
+ *
+ * Returns a pointer to a content-type string (which may include MIME
+ * parameters, such as charset).  Returns a NULL if it cannot determine
+ * the MIME type of the file.  Returns allocated storage that must be
+ * free'd.
+ */
+char *mime_type(const char *filename);
+
+/*
+ * Clear the screen, using the appropriate entry from the terminfo database
+ */
+void nmh_clear_screen(void);
 char *nmh_getpass(const char *);
 char *norm_charmap(char *);
 char *new_fs (char *, char *, char *);
@@ -224,6 +343,23 @@ 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);
@@ -242,7 +378,6 @@ char *SystemName(void);
 int annotate (char *, char *, char *, int, int, int, int);
 void annolist(char *, char *, char *, int);
 void annopreserve(int);
-void clear_screen(void);
 void m_pclose(void);
 int make_intermediates(char *);
 int mhl(int, char **);
@@ -250,21 +385,41 @@ int mhlsbr(int, char **, FILE *(*)(char *));
 int distout (char *, char *, char *);
 void replout (FILE *, char *, char *, struct msgs *, int,
        int, char *, char *, char *, int);
-int sc_hardcopy(void);
 int sc_length(void);
 int sc_width(void);
 int build_form (char *, char *, int *, char *, char *, char *, char *,
                char *, char *);
-int sendsbr (char **, int, char *, char *, struct stat *, int, char *, int);
+int sendsbr (char **, int, char *, char *, struct stat *, int);
 int SOprintf (char *, ...);
 int what_now (char *, int, int, char *, char *,
        int, struct msgs *, char *, int, char *, int);
 int WhatNow(int, char **);
-int writeBase64aux(FILE *, FILE *);
+
+/*
+ * Copy data from one file to another, converting to base64-encoding.
+ *
+ * Arguments include:
+ *
+ * in          - Input filehandle (unencoded data)
+ * out         - Output filename (base64-encoded data)
+ * crlf                - If set, output encoded CRLF for every LF on input.
+ *
+ * Returns OK on success, NOTOK otherwise.
+ */
+int writeBase64aux(FILE *in, FILE *out, int crlf);
+
 int writeBase64 (unsigned char *, size_t, unsigned char *);
+int writeBase64raw (unsigned char *, size_t, unsigned char *);
 
 /*
  * credentials management
  */
 void init_credentials_file ();
 int nmh_get_credentials (char *, char *, int, nmh_creds_t);
+
+/*
+ * temporary file management
+ */
+int nmh_init(const char *argv0, int read_context);
+int m_unlink(const char *);
+void unregister_for_removal(int remove_files);