Add a note how to use `tramp-own-remote-path'
[emacs.git] / src / decompress.c
blob6ebf74aaf5ef3579ed42ccd2a06a95b5660ab286
1 /* Interface to zlib.
2 Copyright (C) 2013-2016 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs 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 3 of the License, or (at
9 your option) any later version.
11 GNU Emacs 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.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
19 #include <config.h>
21 #ifdef HAVE_ZLIB
23 #include <zlib.h>
25 #include "lisp.h"
26 #include "buffer.h"
28 #include <verify.h>
30 #ifdef WINDOWSNT
31 # include <windows.h>
32 # include "w32.h"
34 DEF_DLL_FN (int, inflateInit2_,
35 (z_streamp strm, int windowBits, const char *version,
36 int stream_size));
37 DEF_DLL_FN (int, inflate, (z_streamp strm, int flush));
38 DEF_DLL_FN (int, inflateEnd, (z_streamp strm));
40 static bool zlib_initialized;
42 static bool
43 init_zlib_functions (void)
45 HMODULE library = w32_delayed_load (Qzlib);
47 if (!library)
48 return false;
50 LOAD_DLL_FN (library, inflateInit2_);
51 LOAD_DLL_FN (library, inflate);
52 LOAD_DLL_FN (library, inflateEnd);
53 return true;
56 # undef inflate
57 # undef inflateEnd
58 # undef inflateInit2_
60 # define inflate fn_inflate
61 # define inflateEnd fn_inflateEnd
62 # define inflateInit2_ fn_inflateInit2_
64 #endif /* WINDOWSNT */
67 struct decompress_unwind_data
69 ptrdiff_t old_point, start, nbytes;
70 z_stream *stream;
73 static void
74 unwind_decompress (void *ddata)
76 struct decompress_unwind_data *data = ddata;
77 inflateEnd (data->stream);
79 /* Delete any uncompressed data already inserted on error. */
80 if (data->start)
81 del_range (data->start, data->start + data->nbytes);
83 /* Put point where it was, or if the buffer has shrunk because the
84 compressed data is bigger than the uncompressed, at
85 point-max. */
86 SET_PT (min (data->old_point, ZV));
89 DEFUN ("zlib-available-p", Fzlib_available_p, Szlib_available_p, 0, 0, 0,
90 doc: /* Return t if zlib decompression is available in this instance of Emacs. */)
91 (void)
93 #ifdef WINDOWSNT
94 Lisp_Object found = Fassq (Qzlib, Vlibrary_cache);
95 if (CONSP (found))
96 return XCDR (found);
97 else
99 Lisp_Object status;
100 zlib_initialized = init_zlib_functions ();
101 status = zlib_initialized ? Qt : Qnil;
102 Vlibrary_cache = Fcons (Fcons (Qzlib, status), Vlibrary_cache);
103 return status;
105 #else
106 return Qt;
107 #endif
110 DEFUN ("zlib-decompress-region", Fzlib_decompress_region,
111 Szlib_decompress_region,
112 2, 2, 0,
113 doc: /* Decompress a gzip- or zlib-compressed region.
114 Replace the text in the region by the decompressed data.
115 On failure, return nil and leave the data in place.
116 This function can be called only in unibyte buffers. */)
117 (Lisp_Object start, Lisp_Object end)
119 ptrdiff_t istart, iend, pos_byte;
120 z_stream stream;
121 int inflate_status;
122 struct decompress_unwind_data unwind_data;
123 ptrdiff_t count = SPECPDL_INDEX ();
125 validate_region (&start, &end);
127 if (! NILP (BVAR (current_buffer, enable_multibyte_characters)))
128 error ("This function can be called only in unibyte buffers");
130 #ifdef WINDOWSNT
131 if (!zlib_initialized)
132 zlib_initialized = init_zlib_functions ();
133 if (!zlib_initialized)
135 message1 ("zlib library not found");
136 return Qnil;
138 #endif
140 /* This is a unibyte buffer, so character positions and bytes are
141 the same. */
142 istart = XINT (start);
143 iend = XINT (end);
144 move_gap_both (iend, iend);
146 stream.zalloc = Z_NULL;
147 stream.zfree = Z_NULL;
148 stream.opaque = Z_NULL;
149 stream.avail_in = 0;
150 stream.next_in = Z_NULL;
152 /* The magic number 32 apparently means "autodetect both the gzip and
153 zlib formats" according to zlib.h. */
154 if (inflateInit2 (&stream, MAX_WBITS + 32) != Z_OK)
155 return Qnil;
157 unwind_data.start = iend;
158 unwind_data.stream = &stream;
159 unwind_data.old_point = PT;
160 unwind_data.nbytes = 0;
161 record_unwind_protect_ptr (unwind_decompress, &unwind_data);
163 /* Insert the decompressed data at the end of the compressed data. */
164 SET_PT (iend);
166 pos_byte = istart;
168 /* Keep calling 'inflate' until it reports an error or end-of-input. */
171 /* Maximum number of bytes that one 'inflate' call should read and write.
172 Do not make avail_out too large, as that might unduly delay C-g.
173 zlib requires that avail_in and avail_out not exceed UINT_MAX. */
174 ptrdiff_t avail_in = min (iend - pos_byte, UINT_MAX);
175 int avail_out = 16 * 1024;
176 int decompressed;
178 if (GAP_SIZE < avail_out)
179 make_gap (avail_out - GAP_SIZE);
180 stream.next_in = BYTE_POS_ADDR (pos_byte);
181 stream.avail_in = avail_in;
182 stream.next_out = GPT_ADDR;
183 stream.avail_out = avail_out;
184 inflate_status = inflate (&stream, Z_NO_FLUSH);
185 pos_byte += avail_in - stream.avail_in;
186 decompressed = avail_out - stream.avail_out;
187 insert_from_gap (decompressed, decompressed, 0);
188 unwind_data.nbytes += decompressed;
189 QUIT;
191 while (inflate_status == Z_OK);
193 if (inflate_status != Z_STREAM_END)
194 return unbind_to (count, Qnil);
196 unwind_data.start = 0;
198 /* Delete the compressed data. */
199 del_range (istart, iend);
201 return unbind_to (count, Qt);
205 /***********************************************************************
206 Initialization
207 ***********************************************************************/
208 void
209 syms_of_decompress (void)
211 defsubr (&Szlib_decompress_region);
212 defsubr (&Szlib_available_p);
215 #endif /* HAVE_ZLIB */