Convert-UUlib/uulib/uuint.h

/*
 * This file is part of uudeview, the simple and friendly multi-part multi-
 * file uudecoder  program  (c) 1994-2001 by Frank Pilhofer. The author may
 * be contacted at fp@fpx.de
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 */

#ifndef __UUINT_H__
#define __UUINT_H__

/*
 * This file describes the internal structures, variables and definitions
 * of UUDeview. It should not be included from other packages. Subject to
 * change without notice. Do not depend on anything here.
 *
 * $Id$
 */

/*
 * Busy Polls will be made after processing ... lines
 */

#define BUSY_LINE_TICKS         50

/*
 * States of MIME scanner
 */

#define MS_HEADERS      1       /* still inside of headers      */
#define MS_BODY         2       /* body of `simple' messages    */
#define MS_PREAMBLE     3       /* preamble of Multipart/Mixed  */
#define MS_SUBPART      4       /* within one of the Multiparts */
#define MS_EPILOGUE     5       /* epilogue of Multipart/Mixed  */

/*
 * Number of subsequent encoded lines we require to believe this
 * is valid data.
 */

#define ELC_COUNT       4

/*
 * Flags a part may have. FL_PROPER means that we are sure about the file's
 * encoding, beginning and end, and don't have to use special care when de-
 * coding.
 */

#define FL_NONE         0       /* no flag, just plain normal   */
#define FL_SINGLE       1       /* standalone MSG, do not mix   */
#define FL_PARTIAL      2       /* from Message/Partial         */
#define FL_PROPER       4       /* proper MIME part             */
#define FL_TOEND        8       /* part continues to EOF        */

/*
 * Auxiliary macro: compute the percentage of a against b.
 * The obvious answer is (100*a)/b, but this overflows for large a.
 * a/(b/100) is better; we use a/((b/100)+1) so that we don't divide
 * by zero for b<100 and the result doesn't become larger than 100%
 */

#define UUPERCENT(a,b)  ((int) ((unsigned long)(a) / \
                                (((unsigned long)(b)/100)+1)))
     
/*
 * Make the Busy Callback easier. The macro returns true if the BusyCallback
 * wants us to terminate.
 */

extern unsigned long uuyctr;
#define UUBUSYPOLL(a,b) (((++uuyctr%BUSY_LINE_TICKS)==0) ? (progress.percent=UUPERCENT((a),(b)),UUBusyPoll()):0)

/*
 * How many lines of headers do we need to believe another mail
 * header is approaching? Use more restrictive values for MIME
 * mails, less restrictive for Freestyle
 */

typedef struct {
  int restart;          /* restarting after a MIME body (not subpart) */
  int afterdata;        /* after we had useful data in freestyle mode */
  int afternl;          /* after an empty line in freestyle mode      */
} headercount;

extern headercount hlcount;

/*
 * Information from the headers of a message. Each instance must
 * have its very own copy of the strings. If `mimevers' is NULL,
 * then this message does not comply to the MIME standard.
 */

typedef struct _headers {
  char *from;           /* From:                                          */
  char *subject;        /* Subject:                                       */
  char *rcpt;           /* To:                                            */
  char *date;           /* Date:                                          */
  char *mimevers;       /* MIME-Version:                                  */
  char *ctype;          /* Content-Type:                                  */
  char *ctenc;          /* Content-Transfer-Encoding:                     */
  char *fname;          /* Potential Filename from Content-Type Parameter */
  char *boundary;       /* MIME-Boundary from Content-Type Parameter      */
  char *mimeid;         /* MIME-Id for Message/Partial                    */
  int partno;           /* part number for Message/Partial                */
  int numparts;         /* number of parts for Message/Partial            */
} headers;

/*
 * Scanner state
 */

typedef struct _scanstate {
  int isfolder;         /* if we think this is a valid email folder       */
  int ismime;           /* if we are within a valid MIME message          */
  int mimestate;        /* state of MIME scanner                          */
  int mimeenc;          /* encoding of this MIME file                     */
  char *source;         /* source filename                                */
  headers envelope;     /* mail envelope headers                          */
} scanstate;

/*
 * Structure that holds the information for a single file / part of
 * a file. If a subject line is encountered, it is copied to subject;
 * if a begin is found, the mode and name of the file is extracted.
 * flags are set if 'begin' or 'end' is detected and 'uudet' if valid
 * uuencoded data is found. If the file contains a 'From:' line with
 * a '@' in it (indicating an origin email address), it is preserved
 * in 'origin'.
 **/

