summaryrefslogtreecommitdiffstats
path: root/Modules/zlib/contrib/dotzlib/DotZLib/GZipStream.cs
blob: f861675b518ff730019e08af9869ace8d475a768 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
//

// © Copyright Henrik Ravn 2004

//

// Use, modification and distribution are subject to the Boost Software License, Version 1.0. 

// (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

//


using System;
using System.IO;
using System.Runtime.InteropServices;

namespace DotZLib
{
	/// <summary>

	/// Implements a compressed <see cref="Stream"/>, in GZip (.gz) format.

	/// </summary>

	public class GZipStream : Stream, IDisposable
	{
        #region Dll Imports

        [DllImport("ZLIB1.dll", CallingConvention=CallingConvention.Cdecl, CharSet=CharSet.Ansi)]
        private static extern IntPtr gzopen(string name, string mode);

        [DllImport("ZLIB1.dll", CallingConvention=CallingConvention.Cdecl)]
        private static extern int gzclose(IntPtr gzFile);

        [DllImport("ZLIB1.dll", CallingConvention=CallingConvention.Cdecl)]
        private static extern int gzwrite(IntPtr gzFile, int data, int length);

        [DllImport("ZLIB1.dll", CallingConvention=CallingConvention.Cdecl)]
        private static extern int gzread(IntPtr gzFile, int data, int length);

        [DllImport("ZLIB1.dll", CallingConvention=CallingConvention.Cdecl)]
        private static extern int gzgetc(IntPtr gzFile);

        [DllImport("ZLIB1.dll", CallingConvention=CallingConvention.Cdecl)]
        private static extern int gzputc(IntPtr gzFile, int c);

        #endregion


        #region Private data

        private IntPtr _gzFile;
        private bool _isDisposed = false;
        private bool _isWriting;
        #endregion


        #region Constructors

        /// <summary>

        /// Creates a new file as a writeable GZipStream

        /// </summary>

        /// <param name="fileName">The name of the compressed file to create</param>

        /// <param name="level">The compression level to use when adding data</param>

        /// <exception cref="ZLibException">If an error occurred in the internal zlib function</exception>

		public GZipStream(string fileName, CompressLevel level)
		{
            _isWriting = true;
            _gzFile = gzopen(fileName, String.Format("wb{0}", (int)level));
            if (_gzFile == IntPtr.Zero)
                throw new ZLibException(-1, "Could not open " + fileName);
		}

        /// <summary>

        /// Opens an existing file as a readable GZipStream

        /// </summary>

        /// <param name="fileName">The name of the file to open</param>

        /// <exception cref="ZLibException">If an error occurred in the internal zlib function</exception>

        public GZipStream(string fileName)
        {
            _isWriting = false;
            _gzFile = gzopen(fileName, "rb");
            if (_gzFile == IntPtr.Zero)
                throw new ZLibException(-1, "Could not open " + fileName);

        }
        #endregion


        #region Access properties

        /// <summary>

        /// Returns true of this stream can be read from, false otherwise

        /// </summary>

        public override bool CanRead
        {
            get
            {
                return !_isWriting;
            }
        }
    

        /// <summary>

        /// Returns false.

        /// </summary>

        public override bool CanSeek
        {
            get
            {
                return false;
            }
        }
    
        /// <summary>

        /// Returns true if this tsream is writeable, false otherwise

        /// </summary>

        public override bool CanWrite
        {
            get
            {
                return _isWriting;
            }
        }
        #endregion

    
        #region Destructor & IDispose stuff


        /// <summary>

        /// Destroys this instance

        /// </summary>

        ~GZipStream()
        {
            cleanUp(false);
        }

        /// <summary>

        /// Closes the external file handle

        /// </summary>

        public void Dispose()
        {
            cleanUp(true);
        }

        // Does the actual closing of the file handle.

        private void cleanUp(bool isDisposing)
        {
            if (!_isDisposed)
            {
                gzclose(_gzFile);
                _isDisposed = true;
            }
        }
        #endregion

    
        #region Basic reading and writing

        /// <summary>

        /// Attempts to read a number of bytes from the stream.

        /// </summary>

        /// <param name="buffer">The destination data buffer</param>

        /// <param name="offset">The index of the first destination byte in <c>buffer</c></param>

        /// <param name="count">The number of bytes requested</param>

        /// <returns>The number of bytes read</returns>

        /// <exception cref="ArgumentNullException">If <c>buffer</c> is null</exception>

        /// <exception cref="ArgumentOutOfRangeException">If <c>count</c> or <c>offset</c> are negative</exception>

        /// <exception cref="ArgumentException">If <c>offset</c>  + <c>count</c> is &gt; buffer.Length</exception>

        /// <exception cref="NotSupportedException">If this stream is not readable.</exception>

        /// <exception cref="ObjectDisposedException">If this stream has been disposed.</exception>

