Start supporting ordered tags and non-tags

CHANGELIST.md

@@ -56,6 +56,7 @@
 - Ensure ordering in output site tags
 - Make site code formatting helper method
 - Better helper method organization
+- Start supporting ordered tags and non-tags
 
 ### 2.2 (2021-12-30)
 - Fix Saturn header finding

MPF.Library/InfoTool.cs

@@ -912,8 +912,7 @@ namespace MPF.Library
 
                 // Add all special fields before any contents
                 info.CommonDiscInfo.Contents = string.Join(
-                    "\n", info.CommonDiscInfo.ContentsSpecialFields
-                        .OrderBy(kvp => kvp.Key)
+                    "\n", OrderContentTags(info.CommonDiscInfo.ContentsSpecialFields)
                         .Where(kvp => !string.IsNullOrWhiteSpace(kvp.Value))
                         .Select(FormatSiteTag)
                         .Where(s => !string.IsNullOrEmpty(s))
@@ -1875,6 +1874,64 @@ namespace MPF.Library
             }
         }
 
+        /// <summary>
+        /// Order comment code tags according to Redump requirements
+        /// </summary>
+        /// <returns>Ordered list of KeyValuePairs representing the tags and values</returns>
+        private static List<KeyValuePair<SiteCode?, string>> OrderCommentTags(Dictionary<SiteCode?, string> tags)
+        {
+            var sorted = new List<KeyValuePair<SiteCode?, string>>();
+
+            // If the input is invalid, just return an empty set
+            if (tags == null || tags.Count == 0)
+                return sorted;
+
+            return sorted;
+        }
+
+        /// <summary>
+        /// Order content code tags according to Redump requirements
+        /// </summary>
+        /// <returns>Ordered list of KeyValuePairs representing the tags and values</returns>
+        private static List<KeyValuePair<SiteCode?, string>> OrderContentTags(Dictionary<SiteCode?, string> tags)
+        {
+            var sorted = new List<KeyValuePair<SiteCode?, string>>();
+
+            // If the input is invalid, just return an empty set
+            if (tags == null || tags.Count == 0)
+                return sorted;
+
+            // Games
+            if (tags.ContainsKey(SiteCode.Games))
+                sorted.Add(new KeyValuePair<SiteCode?, string>(SiteCode.Games, tags[SiteCode.Games]));
+            if (tags.ContainsKey(SiteCode.NetYarozeGames))
+                sorted.Add(new KeyValuePair<SiteCode?, string>(SiteCode.NetYarozeGames, tags[SiteCode.NetYarozeGames]));
+            
+            // Demos
+            if (tags.ContainsKey(SiteCode.PlayableDemos))
+                sorted.Add(new KeyValuePair<SiteCode?, string>(SiteCode.PlayableDemos, tags[SiteCode.PlayableDemos]));
+            if (tags.ContainsKey(SiteCode.RollingDemos))
+                sorted.Add(new KeyValuePair<SiteCode?, string>(SiteCode.RollingDemos, tags[SiteCode.RollingDemos]));
+            if (tags.ContainsKey(SiteCode.TechDemos))
+                sorted.Add(new KeyValuePair<SiteCode?, string>(SiteCode.TechDemos, tags[SiteCode.TechDemos]));
+
+            // Video
+            if (tags.ContainsKey(SiteCode.GameFootage))
+                sorted.Add(new KeyValuePair<SiteCode?, string>(SiteCode.GameFootage, tags[SiteCode.GameFootage]));
+            if (tags.ContainsKey(SiteCode.Videos))
+                sorted.Add(new KeyValuePair<SiteCode?, string>(SiteCode.Videos, tags[SiteCode.Videos]));
+
+            // Miscellaneous
+            if (tags.ContainsKey(SiteCode.Patches))
+                sorted.Add(new KeyValuePair<SiteCode?, string>(SiteCode.Patches, tags[SiteCode.Patches]));
+            if (tags.ContainsKey(SiteCode.Savegames))
+                sorted.Add(new KeyValuePair<SiteCode?, string>(SiteCode.Savegames, tags[SiteCode.Savegames]));
+            if (tags.ContainsKey(SiteCode.Extras))
+                sorted.Add(new KeyValuePair<SiteCode?, string>(SiteCode.Extras, tags[SiteCode.Extras]));
+
+            return sorted;
+        }
+
         #endregion
     }
 }

