Merge pull request #10 from jazzdelightsme/personal/danthom/ScreenCaptureUsability

Personal/danthom/screen capture usability

Author: lzybkr

PSReadLine/ConsoleLib.cs

@@ -536,6 +536,11 @@ public void WriteLine(string value)
         }
 
         public void WriteBufferLines(CHAR_INFO[] buffer, ref int top)
+        {
+            WriteBufferLines(buffer, ref top, true);
+        }
+
+        public void WriteBufferLines(CHAR_INFO[] buffer, ref int top, bool ensureBottomLineVisible)
         {
             var handle = NativeMethods.GetStdHandle((uint) StandardHandleId.Output);
 
@@ -565,7 +570,8 @@ public void WriteBufferLines(CHAR_INFO[] buffer, ref int top)
                                              bufferSize, bufferCoord, ref writeRegion);
 
             // Now make sure the bottom line is visible
-            if (bottom >= (Console.WindowTop + Console.WindowHeight))
+            if (ensureBottomLineVisible &&
+                (bottom >= (Console.WindowTop + Console.WindowHeight)))
             {
                 Console.CursorTop = bottom;
             }

PSReadLine/PublicAPI.cs

@@ -47,6 +47,7 @@ public interface IConsole
             void WriteLine(string s);
             void Write(string s);
             void WriteBufferLines(CHAR_INFO[] buffer, ref int top);
+            void WriteBufferLines(CHAR_INFO[] buffer, ref int top, bool ensureBottomLineVisible);
             void ScrollBuffer(int lines);
             CHAR_INFO[] ReadBufferLines(int top, int count);
         }

PSReadLine/Render.cs

@@ -975,6 +975,19 @@ public static void ScrollDisplayToCursor(ConsoleKeyInfo? key = null, object arg
             var console = _singleton._console;
             var newTop = coordinates.Y - console.WindowHeight + 1;
 
+            // If the cursor is already visible, and we're on the first
+            // page-worth of the buffer, then just scroll to the top (we can't
+            // scroll to before the beginning of the buffer).
+            //
+            // Note that we don't want to just return, because the window may
+            // have been scrolled way past the end of the content, so we really
+            // do need to set the new window top to 0 to bring it back into
+            // view.
+            if (newTop < 0)
+            {
+                newTop = 0;
+            }
+
             // But if the cursor won't be visible, make sure it is.
             if (newTop > console.CursorTop)
             {

PSReadLine/ScreenCapture.cs

@@ -20,7 +20,7 @@ private static void InvertLines(int start, int count)
                 buffer[i].ForegroundColor = (ConsoleColor)((int)buffer[i].ForegroundColor ^ 7);
                 buffer[i].BackgroundColor = (ConsoleColor)((int)buffer[i].BackgroundColor ^ 7);
             }
-            _singleton._console.WriteBufferLines(buffer, ref start);
+            _singleton._console.WriteBufferLines(buffer, ref start, false);
         }
 
         /// <summary>
@@ -33,6 +33,13 @@ public static void CaptureScreen(ConsoleKeyInfo? key = null, object arg = null)
             int selectionTop = _singleton._console.CursorTop;
             int selectionHeight = 1;
             int currentY = selectionTop;
+            Internal.IConsole console = _singleton._console;
+
+            // We'll keep the current selection line (currentY) at least 4 lines
+            // away from the top or bottom of the window.
+            const int margin = 5;
+            Func<bool> tooCloseToTop = () => { return (currentY - console.WindowTop) < margin; };
+            Func<bool> tooCloseToBottom = () => { return ((console.WindowTop + console.WindowHeight) - currentY) < margin; };
 
             // Current lines starts out selected
             InvertLines(selectionTop, selectionHeight);
@@ -42,7 +49,11 @@ public static void CaptureScreen(ConsoleKeyInfo? key = null, object arg = null)
                 var k = ReadKey();
                 switch (k.Key)
                 {
+                case ConsoleKey.K:
                 case ConsoleKey.UpArrow:
+                    if (tooCloseToTop())
+                        ScrollDisplayUpLine();
+
                     if (currentY > 0)
                     {
                         currentY -= 1;
@@ -67,8 +78,12 @@ public static void CaptureScreen(ConsoleKeyInfo? key = null, object arg = null)
                     }
                     break;
 
+                case ConsoleKey.J:
                 case ConsoleKey.DownArrow:
-                    if (currentY < (_singleton._console.BufferHeight - 1))
+                    if (tooCloseToBottom())
+                        ScrollDisplayDownLine();
+
+                    if (currentY < (console.BufferHeight - 1))
                     {
                         currentY += 1;
                         if ((k.Modifiers & ConsoleModifiers.Shift) == ConsoleModifiers.Shift)
@@ -103,6 +118,7 @@ public static void CaptureScreen(ConsoleKeyInfo? key = null, object arg = null)
                 case ConsoleKey.Enter:
                     InvertLines(selectionTop, selectionHeight);
                     DumpScreenToClipboard(selectionTop, selectionHeight);
+                    ScrollDisplayToCursor();
                     return;
 
                 case ConsoleKey.Escape:
@@ -124,6 +140,7 @@ public static void CaptureScreen(ConsoleKeyInfo? key = null, object arg = null)
                 }
             }
             InvertLines(selectionTop, selectionHeight);
+            ScrollDisplayToCursor();
         }
 
         private const string CmdColorTable = @"

UnitTestPSReadLine/UnitTestReadLine.cs

@@ -191,6 +191,11 @@ public void Write(string s)
         }
 
         public void WriteBufferLines(CHAR_INFO[] bufferToWrite, ref int top)
+        {
+            WriteBufferLines(bufferToWrite, ref top, true);
+        }
+
+        public void WriteBufferLines(CHAR_INFO[] bufferToWrite, ref int top, bool ensureBottomLineVisible)
         {
             var startPos = top * BufferWidth;
             for (int i = 0; i < bufferToWrite.Length; i++)