Skip to content

Commit ad8b2d0

Browse files
committed
Add some notes
1 parent 6aa463f commit ad8b2d0

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

UnshieldSharp/InstallShieldCabinet.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ public class InstallShieldCabinet
3030
/// <summary>
3131
/// Maximum size of the window in bits
3232
/// </summary>
33+
/// TODO: Remove when Serialization is updated
3334
private const int MAX_WBITS = 15;
3435

3536
#region Open Cabinet
@@ -272,6 +273,7 @@ public bool FileSaveRaw(int index, string filename)
272273
/// <summary>
273274
/// Common code for getting the bytes to read
274275
/// </summary>
276+
/// TODO: Replace with GetReadableBytes when Serialization is updated
275277
private static ulong GetBytesToRead(FileDescriptor fd)
276278
{
277279
#if NET20 || NET35
@@ -287,6 +289,7 @@ private static ulong GetBytesToRead(FileDescriptor fd)
287289
/// <summary>
288290
/// Common code for getting the file descriptor
289291
/// </summary>
292+
/// TODO: Replace with GetFileDescriptorWithVerification when Serialization is updated
290293
private FileDescriptor? GetFileDescriptor(int index)
291294
{
292295
if (HeaderList == null)
@@ -322,6 +325,7 @@ private static ulong GetBytesToRead(FileDescriptor fd)
322325
/// <summary>
323326
/// Uncompress a source byte array to a destination
324327
/// </summary>
328+
/// TODO: Remove when Serialization is updated
325329
internal unsafe static int Uncompress(byte[] dest, ref ulong destLen, byte[] source, ref ulong sourceLen)
326330
{
327331
fixed (byte* sourcePtr = source)
@@ -356,6 +360,7 @@ internal unsafe static int Uncompress(byte[] dest, ref ulong destLen, byte[] sou
356360
/// <summary>
357361
/// Uncompress a source byte array to a destination (old version)
358362
/// </summary>
363+
/// TODO: Remove when Serialization is updated
359364
internal unsafe static int UncompressOld(byte[] dest, ref ulong destLen, byte[] source, ref ulong sourceLen)
360365
{
361366
fixed (byte* sourcePtr = source)
@@ -400,6 +405,7 @@ internal unsafe static int UncompressOld(byte[] dest, ref ulong destLen, byte[]
400405
/// <summary>
401406
/// Open a cabinet file for reading
402407
/// </summary>
408+
/// TODO: Remove when Serialization is updated
403409
public Stream? OpenFileForReading(int index, string suffix)
404410
{
405411
if (string.IsNullOrEmpty(filenamePattern))
@@ -421,6 +427,7 @@ internal unsafe static int UncompressOld(byte[] dest, ref ulong destLen, byte[]
421427
/// <summary>
422428
/// Create the generic filename pattern to look for from the input filename
423429
/// </summary>
430+
/// TODO: Remove when Serialization is updated
424431
private bool CreateFilenamePattern(string filename)
425432
{
426433
if (string.IsNullOrEmpty(filename))
@@ -440,6 +447,7 @@ private bool CreateFilenamePattern(string filename)
440447
/// <summary>
441448
/// Read headers from the current file
442449
/// </summary>
450+
/// TODO: Remove when Serialization is updated
443451
private bool ReadHeaders()
444452
{
445453
if (HeaderList != null)

0 commit comments

Comments
 (0)