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