add - Added allow/disallow background colors

--- We've added a new config entry that controls whether foreground and background colors are allowed to be set. --- Type: add Breaking: False Doc Required: False Part: 1/1
Aptivi · Feb 20, 2024 · 40a78b1 · 40a78b1
1 parent f151cf5
commit 40a78b1
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 1 deletion.
diff --git a/public/Nitrocid/ConsoleBase/Colors/KernelColorTools.cs b/public/Nitrocid/ConsoleBase/Colors/KernelColorTools.cs
@@ -41,6 +41,10 @@ public static class KernelColorTools
         internal static Color accentForegroundColor = GetColor(KernelColorType.Warning);
         internal static Color accentBackgroundColor = GetColor(KernelColorType.Background);
 
+        // Variables to allow/disallow background/foreground color
+        internal static bool allowForeground = true;
+        internal static bool allowBackground = true;
+
         /// <summary>
         /// Enables color blindness
         /// </summary>

diff --git a/public/Nitrocid/Kernel/Configuration/Instances/KernelMainConfig.cs b/public/Nitrocid/Kernel/Configuration/Instances/KernelMainConfig.cs
@@ -256,6 +256,30 @@ public bool UseConsoleColorPalette
             set => ColorTools.GlobalSettings.UseTerminalPalette = value;
         }
         /// <summary>
+        /// Whether to allow foreground color
+        /// </summary>
+        public bool AllowForegroundColor
+        {
+            get => KernelColorTools.allowForeground;
+            set
+            {
+                KernelColorTools.allowForeground = value;
+                ColorTools.AllowForeground = KernelColorTools.allowForeground;
+            }
+        }
+        /// <summary>
+        /// Whether to allow background color
+        /// </summary>
+        public bool AllowBackgroundColor
+        {
+            get => KernelColorTools.allowBackground;
+            set
+            {
+                KernelColorTools.allowBackground = value;
+                ColorTools.AllowBackground = KernelColorTools.allowBackground;
+            }
+        }
+        /// <summary>
         /// User Name Shell Color
         /// </summary>
         public string UserNameShellColor

diff --git a/public/Nitrocid/Kernel/Starting/KernelInitializers.cs b/public/Nitrocid/Kernel/Starting/KernelInitializers.cs
@@ -72,6 +72,10 @@ internal static void InitializeCritical()
                 // Check for terminal
                 ConsoleChecker.CheckConsole();
 
+                // Allow fore/background colors
+                ColorTools.AllowForeground = true;
+                ColorTools.AllowBackground = true;
+
                 // Initialize crucial things
                 if (!KernelPlatform.IsOnUnix())
                 {

diff --git a/public/Nitrocid/Nitrocid.csproj b/public/Nitrocid/Nitrocid.csproj
@@ -52,7 +52,7 @@
     <NitrocidModAPIVersionMajor>3.0.25</NitrocidModAPIVersionMajor>
 
     <!-- Increment NitrocidModAPIVersionChangeset every time there is a breaking change or an API addition in the N-KS API. -->
-    <NitrocidModAPIVersionChangeset>431</NitrocidModAPIVersionChangeset>
+    <NitrocidModAPIVersionChangeset>432</NitrocidModAPIVersionChangeset>
 
     <!-- To be installed to the file version -->
     <NitrocidModAPIVersion>$(NitrocidModAPIVersionMajor).$(NitrocidModAPIVersionChangeset)</NitrocidModAPIVersion>

diff --git a/public/Nitrocid/Resources/Settings/SettingsEntries.json b/public/Nitrocid/Resources/Settings/SettingsEntries.json
@@ -250,6 +250,18 @@
                 "Variable": "UseConsoleColorPalette",
                 "Description": "When this is set to true, the color palette defined by the terminal is used."
             },
+            {
+                "Name": "Allow foreground color",
+                "Type": "SBoolean",
+                "Variable": "AllowForegroundColor",
+                "Description": "When this is set to true, the current foreground color is honored. Else, it uses your terminal's default colors."
+            },
+            {
+                "Name": "Allow background color",
+                "Type": "SBoolean",
+                "Variable": "AllowBackgroundColor",
+                "Description": "When this is set to true, the current background color is honored. Else, it uses your terminal's default colors."
+            },
             {
                 "Name": "User Name Shell Color",
                 "Type": "SColor",