Remove demo mode

Demo mode doesn't work right now, and I found a better alternative
here:  https://github.com/Code52/carnac

Fixes #192

Author: lzybkr

PSReadLine/BasicEditing.cs

@@ -220,7 +220,6 @@ private bool AcceptLineImpl(bool validate)
             // and that requires rendering.
             bool renderNeeded = _emphasisStart >= 0 || _queuedKeys.Count > 0;
 
-            _renderForDemoNeeded = false;
             _emphasisStart = -1;
             _emphasisLength = 0;
 

PSReadLine/Changes.txt

@@ -52,6 +52,10 @@ New cmdlet:
 * Remove-PSReadlineKeyHandler
     This will remove a key binding for previously bound keys.
 
+Breaking change:
+* Demo mode removed
+    - Trying to bind functions EnableDemoMode or DisableDemoMode will result in an error.
+
 ### Version 1.0.0.12
 
 New features:

PSReadLine/History.cs

@@ -60,10 +60,6 @@ private string MaybeAddToHistory(string result, List<EditItem> edits, int undoEd
                     IncrementalHistoryWrite();
                 }
             }
-            if (_demoMode)
-            {
-                ClearDemoWindow();
-            }
 
             // Clear the saved line unless we used AcceptAndGetNext in which
             // case we're really still in middle of history and might want

PSReadLine/PSReadLineResources.Designer.cs

@@ -297,12 +297,6 @@
   <data name="AcceptAndGetNextDescription" xml:space="preserve">
     <value>Accept the current line and recall the next line from history after the current line finishes executing</value>
   </data>
-  <data name="DisableDemoModeDescription" xml:space="preserve">
-    <value>Disable demo mode</value>
-  </data>
-  <data name="EnableDemoModeDescription" xml:space="preserve">
-    <value>Displays a window below the input line that shows which keys are typed</value>
-  </data>
   <data name="KeyIsUnbound" xml:space="preserve">
     <value>Key is unbound</value>
   </data>

PSReadLine/PSReadLineResources.resx

