annotate src/gifrlib.h @ 844:047d37eb70d7

[xemacs-hg @ 2002-05-16 13:30:23 by ben] ui fixes for things that were bothering me bytecode.c, editfns.c, lisp.h, lread.c: Fix save-restriction to use markers rather than pseudo-markers (integers representing the amount of text on either side of the region). That way, all inserts are handled correctly, not just those inside old restriction. Add buffer argument to save_restriction_save(). process.c: Clean up very dirty and kludgy code that outputs into a buffer -- use proper unwind protects, etc. font-lock.c: Do save-restriction/widen around the function -- otherwise, incorrect results will ensue when a buffer has been narrowed before a call to e.g. `buffer-syntactic-context' -- something that happens quite often. fileio.c: Look for a handler for make-temp-name. window.c, winslots.h: Try to solve this annoying problem: have two frames displaying the buffer, in different places; in one, temporarily switch away to another buffer and then back -- and you've lost your position; it's reset to the other one in the other frame. My current solution involves window-level caches of buffers and points (also a cache for window-start); when set-window-buffer is called, it looks to see if the buffer was previously visited in the window, and if so, uses the most recent point at that time. (It's a marker, so it handles changes.) #### Note: It could be argued that doing it on the frame level would be better -- e.g. if you visit a buffer temporarily through a grep, and then go back to that buffer, you presumably want the grep's position rather than some previous position provided everything was in the same frame, even though the grep was in another window in the frame. However, doing it on the frame level fails when you have two windows on the same frame. Perhaps we keep both a window and a frame cache, and use the frame cache if there are no other windows on the frame showing the buffer, else the window's cache? This is probably something to be configurable using a specifier. Suggestions please please please? window.c: Clean up a bit code that deals with the annoyance of window-point vs. point. dialog.el: Function to ask a multiple-choice question, automatically choosing a dialog box or minibuffer representation as necessary. Generalized version of yes-or-no-p, y-or-n-p. files.el: Use get-user-response to ask "yes/no/diff" question when recovering. "diff" means that a diff is displayed between the current file and the autosave. (Converts/deconverts escape-quoted as necessary. No more complaints from you, Mr. Turnbull!) One known problem: when a dialog is used, it's modal, so you can't scroll the diff. Will fix soon. lisp-mode.el: If we're filling a string, don't treat semicolon as a comment, which would give very unfriendly results. Uses `buffer-syntactic-context'. simple.el: all changes back to the beginning. (Useful if you've saved the file in the middle of the changes.) simple.el: Add option kill-word-into-kill-ring, which controls whether words deleted with kill-word, backward-kill-word, etc. are "cut" into the kill ring, or "cleared" into nothingness. (My preference is the latter, by far. I'd almost go so far as suggesting we make it the default, as you can always select a word and then cut it if you want it cut.) menubar-items.el: Add option corresponding to kill-word-into-kill-ring.
author ben
date Thu, 16 May 2002 13:30:58 +0000
parents fdefd0186b75
children 61855263cb07
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
1 /******************************************************************************
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
2 * In order to make life a little bit easier when using the GIF file format, *
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
3 * this library was written, and which does all the dirty work... *
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
4 * *
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
5 * Written by Gershon Elber, Jun. 1989 *
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
6 * Hacks by Eric S. Raymond, Sep. 1992 *
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
7 * and Jareth Hein, Jan. 1998 *
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
8 *******************************************************************************
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
9 * History: *
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
10 * 14 Jun 89 - Version 1.0 by Gershon Elber. *
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
11 * 3 Sep 90 - Version 1.1 by Gershon Elber (Support for Gif89, Unique names). *
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
12 * 15 Sep 90 - Version 2.0 by Eric S. Raymond (Changes to suoport GIF slurp) *
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
13 * 26 Jun 96 - Version 3.0 by Eric S. Raymond (Full GIF89 support) *
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
14 * 19 Jan 98 - Version 3.1 by Jareth Hein (Support for user-defined I/O). *
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
15 ******************************************************************************/
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
16
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
17 #ifndef INCLUDED_gifrlib_h_
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
18 #define INCLUDED_gifrlib_h_
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
19
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
20 #define GIF_ERROR 0
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
21 #define GIF_OK 1
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
22
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
23 #ifndef TRUE
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
24 #define TRUE 1
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
25 #define FALSE 0
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
26 #endif
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
27
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
28 #ifndef NULL
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
29 #define NULL 0
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
30 #endif /* NULL */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
31
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
32 #define GIF_FILE_BUFFER_SIZE 16384 /* Files uses bigger buffers than usual. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
33
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
34 typedef int GifBooleanType;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
35 typedef unsigned char GifPixelType;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
36 typedef unsigned char * GifRowType;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
37 typedef unsigned char GifByteType;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
38
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
39 #define VoidPtr void *
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
40
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
41 typedef struct GifColorType {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
42 GifByteType Red, Green, Blue;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
43 } GifColorType;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
44
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
45 typedef struct ColorMapObject
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
46 {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
47 int ColorCount;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
48 int BitsPerPixel;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
49 GifColorType *Colors; /* on malloc(3) heap */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
50 }
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
51 ColorMapObject;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
52
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
53 typedef struct GifImageDesc {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
54 int Left, Top, Width, Height, /* Current image dimensions. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
55 Interlace; /* Sequential/Interlaced lines. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
56 ColorMapObject *ColorMap; /* The local color map */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
57 } GifImageDesc;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
58
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
59 /* I/O operations. If you roll your own, they need to be semantically equivilent to
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
60 fread/fwrite, with an additional paramater to hold data local to your method. */
665
fdefd0186b75 [xemacs-hg @ 2001-09-20 06:28:42 by ben]
ben
parents: 647
diff changeset
61 typedef Bytecount (*Gif_rw_func)(GifByteType *buffer, Bytecount size, VoidPtr method_data);
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
62 /* Finish up stream. Non-zero return indicates failure */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
63 typedef int (*Gif_close_func)(VoidPtr close_data);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
64 /* Error handling function */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
65 typedef void (*Gif_error_func)(const char *string, VoidPtr error_data);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
66
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
67 typedef struct GifFileType {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
68 int SWidth, SHeight, /* Screen dimensions. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
69 SColorResolution, /* How many colors can we generate? */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
70 SBackGroundColor; /* I hope you understand this one... */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
71 ColorMapObject *SColorMap; /* NULL if it doesn't exist. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
72 int ImageCount; /* Number of current image */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
73 GifImageDesc Image; /* Block describing current image */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
74 struct SavedImage *SavedImages; /* Use this to accumulate file state */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
75 VoidPtr Private; /* Don't mess with this! */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
76 VoidPtr GifIO; /* Contains all information for I/O */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
77 } GifFileType;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
78
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
79 typedef enum {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
80 UNDEFINED_RECORD_TYPE,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
81 SCREEN_DESC_RECORD_TYPE,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
82 IMAGE_DESC_RECORD_TYPE, /* Begin with ',' */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
83 EXTENSION_RECORD_TYPE, /* Begin with '!' */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
84 TERMINATE_RECORD_TYPE /* Begin with ';' */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
85 } GifRecordType;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
86
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
87 /******************************************************************************
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
88 * GIF89 extension function codes *
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
89 ******************************************************************************/
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
90
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
91 #define COMMENT_EXT_FUNC_CODE 0xfe /* comment */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
92 #define GRAPHICS_EXT_FUNC_CODE 0xf9 /* graphics control */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
93 #define PLAINTEXT_EXT_FUNC_CODE 0x01 /* plaintext */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
94 #define APPLICATION_EXT_FUNC_CODE 0xff /* application block */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
95
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
96 /******************************************************************************
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
97 * IO related routines. Defined in gif_io.c *
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
98 ******************************************************************************/
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
99 GifFileType *GifSetup(void);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
100 void GifFree(GifFileType *GifFile);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
101 void GifSetReadFunc (GifFileType *GifFile, Gif_rw_func func, VoidPtr data);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
102 void GifSetWriteFunc(GifFileType *GifFile, Gif_rw_func func, VoidPtr data);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
103 void GifSetCloseFunc(GifFileType *GifFile, Gif_close_func func, VoidPtr data);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
104
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
105 /******************************************************************************
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
106 * O.K., here are the routines one can access in order to decode GIF file: *
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
107 ******************************************************************************/
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
108
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
109 void DGifOpenFileName(GifFileType *GifFile, const char *GifFileName);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
110 void DGifOpenFileHandle(GifFileType *GifFile, int GifFileHandle);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
111 void DGifInitRead(GifFileType *GifFile);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
112 void DGifSlurp(GifFileType *GifFile);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
113 void DGifGetScreenDesc(GifFileType *GifFile);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
114 void DGifGetRecordType(GifFileType *GifFile, GifRecordType *GifType);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
115 void DGifGetImageDesc(GifFileType *GifFile);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
116 void DGifGetLine(GifFileType *GifFile, GifPixelType *GifLine, int GifLineLen);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
117 void DGifGetPixel(GifFileType *GifFile, GifPixelType GifPixel);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
118 void DGifGetComment(GifFileType *GifFile, char *GifComment);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
119 void DGifGetExtension(GifFileType *GifFile, int *GifExtCode,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
120 GifByteType **GifExtension);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
121 void DGifGetExtensionNext(GifFileType *GifFile, GifByteType **GifExtension);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
122 void DGifGetCode(GifFileType *GifFile, int *GifCodeSize,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
123 GifByteType **GifCodeBlock);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
124 void DGifGetCodeNext(GifFileType *GifFile, GifByteType **GifCodeBlock);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
125 void DGifGetLZCodes(GifFileType *GifFile, int *GifCode);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
126 int DGifCloseFile(GifFileType *GifFile);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
127
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
128 #define D_GIF_ERR_OPEN_FAILED 101 /* And DGif possible errors. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
129 #define D_GIF_ERR_READ_FAILED 102
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
130 #define D_GIF_ERR_NOT_GIF_FILE 103
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
131 #define D_GIF_ERR_NO_SCRN_DSCR 104
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
132 #define D_GIF_ERR_NO_IMAG_DSCR 105
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
133 #define D_GIF_ERR_NO_COLOR_MAP 106
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
134 #define D_GIF_ERR_WRONG_RECORD 107
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
135 #define D_GIF_ERR_DATA_TOO_BIG 108
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
136 #define GIF_ERR_NOT_ENOUGH_MEM 109
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
137 #define D_GIF_ERR_NOT_ENOUGH_MEM 109
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
138 #define D_GIF_ERR_CLOSE_FAILED 110
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
139 #define D_GIF_ERR_NOT_READABLE 111
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
140 #define D_GIF_ERR_IMAGE_DEFECT 112
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
141 #define D_GIF_ERR_EOF_TOO_SOON 113
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
142
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
143 /******************************************************************************
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
144 * O.K., here are the error routines *
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
145 ******************************************************************************/
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
146 extern void GifSetErrorFunc(GifFileType *GifFile, Gif_error_func func, VoidPtr data);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
147 extern void GifSetWarningFunc(GifFileType *GifFile, Gif_error_func func, VoidPtr data);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
148 extern void GifInternError(GifFileType *GifFile, int errnum);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
149 extern void GifInternWarning(GifFileType *GifFile, int errnum);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
150 extern void GifError(GifFileType *GifFile, const char *err_str);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
151 extern void GifWarning(GifFileType *GifFile, const char *err_str);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
152
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
153 /*****************************************************************************
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
154 *
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
155 * Everything below this point is new after version 1.2, supporting `slurp
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
156 * mode' for doing I/O in two big belts with all the image-bashing in core.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
157 *
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
158 *****************************************************************************/
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
159
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
160 /******************************************************************************
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
161 * Support for the in-core structures allocation (slurp mode). *
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
162 ******************************************************************************/
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
163
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
164 /* This is the in-core version of an extension record */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
165 typedef struct {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
166 int ByteCount;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
167 GifByteType *Bytes; /* on malloc(3) heap */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
168 } ExtensionBlock;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
169
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
170 /* This holds an image header, its unpacked raster bits, and extensions */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
171 typedef struct SavedImage {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
172 GifImageDesc ImageDesc;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
173
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
174 GifPixelType *RasterBits; /* on malloc(3) heap */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
175
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
176 int Function;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
177 int ExtensionBlockCount;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
178 ExtensionBlock *ExtensionBlocks; /* on malloc(3) heap */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
179 } SavedImage;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
180
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
181 extern void ApplyTranslation(SavedImage *Image, GifPixelType Translation[]);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
182
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
183 extern void MakeExtension(SavedImage *New, int Function);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
184 extern int AddExtensionBlock(SavedImage *New, int Length, GifByteType *data);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
185 extern void FreeExtension(SavedImage *Image);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
186
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
187 extern SavedImage *MakeSavedImage(GifFileType *GifFile, SavedImage *CopyFrom);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
188 extern void FreeSavedImages(GifFileType *GifFile);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
189
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
190 /* Common defines used by encode/decode functions */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
191
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
192 #define COMMENT_EXT_FUNC_CODE 0xfe /* Extension function code for comment. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
193 #define GIF_STAMP "GIFVER" /* First chars in file - GIF stamp. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
194 #define GIF_STAMP_LEN sizeof(GIF_STAMP) - 1
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
195 #define GIF_VERSION_POS 3 /* Version first character in stamp. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
196 #define GIF87_STAMP "GIF87a" /* First chars in file - GIF stamp. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
197 #define GIF89_STAMP "GIF89a" /* First chars in file - GIF stamp. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
198
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
199 #define LZ_MAX_CODE 4095 /* Biggest code possible in 12 bits. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
200 #define LZ_BITS 12
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
201
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
202 #define FILE_STATE_READ 0x01
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
203 #define FILE_STATE_WRITE 0x01
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
204 #define FILE_STATE_SCREEN 0x02
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
205 #define FILE_STATE_IMAGE 0x04
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
206
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
207 #define FLUSH_OUTPUT 4096 /* Impossible code, to signal flush. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
208 #define FIRST_CODE 4097 /* Impossible code, to signal first. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
209 #define NO_SUCH_CODE 4098 /* Impossible code, to signal empty. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
210
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
211 #define IS_READABLE(Private) (!(Private->FileState & FILE_STATE_READ))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
212 #define IS_WRITEABLE(Private) (Private->FileState & FILE_STATE_WRITE)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
213
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
214 typedef struct GifFilePrivateType {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
215 int FileState,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
216 BitsPerPixel, /* Bits per pixel (Codes uses at list this + 1). */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
217 ClearCode, /* The CLEAR LZ code. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
218 EOFCode, /* The EOF LZ code. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
219 RunningCode, /* The next code algorithm can generate. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
220 RunningBits,/* The number of bits required to represent RunningCode. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
221 MaxCode1, /* 1 bigger than max. possible code, in RunningBits bits. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
222 LastCode, /* The code before the current code. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
223 CrntCode, /* Current algorithm code. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
224 StackPtr, /* For character stack (see below). */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
225 CrntShiftState; /* Number of bits in CrntShiftDWord. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
226 unsigned long CrntShiftDWord; /* For bytes decomposition into codes. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
227 unsigned long PixelCount; /* Number of pixels in image. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
228 GifByteType Buf[256]; /* Compressed input is buffered here. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
229 GifByteType Stack[LZ_MAX_CODE]; /* Decoded pixels are stacked here. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
230 GifByteType Suffix[LZ_MAX_CODE+1]; /* So we can trace the codes. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
231 unsigned int Prefix[LZ_MAX_CODE+1];
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
232 } GifFilePrivateType;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
233
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
234 typedef struct GifIODataType {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
235 Gif_rw_func ReadFunc, WriteFunc; /* Pointers to the functions that will do the I/O */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
236 Gif_close_func CloseFunc;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
237 VoidPtr ReadFunc_data; /* data to be passed to the read function */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
238 VoidPtr WriteFunc_data; /* data to be passed to the write function */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
239 VoidPtr CloseFunc_data; /* data to be passed to the close function */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
240 Gif_error_func ErrorFunc; /* MUST NOT RETURN (use lng_jmp or exit)! */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
241 Gif_error_func WarningFunc; /* For warning messages (can be ignored) */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
242 VoidPtr ErrorFunc_data;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
243 VoidPtr WarningFunc_data;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
244 } GifIODataType;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
245
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
246 typedef struct GifStdIODataType {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
247 FILE *File;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
248 int FileHandle;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
249 } GifStdIODataType;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
250
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
251 /* Install StdIO funcs on FILE into GifFile */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
252 void GifStdIOInit(GifFileType *GifFile, FILE *file, int filehandle);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
253
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
254 /* Error checking reads, writes and closes */
665
fdefd0186b75 [xemacs-hg @ 2001-09-20 06:28:42 by ben]
ben
parents: 647
diff changeset
255 void GifRead(GifByteType *buf, Bytecount size, GifFileType *GifFile);
fdefd0186b75 [xemacs-hg @ 2001-09-20 06:28:42 by ben]
ben
parents: 647
diff changeset
256 void GifWrite(GifByteType *buf, Bytecount size, GifFileType *GifFile);
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
257 int GifClose(GifFileType *GifFile);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
258
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
259 /* The default Read and Write functions for files */
665
fdefd0186b75 [xemacs-hg @ 2001-09-20 06:28:42 by ben]
ben
parents: 647
diff changeset
260 Bytecount GifStdRead(GifByteType *buf, Bytecount size, VoidPtr method_data);
fdefd0186b75 [xemacs-hg @ 2001-09-20 06:28:42 by ben]
ben
parents: 647
diff changeset
261 Bytecount GifStdWrite(GifByteType *buf, Bytecount size, VoidPtr method_data);
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
262 int GifStdFileClose(VoidPtr method_data);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
263
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
264 ColorMapObject *MakeMapObject(int ColorCount, GifColorType *ColorMap);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
265 void FreeMapObject(ColorMapObject *Object);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
266
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
267 #endif /* INCLUDED_gifrlib_h_ */