Convert-UUlib/uulib/uudeview.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 __UUDEVIEW_H__
#define __UUDEVIEW_H__

/*
 * This include file features all the definitions that should
 * be externally visible. This isn't much.
 *
 * $Id: uudeview.h,v 1.15 2001/06/06 18:21:47 fp Exp $
 */

#ifndef _ANSI_ARGS_
#ifdef PROTOTYPES
#define _ANSI_ARGS_(c)  c
#else
#define _ANSI_ARGS_(c)  ()
#endif
#endif

/*
 * Message Types
 */

#define UUMSG_MESSAGE   (0)     /* just a message, nothing important */
#define UUMSG_NOTE      (1)     /* something that should be noticed */
#define UUMSG_WARNING   (2)     /* important msg, processing continues */
#define UUMSG_ERROR     (3)     /* processing has been terminated */
#define UUMSG_FATAL     (4)     /* decoder cannot process further requests */
#define UUMSG_PANIC     (5)     /* recovery impossible, app must terminate */

/*
 * Return Values
 */

#define UURET_OK        (0)     /* everything went fine */
#define UURET_IOERR     (1)     /* I/O Error - examine errno */
#define UURET_NOMEM     (2)     /* not enough memory */
#define UURET_ILLVAL    (3)     /* illegal value for operation */
#define UURET_NODATA    (4)     /* decoder didn't find any data */
#define UURET_NOEND     (5)     /* encoded data wasn't ended properly */
#define UURET_UNSUP     (6)     /* unsupported function (encoding) */
#define UURET_EXISTS    (7)     /* file exists (decoding) */
#define UURET_CONT      (8)     /* continue -- special from ScanPart */
#define UURET_CANCEL    (9)     /* operation canceled */

/*
 * File states, may be OR'ed
 */

#define UUFILE_READ     (0)     /* Read in, but not further processed */
#define UUFILE_MISPART  (1)     /* Missing Part(s) detected */
#define UUFILE_NOBEGIN  (2)     /* No 'begin' found */
#define UUFILE_NOEND    (4)     /* No 'end' found */
#define UUFILE_NODATA   (8)     /* File does not contain valid uudata */
#define UUFILE_OK       (16)    /* All Parts found, ready to decode */
#define UUFILE_ERROR    (32)    /* Error while decoding */
#define UUFILE_DECODED  (64)    /* Successfully decoded */
#define UUFILE_TMPFILE  (128)   /* Temporary decoded file exists */

/*
 * Encoding Types
 */

#define UU_ENCODED      (1)     /* UUencoded data   */
#define B64ENCODED      (2)     /* Mime-Base64 data */
#define XX_ENCODED      (3)     /* XXencoded data   */
#define BH_ENCODED      (4)     /* Binhex encoded   */
#define PT_ENCODED      (5)     /* Plain-Text encoded (MIME) */
#define QP_ENCODED      (6)     /* Quoted-Printable (MIME)   */

/*
 * Option indices for GetOption / SetOption
 */

#define UUOPT_VERSION   (0)     /* version number MAJOR.MINORplPATCH (ro) */
#define UUOPT_FAST      (1)     /* assumes only one part per file */
#define UUOPT_DUMBNESS  (2)     /* switch off the program's intelligence */
#define UUOPT_BRACKPOL  (3)     /* give numbers in [] higher precendence */
#define UUOPT_VERBOSE   (4)     /* generate informative messages */
#define UUOPT_DESPERATE (5)     /* try to decode incomplete files */
#define UUOPT_IGNREPLY  (6)     /* ignore RE:plies (off by default) */
#define UUOPT_OVERWRITE (7)     /* whether it's OK to overwrite ex. files */
#define UUOPT_SAVEPATH  (8)     /* prefix to save-files on disk */
#define UUOPT_IGNMODE   (9)     /* ignore the original file mode */
#define UUOPT_DEBUG     (10)    /* print messages with FILE/LINE info */
#define UUOPT_ERRNO     (14)    /* get last error code for UURET_IOERR (ro) */
#define UUOPT_PROGRESS  (15)    /* retrieve progress information */
#define UUOPT_USETEXT   (16)    /* handle text messages */
#define UUOPT_PREAMB    (17)    /* handle Mime preambles/epilogues */
#define UUOPT_TINYB64   (18)    /* detect short B64 outside of Mime */
#define UUOPT_ENCEXT    (19)    /* extension for single-part encoded files */
#define UUOPT_REMOVE    (20)    /* remove input files after decoding */
#define UUOPT_MOREMIME  (21)    /* strict MIME adherence */

