Don't lock and write the sequence files until after the searching

[nmh] / h / prototypes.h

diff --git a/h/prototypes.h b/h/prototypes.h
index d10346f3824d2a0e8b8665457c72a00aaaeaa3a4..484bef28648bcc48c578015c437bd631d18418e0 100644 (file)
--- a/h/prototypes.h
+++ b/h/prototypes.h
@@ -2,19 +2,20 @@
 /*
  * prototypes.h -- various prototypes
  *
 /*
  * prototypes.h -- various prototypes
  *

- * $Id$
+ * If you modify functions here, please document their current behavior
+ * as much as practical.

  */
 
 /*
  * missing system prototypes
  */
  */
 
 /*
  * missing system prototypes
  */

-#ifndef HAVE_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));
+#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
 
 /*
 #endif
 
 /*


@@ -25,63 +26,112 @@ char *etcpath(char *);
 /*
  * prototypes from the nmh subroutine library
  */
 /*
  * prototypes from the nmh subroutine library
  */

+
+struct msgs_array;
+

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

+char **argsplit (char *, char **, int *);
+void argsplit_msgarg (struct msgs_array *, char *, char **);
+void argsplit_insert (struct msgs_array *, char *, char **);
+void arglist_free (char *, char **);

 void ambigsw (char *, struct swit *);
 int atooi(char *);
 char **brkstring (char *, char *, char *);
 int check_charset (char *, int);
 void ambigsw (char *, struct swit *);
 int atooi(char *);
 char **brkstring (char *, char *, char *);
 int check_charset (char *, int);

+int client(char *, char *, char *, int, int);

 void closefds(int);
 void closefds(int);

-char *concat (char *, ...);
+char *concat (const char *, ...);

 int context_del (char *);
 char *context_find (char *);
 int context_foil (char *);
 void context_read (void);
 void context_replace (char *, char *);
 void context_save (void);
 int context_del (char *);
 char *context_find (char *);
 int context_foil (char *);
 void context_read (void);
 void context_replace (char *, char *);
 void context_save (void);

-char *copy (char *, char *);
+char *copy (const char *, char *);

 char **copyip (char **, char **, int);
 void cpydata (int, int, char *, char *);
 void cpydgst (int, int, char *, char *);
 char **copyip (char **, char **, int);
 void cpydata (int, int, char *, char *);
 void cpydgst (int, int, char *, char *);

+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);

+void escape_display_name (char *, size_t);
+void escape_local_part (char *, size_t);

 int ext_hook(char *, char *, char *);
 int fdcompare (int, int);
 int folder_addmsg (struct msgs **, char *, int, int, int, int, char *);
 int folder_delmsgs (struct msgs *, int, int);
 void folder_free (struct msgs *);
 int folder_pack (struct msgs **, int);
 int ext_hook(char *, char *, char *);
 int fdcompare (int, int);
 int folder_addmsg (struct msgs **, char *, int, int, int, int, char *);
 int folder_delmsgs (struct msgs *, int, int);
 void folder_free (struct msgs *);
 int folder_pack (struct msgs **, int);

-struct msgs *folder_read (char *);
+
+/*
+ * Read a MH folder structure and return an allocated "struct msgs"
+ * corresponding to the contents of the folder.
+ *
+ * Arguments include:
+ *
+ * name                - Name of folder
+ * lockflag    - If true, write-lock (and keep open) metadata files.
+ *               See comments for seq_read() for more information.
+ */
+struct msgs *folder_read (char *name, int lockflag);
+

 struct msgs *folder_realloc (struct msgs *, int, int);
 int gans (char *, struct swit *);
 char **getans (char *, struct swit *);
 struct msgs *folder_realloc (struct msgs *, int, int);
 int gans (char *, struct swit *);
 char **getans (char *, struct swit *);

+#ifdef READLINE_SUPPORT
+char **getans_via_readline (char *, struct swit *);
+#endif /* READLINE_SUPPORT */

 int getanswer (char *);
 char **getarguments (char *, int, char **, int);
 int getanswer (char *);
 char **getarguments (char *, int, char **, int);

-char *get_charset();
+char *get_charset(void);

 char *getcpy (char *);
 char *getcpy (char *);