typedef struct _fileread {
  char *subject;        /* Whole subject line */
  char *filename;       /* Only filled in if begin detected */
  char *origin;         /* Whole 'From:' line */
  char *mimeid;         /* the ID for Mime-encoded files */
  char *mimetype;       /* Content-Type */
  short mode;           /* Mode of File (from 'begin') */
  int   begin;          /* begin detected */
  int   end;            /* end detected */
  int   flags;          /* associated flags */

  short uudet;          /* valid encoded data. value indicates encoding */
  short partno;         /* Mime-files have a part number within */
  short maxpno;         /* ... plus the total number of parts   */

  char *sfname;         /* Associated source file */
  long startpos;        /* ftell() position where data starts */
  long length;          /* length of data */
} fileread;

/*
 * Structure for holding one part of a file, with some more information
 * about it. The UUPreProcessPart() function takes one a fileread structure
 * and produces this uufile structure.
 * Linked List, ordered by partno.
 **/

typedef struct _uufile {
  char     *filename;
  char     *subfname;
  char     *mimeid;
  char     *mimetype;
  short     partno;
  fileread *data;
  struct _uufile *NEXT;
} uufile;

extern void *uu_MsgCBArg;
extern void *uu_BusyCBArg;
extern void *uu_FileCBArg;
extern void *uu_FFCBArg;
extern void *uu_FNCBArg;

/*
 * variables
 */

extern int uu_rbuf;
extern int uu_wbuf;
#define UUSETBUF(fp,buff,size) if (size) setvbuf ((fp), ((buff) = malloc (size)), _IOFBF, (size))
#define UUCLRBUF(size,buff) if (size) free (buff)

extern int uu_fast_scanning;
extern int uu_bracket_policy;
extern int uu_verbose;
extern int uu_desperate;
extern int uu_ignreply;
extern int uu_debug;
extern int uu_errno;
extern int uu_dumbness;
extern int uu_overwrite;
extern int uu_ignmode;
extern int uu_headercount;
extern int uu_usepreamble;
extern int uu_handletext;
extern int uu_tinyb64;
extern int uu_remove_input;
extern int uu_more_mime;
extern int uu_dotdot;

extern char *uusavepath;
extern char *uuencodeext;

/*
 * Encoding/Decoding tables
 */

extern unsigned char UUEncodeTable[];
extern unsigned char XXEncodeTable[];
extern unsigned char B64EncodeTable[];
extern unsigned char BHEncodeTable[];

/*
 * String tables from uustring.c
 */

extern char *msgnames[];
extern char *codenames[];
extern char *uuretcodes[];

extern uulist *UUGlobalFileList;

/*
 * State of MIME variables and current progress
 */

extern int nofnum, mssdepth;
extern int mimseqno, lastvalid;
extern int lastenc;
extern scanstate  multistack[];
extern headers    localenv;
extern scanstate  sstate;
extern uuprogress progress;

/*
 * mallocable areas
 */

extern char *uugen_fnbuffer, *uugen_inbuffer;
extern char *uucheck_lastname, *uucheck_tempname;
extern char *uuestr_itemp, *uuestr_otemp;
extern char *uulib_msgstring, *uuncdl_fulline;
extern char *uuncdp_oline, *uuscan_shlline, *uuscan_shlline2;
extern char *uuscan_pvvalue, *uuscan_phtext;
extern char *uuscan_sdline, *uuscan_sdbhds1;
extern char *uuscan_sdbhds2, *uuscan_spline;
extern char *uuutil_bhwtmp;
extern char *uunconc_UUxlat, *uunconc_UUxlen;
extern char *uunconc_B64xlat, *uunconc_XXxlat;
extern char *uunconc_BHxlat, *uunconc_save;