@@ -426,8 +426,6 @@ void ProcessOneKey(ConsoleKeyInfo key, Dictionary<ConsoleKeyInfo, KeyHandler> di
             }
             if (handler != null)
             {
-                _renderForDemoNeeded = _demoMode;
-
                 if (handler.ScriptBlock != null)
                 {
                     CalloutUsingDefaultConsoleMode(() => handler.Action(key, arg));
@@ -436,11 +434,6 @@ void ProcessOneKey(ConsoleKeyInfo key, Dictionary<ConsoleKeyInfo, KeyHandler> di
                 {
                     handler.Action(key, arg);
                 }
-
-                if (_renderForDemoNeeded)
-                {
-                    Render();
-                }
             }
             else if (!ignoreIfNoAction && key.KeyChar != 0)
             {
@@ -486,8 +479,6 @@ private PSConsoleReadLine()
 
             _captureKeys = false;
             _savedKeys = new Queue<ConsoleKeyInfo>();
-            _demoStrings = new HistoryQueue<string>(100);
-            _demoMode = false;
 
             SetDefaultWindowsBindings();
 
@@ -612,11 +603,6 @@ private static void Chord(ConsoleKeyInfo? key = null, object arg = null)
             Dictionary<ConsoleKeyInfo, KeyHandler> secondKeyDispatchTable;
             if (_singleton._chordDispatchTable.TryGetValue(key.Value, out secondKeyDispatchTable))
             {
-                if (_singleton._demoMode)
-                {
-                    // Render so the first key of the chord appears in the demo window
-                    _singleton.Render();
-                }
                 var secondKey = ReadKey();
                 _singleton.ProcessOneKey(secondKey, secondKeyDispatchTable, ignoreIfNoAction: true, arg: arg);
             }

PSReadLine/ReadLine.cs

@@ -72,12 +72,10 @@ private void Render()
 
         private void ReallyRender()
         {
-            _renderForDemoNeeded = false;
-
             var text = ParseInput();
 
             int statusLineCount = GetStatusLineCount();
-            int bufferLineCount = ConvertOffsetToCoordinates(text.Length).Y - _initialY + 1 + _demoWindowLineCount + statusLineCount;
+            int bufferLineCount = ConvertOffsetToCoordinates(text.Length).Y - _initialY + 1 + statusLineCount;
             int bufferWidth = Console.BufferWidth;
             if (_consoleBuffer.Length != bufferLineCount * bufferWidth)
             {
@@ -202,7 +200,7 @@ private void ReallyRender()
                 }
             }
 
-            for (; j < (_consoleBuffer.Length - ((statusLineCount + _demoWindowLineCount) * _bufferWidth)); j++)
+            for (; j < (_consoleBuffer.Length - (statusLineCount * _bufferWidth)); j++)
             {
                 _consoleBuffer[j] = _space;
             }
@@ -225,17 +223,12 @@ private void ReallyRender()
                     _consoleBuffer[j].BackgroundColor = backgroundColor;
                 }
 
-                for (; j < (_consoleBuffer.Length - (_demoWindowLineCount * _bufferWidth)); j++)
+                for (; j < _consoleBuffer.Length; j++)
                 {
                     _consoleBuffer[j] = _space;
                 }
             }
 
-            if (_demoMode)
-            {
-                RenderDemoWindow(j);
-            }
-
             bool rendered = false;
             if (_parseErrors.Length > 0)
             {
@@ -266,9 +259,9 @@ private void ReallyRender()
 
             PlaceCursor();
 
-            if ((_initialY + bufferLineCount + (_demoMode ? 1 : 0)) > (Console.WindowTop + Console.WindowHeight))
+            if ((_initialY + bufferLineCount) > (Console.WindowTop + Console.WindowHeight))
             {
-                Console.WindowTop = _initialY + bufferLineCount + (_demoMode ? 1 : 0) - Console.WindowHeight;
+                Console.WindowTop = _initialY + bufferLineCount - Console.WindowHeight;
             }
 
             _lastRenderTime.Restart();
@@ -487,9 +480,9 @@ private static void ScrollBuffer(int lines)
         private void PlaceCursor(int x, ref int y)
         {
             int statusLineCount = GetStatusLineCount();
-            if ((y + _demoWindowLineCount + statusLineCount) >= Console.BufferHeight)
+            if ((y + statusLineCount) >= Console.BufferHeight)
             {
-                ScrollBuffer((y + _demoWindowLineCount + statusLineCount) - Console.BufferHeight + 1);
+                ScrollBuffer((y + statusLineCount) - Console.BufferHeight + 1);
                 y = Console.BufferHeight - 1;
             }
             Console.SetCursorPosition(x, y);
@@ -631,139 +624,6 @@ private bool PromptYesOrNo(string s)
             return key.Key == ConsoleKey.Y;
         }
 
-        #region Demo mode
-
-        private readonly HistoryQueue<string> _demoStrings;
-        private bool _demoMode;
-        private int _demoWindowLineCount;
-        private bool _renderForDemoNeeded;
-
-        /// <summary>
-        /// Turn on demo mode (display events like keys pressed)
-        /// </summary>
-        public static void EnableDemoMode(ConsoleKeyInfo? key = null, object arg = null)
-        {
-            const int windowLineCount = 4;  // 1 blank line, 2 border lines, 1 line of info
-            _singleton._captureKeys = true;
-            _singleton._demoMode = true;
-            _singleton._demoWindowLineCount = windowLineCount;
-            var newBuffer = new CHAR_INFO[_singleton._consoleBuffer.Length + (windowLineCount * _singleton._bufferWidth)];
-            Array.Copy(_singleton._consoleBuffer, newBuffer,
-                _singleton._initialX + (_singleton.Options.ExtraPromptLineCount * _singleton._bufferWidth));
-            _singleton._consoleBuffer = newBuffer;
-            _singleton.Render();
-        }
-
-        /// <summary>
-        /// Turn off demo mode (display events like keys pressed)
-        /// </summary>
-        public static void DisableDemoMode(ConsoleKeyInfo? key = null, object arg = null)
-        {
-            _singleton._savedKeys.Clear();
-            _singleton._captureKeys = false;
-            _singleton._demoMode = false;
-            _singleton._demoStrings.Clear();
-            _singleton._demoWindowLineCount = 0;
-            _singleton.ClearDemoWindow();
-        }
-
-
-        private void RenderDemoWindow(int windowStart)
-        {
-            int i;
-
-            Action<int, char> setChar = (index, c) =>
-            {
-                _consoleBuffer[index].UnicodeChar = c;
-                _consoleBuffer[index].ForegroundColor = ConsoleColor.DarkCyan;
-                _consoleBuffer[index].BackgroundColor = ConsoleColor.White;
-            };
-
-            for (i = 0; i < _bufferWidth; i++)
-            {
-                _consoleBuffer[windowStart + i].UnicodeChar = ' ';
-                _consoleBuffer[windowStart + i].ForegroundColor = _initialForegroundColor;
-                _consoleBuffer[windowStart + i].BackgroundColor = _initialBackgroundColor;
-            }
-            windowStart += _bufferWidth;
-
-            const int extraSpace = 2;
-            // Draw the box
-            setChar(windowStart + extraSpace, (char)9484); // upper left
-            setChar(windowStart + _bufferWidth * 2 + extraSpace, (char)9492); // lower left
-            setChar(windowStart + _bufferWidth - 1 - extraSpace, (char)9488); // upper right
-            setChar(windowStart + _bufferWidth * 3 - 1 - extraSpace, (char)9496); // lower right
-            setChar(windowStart + _bufferWidth + extraSpace, (char)9474); // side
-            setChar(windowStart + _bufferWidth * 2 - 1 - extraSpace, (char)9474); // side
-
-            for (i = 1 + extraSpace; i < _bufferWidth - 1 - extraSpace; i++)
-            {
-                setChar(windowStart + i, (char)9472);
-                setChar(windowStart + i + 2 * _bufferWidth, (char)9472);
-            }
-
-            while (_savedKeys.Count > 0)
-            {
-                var key = _savedKeys.Dequeue();
-                _demoStrings.Enqueue(key.ToGestureString());
-            }
-
-            int charsToDisplay = _bufferWidth - 2 - (2 * extraSpace);
-            i = windowStart + _bufferWidth + 1 + extraSpace;
-            bool first = true;
-            for (int j = _demoStrings.Count; j > 0; j--)
-            {
-                string eventString = _demoStrings[j - 1];
-                if ((eventString.Length + (first ? 0 : 1)) > charsToDisplay)
-                    break;
-
-                if (!first)
-                {
-                    setChar(i++, ' ');
-                    charsToDisplay--;
-                }
-
-                foreach (char c in eventString)
-                {
-                    setChar(i, c);
-                    if (first)
-                    {
-                        // Invert the first word to highlight it
-                        var color = _consoleBuffer[i].ForegroundColor;
-                        _consoleBuffer[i].ForegroundColor = _consoleBuffer[i].BackgroundColor;
-                        _consoleBuffer[i].BackgroundColor = color;
-                    }
-                    i++;
-                    charsToDisplay--;
-                }
-
-                first = false;
-            }
-            while (charsToDisplay-- > 0)
-            {
-                setChar(i++, ' ');
-            }
-        }
-
-        private void ClearDemoWindow()
-        {
-            int bufferWidth = Console.BufferWidth;
-            var charInfoBuffer = new CHAR_INFO[bufferWidth * 3];
-
-            for (int i = 0; i < charInfoBuffer.Length; i++)
-            {
-                charInfoBuffer[i].UnicodeChar = ' ';
-                charInfoBuffer[i].ForegroundColor = _initialForegroundColor;
-                charInfoBuffer[i].BackgroundColor= _initialBackgroundColor;
-            }
-
-            int bufferLineCount = ConvertOffsetToCoordinates(_buffer.Length).Y - _initialY + 1;
-            int y = _initialY + bufferLineCount + 1;
-            WriteBufferLines(charInfoBuffer, ref y);
-        }
-
-        #endregion Demo mode
-
         #region Screen scrolling
 
         /// <summary>

PSReadLine/Render.cs

@@ -38,10 +38,6 @@ Set-PSReadlineKeyHandler -Key Ctrl+Shift+Q -Function TabCompletePrevious
 Set-PSReadlineKeyHandler -Key Shift+Ctrl+C -Function Copy
 Set-PSReadlineKeyHandler -Key Ctrl+V -Function Paste
 
-# Demo mode is great for giving demos of PSReadline,
-Set-PSReadlineKeyHandler -Chord 'Ctrl+D,Ctrl+E' -Function EnableDemoMode
-Set-PSReadlineKeyHandler -Chord 'Ctrl+D,Ctrl+D' -Function DisableDemoMode
-
 # CaptureScreen is good for blog posts or email showing a transaction
 # of what you did when asking for help or demonstrating a technique.
 Set-PSReadlineKeyHandler -Chord 'Ctrl+D,Ctrl+C' -Function CaptureScreen

PSReadLine/SamplePSReadlineProfile.ps1

@@ -436,15 +436,6 @@ LONG DESCRIPTION
         multiple lines.  After selecting, press Enter to copy the text.  Escape/Ctrl+C/Ctrl+G
         will cancel so nothing is copied to the clipboard.
 
-    DisableDemoMode          (Cmd: unbound              Emacs: unbound)
-
-        Turn off demo mode.
-
-    EnableDemoMode           (Cmd: unbound              Emacs: unbound)
-
-        Turn on demo mode.  Displays a window below the input line that shows which
-        keys are typed.
-
     InvokePrompt             (Cmd: unbound              Emacs: unbound)
 
         Erases the current prompt and calls the prompt function to redisplay

PSReadLine/en-US/about_PSReadline.help.txt

@@ -157,24 +157,6 @@ public void TestLongLine()
             Test(input, Keys(input));
         }
 
-        [TestMethod]
-        public void TestDemoWindow()
-        {
-            TestSetup(KeyMode.Cmd,
-                new KeyHandler("Ctrl+D,Ctrl+E", PSConsoleReadLine.EnableDemoMode),
-                new KeyHandler("Ctrl+D,Ctrl+D", PSConsoleReadLine.DisableDemoMode));
-
-            Test("a", Keys(
-                _.CtrlD, _.CtrlE,
-                "a",
-                _.CtrlD, _.CtrlD));
-
-            // To test:
-            //   * Actually check rendering
-            //   * With status line
-            //   * WIth show completions
-        }
-
         [TestMethod]
         public void TestInvokePrompt()
         {