MPF/ViewModels/DiscInformationViewModel.cs

@@ -268,24 +268,33 @@ namespace MPF.GUI.ViewModels
             // Content Fields
             if (SubmissionInfo.CommonDiscInfo.ContentsSpecialFields != null)
             {
-                if (SubmissionInfo.CommonDiscInfo.ContentsSpecialFields.ContainsKey(SiteCode.Extras))
-                    Parent.ExtrasTextBox.Text = SubmissionInfo.CommonDiscInfo.ContentsSpecialFields[SiteCode.Extras];
-                if (SubmissionInfo.CommonDiscInfo.ContentsSpecialFields.ContainsKey(SiteCode.GameFootage))
-                    Parent.GameFootageTextBox.Text = SubmissionInfo.CommonDiscInfo.ContentsSpecialFields[SiteCode.GameFootage];
+                // Games
+                if (SubmissionInfo.CommonDiscInfo.ContentsSpecialFields.ContainsKey(SiteCode.Games))
+                    Parent.GamesTextBox.Text = SubmissionInfo.CommonDiscInfo.ContentsSpecialFields[SiteCode.Games];
                 if (SubmissionInfo.CommonDiscInfo.ContentsSpecialFields.ContainsKey(SiteCode.NetYarozeGames))
                     Parent.NetYarozeGamesTextBox.Text = SubmissionInfo.CommonDiscInfo.ContentsSpecialFields[SiteCode.NetYarozeGames];
-                if (SubmissionInfo.CommonDiscInfo.ContentsSpecialFields.ContainsKey(SiteCode.Patches))
-                    Parent.PatchesTextBox.Text = SubmissionInfo.CommonDiscInfo.ContentsSpecialFields[SiteCode.Patches];
+
+                // Demos
                 if (SubmissionInfo.CommonDiscInfo.ContentsSpecialFields.ContainsKey(SiteCode.PlayableDemos))
                     Parent.PlayableDemosTextBox.Text = SubmissionInfo.CommonDiscInfo.ContentsSpecialFields[SiteCode.PlayableDemos];
                 if (SubmissionInfo.CommonDiscInfo.ContentsSpecialFields.ContainsKey(SiteCode.RollingDemos))
                     Parent.RollingDemosTextBox.Text = SubmissionInfo.CommonDiscInfo.ContentsSpecialFields[SiteCode.RollingDemos];
-                if (SubmissionInfo.CommonDiscInfo.ContentsSpecialFields.ContainsKey(SiteCode.Savegames))
-                    Parent.SavegamesTextBox.Text = SubmissionInfo.CommonDiscInfo.ContentsSpecialFields[SiteCode.Savegames];
                 if (SubmissionInfo.CommonDiscInfo.ContentsSpecialFields.ContainsKey(SiteCode.TechDemos))
                     Parent.TechDemosTextBox.Text = SubmissionInfo.CommonDiscInfo.ContentsSpecialFields[SiteCode.TechDemos];
+
+                // Video
+                if (SubmissionInfo.CommonDiscInfo.ContentsSpecialFields.ContainsKey(SiteCode.GameFootage))
+                    Parent.GameFootageTextBox.Text = SubmissionInfo.CommonDiscInfo.ContentsSpecialFields[SiteCode.GameFootage];
                 if (SubmissionInfo.CommonDiscInfo.ContentsSpecialFields.ContainsKey(SiteCode.Videos))
                     Parent.VideosTextBox.Text = SubmissionInfo.CommonDiscInfo.ContentsSpecialFields[SiteCode.Videos];
+
+                // Miscellaneous
+                if (SubmissionInfo.CommonDiscInfo.ContentsSpecialFields.ContainsKey(SiteCode.Patches))
+                    Parent.PatchesTextBox.Text = SubmissionInfo.CommonDiscInfo.ContentsSpecialFields[SiteCode.Patches];
+                if (SubmissionInfo.CommonDiscInfo.ContentsSpecialFields.ContainsKey(SiteCode.Savegames))
+                    Parent.SavegamesTextBox.Text = SubmissionInfo.CommonDiscInfo.ContentsSpecialFields[SiteCode.Savegames];
+                if (SubmissionInfo.CommonDiscInfo.ContentsSpecialFields.ContainsKey(SiteCode.Extras))
+                    Parent.ExtrasTextBox.Text = SubmissionInfo.CommonDiscInfo.ContentsSpecialFields[SiteCode.Extras];
             }
         }
 