#ifdef __cplusplus
extern "C" {
#endif

extern void   (*uu_MsgCallback)     (void *, char *, int);
extern int    (*uu_BusyCallback)    (void *, uuprogress *);
extern int    (*uu_FileCallback)    (void *, char *, char *, int);
extern char * (*uu_FNameFilter)     (void *, char *);
extern char * (*uu_FileNameCallback)(void *, char *, char *);

/*
 * Functions from uulib.c that aren't defined in <uudeview.h>
 * Be careful about the definition with variable arguments.
 */

#if defined(STDC_HEADERS) || defined(HAVE_STDARG_H)
int             UUMessage               (char *, int, int, char *, ...);
#else
int             UUMessage               ();
#endif
int             UUBusyPoll              (void);

/*
 * Functions from uucheck.c
 */

uufile *        UUPreProcessPart        (fileread *, int *);
int             UUInsertPartToList      (uufile *);
uulist *        UUCheckGlobalList       (void);

/*
 * Functions from uuutil.c
 */

void            UUkillfread             (fileread *);
void            UUkillfile              (uufile *);
void            UUkilllist              (uulist *);
void            UUkillheaders           (headers *);

fileread *      ScanPart                (FILE *, char *, int *);

int             UUbhdecomp              (char *, char *,
                                         char *, int *,
                                         size_t, size_t, 
                                         size_t *);
size_t          UUbhwrite               (char *, size_t, size_t, FILE *);

/*
 * Functions from uunconc.c
 */

int             UURepairData            (FILE *, char *, int, int *);

void            UUInitConc              _ANSI_ARGS_((void));
int             UUValidData             _ANSI_ARGS_((char *, int, int *));
size_t          UUDecodeLine            _ANSI_ARGS_((char *, char *, int));
int             UUDecodeField           _ANSI_ARGS_((char *, char *, int));
int             UUDecodePart            _ANSI_ARGS_((FILE *, FILE *, int *,
                                                     long, int, int, char *));
int             UUDecode                _ANSI_ARGS_((uulist *));

/*
 * Message retrieval from uustring.c
 */

char *          uustring                (int);

/*
 * From uuscan.c
 */

int             UUScanHeader            (FILE *, headers *);

#ifdef __cplusplus
}
#endif
#endif
Revision:	1.7
Committed:	Mon May 2 19:58:40 2005 UTC (19 years, 1 month ago) by root
Content type:	text/plain
Branch:	MAIN
CVS Tags:	rel-1_11, rel-1_10, rel-0_7, rel-1_06, rel-1_08, rel-1_09
Changes since 1.6:	+5 -0 lines
Log Message:	* empty log message *
#	Content
1	/*
2	* This file is part of uudeview, the simple and friendly multi-part multi-
3	* file uudecoder program (c) 1994-2001 by Frank Pilhofer. The author may
4	* be contacted at fp@fpx.de
5	*
6	* This program is free software; you can redistribute it and/or modify
7	* it under the terms of the GNU General Public License as published by
8	* the Free Software Foundation; either version 2 of the License, or
9	* (at your option) any later version.
10	*
11	* This program is distributed in the hope that it will be useful,
12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14	* GNU General Public License for more details.
15	*/
16
17	#ifndef __UUINT_H__
18	#define __UUINT_H__
19
20	/*
21	* This file describes the internal structures, variables and definitions
22	* of UUDeview. It should not be included from other packages. Subject to
23	* change without notice. Do not depend on anything here.
24	*
25	* $Id$
26	*/
27
28	/*
29	* Busy Polls will be made after processing ... lines
30	*/
31
32	#define BUSY_LINE_TICKS 50
33
34	/*
35	* States of MIME scanner
36	*/
37
38	#define MS_HEADERS 1 /* still inside of headers */
39	#define MS_BODY 2 /* body of `simple' messages */
40	#define MS_PREAMBLE 3 /* preamble of Multipart/Mixed */
41	#define MS_SUBPART 4 /* within one of the Multiparts */
42	#define MS_EPILOGUE 5 /* epilogue of Multipart/Mixed */
43
44	/*
45	* Number of subsequent encoded lines we require to believe this
46	* is valid data.
47	*/
48
49	#define ELC_COUNT 4
50
51	/*
52	* Flags a part may have. FL_PROPER means that we are sure about the file's
53	* encoding, beginning and end, and don't have to use special care when de-
54	* coding.
55	*/
56
57	#define FL_NONE 0 /* no flag, just plain normal */
58	#define FL_SINGLE 1 /* standalone MSG, do not mix */
59	#define FL_PARTIAL 2 /* from Message/Partial */
60	#define FL_PROPER 4 /* proper MIME part */
61	#define FL_TOEND 8 /* part continues to EOF */
62
63	/*
64	* Auxiliary macro: compute the percentage of a against b.
65	* The obvious answer is (100*a)/b, but this overflows for large a.
66	* a/(b/100) is better; we use a/((b/100)+1) so that we don't divide
67	* by zero for b<100 and the result doesn't become larger than 100%
68	*/
69
70	#define UUPERCENT(a,b) ((int) ((unsigned long)(a) / \
71	(((unsigned long)(b)/100)+1)))
72
73	/*
74	* Make the Busy Callback easier. The macro returns true if the BusyCallback
75	* wants us to terminate.
76	*/
77
78	extern unsigned long uuyctr;
79	#define UUBUSYPOLL(a,b) (((++uuyctr%BUSY_LINE_TICKS)==0) ? (progress.percent=UUPERCENT((a),(b)),UUBusyPoll()):0)
80
81	/*
82	* How many lines of headers do we need to believe another mail
83	* header is approaching? Use more restrictive values for MIME
84	* mails, less restrictive for Freestyle
85	*/
86
87	typedef struct {
88	int restart; /* restarting after a MIME body (not subpart) */
89	int afterdata; /* after we had useful data in freestyle mode */
90	int afternl; /* after an empty line in freestyle mode */
91	} headercount;
92
93	extern headercount hlcount;
94
95	/*
96	* Information from the headers of a message. Each instance must
97	* have its very own copy of the strings. If `mimevers' is NULL,
98	* then this message does not comply to the MIME standard.
99	*/
100
101	typedef struct _headers {
102	char from; / From: */
103	char subject; / Subject: */
104	char rcpt; / To: */
105	char date; / Date: */
106	char mimevers; / MIME-Version: */
107	char ctype; / Content-Type: */
108	char ctenc; / Content-Transfer-Encoding: */
109	char fname; / Potential Filename from Content-Type Parameter */
110	char boundary; / MIME-Boundary from Content-Type Parameter */
111	char mimeid; / MIME-Id for Message/Partial */
112	int partno; /* part number for Message/Partial */
113	int numparts; /* number of parts for Message/Partial */
114	} headers;
115
116	/*
117	* Scanner state
118	*/
119
120	typedef struct _scanstate {
121	int isfolder; /* if we think this is a valid email folder */
122	int ismime; /* if we are within a valid MIME message */
123	int mimestate; /* state of MIME scanner */
124	int mimeenc; /* encoding of this MIME file */
125	char source; / source filename */
126	headers envelope; /* mail envelope headers */
127	} scanstate;
128
129	/*
130	* Structure that holds the information for a single file / part of
131	* a file. If a subject line is encountered, it is copied to subject;
132	* if a begin is found, the mode and name of the file is extracted.
133	* flags are set if 'begin' or 'end' is detected and 'uudet' if valid
134	* uuencoded data is found. If the file contains a 'From:' line with
135	* a '@' in it (indicating an origin email address), it is preserved
136	* in 'origin'.
137	**/
138
139	typedef struct _fileread {
140	char subject; / Whole subject line */
141	char filename; / Only filled in if begin detected */
142	char origin; / Whole 'From:' line */
143	char mimeid; / the ID for Mime-encoded files */
144	char mimetype; / Content-Type */
145	short mode; /* Mode of File (from 'begin') */
146	int begin; /* begin detected */
147	int end; /* end detected */
148	int flags; /* associated flags */
149
150	short uudet; /* valid encoded data. value indicates encoding */
151	short partno; /* Mime-files have a part number within */
152	short maxpno; /* ... plus the total number of parts */
153
154	char sfname; / Associated source file */
155	long startpos; /* ftell() position where data starts */
156	long length; /* length of data */
157	} fileread;
158
159	/*
160	* Structure for holding one part of a file, with some more information
161	* about it. The UUPreProcessPart() function takes one a fileread structure
162	* and produces this uufile structure.
163	* Linked List, ordered by partno.
164	**/
165
166	typedef struct _uufile {
167	char *filename;
168	char *subfname;
169	char *mimeid;
170	char *mimetype;
171	short partno;
172	fileread *data;
173	struct _uufile *NEXT;
174	} uufile;
175
176	extern void *uu_MsgCBArg;
177	extern void *uu_BusyCBArg;
178	extern void *uu_FileCBArg;
179	extern void *uu_FFCBArg;
180	extern void *uu_FNCBArg;
181
182	/*
183	* variables
184	*/
185
186	extern int uu_rbuf;
187	extern int uu_wbuf;
188	#define UUSETBUF(fp,buff,size) if (size) setvbuf ((fp), ((buff) = malloc (size)), _IOFBF, (size))
189	#define UUCLRBUF(size,buff) if (size) free (buff)
190
191	extern int uu_fast_scanning;
192	extern int uu_bracket_policy;
193	extern int uu_verbose;
194	extern int uu_desperate;
195	extern int uu_ignreply;
196	extern int uu_debug;
197	extern int uu_errno;
198	extern int uu_dumbness;
199	extern int uu_overwrite;
200	extern int uu_ignmode;
201	extern int uu_headercount;
202	extern int uu_usepreamble;
203	extern int uu_handletext;
204	extern int uu_tinyb64;
205	extern int uu_remove_input;
206	extern int uu_more_mime;
207	extern int uu_dotdot;
208
209	extern char *uusavepath;
210	extern char *uuencodeext;
211
212	/*
213	* Encoding/Decoding tables
214	*/
215
216	extern unsigned char UUEncodeTable[];
217	extern unsigned char XXEncodeTable[];
218	extern unsigned char B64EncodeTable[];
219	extern unsigned char BHEncodeTable[];
220
221	/*
222	* String tables from uustring.c
223	*/
224
225	extern char *msgnames[];
226	extern char *codenames[];
227	extern char *uuretcodes[];
228
229	extern uulist *UUGlobalFileList;
230
231	/*
232	* State of MIME variables and current progress
233	*/
234
235	extern int nofnum, mssdepth;
236	extern int mimseqno, lastvalid;
237	extern int lastenc;
238	extern scanstate multistack[];
239	extern headers localenv;
240	extern scanstate sstate;
241	extern uuprogress progress;
242
243	/*
244	* mallocable areas
245	*/
246
247	extern char uugen_fnbuffer, uugen_inbuffer;
248	extern char uucheck_lastname, uucheck_tempname;
249	extern char uuestr_itemp, uuestr_otemp;
250	extern char uulib_msgstring, uuncdl_fulline;
251	extern char uuncdp_oline, uuscan_shlline, *uuscan_shlline2;
252	extern char uuscan_pvvalue, uuscan_phtext;
253	extern char uuscan_sdline, uuscan_sdbhds1;
254	extern char uuscan_sdbhds2, uuscan_spline;
255	extern char *uuutil_bhwtmp;
256	extern char uunconc_UUxlat, uunconc_UUxlen;
257	extern char uunconc_B64xlat, uunconc_XXxlat;
258	extern char uunconc_BHxlat, uunconc_save;
259
260	#ifdef __cplusplus
261	extern "C" {
262	#endif
263
264	extern void (uu_MsgCallback) (void , char *, int);
265	extern int (uu_BusyCallback) (void , uuprogress *);
266	extern int (uu_FileCallback) (void , char , char , int);
267	extern char * (uu_FNameFilter) (void , char *);
268	extern char * (uu_FileNameCallback)(void , char , char );
269
270	/*
271	* Functions from uulib.c that aren't defined in <uudeview.h>
272	* Be careful about the definition with variable arguments.
273	*/
274
275	#if defined(STDC_HEADERS) \|\| defined(HAVE_STDARG_H)
276	int UUMessage (char , int, int, char , ...);
277	#else
278	int UUMessage ();
279	#endif
280	int UUBusyPoll (void);
281
282	/*
283	* Functions from uucheck.c
284	*/
285
286	uufile * UUPreProcessPart (fileread , int );
287	int UUInsertPartToList (uufile *);
288	uulist * UUCheckGlobalList (void);
289
290	/*
291	* Functions from uuutil.c
292	*/
293
294	void UUkillfread (fileread *);
295	void UUkillfile (uufile *);
296	void UUkilllist (uulist *);
297	void UUkillheaders (headers *);
298
299	fileread * ScanPart (FILE , char , int *);
300
301	int UUbhdecomp (char , char ,
302	char , int ,
303	size_t, size_t,
304	size_t *);
305	size_t UUbhwrite (char , size_t, size_t, FILE );
306
307	/*
308	* Functions from uunconc.c
309	*/
310
311	int UURepairData (FILE , char , int, int *);
312
313	void UUInitConc _ANSI_ARGS_((void));
314	int UUValidData _ANSI_ARGS_((char , int, int ));
315	size_t UUDecodeLine _ANSI_ARGS_((char , char , int));
316	int UUDecodeField _ANSI_ARGS_((char , char , int));
317	int UUDecodePart _ANSI_ARGS_((FILE , FILE , int *,
318	long, int, int, char *));
319	int UUDecode _ANSI_ARGS_((uulist *));
320
321	/*
322	* Message retrieval from uustring.c
323	*/
324
325	char * uustring (int);
326
327	/*
328	* From uuscan.c
329	*/
330
331	int UUScanHeader (FILE , headers );
332
333	#ifdef __cplusplus
334	}
335	#endif
336	#endif