2
// � Copyright Henrik Ravn 2004
4
// Use, modification and distribution are subject to the Boost Software License, Version 1.0.
5
// (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
10
using System.Runtime.InteropServices;
17
#region Internal types
20
/// Defines constants for the various flush types used with zlib
22
internal enum FlushTypes
24
None, Partial, Sync, Full, Finish, Block
27
#region ZStream structure
28
// internal mapping of the zlib zstream structure for marshalling
29
[StructLayoutAttribute(LayoutKind.Sequential, Pack=4, Size=0, CharSet=CharSet.Ansi)]
30
internal struct ZStream
32
public IntPtr next_in;
36
public IntPtr next_out;
37
public uint avail_out;
38
public uint total_out;
40
[MarshalAs(UnmanagedType.LPStr)]
59
/// Defines constants for the available compression levels in zlib
61
public enum CompressLevel : int
64
/// The default compression level with a reasonable compromise between compression and speed
68
/// No compression at all. The data are passed straight through.
72
/// The maximum compression rate available.
76
/// The fastest available compression level.
82
#region Exception classes
84
/// The exception that is thrown when an error occurs on the zlib dll
86
public class ZLibException : ApplicationException
89
/// Initializes a new instance of the <see cref="ZLibException"/> class with a specified
90
/// error message and error code
92
/// <param name="errorCode">The zlib error code that caused the exception</param>
93
/// <param name="msg">A message that (hopefully) describes the error</param>
94
public ZLibException(int errorCode, string msg) : base(String.Format("ZLib error {0} {1}", errorCode, msg))
99
/// Initializes a new instance of the <see cref="ZLibException"/> class with a specified
102
/// <param name="errorCode">The zlib error code that caused the exception</param>
103
public ZLibException(int errorCode) : base(String.Format("ZLib error {0}", errorCode))
112
/// Declares methods and properties that enables a running checksum to be calculated
114
public interface ChecksumGenerator
117
/// Gets the current value of the checksum
122
/// Clears the current checksum to 0
127
/// Updates the current checksum with an array of bytes
129
/// <param name="data">The data to update the checksum with</param>
130
void Update(byte[] data);
133
/// Updates the current checksum with part of an array of bytes
135
/// <param name="data">The data to update the checksum with</param>
136
/// <param name="offset">Where in <c>data</c> to start updating</param>
137
/// <param name="count">The number of bytes from <c>data</c> to use</param>
138
/// <exception cref="ArgumentException">The sum of offset and count is larger than the length of <c>data</c></exception>
139
/// <exception cref="ArgumentNullException"><c>data</c> is a null reference</exception>
140
/// <exception cref="ArgumentOutOfRangeException">Offset or count is negative.</exception>
141
void Update(byte[] data, int offset, int count);
144
/// Updates the current checksum with the data from a string
146
/// <param name="data">The string to update the checksum with</param>
147
/// <remarks>The characters in the string are converted by the UTF-8 encoding</remarks>
148
void Update(string data);
151
/// Updates the current checksum with the data from a string, using a specific encoding
153
/// <param name="data">The string to update the checksum with</param>
154
/// <param name="encoding">The encoding to use</param>
155
void Update(string data, Encoding encoding);
160
/// Represents the method that will be called from a codec when new data
163
/// <paramref name="data">The byte array containing the processed data</paramref>
164
/// <paramref name="startIndex">The index of the first processed byte in <c>data</c></paramref>
165
/// <paramref name="count">The number of processed bytes available</paramref>
166
/// <remarks>On return from this method, the data may be overwritten, so grab it while you can.
167
/// You cannot assume that startIndex will be zero.
169
public delegate void DataAvailableHandler(byte[] data, int startIndex, int count);
172
/// Declares methods and events for implementing compressors/decompressors
174
public interface Codec
177
/// Occurs when more processed data are available.
179
event DataAvailableHandler DataAvailable;
182
/// Adds more data to the codec to be processed.
184
/// <param name="data">Byte array containing the data to be added to the codec</param>
185
/// <remarks>Adding data may, or may not, raise the <c>DataAvailable</c> event</remarks>
186
void Add(byte[] data);
189
/// Adds more data to the codec to be processed.
191
/// <param name="data">Byte array containing the data to be added to the codec</param>
192
/// <param name="offset">The index of the first byte to add from <c>data</c></param>
193
/// <param name="count">The number of bytes to add</param>
194
/// <remarks>Adding data may, or may not, raise the <c>DataAvailable</c> event</remarks>
195
void Add(byte[] data, int offset, int count);
198
/// Finishes up any pending data that needs to be processed and handled.
203
/// Gets the checksum of the data that has been added so far
205
uint Checksum { get; }
214
/// Encapsulates general information about the ZLib library
219
[DllImport("ZLIB1.dll", CallingConvention=CallingConvention.Cdecl)]
220
private static extern uint zlibCompileFlags();
222
[DllImport("ZLIB1.dll", CallingConvention=CallingConvention.Cdecl)]
223
private static extern string zlibVersion();
226
#region Private stuff
229
// helper function that unpacks a bitsize mask
230
private static int bitSize(uint bits)
243
/// Constructs an instance of the <c>Info</c> class.
247
_flags = zlibCompileFlags();
251
/// True if the library is compiled with debug info
253
public bool HasDebugInfo { get { return 0 != (_flags & 0x100); } }
256
/// True if the library is compiled with assembly optimizations
258
public bool UsesAssemblyCode { get { return 0 != (_flags & 0x200); } }
261
/// Gets the size of the unsigned int that was compiled into Zlib
263
public int SizeOfUInt { get { return bitSize(_flags & 3); } }
266
/// Gets the size of the unsigned long that was compiled into Zlib
268
public int SizeOfULong { get { return bitSize((_flags >> 2) & 3); } }
271
/// Gets the size of the pointers that were compiled into Zlib
273
public int SizeOfPointer { get { return bitSize((_flags >> 4) & 3); } }
276
/// Gets the size of the z_off_t type that was compiled into Zlib
278
public int SizeOfOffset { get { return bitSize((_flags >> 6) & 3); } }
281
/// Gets the version of ZLib as a string, e.g. "1.2.1"
283
public static string Version { get { return zlibVersion(); } }