Merge pull request #160 from PixiEditor/debuggerDisplays

Added Debugging Tools
PixiEditor · Mar 11, 2021 · 43642b2 · 43642b2
2 parents bef0171 + aad1679
commit 43642b2
Show file tree

Hide file tree

Showing 9 changed files with 45 additions and 2 deletions.
diff --git a/PixiEditor/Models/Controllers/BitmapManager.cs b/PixiEditor/Models/Controllers/BitmapManager.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
+using System.Diagnostics;
 using System.Linq;
 using System.Windows;
 using System.Windows.Input;
@@ -18,6 +19,7 @@
 
 namespace PixiEditor.Models.Controllers
 {
+    [DebuggerDisplay("{Documents.Count} Document(s)")]
     public class BitmapManager : NotifyableObject
     {
         private Document activeDocument;

diff --git a/PixiEditor/Models/Controllers/UndoManager.cs b/PixiEditor/Models/Controllers/UndoManager.cs
@@ -1,12 +1,14 @@
 using System;
 using System.Collections.Generic;
+using System.Diagnostics;
 using System.Linq;
 using System.Reflection;
 using PixiEditor.Models.Undo;
 using PixiEditor.ViewModels;
 
 namespace PixiEditor.Models.Controllers
 {
+    [DebuggerDisplay("{UndoStack.Count} undo steps, {RedoStack.Count} redo step(s)")]
     public class UndoManager
     {
         private bool lastChangeWasUndo;

diff --git a/PixiEditor/Models/DataHolders/Document/Document.cs b/PixiEditor/Models/DataHolders/Document/Document.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Buffers;
 using System.Collections.ObjectModel;
+using System.Diagnostics;
 using System.IO;
 using System.Linq;
 using System.Threading;
@@ -20,6 +21,7 @@
 
 namespace PixiEditor.Models.DataHolders
 {
+    [DebuggerDisplay("'{Name, nq}' {width}x{height} {Layers.Count} Layer(s)")]
     public partial class Document : NotifyableObject
     {
         private int height;

diff --git a/PixiEditor/Models/Layers/Layer.cs b/PixiEditor/Models/Layers/Layer.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Diagnostics;
 using System.Linq;
 using System.Windows;
 using System.Windows.Media;
@@ -12,6 +13,7 @@
 
 namespace PixiEditor.Models.Layers
 {
+    [DebuggerDisplay("'{name,nq}' {width}x{height}")]
     public class Layer : BasicLayer
     {
         private const int SizeOfArgb = 4;

diff --git a/PixiEditor/Models/Tools/Tools/PenTool.cs b/PixiEditor/Models/Tools/Tools/PenTool.cs
@@ -92,7 +92,7 @@ public BitmapPixelChanges Draw(Coordinates startingCoords, Coordinates latestCor
                 return changes;
             }
 
-            changedPixelsindex += changedPixelsindex >= 2 ? 0 : 1;
+            changedPixelsindex += changedPixelsindex >= 2 ? (byte)0 : (byte)1;
 
             var result = BitmapPixelChanges.FromSingleColoredArray(GetThickShape(latestPixels, toolSize), color);
 

diff --git a/PixiEditor/Models/UserPreferences/PreferencesSettings.cs b/PixiEditor/Models/UserPreferences/PreferencesSettings.cs
@@ -1,11 +1,13 @@
 using System;
 using System.Collections.Generic;
+using System.Diagnostics;
 using System.IO;
 using Newtonsoft.Json;
 using PixiEditor.ViewModels;
 
 namespace PixiEditor.Models.UserPreferences
 {
+    [DebuggerDisplay("{Preferences.Count + LocalPreferences.Count} Preference(s)")]
     public class PreferencesSettings : IPreferences
     {
         public static IPreferences Current => ViewModelMain.Current.Preferences;

diff --git a/PixiEditor/ViewModels/SubViewModels/Main/DebugViewModel.cs b/PixiEditor/ViewModels/SubViewModels/Main/DebugViewModel.cs
@@ -0,0 +1,13 @@
+using System.Diagnostics;
+using PixiEditor.Helpers;
+
+namespace PixiEditor.ViewModels.SubViewModels.Main
+{
+    public class DebugViewModel : SubViewModel<ViewModelMain>
+    {
+        public DebugViewModel(ViewModelMain owner)
+            : base(owner)
+        {
+        }
+    }
+}
diff --git a/PixiEditor/ViewModels/ViewModelMain.cs b/PixiEditor/ViewModels/ViewModelMain.cs
@@ -59,6 +59,10 @@ public class ViewModelMain : ViewModelBase
 
         public DiscordViewModel DiscordViewModel { get; set; }
 
+#if DEBUG
+        public DebugViewModel DebugSubViewModel { get; set; }
+#endif
+
         public BitmapManager BitmapManager { get; set; }
 
         public PixelChangesController ChangesController { get; set; }
@@ -67,6 +71,16 @@ public class ViewModelMain : ViewModelBase
 
         public IPreferences Preferences { get; set; }
 
+        public bool IsDebug
+        {
+            get =>
+#if DEBUG
+                true;
+#else
+                false;
+#endif
+        }
+
         public ViewModelMain(IServiceProvider services)
         {
             Current = this;
@@ -98,6 +112,9 @@ public ViewModelMain(IServiceProvider services)
             DocumentSubViewModel = new DocumentViewModel(this);
             MiscSubViewModel = new MiscViewModel(this);
             DiscordViewModel = new DiscordViewModel(this, "764168193685979138");
+#if DEBUG
+            DebugSubViewModel = new DebugViewModel(this);
+#endif
 
             ShortcutController = new ShortcutController
             {
@@ -147,7 +164,7 @@ public ViewModelMain(IServiceProvider services)
                     new Shortcut(Key.F2, LayersSubViewModel.RenameLayerCommand, BitmapManager.ActiveDocument?.ActiveLayerIndex),
 
                     // View
-                    new Shortcut(Key.OemTilde, ViewportSubViewModel.ToggleGridLinesCommand, modifier: ModifierKeys.Control)
+                    new Shortcut(Key.OemTilde, ViewportSubViewModel.ToggleGridLinesCommand, modifier: ModifierKeys.Control),
                 }
             };
             BitmapManager.PrimaryColor = ColorsSubViewModel.PrimaryColor;

diff --git a/PixiEditor/Views/MainWindow.xaml b/PixiEditor/Views/MainWindow.xaml
@@ -143,6 +143,9 @@
                     <MenuItem Header="Third Party Licenses" Command="{Binding MiscSubViewModel.OpenHyperlinkCommand}"
                               CommandParameter="https://github.com/PixiEditor/PixiEditor/wiki/Third-party-licenses"/>
                 </MenuItem>
+                <MenuItem Header="_Debug" Visibility="{Binding IsDebug, Converter={StaticResource BoolToVisibilityConverter}}">
+                    <MenuItem Header="Such empty here..." IsEnabled="False"/>
+                </MenuItem>
             </Menu>
             <StackPanel DockPanel.Dock="Right" VerticalAlignment="Top" Orientation="Horizontal"
                         HorizontalAlignment="Right" WindowChrome.IsHitTestVisibleInChrome="True">