MPF/Windows/DiscInformationWindow.xaml

@@ -229,24 +229,34 @@
                             <controls:UserInput x:Name="GeneralContent" Label="General"
                                                 Text="{Binding SubmissionInfo.CommonDiscInfo.Contents, Mode=TwoWay}" TextHeight="50"
                                                 Enter="True" TextWrapping="Wrap" VerticalContentAlignmentValue="Top"/>
-                            <controls:UserInput x:Name="ExtrasTextBox" Label="Extras" TextHeight="50"
-                                                Enter="True" TextWrapping="Wrap" VerticalContentAlignmentValue="Top"/>
-                            <controls:UserInput x:Name="GameFootageTextBox" Label="Game Footage" TextHeight="50"
+                            
+                            <!-- Games -->
+                            <controls:UserInput x:Name="GamesTextBox" Label="Games" TextHeight="50"
                                                 Enter="True" TextWrapping="Wrap" VerticalContentAlignmentValue="Top"/>
                             <controls:UserInput x:Name="NetYarozeGamesTextBox" Label="Net Yaroze Games" TextHeight="50"
                                                 Enter="True" TextWrapping="Wrap" VerticalContentAlignmentValue="Top"/>
-                            <controls:UserInput x:Name="PatchesTextBox" Label="Patches" TextHeight="50"
-                                                Enter="True" TextWrapping="Wrap" VerticalContentAlignmentValue="Top"/>
+                            
+                            <!-- Demos -->
                             <controls:UserInput x:Name="PlayableDemosTextBox" Label="Playable Demos" TextHeight="50"
                                                 Enter="True" TextWrapping="Wrap" VerticalContentAlignmentValue="Top"/>
                             <controls:UserInput x:Name="RollingDemosTextBox" Label="Rolling Demos" TextHeight="50"
                                                 Enter="True" TextWrapping="Wrap" VerticalContentAlignmentValue="Top"/>
-                            <controls:UserInput x:Name="SavegamesTextBox" Label="Savegames" TextHeight="50"
-                                                Enter="True" TextWrapping="Wrap" VerticalContentAlignmentValue="Top"/>
                             <controls:UserInput x:Name="TechDemosTextBox" Label="Tech Demos" TextHeight="50"
                                                 Enter="True" TextWrapping="Wrap" VerticalContentAlignmentValue="Top"/>
+
+                            <!-- Video -->
+                            <controls:UserInput x:Name="GameFootageTextBox" Label="Game Footage" TextHeight="50"
+                                                Enter="True" TextWrapping="Wrap" VerticalContentAlignmentValue="Top"/>
                             <controls:UserInput x:Name="VideosTextBox" Label="Videos" TextHeight="50"
                                                 Enter="True" TextWrapping="Wrap" VerticalContentAlignmentValue="Top"/>
+
+                            <!-- Miscellaneous -->
+                            <controls:UserInput x:Name="PatchesTextBox" Label="Patches" TextHeight="50"
+                                                Enter="True" TextWrapping="Wrap" VerticalContentAlignmentValue="Top"/>
+                            <controls:UserInput x:Name="SavegamesTextBox" Label="Savegames" TextHeight="50"
+                                                Enter="True" TextWrapping="Wrap" VerticalContentAlignmentValue="Top"/>
+                            <controls:UserInput x:Name="ExtrasTextBox" Label="Extras" TextHeight="50"
+                                                Enter="True" TextWrapping="Wrap" VerticalContentAlignmentValue="Top"/>
                         </StackPanel>
                     </ScrollViewer>
                 </TabItem>

RedumpLib/Data/Enumerations.cs

@@ -3465,6 +3465,10 @@ namespace RedumpLib.Data
         [HumanReadable(ShortName = "[T:GF]", LongName = "<b>Game Footage</b>:")]
         GameFootage,
 
+        // TODO: This doesn't have a site tag yet
+        [HumanReadable(ShortName = "<b>Games</b>:", LongName = "<b>Games</b>:")]
+        Games,
+
         [HumanReadable(ShortName = "[T:G]", LongName = "<b>Genre</b>:")]
         Genre,