/*
 * Code for the "action" in the progress structure
 */

#define UUACT_IDLE      (0)     /* we don't do anything */
#define UUACT_SCANNING  (1)     /* scanning an input file */
#define UUACT_DECODING  (2)     /* decoding into a temp file */
#define UUACT_COPYING   (3)     /* copying temp to target */
#define UUACT_ENCODING  (4)     /* encoding a file */

/*
 * forward definition
 */

struct _uufile;

/*
 * Structure for holding the list of files that have been found
 * uufile items are inserted into this list with UUInsertPartToList
 * After inserting a bunch of files, UUCheckGlobalList must be called
 * to update the states.
 */

typedef struct _uulist {
  short    state;               /* Status as described by the macros above */
  short    mode;                /* file mode as found on begin line        */

  int      begin;               /* part number where begin was detected    */
  int      end;                 /* part number where end was detected      */

  short    uudet;               /* Encoding type (see macros above)        */
  int      flags;               /* flags, especially for single-part files */

  long     size;                /* approximate size of resulting file      */
  char    *filename;            /* malloc'ed file name                     */
  char    *subfname;            /* malloc'ed ID from subject line          */
  char    *mimeid;              /* malloc'ed MIME-ID, if available         */
  char    *mimetype;            /* malloc'ed Content-Type, if available    */

  char    *binfile;             /* name of temp file, if already decoded   */

  struct _uufile *thisfile;     /* linked list of this file's parts        */

  int     *haveparts;           /* the parts we have (max. 256 are listed) */
  int     *misparts;            /* list of missing parts (max. 256)        */

  struct _uulist *NEXT;         /* next item of the list                   */
  struct _uulist *PREV;         /* previous item of the list               */
} uulist;

/*
 * The "progress" structure which is passed to the Busy Callback
 */

typedef struct {
  int  action;                  /* see UUACT_* definitions above           */
  char curfile[256];            /* the file we are working on, incl. path  */
  int  partno;                  /* part we're currently decoding           */
  int  numparts;                /* total number of parts of this file      */
  long fsize;                   /* size of the current file                */
  int  percent;                 /* % of _current part_                     */
  long foffset;                 /* file offset -- internal use only        */
  long totsize;                 /* file total size -- internal use only    */
} uuprogress;
  

/*
 * Externally visible Functions
 */

#ifndef UUEXPORT
#define UUEXPORT
#endif