        public override int Read(byte[] buffer, int offset, int count)
        {
            if (!CanRead) throw new NotSupportedException();
            if (buffer == null) throw new ArgumentNullException();
            if (offset < 0 || count < 0) throw new ArgumentOutOfRangeException();
            if ((offset+count) > buffer.Length) throw new ArgumentException();
            if (_isDisposed) throw new ObjectDisposedException("GZipStream");

            GCHandle h = GCHandle.Alloc(buffer, GCHandleType.Pinned);
            int result;
            try
            {
                result = gzread(_gzFile, h.AddrOfPinnedObject().ToInt32() + offset, count);
                if (result < 0)
                    throw new IOException();
            }
            finally
            {
                h.Free();
            }
            return result;
        }

        /// <summary>

        /// Attempts to read a single byte from the stream.

        /// </summary>

        /// <returns>The byte that was read, or -1 in case of error or End-Of-File</returns>

        public override int ReadByte()
        {
            if (!CanRead) throw new NotSupportedException();
            if (_isDisposed) throw new ObjectDisposedException("GZipStream");
            return gzgetc(_gzFile);
        }

        /// <summary>

        /// Writes a number of bytes to the stream

        /// </summary>

        /// <param name="buffer"></param>

        /// <param name="offset"></param>

        /// <param name="count"></param>

        /// <exception cref="ArgumentNullException">If <c>buffer</c> is null</exception>

        /// <exception cref="ArgumentOutOfRangeException">If <c>count</c> or <c>offset</c> are negative</exception>

        /// <exception cref="ArgumentException">If <c>offset</c>  + <c>count</c> is &gt; buffer.Length</exception>

        /// <exception cref="NotSupportedException">If this stream is not writeable.</exception>

        /// <exception cref="ObjectDisposedException">If this stream has been disposed.</exception>

        public override void Write(byte[] buffer, int offset, int count)
        {
            if (!CanWrite) throw new NotSupportedException();
            if (buffer == null) throw new ArgumentNullException();
            if (offset < 0 || count < 0) throw new ArgumentOutOfRangeException();
            if ((offset+count) > buffer.Length) throw new ArgumentException();
            if (_isDisposed) throw new ObjectDisposedException("GZipStream");

            GCHandle h = GCHandle.Alloc(buffer, GCHandleType.Pinned);
            try
            {
                int result = gzwrite(_gzFile, h.AddrOfPinnedObject().ToInt32() + offset, count);
                if (result < 0)
                    throw new IOException();
            }
            finally
            {
                h.Free();
            }
        }

        /// <summary>

        /// Writes a single byte to the stream

        /// </summary>

        /// <param name="value">The byte to add to the stream.</param>

        /// <exception cref="NotSupportedException">If this stream is not writeable.</exception>

        /// <exception cref="ObjectDisposedException">If this stream has been disposed.</exception>

        public override void WriteByte(byte value)
        {
            if (!CanWrite) throw new NotSupportedException();
            if (_isDisposed) throw new ObjectDisposedException("GZipStream");

            int result = gzputc(_gzFile, (int)value);
            if (result < 0)
                throw new IOException();
        }
        #endregion


        #region Position & length stuff

        /// <summary>

        /// Not supported.

        /// </summary>

        /// <param name="value"></param>

        /// <exception cref="NotSupportedException">Always thrown</exception>

        public override void SetLength(long value)
        {
            throw new NotSupportedException();
        }
    
        /// <summary>

        ///  Not suppported.

        /// </summary>

        /// <param name="offset"></param>

        /// <param name="origin"></param>

        /// <returns></returns>

        /// <exception cref="NotSupportedException">Always thrown</exception>

        public override long Seek(long offset, SeekOrigin origin)
        {
            throw new NotSupportedException();
        }
    
        /// <summary>

        /// Flushes the <c>GZipStream</c>.

        /// </summary>

        /// <remarks>In this implementation, this method does nothing. This is because excessive

        /// flushing may degrade the achievable compression rates.</remarks>

        public override void Flush()
        {
            // left empty on purpose

        }
    
        /// <summary>

        /// Gets/sets the current position in the <c>GZipStream</c>. Not suppported.

        /// </summary>

        /// <remarks>In this implementation this property is not supported</remarks>

        /// <exception cref="NotSupportedException">Always thrown</exception>

        public override long Position
        {
            get
            {
                throw new NotSupportedException();
            }
            set
            {
                throw new NotSupportedException();
            }
        }
    
        /// <summary>

        /// Gets the size of the stream. Not suppported.

        /// </summary>

        /// <remarks>In this implementation this property is not supported</remarks>

        /// <exception cref="NotSupportedException">Always thrown</exception>

        public override long Length
        {
            get
            {
                throw new NotSupportedException();
            }
        }
        #endregion

    }
}