SabreTools.Serialization/SabreTools.Data.Models/Metadata/Header.cs

namespace SabreTools.Data.Models.Metadata
{
    /// <summary>
    /// Format-agnostic representation of metadata header data
    /// </summary>
    public class Header : DictionaryBase
    {
        #region Properties

        public string? Author { get; set; }

        /// <remarks>(none|split|merged|nonmerged|fullmerged|device|full) "split"</remarks>
        public MergingFlag BiosMode { get; set; }

        public string? Build { get; set; }

        public string? Category { get; set; }

        public string? Comment { get; set; }

        public string? Date { get; set; }

        public string? DatVersion { get; set; }

        /// <remarks>(yes|no) "no"</remarks>
        public bool? Debug { get; set; }

        public string? Description { get; set; }

        public string? Email { get; set; }

        public string? EmulatorVersion { get; set; }

        /// <remarks>(none|split|merged|nonmerged|fullmerged|device|full) "split"</remarks>
        public MergingFlag ForceMerging { get; set; }

        /// <remarks>(obsolete|required|ignore) "obsolete"</remarks>
        public NodumpFlag ForceNodump { get; set; }

        /// <remarks>(zip|unzip) "zip"</remarks>
        public PackingFlag ForcePacking { get; set; }

        /// <remarks>(yes|no) "yes"</remarks>
        public bool? ForceZipping { get; set; }

        public string? Homepage { get; set; }

        public string? Id { get; set; }

        /// <remarks>(yes|no) "no"</remarks>
        public bool? LockBiosMode { get; set; }

        /// <remarks>(yes|no) "no"</remarks>
        public bool? LockRomMode { get; set; }

        /// <remarks>(yes|no) "no"</remarks>
        public bool? LockSampleMode { get; set; }

        public string? MameConfig { get; set; }

        public string? Name { get; set; }

        public string? Notes { get; set; }

        public string? Plugin { get; set; }

        public string? RefName { get; set; }

        /// <remarks>(none|split|merged|nonmerged|fullmerged|device|full) "split"</remarks>
        public MergingFlag RomMode { get; set; }

        public string? RomTitle { get; set; }

        public string? RootDir { get; set; }

        /// <remarks>(none|split|merged|nonmerged|fullmerged|device|full) "split"</remarks>
        public MergingFlag SampleMode { get; set; }

        public string? System { get; set; }

        public string? Timestamp { get; set; }

        public string? Type { get; set; }

        public string? Url { get; set; }

        public string? Version { get; set; }

        #endregion

        #region Keys

        /// TODO: This needs an internal model OR mapping to fields
        /// <remarks>CanOpen</remarks>
        [NoFilter]
        public const string CanOpenKey = "canOpen";

        /// <remarks>string, string[]</remarks>
        public const string HeaderKey = "header";

        /// TODO: This needs an internal model OR mapping to fields
        /// <remarks>Search</remarks>
        [NoFilter]
        public const string ImagesKey = "images";

        /// <remarks>string</remarks>
        public const string ImFolderKey = "imFolder";

        /// TODO: This needs an internal model OR mapping to fields
        /// <remarks>Infos</remarks>
        [NoFilter]
        public const string InfosKey = "infos";

        /// TODO: This needs an internal model OR mapping to fields
        /// <remarks>NewDat</remarks>
        [NoFilter]
        public const string NewDatKey = "newDat";

        /// <remarks>string</remarks>
        public const string SchemaLocationKey = "schemaLocation";

        /// <remarks>string</remarks>
        public const string ScreenshotsHeightKey = "screenshotsHeight";

        /// <remarks>string</remarks>
        public const string ScreenshotsWidthKey = "screenshotsWidth";

        /// TODO: This needs an internal model OR mapping to fields
        /// <remarks>Search</remarks>
        [NoFilter]
        public const string SearchKey = "search";

        #endregion
    }
}