Name is not guaranteed

SabreTools.Library/DatItems/Sample.cs

@@ -1,4 +1,10 @@
-using Newtonsoft.Json;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+
+using SabreTools.Library.Filtering;
+using SabreTools.Library.Tools;
+using Newtonsoft.Json;
 
 namespace SabreTools.Library.DatItems
 {
@@ -8,6 +14,43 @@ namespace SabreTools.Library.DatItems
     [JsonObject("sample")]
     public class Sample : DatItem
     {
+        #region Fields
+
+        /// <summary>
+        /// Name of the item
+        /// </summary>
+        [JsonProperty("name")]
+        public string Name { get; set; }
+
+        #endregion
+
+        #region Accessors
+
+        /// <summary>
+        /// Gets the name to use for a DatItem
+        /// </summary>
+        /// <returns>Name if available, null otherwise</returns>
+        public override string GetName()
+        {
+            return Name;
+        }
+
+        /// <summary>
+        /// Set fields with given values
+        /// </summary>
+        /// <param name="mappings">Mappings dictionary</param>
+        public override void SetFields(Dictionary<Field, string> mappings)
+        {
+            // Set base fields
+            base.SetFields(mappings);
+
+            // Handle Sample-specific fields
+            if (mappings.Keys.Contains(Field.DatItem_Name))
+                Name = mappings[Field.DatItem_Name];
+        }
+
+        #endregion
+
         #region Constructors
 
         /// <summary>
@@ -73,5 +116,106 @@ namespace SabreTools.Library.DatItems
         }
 
         #endregion
+
+        #region Filtering
+
+        /// <summary>
+        /// Clean a DatItem according to the cleaner
+        /// </summary>
+        /// <param name="cleaner">Cleaner to implement</param>
+        public override void Clean(Cleaner cleaner)
+        {
+            // Clean common items first
+            base.Clean(cleaner);
+
+            // If we're stripping unicode characters, strip item name
+            if (cleaner?.RemoveUnicode == true)
+                Name = Sanitizer.RemoveUnicodeCharacters(Name);
+
+            // If we are in NTFS trim mode, trim the game name
+            if (cleaner?.Trim == true)
+            {
+                // Windows max name length is 260
+                int usableLength = 260 - Machine.Name.Length - (cleaner.Root?.Length ?? 0);
+                if (Name.Length > usableLength)
+                {
+                    string ext = Path.GetExtension(Name);
+                    Name = Name.Substring(0, usableLength - ext.Length);
+                    Name += ext;
+                }
+            }
+        }
+
+        /// <summary>
+        /// Check to see if a DatItem passes the filter
+        /// </summary>
+        /// <param name="filter">Filter to check against</param>
+        /// <returns>True if the item passed the filter, false otherwise</returns>
+        public override bool PassesFilter(Filter filter)
+        {
+            // Check common fields first
+            if (!base.PassesFilter(filter))
+                return false;
+
+            // Filter on item name
+            if (filter.DatItem_Name.MatchesPositiveSet(Name) == false)
+                return false;
+            if (filter.DatItem_Name.MatchesNegativeSet(Name) == true)
+                return false;
+
+            return true;
+        }
+
+        /// <summary>
+        /// Remove fields from the DatItem
+        /// </summary>
+        /// <param name="fields">List of Fields to remove</param>
+        public override void RemoveFields(List<Field> fields)
+        {
+            // Remove common fields first
+            base.RemoveFields(fields);
+
+            // Remove the fields
+            if (fields.Contains(Field.DatItem_Name))
+                Name = null;
+        }
+
+        /// <summary>
+        /// Set internal names to match One Rom Per Game (ORPG) logic
+        /// </summary>
+        public override void SetOneRomPerGame()
+        {
+            string[] splitname = Name.Split('.');
+            Machine.Name += $"/{string.Join(".", splitname.Take(splitname.Length > 1 ? splitname.Length - 1 : 1))}";
+            Name = Path.GetFileName(Name);
+        }
+
+        #endregion
+
+        #region Sorting and Merging
+
+        /// <summary>
+        /// Replace fields from another item
+        /// </summary>
+        /// <param name="item">DatItem to pull new information from</param>
+        /// <param name="fields">List of Fields representing what should be updated</param>
+        public override void ReplaceFields(DatItem item, List<Field> fields)
+        {
+            // Replace common fields first
+            base.ReplaceFields(item, fields);
+
+            // If we don't have a Sample to replace from, ignore specific fields
+            if (item.ItemType != ItemType.Sample)
+                return;
+
+            // Cast for easier access
+            Sample newItem = item as Sample;
+
+            // Replace the fields
+            if (fields.Contains(Field.DatItem_Name))
+                Name = newItem.Name;
+        }
+
+        #endregion
     }
 }