SabreTools/SabreTools.Library/DatItems/Enums.cs

using System;

namespace SabreTools.Library.DatItems
{
    /// <summary>
    /// Determines which type of duplicate a file is
    /// </summary>
    [Flags]
    public enum DupeType
    {
        // Type of match
        Hash = 1 << 0,
        All = 1 << 1,

        // Location of match
        Internal = 1 << 2,
        External = 1 << 3,
    }

    /// <summary>
    /// List of valid field types within a DatItem/Machine
    /// </summary>
    /// TODO: Should this be split into MachineField and DatItemField?
    /// TODO: Should there also be a DatFileField?
    public enum Field : int
    {
        NULL = 0,

        #region Machine

        #region Common

        MachineName,
        Comment,
        Description,
        Year,
        Manufacturer,
        Publisher,
        Category,
        RomOf,
        CloneOf,
        SampleOf,
        MachineType,

        #endregion

        #region AttractMode

        Players,
        Rotation,
        Control,
        SupportStatus,
        DisplayCount,
        DisplayType,
        Buttons,

        #endregion

        #region ListXML

        SourceFile,
        Runnable,
        DeviceReferences, // TODO: Double-check DeviceReferences usage
        Chips, // TODO: Implement Chips usage
        Displays, // TODO: Implement Displays usage
        Sounds, // TODO: Implement Sounds usage
        Conditions, // TODO: Implement Conditions usage
        Slots, // TODO: Fix Slots usage
        Infos,

        #endregion

        #region Logiqx

        Board,
        RebuildTo,

        #endregion

        #region Logiqx EmuArc

        TitleID,
        Developer,
        Genre,
        Subgenre,
        Ratings,
        Score,
        Enabled,
        HasCrc,
        RelatedTo,

        #endregion

        #region OpenMSX

        GenMSXID,
        System,
        Country,

        #endregion

        #region SoftwareList

        Supported,
        SharedFeatures,
        DipSwitches,

        #endregion

        #endregion // Machine

        #region DatItem

        #region Common

        Name,
        ItemType,

        #endregion

        #region AttractMode

        AltName,
        AltTitle,

        #endregion

        #region OpenMSX

        Original,
        OpenMSXSubType,
        OpenMSXType,
        Remark,
        Boot,

        #endregion

        #region SoftwareList

        PartName,
        PartInterface,
        Features,
        AreaName,
        AreaSize,
        AreaWidth,
        AreaEndianness,
        Value,
        LoadFlag,

        #endregion

        // BiosSet
        Default,
        BiosDescription,

        // Disk
        MD5,
#if NET_FRAMEWORK
        RIPEMD160,
#endif
        SHA1,
        SHA256,
        SHA384,
        SHA512,
        Merge,
        Region,
        Index,
        Writable,
        Optional,
        Status,

        // Release
        Language,
        Date,

        // Rom
        Bios,
        Size,
        CRC,
        Offset,
        Inverted,

        #endregion // DatItem
    }

    /// <summary>
    /// Determine the status of the item
    /// </summary>
    [Flags]
    public enum ItemStatus
    {
        /// <summary>
        /// This is a fake flag that is used for filter only
        /// </summary>
        NULL = 0x00,

        None = 1 << 0,
        Good = 1 << 1,
        BadDump = 1 << 2,
        Nodump = 1 << 3,
        Verified = 1 << 4,
    }

    /// <summary>
    /// Determine what type of file an item is
    /// </summary>
    public enum ItemType
    {
        Rom = 0,
        Disk = 1,
        Sample = 2,
        Release = 3,
        BiosSet = 4,
        Archive = 5,

        Blank = 99, // This is not a real type, only used internally
    }

    /// <summary>
    /// Determine which OpenMSX subtype an item is
    /// </summary>
    [Flags]
    public enum OpenMSXSubType
    {
        NULL = 0,
        Rom = 1,
        MegaRom = 2,
        SCCPlusCart = 3,
    }

    /// <summary>
    /// Determine what type of machine it is
    /// </summary>
    [Flags]
    public enum MachineType
    {
        /// <summary>
        /// This is a fake flag that is used for filter only
        /// </summary>
        NULL = 0x00,

        None = 1 << 0,
        Bios = 1 << 1,
        Device = 1 << 2,
        Mechanical = 1 << 3,
    }

    /// <summary>
    /// Determine machine runnable status
    /// </summary>
    [Flags]
    public enum Runnable
    {
        NULL,
        No,
        Partial,
        Yes,
    }

    /// <summary>
    /// Determine machine support status
    /// </summary>
    [Flags]
    public enum Supported
    {
        NULL,
        No,
        Partial,
        Yes,
    }
}