#ifdef __cplusplus
extern "C" {
#endif

int     UUEXPORT UUInitialize           _ANSI_ARGS_((void));
int     UUEXPORT UUGetOption            _ANSI_ARGS_((int, int *, char *, int));
int     UUEXPORT UUSetOption            _ANSI_ARGS_((int, int, char *));
char *  UUEXPORT UUstrerror             _ANSI_ARGS_((int));
int     UUEXPORT UUSetMsgCallback       _ANSI_ARGS_((void *,
                                                     void (*) (void *, 
                                                               char *,
                                                               int)));
int     UUEXPORT UUSetBusyCallback      _ANSI_ARGS_((void *,
                                                     int (*) (void *,
                                                              uuprogress *),
                                                     long));
int     UUEXPORT UUSetFileCallback      _ANSI_ARGS_((void *,
                                                     int (*) (void *, char *,
                                                              char *, int)));
int     UUEXPORT UUSetFNameFilter       _ANSI_ARGS_((void *,
                                                     char * (*) (void *,
                                                                 char *)));
char *  UUEXPORT UUFNameFilter          _ANSI_ARGS_((char *));
int     UUEXPORT UULoadFile             _ANSI_ARGS_((char *, char *, int));
uulist *UUEXPORT UUGetFileListItem      _ANSI_ARGS_((int));
int     UUEXPORT UURenameFile           _ANSI_ARGS_((uulist *, char *));
int     UUEXPORT UUDecodeToTemp         _ANSI_ARGS_((uulist *));
int     UUEXPORT UURemoveTemp           _ANSI_ARGS_((uulist *));
int     UUEXPORT UUDecodeFile           _ANSI_ARGS_((uulist *, char *));
int     UUEXPORT UUInfoFile             _ANSI_ARGS_((uulist *, void *,
                                                     int (*) (void *, 
                                                              char *)));
int     UUEXPORT UUSmerge               _ANSI_ARGS_((int));
int     UUEXPORT UUCleanUp              _ANSI_ARGS_((void));

int     UUEXPORT UUQuickDecode          _ANSI_ARGS_((FILE *, FILE *,
                                                     char *, long));

int     UUEXPORT UUEncodeMulti          _ANSI_ARGS_((FILE *, FILE *,
                                                     char *, int,
                                                     char *, char *, int));
int     UUEXPORT UUEncodePartial        _ANSI_ARGS_((FILE *, FILE *,
                                                     char *, int,
                                                     char *, char *,
                                                     int, int, long));
int     UUEXPORT UUEncodeToStream       _ANSI_ARGS_((FILE *, FILE *,
                                                     char *, int,
                                                     char *, int));
int     UUEXPORT UUEncodeToFile         _ANSI_ARGS_((FILE *, char *, int,
                                                     char *, char *, long));
int     UUEXPORT UUE_PrepSingle         _ANSI_ARGS_((FILE *, FILE *,
                                                     char *, int,
                                                     char *, int,
                                                     char *, char *,
                                                     char *, int));
int     UUEXPORT UUE_PrepPartial        _ANSI_ARGS_((FILE *, FILE *,
                                                     char *, int,
                                                     char *, int,
                                                     int, long, long, char *,
                                                     char *, char *, int));

int     UUEXPORT UUE_PrepSingleExt      _ANSI_ARGS_((FILE *, FILE *,
                                                     char *, int,
                                                     char *, int,
                                                     char *, char *,
                                                     char *, char *,
                                                     int));
int     UUEXPORT UUE_PrepPartialExt     _ANSI_ARGS_((FILE *, FILE *,
                                                     char *, int,
                                                     char *, int,
                                                     int, long, long, char *,
                                                     char *, char *, char *,
                                                     int));
#ifdef __cplusplus
}
#endif
#endif
Revision:	1.1
Committed:	Sun Mar 31 19:50:21 2002 UTC (22 years, 2 months ago) by root
Content type:	text/plain
Branch:	MAIN
Branch point for:	UUDEVIEW
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 __UUDEVIEW_H__
18	#define __UUDEVIEW_H__
19
20	/*
21	* This include file features all the definitions that should
22	* be externally visible. This isn't much.
23	*
24	* $Id: uudeview.h,v 1.15 2001/06/06 18:21:47 fp Exp $
25	*/
26
27	#ifndef _ANSI_ARGS_
28	#ifdef PROTOTYPES
29	#define _ANSI_ARGS_(c) c
30	#else
31	#define _ANSI_ARGS_(c) ()
32	#endif
33	#endif
34
35	/*
36	* Message Types
37	*/
38
39	#define UUMSG_MESSAGE (0) /* just a message, nothing important */
40	#define UUMSG_NOTE (1) /* something that should be noticed */
41	#define UUMSG_WARNING (2) /* important msg, processing continues */
42	#define UUMSG_ERROR (3) /* processing has been terminated */
43	#define UUMSG_FATAL (4) /* decoder cannot process further requests */
44	#define UUMSG_PANIC (5) /* recovery impossible, app must terminate */
45
46	/*
47	* Return Values
48	*/
49
50	#define UURET_OK (0) /* everything went fine */
51	#define UURET_IOERR (1) /* I/O Error - examine errno */
52	#define UURET_NOMEM (2) /* not enough memory */
53	#define UURET_ILLVAL (3) /* illegal value for operation */
54	#define UURET_NODATA (4) /* decoder didn't find any data */
55	#define UURET_NOEND (5) /* encoded data wasn't ended properly */
56	#define UURET_UNSUP (6) /* unsupported function (encoding) */
57	#define UURET_EXISTS (7) /* file exists (decoding) */
58	#define UURET_CONT (8) /* continue -- special from ScanPart */
59	#define UURET_CANCEL (9) /* operation canceled */
60
61	/*
62	* File states, may be OR'ed
63	*/
64
65	#define UUFILE_READ (0) /* Read in, but not further processed */
66	#define UUFILE_MISPART (1) /* Missing Part(s) detected */
67	#define UUFILE_NOBEGIN (2) /* No 'begin' found */
68	#define UUFILE_NOEND (4) /* No 'end' found */
69	#define UUFILE_NODATA (8) /* File does not contain valid uudata */
70	#define UUFILE_OK (16) /* All Parts found, ready to decode */
71	#define UUFILE_ERROR (32) /* Error while decoding */
72	#define UUFILE_DECODED (64) /* Successfully decoded */
73	#define UUFILE_TMPFILE (128) /* Temporary decoded file exists */
74
75	/*
76	* Encoding Types
77	*/
78
79	#define UU_ENCODED (1) /* UUencoded data */
80	#define B64ENCODED (2) /* Mime-Base64 data */
81	#define XX_ENCODED (3) /* XXencoded data */
82	#define BH_ENCODED (4) /* Binhex encoded */
83	#define PT_ENCODED (5) /* Plain-Text encoded (MIME) */
84	#define QP_ENCODED (6) /* Quoted-Printable (MIME) */
85
86	/*
87	* Option indices for GetOption / SetOption
88	*/
89
90	#define UUOPT_VERSION (0) /* version number MAJOR.MINORplPATCH (ro) */
91	#define UUOPT_FAST (1) /* assumes only one part per file */
92	#define UUOPT_DUMBNESS (2) /* switch off the program's intelligence */
93	#define UUOPT_BRACKPOL (3) /* give numbers in [] higher precendence */
94	#define UUOPT_VERBOSE (4) /* generate informative messages */
95	#define UUOPT_DESPERATE (5) /* try to decode incomplete files */
96	#define UUOPT_IGNREPLY (6) /* ignore RE:plies (off by default) */
97	#define UUOPT_OVERWRITE (7) /* whether it's OK to overwrite ex. files */
98	#define UUOPT_SAVEPATH (8) /* prefix to save-files on disk */
99	#define UUOPT_IGNMODE (9) /* ignore the original file mode */
100	#define UUOPT_DEBUG (10) /* print messages with FILE/LINE info */
101	#define UUOPT_ERRNO (14) /* get last error code for UURET_IOERR (ro) */
102	#define UUOPT_PROGRESS (15) /* retrieve progress information */
103	#define UUOPT_USETEXT (16) /* handle text messages */
104	#define UUOPT_PREAMB (17) /* handle Mime preambles/epilogues */
105	#define UUOPT_TINYB64 (18) /* detect short B64 outside of Mime */
106	#define UUOPT_ENCEXT (19) /* extension for single-part encoded files */
107	#define UUOPT_REMOVE (20) /* remove input files after decoding */
108	#define UUOPT_MOREMIME (21) /* strict MIME adherence */
109
110	/*
111	* Code for the "action" in the progress structure
112	*/
113
114	#define UUACT_IDLE (0) /* we don't do anything */
115	#define UUACT_SCANNING (1) /* scanning an input file */
116	#define UUACT_DECODING (2) /* decoding into a temp file */
117	#define UUACT_COPYING (3) /* copying temp to target */
118	#define UUACT_ENCODING (4) /* encoding a file */
119
120	/*
121	* forward definition
122	*/
123
124	struct _uufile;
125
126	/*
127	* Structure for holding the list of files that have been found
128	* uufile items are inserted into this list with UUInsertPartToList
129	* After inserting a bunch of files, UUCheckGlobalList must be called
130	* to update the states.
131	*/
132
133	typedef struct _uulist {
134	short state; /* Status as described by the macros above */
135	short mode; /* file mode as found on begin line */
136
137	int begin; /* part number where begin was detected */
138	int end; /* part number where end was detected */
139
140	short uudet; /* Encoding type (see macros above) */
141	int flags; /* flags, especially for single-part files */
142
143	long size; /* approximate size of resulting file */
144	char filename; / malloc'ed file name */
145	char subfname; / malloc'ed ID from subject line */
146	char mimeid; / malloc'ed MIME-ID, if available */
147	char mimetype; / malloc'ed Content-Type, if available */
148
149	char binfile; / name of temp file, if already decoded */
150
151	struct _uufile thisfile; / linked list of this file's parts */
152
153	int haveparts; / the parts we have (max. 256 are listed) */
154	int misparts; / list of missing parts (max. 256) */
155
156	struct _uulist NEXT; / next item of the list */
157	struct _uulist PREV; / previous item of the list */
158	} uulist;
159
160	/*
161	* The "progress" structure which is passed to the Busy Callback
162	*/
163
164	typedef struct {
165	int action; /* see UUACT_* definitions above */
166	char curfile[256]; /* the file we are working on, incl. path */
167	int partno; /* part we're currently decoding */
168	int numparts; /* total number of parts of this file */
169	long fsize; /* size of the current file */
170	int percent; /* % of _current part_ */
171	long foffset; /* file offset -- internal use only */
172	long totsize; /* file total size -- internal use only */
173	} uuprogress;
174
175
176	/*
177	* Externally visible Functions
178	*/
179
180	#ifndef UUEXPORT
181	#define UUEXPORT
182	#endif
183
184	#ifdef __cplusplus
185	extern "C" {
186	#endif
187
188	int UUEXPORT UUInitialize _ANSI_ARGS_((void));
189	int UUEXPORT UUGetOption _ANSI_ARGS_((int, int , char , int));
190	int UUEXPORT UUSetOption _ANSI_ARGS_((int, int, char *));
191	char * UUEXPORT UUstrerror _ANSI_ARGS_((int));
192	int UUEXPORT UUSetMsgCallback _ANSI_ARGS_((void *,
193	void () (void ,
194	char *,
195	int)));
196	int UUEXPORT UUSetBusyCallback _ANSI_ARGS_((void *,
197	int () (void ,
198	uuprogress *),
199	long));
200	int UUEXPORT UUSetFileCallback _ANSI_ARGS_((void *,
201	int () (void , char *,
202	char *, int)));
203	int UUEXPORT UUSetFNameFilter _ANSI_ARGS_((void *,
204	char * () (void ,
205	char *)));
206	char * UUEXPORT UUFNameFilter _ANSI_ARGS_((char *));
207	int UUEXPORT UULoadFile _ANSI_ARGS_((char , char , int));
208	uulist *UUEXPORT UUGetFileListItem _ANSI_ARGS_((int));
209	int UUEXPORT UURenameFile _ANSI_ARGS_((uulist , char ));
210	int UUEXPORT UUDecodeToTemp _ANSI_ARGS_((uulist *));
211	int UUEXPORT UURemoveTemp _ANSI_ARGS_((uulist *));
212	int UUEXPORT UUDecodeFile _ANSI_ARGS_((uulist , char ));
213	int UUEXPORT UUInfoFile _ANSI_ARGS_((uulist , void ,
214	int () (void ,
215	char *)));
216	int UUEXPORT UUSmerge _ANSI_ARGS_((int));
217	int UUEXPORT UUCleanUp _ANSI_ARGS_((void));
218
219	int UUEXPORT UUQuickDecode _ANSI_ARGS_((FILE , FILE ,
220	char *, long));
221
222	int UUEXPORT UUEncodeMulti _ANSI_ARGS_((FILE , FILE ,
223	char *, int,
224	char , char , int));
225	int UUEXPORT UUEncodePartial _ANSI_ARGS_((FILE , FILE ,
226	char *, int,
227	char , char ,
228	int, int, long));
229	int UUEXPORT UUEncodeToStream _ANSI_ARGS_((FILE , FILE ,
230	char *, int,
231	char *, int));
232	int UUEXPORT UUEncodeToFile _ANSI_ARGS_((FILE , char , int,
233	char , char , long));
234	int UUEXPORT UUE_PrepSingle _ANSI_ARGS_((FILE , FILE ,
235	char *, int,
236	char *, int,
237	char , char ,
238	char *, int));
239	int UUEXPORT UUE_PrepPartial _ANSI_ARGS_((FILE , FILE ,
240	char *, int,
241	char *, int,
242	int, long, long, char *,
243	char , char , int));
244
245	int UUEXPORT UUE_PrepSingleExt _ANSI_ARGS_((FILE , FILE ,
246	char *, int,
247	char *, int,
248	char , char ,
249	char , char ,
250	int));
251	int UUEXPORT UUE_PrepPartialExt _ANSI_ARGS_((FILE , FILE ,
252	char *, int,
253	char *, int,
254	int, long, long, char *,
255	char , char , char *,
256	int));
257	#ifdef __cplusplus
258	}
259	#endif
260	#endif