SabreTools.Serialization/SabreTools.Data.Models/WiseInstaller/OverlayHeader.cs

namespace SabreTools.Data.Models.WiseInstaller
{
    /// <summary>
    /// Wise installer overlay data header
    /// </summary>
    /// <see href="https://codeberg.org/CYBERDEV/REWise/src/branch/master/src/wiseoverlay.h"/>
    public class OverlayHeader
    {
        /// <summary>
        /// DLL name length, if it exists
        /// </summary>
        public byte DllNameLen { get; set; } // 0x00

        /// <summary>
        /// DLL name, missing if <see cref="DllNameLen"/> is 0
        /// </summary>
        public string? DllName { get; set; } //

        /// <summary>
        /// DLL size, missing if <see cref="DllNameLen"/> is 0
        /// </summary>
        public uint? DllSize { get; set; } //

        /// <summary>
        /// Packing flags
        /// </summary>
        public OverlayHeaderFlags Flags { get; set; } // 0x01 - 0x04

        /// <summary>
        /// Graphics data
        /// </summary>
        /// <remarks>
        /// 12 bytes
        ///
        /// When the data is processed, it does the following:
        ///
        /// ushort[] colors = new ushort[3];
        /// int colorsPtr = 0;
        ///
        /// for (int i = 0; i < 3; i++)
        /// {
        ///     uint color = (GraphicsData[i + 3] * <mult>) / 0x5F + GraphicsData[i];
        ///     colors[colorsPtr] = color;
        ///     if (color < 0)
        ///         colors[colorsPtr] = 0;
        ///     if (colors[colorsPtr] > 0xFF)
        ///         colors[colorsPtr] = 0xFF
        ///
        ///     colorsPtr++;
        /// }
        /// </remarks>
        public byte[] GraphicsData { get; set; } = new byte[12]; // 0x05 - 0x10

        /// <summary>
        /// Points to the Exit event in the script, if it exists
        /// </summary>
        public uint WiseScriptExitEventOffset { get; set; } // 0x11 - 0x14

        /// <summary>
        /// Points to the Cancel event in the script, if it exists
        /// </summary>
        public uint WiseScriptCancelEventOffset { get; set; } // 0x15 - 0x18

        /// <summary>
        /// Inflated size of the Wise installer script
        /// </summary>
        public uint WiseScriptInflatedSize { get; set; } // 0x19 - 0x1C

        /// <summary>
        /// Deflated size of the Wise installer script
        /// </summary>
        public uint WiseScriptDeflatedSize { get; set; } // 0x1D - 0x20

        /// <summary>
        /// Deflated size of WISE0001.DLL
        /// </summary>
        public uint WiseDllDeflatedSize { get; set; } // 0x21 - 0x24

        /// <summary>
        /// Deflated size of CTL3D32.DLL
        /// </summary>
        public uint Ctl3d32DeflatedSize { get; set; } // 0x25 - 0x28

        /// <summary>
        /// Deflated size of unknown data
        /// </summary>
        public uint SomeData4DeflatedSize { get; set; } // 0x29 - 0x2C

        /// <summary>
        /// Deflated size of Ocxreg32.EXE,
        /// </summary>
        public uint RegToolDeflatedSize { get; set; } // 0x2D - 0x30

        /// <summary>
        /// Deflated size of PROGRESS.DLL
        /// </summary>
        public uint ProgressDllDeflatedSize { get; set; } // 0x31 - 0x34

        /// <summary>
        /// Deflated size of unknown data
        /// </summary>
        public uint SomeData7DeflatedSize { get; set; } // 0x35 - 0x38

        /// <summary>
        /// Deflated size of unknown data
        /// </summary>
        public uint SomeData8DeflatedSize { get; set; } // 0x39 - 0x3C

        /// <summary>
        /// Deflated size of unknown data
        /// </summary>
        /// <remarks>Samples were MS-DOS executables</remarks>
        public uint SomeData9DeflatedSize { get; set; } // 0x3D - 0x40

        /// <summary>
        /// Deflated size of unknown data
        /// </summary>
        public uint SomeData10DeflatedSize { get; set; } // 0x41 - 0x44

        /// <summary>
        /// Deflated size of FILE000{n}.DAT
        /// </summary>
        public uint FinalFileDeflatedSize { get; set; } // 0x45 - 0x48

        /// <summary>
        /// Inflated size of FILE000{n}.DAT
        /// </summary>
        public uint FinalFileInflatedSize { get; set; } // 0x49 - 0x4C

        /// <summary>
        /// On multi-disc installers this is set to 0x00000000, so it may
        /// represent EOF instead of filesize? At least for now. Only compared
        /// the two multi-disc installers listed in the README.md, need more
        /// multi-disc installers to properly compare. On single file
        /// installers this is this installer it's filesize.
        /// </summary>
        public uint EOF { get; set; } // 0x4D - 0x50

        /// <summary>
        /// Deflated size of the DIB
        /// </summary>
        /// <remarks>First file</remarks>
        public uint DibDeflatedSize { get; set; } // 0x51 - 0x54

        /// <summary>
        /// Inflated size of the DIB
        /// </summary>
        /// <remarks>First file</remarks>
        public uint DibInflatedSize { get; set; } // 0x55 - 0x58

        /// <summary>
        /// Deflated size of the install script
        /// </summary>
        /// <remarks>Only present in later versions</remarks>
        public uint? InstallScriptDeflatedSize { get; set; } // 0x59 - 0x5C

        /// <summary>
        /// Character set for the font
        /// </summary>
        /// <remarks>
        /// Only present in later versions. In the overlay reading code
        /// present in those later versions, it is lumped in with the
        /// rest of the sizes above.
        /// </remarks>
        public CharacterSet? CharacterSet { get; set; } // 0x5D - 0x60

        /// <summary>
        /// Endianness of the file(?)
        /// </summary>
        public Endianness Endianness { get; set; } // 0x61 - 0x62

        /// <summary>
        /// Init text length
        /// </summary>
        public byte InitTextLen { get; set; } // 0x63

        /// <summary>
        /// Init text whose length is given by <see cref="InitTextLen"/>
        /// </summary>
        public string? InitText { get; set; } // 0x64 -
    }
}