+char *get_default_editor(void);

 char *getfolder(int);
 char *getfolder(int);

-int lkclose(int, char*);
-int lkfclose(FILE *, char *);
-FILE *lkfopen(char *, char *);
-int lkopen(char *, int, mode_t);
+/*
+ * Lock open/close routines.
+ *
+ * The lk[f]opendata() functions are designed to open "data" files (anything
+ * not a mail spool file) using the locking mechanism configured for data
+ * files.  The lk[f]openspool() functions are for opening the mail spool
+ * file, which will use the locking algorithm configured for the mail
+ * spool.
+ *
+ * Files opened for reading are locked with a read lock (if possible by
+ * the underlying lock mechanism), files opened for writing are locked
+ * using an exclusive lock.
+ */
+int lkclosedata(int, const char *);
+int lkclosespool(int, const char *);
+int lkfclosedata(FILE *, const char *);
+int lkfclosespool(FILE *, const char *);
+FILE *lkfopendata(const char *, const char *);
+int lkopendata(const char *, int, mode_t);
+FILE *lkfopenspool(const char *, const char *);
+int lkopenspool(const char *, int, mode_t);

 int m_atoi (char *);
 char *m_backup (char *);
 int m_convert (struct msgs *, char *);
 char *m_draft (char *, char *, int, int *);
 int m_atoi (char *);
 char *m_backup (char *);
 int m_convert (struct msgs *, char *);
 char *m_draft (char *, char *, int, int *);

-void m_eomsbr (int (*)(int));
-int m_getfld (int, unsigned char *, unsigned char *, int, FILE *);
+void m_eomsbr (m_getfld_state_t, int (*)(int));
+void m_getfld_state_reset (m_getfld_state_t *);
+void m_getfld_state_destroy (m_getfld_state_t *);
+void m_getfld_track_filepos (m_getfld_state_t *, FILE *);
+int m_getfld (m_getfld_state_t *, char[NAMESZ], char *, int *, FILE *);

 int m_gmprot (void);
 char *m_maildir (char *);
 char *m_mailpath (char *);
 char *m_name (int);
 int m_putenv (char *, char *);
 int m_gmprot (void);
 char *m_maildir (char *);
 char *m_mailpath (char *);
 char *m_name (int);
 int m_putenv (char *, char *);

-char *m_scratch (char *, char *);
-char *m_tmpfil (char *);
-void m_unknown(FILE *);
+int m_rand (unsigned char *, size_t);
+char *m_mktemp(const char *, int *, FILE **);
+char *m_mktemp2(const char *, const char *, int *, FILE **);
+void m_unknown(m_getfld_state_t *, FILE *);

 int makedir (char *);
 int makedir (char *);

+char *message_id (time_t, int);

 char *nmh_getpass(const char *);
 char *norm_charmap(char *);
 char *new_fs (char *, char *, char *);
 char *nmh_getpass(const char *);
 char *norm_charmap(char *);
 char *new_fs (char *, char *, char *);


@@ -91,7 +141,7 @@ int pidwait (pid_t, int);
 int pidstatus (int, FILE *, char *);
 char *pluspath(char *);
 void print_help (char *, struct swit *, int);
 int pidstatus (int, FILE *, char *);
 char *pluspath(char *);
 void print_help (char *, struct swit *, int);

-void print_sw (char *, struct swit *, char *);
+void print_sw (char *, struct swit *, char *, FILE *);

 void print_version (char *);
 void push (void);
 char *pwd (void);
 void print_version (char *);
 void push (void);
 char *pwd (void);


@@ -100,6 +150,10 @@ void readconfig (struct node **, FILE *, char *, int);
 int refile (char **, char *);
 void ruserpass(char *, char **, char **);
 int remdir (char *);
 int refile (char **, char *);
 void ruserpass(char *, char **, char **);
 int remdir (char *);

+void scan_detect_mbox_style (FILE *);
+void scan_finished ();
+void scan_eom_action (int (*)());
+void scan_reset_m_getfld_state ();

 int seq_addmsg (struct msgs *, char *, int, int, int);
 int seq_addsel (struct msgs *, char *, int, int);
 char *seq_bits (struct msgs *);
 int seq_addmsg (struct msgs *, char *, int, int, int);
 int seq_addsel (struct msgs *, char *, int, int);
 char *seq_bits (struct msgs *);


