mattercontrol/MatterControlLib/PrinterControls/TerminalWindow/TextScrollWidget.cs

/*
Copyright (c) 2019, Lars Brubaker, John Lewin
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those
of the authors and should not be interpreted as representing official policies,
either expressed or implied, of the FreeBSD Project.
*/

using System;
using System.Collections.Generic;
using System.Linq;
using MatterHackers.Agg;
using MatterHackers.Agg.Font;
using MatterHackers.Agg.UI;
using MatterHackers.VectorMath;

namespace MatterHackers.MatterControl
{
	public class TextScrollWidget : GuiWidget
	{
		private object locker = new object();

		private List<TerminalLine> allSourceLines;
		private List<string> visibleLines;

		private TypeFacePrinter typeFacePrinter = null;
		private PrinterConfig printer = null;

		private int forceStartLine = -1;

		private Func<TerminalLine, string> _lineFilterFunction;

		public TextScrollWidget(PrinterConfig printer, List<TerminalLine> sourceLines)
		{
			this.printer = printer;
			printer.Connection.TerminalLog.LineAdded += TerminalLog_LineAdded;
			this.typeFacePrinter = new TypeFacePrinter("", new StyledTypeFace(ApplicationController.GetTypeFace(NamedTypeFace.Liberation_Mono), 12));
			this.typeFacePrinter.DrawFromHintedCache = true;
			this.allSourceLines = sourceLines;
			this.visibleLines = sourceLines.Select(ld => ld.Line).ToList();
		}

		public double Position0To1
		{
			get
			{
				if (forceStartLine == -1)
				{
					return 0;
				}
				else
				{
					return (visibleLines.Count - (double)forceStartLine) / visibleLines.Count;
				}
			}

			set
			{
				forceStartLine = (int)(visibleLines.Count * (1 - value)) - 1;
				forceStartLine = Math.Max(0, forceStartLine);
				forceStartLine = Math.Min(visibleLines.Count - 1, forceStartLine);

				// If the start would be less than one screen worth of content, allow
				// the whole screen to have content and scroll with new material.
				if (forceStartLine > visibleLines.Count - NumVisibleLines)
				{
					forceStartLine = -1;
				}

				Invalidate();
			}
		}

		public int NumVisibleLines => (int)Math.Ceiling(Height / typeFacePrinter.TypeFaceStyle.EmSizeInPixels);

		public Color TextColor { get; set; } = new Color(102, 102, 102);

		public Func<TerminalLine, string> LineFilterFunction
		{
			get => _lineFilterFunction;
			set
			{
				_lineFilterFunction = value;
				RebuildFilteredList();
			}
		}

		private void ConditionalyAddToVisible(TerminalLine terminalLine)
		{
			var line = terminalLine.Line;
			if (LineFilterFunction != null)
			{
				line = LineFilterFunction(terminalLine);
			}

			if (!string.IsNullOrEmpty(line))
			{
				visibleLines.Add(line);
			}
		}

		private void TerminalLog_LineAdded(object sender, TerminalLine terminalLine)
		{
			if (terminalLine.Line != null)
			{
				ConditionalyAddToVisible(terminalLine);
			}
			else // the list changed in some big way (probably cleared)
			{
				RebuildFilteredList();
			}

			Invalidate();
		}

		public void RebuildFilteredList()
		{
			lock (locker)
			{
				visibleLines = new List<string>();
				var allSourceLinesTemp = allSourceLines.ToArray();
				foreach (var lineData in allSourceLinesTemp)
				{
					ConditionalyAddToVisible(lineData);
				}
			}
		}

		public void WriteToFile(string filePath)
		{
			// Make a copy so we don't have it change while writing.
			string[] allSourceLinesTemp = allSourceLines.Select(ld => ld.Line).ToArray();
			System.IO.File.WriteAllLines(filePath, allSourceLinesTemp);
		}

		public override void OnClosed(EventArgs e)
		{
			printer.Connection.TerminalLog.LineAdded -= TerminalLog_LineAdded;
			base.OnClosed(e);
		}

		public override void OnDraw(Graphics2D graphics2D)
		{
			RectangleDouble bounds = LocalBounds;

			int numLinesToDraw = NumVisibleLines;

			double y = LocalBounds.Bottom + typeFacePrinter.TypeFaceStyle.EmSizeInPixels * numLinesToDraw;
			lock (visibleLines)
			{
				lock (locker)
				{
					int startLineIndex = visibleLines.Count - numLinesToDraw;
					if (forceStartLine != -1)
					{
						y = LocalBounds.Top;

						if (forceStartLine > visibleLines.Count - numLinesToDraw)
						{
							forceStartLine = -1;
						}
						else
						{
							// make sure we show all the lines we can
							startLineIndex = Math.Min(forceStartLine, startLineIndex);
						}
					}

					int endLineIndex = visibleLines.Count;
					for (int lineIndex = startLineIndex; lineIndex < endLineIndex; lineIndex++)
					{
						if (lineIndex >= 0)
						{
							if (visibleLines[lineIndex] != null)
							{
								typeFacePrinter.Text = visibleLines[lineIndex];
								typeFacePrinter.Origin = new Vector2(bounds.Left + 2, y);
								typeFacePrinter.Render(graphics2D, TextColor);
							}
						}

						y -= typeFacePrinter.TypeFaceStyle.EmSizeInPixels;
						if (y < -typeFacePrinter.TypeFaceStyle.EmSizeInPixels)
						{
							break;
						}
					}
				}
			}

			base.OnDraw(graphics2D);
		}

		public override void OnMouseWheel(MouseEventArgs mouseEvent)
		{
			base.OnMouseWheel(mouseEvent);
			double scrollDelta = mouseEvent.WheelDelta / (visibleLines.Count * 60.0);

			if (scrollDelta < 0) // Rounding seems to favor scrolling up, compensating scroll down to feel as smooth
			{
				scrollDelta *= 2;
			}
			else if (Position0To1 == 0) // If we scroll up at the bottom get pop out from the "on screen" chunk
			{
				scrollDelta = NumVisibleLines / (double)visibleLines.Count;
			}

			double newPos = Position0To1 + scrollDelta;

			if (newPos > 1)
			{
				newPos = 1;
			}
			else if (newPos < 0)
			{
				newPos = 0;
			}

			Position0To1 = newPos;
		}

		public override void OnKeyDown(KeyEventArgs keyEvent)
		{
			// make sure children controls get to try to handle this event first
			base.OnKeyDown(keyEvent);

			// check for arrow keys (but only if no modifiers are pressed)
			if (!keyEvent.Handled
				&& !keyEvent.Control
				&& !keyEvent.Alt
				&& !keyEvent.Shift)
			{
				double startingScrollPosition = Position0To1;
				double scrollDelta = NumVisibleLines / (double)visibleLines.Count;
				double newPos = Position0To1;

				switch (keyEvent.KeyCode)
				{
					case Keys.PageDown:
						newPos -= scrollDelta;
						break;
					case Keys.PageUp:
						newPos += scrollDelta;
						break;
					case Keys.Home:
						newPos = 1;
						break;
					case Keys.End:
						newPos = 0;
						break;
				}

				if (newPos > 1)
				{
					newPos = 1;
				}
				else if (newPos < 0)
				{
					newPos = 0;
				}

				Position0To1 = newPos;

				// we only handled the key if it resulted in the area scrolling
				if (startingScrollPosition != Position0To1)
				{
					keyEvent.Handled = true;
				}
			}
		}
	}
}