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>
    /// Determine the feature type
    /// </summary>
    [Flags]
    public enum FeatureType
    {
        /// <summary>
        /// This is a fake flag that is used for filter only
        /// </summary>
        NULL = 0,

        Protection = 1 << 0,
        Palette = 1 << 1,
        Graphics = 1 << 2,
        Sound = 1 << 3,
        Controls = 1 << 4,
        Keyboard = 1 << 5,
        Mouse = 1 << 6,
        Microphone = 1 << 7,
        Camera = 1 << 8,
        Disk = 1 << 9,
        Printer = 1 << 10,
        Lan = 1 << 11,
        Wan = 1 << 12,
        Timing = 1 << 13,
    }

    /// <summary>
    /// List of valid field types within a DatItem/Machine
    /// </summary>
    /// TODO: Move this to a more common location
    /// TODO: Should this be split into separate enums?
    public enum Field : int
    {
        NULL = 0,

        #region DatHeader

        #region Common

        DatHeader_FileName,
        DatHeader_Name,
        DatHeader_Description,
        DatHeader_RootDir,
        DatHeader_Category,
        DatHeader_Version,
        DatHeader_Date,
        DatHeader_Author,
        DatHeader_Email,
        DatHeader_Homepage,
        DatHeader_Url,
        DatHeader_Comment,
        DatHeader_HeaderSkipper,
        DatHeader_Type,
        DatHeader_ForceMerging,
        DatHeader_ForceNodump,
        DatHeader_ForcePacking,

        #endregion

        #region ListXML

        DatHeader_Debug,
        DatHeader_MameConfig,

        #endregion

        #region Logiqx

        DatHeader_Build,
        DatHeader_RomMode,
        DatHeader_BiosMode,
        DatHeader_SampleMode,
        DatHeader_LockRomMode,
        DatHeader_LockBiosMode,
        DatHeader_LockSampleMode,

        #endregion

        #region OfflineList

        DatHeader_System,
        DatHeader_ScreenshotsWidth,
        DatHeader_ScreenshotsHeight,
        DatHeader_CanOpen,
        DatHeader_RomTitle,

        // Infos
        DatHeader_Infos,
        DatHeader_Info_Name,
        DatHeader_Info_Visible,
        DatHeader_Info_IsNamingOption,
        DatHeader_Info_Default,

        #endregion

        #region RomCenter

        DatHeader_RomCenterVersion,

        #endregion

        #endregion // DatHeader

        #region Machine

        #region Common

        Machine_Name,
        Machine_Comment,
        Machine_Description,
        Machine_Year,
        Machine_Manufacturer,
        Machine_Publisher,
        Machine_Category,
        Machine_RomOf,
        Machine_CloneOf,
        Machine_SampleOf,
        Machine_Type,

        #endregion

        #region AttractMode

        Machine_Players,
        Machine_Rotation,
        Machine_Control,
        Machine_Status,
        Machine_DisplayCount,
        Machine_DisplayType,
        Machine_Buttons,

        #endregion

        #region ListXML

        Machine_SourceFile,
        Machine_Runnable,

        // Displays
        Machine_Displays,
        Machine_Display_Tag,
        Machine_Display_Type,
        Machine_Display_Rotate,
        Machine_Display_FlipX,
        Machine_Display_Width,
        Machine_Display_Height,
        Machine_Display_Refresh,
        Machine_Display_PixClock,
        Machine_Display_HTotal,
        Machine_Display_HBEnd,
        Machine_Display_HBStart,
        Machine_Display_VTotal,
        Machine_Display_VBEnd,
        Machine_Display_VBStart,

        // Conditions
        Machine_Conditions,
        Machine_Condition_Tag,
        Machine_Condition_Mask,
        Machine_Condition_Relation,
        Machine_Condition_Value,

        // Inputs
        Machine_Inputs,
        Machine_Input_Service,
        Machine_Input_Tilt,
        Machine_Input_Players,
        Machine_Input_Coins,

        // Inputs.Controls
        Machine_Input_Controls,
        Machine_Input_Control_Type,
        Machine_Input_Control_Player,
        Machine_Input_Control_Buttons,
        Machine_Input_Control_RegButtons,
        Machine_Input_Control_Minimum,
        Machine_Input_Control_Maximum,
        Machine_Input_Control_Sensitivity,
        Machine_Input_Control_KeyDelta,
        Machine_Input_Control_Reverse,
        Machine_Input_Control_Ways,
        Machine_Input_Control_Ways2,
        Machine_Input_Control_Ways3,

        // Ports
        Machine_Ports,
        Machine_Port_Tag,

        // Ports.Analogs
        Machine_Port_Analogs,
        Machine_Port_Analog_Mask,

        // Drivers
        Machine_Drivers,
        Machine_Driver_Status,
        Machine_Driver_Emulation,
        Machine_Driver_Cocktail,
        Machine_Driver_SaveState,

        // Devices
        Machine_Devices,
        Machine_Device_Type,
        Machine_Device_Tag,
        Machine_Device_FixedImage,
        Machine_Device_Mandatory,
        Machine_Device_Interface,

        // Devices.Instances
        Machine_Device_Instances,
        Machine_Device_Instance_Name,
        Machine_Device_Instance_BriefName,

        // Devices.Extensions
        Machine_Device_Extensions,
        Machine_Device_Extension_Name,

        #endregion

        #region Logiqx

        Machine_Board,
        Machine_RebuildTo,

        #endregion

        #region Logiqx EmuArc

        Machine_TitleID,
        Machine_Developer,
        Machine_Genre,
        Machine_Subgenre,
        Machine_Ratings,
        Machine_Score,
        Machine_Enabled,
        Machine_CRC,
        Machine_RelatedTo,

        #endregion

        #region OpenMSX

        Machine_GenMSXID,
        Machine_System,
        Machine_Country,

        #endregion

        #region SoftwareList

        Machine_Supported,

        // Infos
        Machine_Infos, // TODO: Fix usage of Infos
        Machine_Info_Name,
        Machine_Info_Value,

        // SharedFeatures
        Machine_SharedFeatures, // TODO: Fix usage of SharedFeatures
        Machine_SharedFeature_Name,
        Machine_SharedFeature_Value,

        #endregion

        #endregion // Machine

        #region DatItem

        #region Common

        DatItem_Name,
        DatItem_Type,

        #endregion

        #region AttractMode

        DatItem_AltName,
        DatItem_AltTitle,

        #endregion

        #region OpenMSX

        DatItem_Original,
        DatItem_OpenMSXSubType,
        DatItem_OpenMSXType,
        DatItem_Remark,
        DatItem_Boot,

        #endregion

        #region SoftwareList

        // Part
        DatItem_Part,
        DatItem_Part_Name,
        DatItem_Part_Interface,

        // Feature
        DatItem_Features,
        DatItem_Feature_Name,
        DatItem_Feature_Value,

        DatItem_AreaName,
        DatItem_AreaSize,
        DatItem_AreaWidth,
        DatItem_AreaEndianness,
        DatItem_Value,
        DatItem_LoadFlag,

        #endregion

        #region Item-Specific

        #region Actionable

        // Rom
        DatItem_Bios,
        DatItem_Size,
        DatItem_CRC,
        DatItem_MD5,
#if NET_FRAMEWORK
        DatItem_RIPEMD160,
#endif
        DatItem_SHA1,
        DatItem_SHA256,
        DatItem_SHA384,
        DatItem_SHA512,
        DatItem_Merge,
        DatItem_Region,
        DatItem_Offset,
        DatItem_Date,
        DatItem_Status,
        DatItem_Optional,
        DatItem_Inverted,

        // Disk
        DatItem_Index,
        DatItem_Writable,

        #endregion

        #region Auxiliary

        // Adjuster
        DatItem_Default,
        DatItem_Conditions,
        DatItem_Condition_Tag,
        DatItem_Condition_Mask,
        DatItem_Condition_Relation,
        DatItem_Condition_Value,

        // BiosSet
        DatItem_Description,

        // Chip
        DatItem_Tag,
        DatItem_ChipType,
        DatItem_Clock,

        // Configuration
        DatItem_Mask,

        // Configuration.Locations
        DatItem_Locations,
        DatItem_Location_Name,
        DatItem_Location_Number,
        DatItem_Location_Inverted,

        // Configuration.Settings
        DatItem_Settings,
        DatItem_Setting_Name,
        DatItem_Setting_Value,
        DatItem_Setting_Default,

        // DIP Switch.Values
        DatItem_Values,
        DatItem_Value_Name,
        DatItem_Value_Value,
        DatItem_Value_Default,

        // Feature
        DatItem_FeatureType,
        DatItem_FeatureStatus,
        DatItem_FeatureOverall,

        // Ram Option
        DatItem_Content,

        // Release
        DatItem_Language,

        // Slot.SlotOptions
        DatItem_SlotOptions,
        DatItem_SlotOption_Name,
        DatItem_SlotOption_DeviceName,
        DatItem_SlotOption_Default,

        // Software List
        DatItem_SoftwareListStatus,
        DatItem_Filter,

        // Sounds
        DatItem_Channels,

        #endregion

        #endregion // Item-Specific

        #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 = 0,

        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
    {
        // "Actionable" item types
        Rom,
        Disk,
        Media,

        // "Auxiliary" item types
        Adjuster,
        Archive,
        BiosSet,
        Chip,
        Configuration,
        DeviceReference,
        DipSwitch,
        Feature,
        RamOption,
        Release,
        Sample,
        Slot,
        SoftwareList,
        Sound,

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

    /// <summary>
    /// Determine which OpenMSX subtype an item is
    /// </summary>
    [Flags]
    public enum OpenMSXSubType
    {
        /// <summary>
        /// This is a fake flag that is used for filter only
        /// </summary>
        NULL = 0,

        Rom = 1 << 0,
        MegaRom = 1 << 1,
        SCCPlusCart = 1 << 2,
    }

    /// <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 = 1 << 0,

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

    /// <summary>
    /// Determine machine runnable status
    /// </summary>
    [Flags]
    public enum Runnable
    {
        /// <summary>
        /// This is a fake flag that is used for filter only
        /// </summary>
        NULL = 0,

        No = 1 << 0,
        Partial = 1 << 1,
        Yes = 1 << 2,
    }

    /// <summary>
    /// Determine software list status
    /// </summary>
    [Flags]
    public enum SoftwareListStatus
    {
        /// <summary>
        /// This is a fake flag that is used for filter only
        /// </summary>
        NULL = 0,

        Original = 1 << 0,
        Compatible = 1 << 1,
    }

    /// <summary>
    /// Determine machine support status
    /// </summary>
    [Flags]
    public enum Supported
    {
        /// <summary>
        /// This is a fake flag that is used for filter only
        /// </summary>
        NULL = 0,

        No = 1 << 0,
        Partial = 1 << 1,
        Yes = 1 << 2,
    }
}