@@ -107,10 +161,24 @@ int seq_delmsg (struct msgs *, char *, int);
 int seq_delsel (struct msgs *, char *, int, int);
 int seq_getnum (struct msgs *, char *);
 char *seq_list (struct msgs *, char *);
 int seq_delsel (struct msgs *, char *, int, int);
 int seq_getnum (struct msgs *, char *);
 char *seq_list (struct msgs *, char *);

-int seq_nameok (unsigned char *);
+int seq_nameok (char *);

 void seq_print (struct msgs *, char *);
 void seq_printall (struct msgs *);
 void seq_print (struct msgs *, char *);
 void seq_printall (struct msgs *);

-void seq_read (struct msgs *);
+
+/*
+ * Read the sequence files for the folder referenced in the given
+ * struct msgs and populate the sequence entries in the struct msgs.
+ *
+ * Arguments:
+ *
+ * mp          - Folder structure to add sequence entries to
+ * lockflag    - If true, obtain a write lock on the sequence file.
+ *               Additionally, the sequence file will remain open
+ *               and a pointer to the filehandle will be stored in
+ *               folder structure, where it will later be used by
+ *               seq_save().
+ */
+void seq_read (struct msgs * mp, int lockflag);

 void seq_save (struct msgs *);
 void seq_setcur (struct msgs *, int);
 void seq_setprev (struct msgs *);
 void seq_save (struct msgs *);
 void seq_setcur (struct msgs *, int);
 void seq_setprev (struct msgs *);


@@ -120,24 +188,12 @@ int smatch(char *, struct swit *);
 char *snprintb (char *, size_t, unsigned, char *);
 int ssequal (char *, char *);
 int stringdex (char *, char *);
 char *snprintb (char *, size_t, unsigned, char *);
 int ssequal (char *, char *);
 int stringdex (char *, char *);

-char *trimcpy (unsigned char *);
+char *trimcpy (char *);

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

-#ifdef RPATHS
-int get_returnpath (char *, int, char *, int);
-#endif
-
-/*
- * prototypes for compatibility functions in library
- */
-#ifndef HAVE_SNPRINTF_PROTOTYPE
-int snprintf (char *, size_t, const char *, ...);
-int vsnprintf (char *, size_t, const char *, va_list);
-#endif
-

 int mh_strcasecmp (const char *s1, const char *s2);
 int strncasecmp (const char *s1, const char *s2, size_t n);
 
 int mh_strcasecmp (const char *s1, const char *s2);
 int strncasecmp (const char *s1, const char *s2, size_t n);
 


@@ -146,9 +202,8 @@ int strncasecmp (const char *s1, const char *s2, size_t n);
  * some prototypes for address parsing system
  * (others are in addrsbr.h)
  */
  * some prototypes for address parsing system
  * (others are in addrsbr.h)
  */

-char *LocalName(void);
+char *LocalName(int);

 char *SystemName(void);
 char *SystemName(void);

-char *OfficialName(char *);

 
 /*
  * prototypes for some routines in uip
 
 /*
  * prototypes for some routines in uip


@@ -156,10 +211,23 @@ char *OfficialName(char *);
 int annotate (char *, char *, char *, int, int, int, int);
 void annolist(char *, char *, char *, int);
 void annopreserve(int);
 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 **);
+int mhlsbr(int, char **, FILE *(*)(char *));

 int distout (char *, char *, char *);
 void replout (FILE *, char *, char *, struct msgs *, int,
 int distout (char *, char *, char *);
 void replout (FILE *, char *, char *, struct msgs *, int,

-       int, char *, char *, char *);
-int sendsbr (char **, int, char *, struct stat *, int, char *, 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 SOprintf (char *, ...);

 int what_now (char *, int, int, char *, char *,
 int what_now (char *, int, int, char *, char *,

-       int, struct msgs *, char *, int, char *);
-
+       int, struct msgs *, char *, int, char *, int);
+int WhatNow(int, char **);
+int writeBase64aux(FILE *, FILE *);
+int writeBase64 (unsigned char *, size_t, unsigned char *);