[FileExplorer]GcodeThumbnailProvider and GcodePreviewHandler (#14827)

* Adds the GcodeThumbnailProvider

* Registers the GcodeThumbnailProvider

* Adds Settings support

* Reverts solution changes back to original

* Corrects "Gcode" text with "G-code"

* Adds gcode thumbnail setting description

* Follow up on PR review comments

* Adds GcodePreviewHandler

* Follow up on PR review comments

* Renames assemblies following #14903

src/modules/previewpane/GcodePreviewHandler/GcodePreviewHandlerControl.cs

@@ -0,0 +1,219 @@
+// Copyright (c) Microsoft Corporation
+// The Microsoft Corporation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System;
+using System.Collections.Generic;
+using System.Drawing;
+using System.IO;
+using System.Linq;
+using System.Runtime.InteropServices.ComTypes;
+using System.Text;
+using System.Windows.Forms;
+using Common;
+using Common.Utilities;
+using Microsoft.PowerToys.PreviewHandler.Gcode.Telemetry.Events;
+using Microsoft.PowerToys.Telemetry;
+
+namespace Microsoft.PowerToys.PreviewHandler.Gcode
+{
+    /// <summary>
+    /// Implementation of Control for Gcode Preview Handler.
+    /// </summary>
+    public class GcodePreviewHandlerControl : FormHandlerControl
+    {
+        /// <summary>
+        /// Picture box control to display the G-code thumbnail.
+        /// </summary>
+        private PictureBox _pictureBox;
+
+        /// <summary>
+        /// Text box to display the information about blocked elements from Svg.
+        /// </summary>
+        private RichTextBox _textBox;
+
+        /// <summary>
+        /// Represent if an text box info bar is added for showing message.
+        /// </summary>
+        private bool _infoBarAdded;
+
+        /// <summary>
+        /// Start the preview on the Control.
+        /// </summary>
+        /// <param name="dataSource">Stream reference to access source file.</param>
+        public override void DoPreview<T>(T dataSource)
+        {
+            InvokeOnControlThread(() =>
+            {
+                try
+                {
+                    Bitmap thumbnail = null;
+
+                    using (var stream = new ReadonlyStream(dataSource as IStream))
+                    {
+                        using (var reader = new StreamReader(stream))
+                        {
+#pragma warning disable CA2000 // Do not dispose here
+                            thumbnail = GetThumbnail(reader);
+#pragma warning restore CA2000
+                        }
+                    }
+
+                    _infoBarAdded = false;
+
+                    if (thumbnail == null)
+                    {
+                        _infoBarAdded = true;
+                        AddTextBoxControl(Resource.GcodeWithoutEmbeddedThumbnails);
+                    }
+                    else
+                    {
+                        AddPictureBoxControl(thumbnail);
+                    }
+
+                    Resize += FormResized;
+                    base.DoPreview(dataSource);
+                    PowerToysTelemetry.Log.WriteEvent(new GcodeFilePreviewed());
+                }
+#pragma warning disable CA1031 // Do not catch general exception types
+                catch (Exception ex)
+#pragma warning restore CA1031 // Do not catch general exception types
+                {
+                    PreviewError(ex, dataSource);
+                }
+            });
+        }
+
+        /// <summary>
+        /// Reads the G-code content searching for thumbnails and returns the largest.
+        /// </summary>
+        /// <param name="reader">The TextReader instance for the G-code content.</param>
+        /// <returns>A thumbnail extracted from the G-code content.</returns>
+        public static Bitmap GetThumbnail(TextReader reader)
+        {
+            if (reader == null)
+            {
+                return null;
+            }
+
+            Bitmap thumbnail = null;
+
+            var bitmapBase64 = GetBase64Thumbnails(reader)
+                .OrderByDescending(x => x.Length)
+                .FirstOrDefault();
+
+            if (!string.IsNullOrEmpty(bitmapBase64))
+            {
+                var bitmapBytes = Convert.FromBase64String(bitmapBase64);
+
+                using (var bitmapStream = new MemoryStream(bitmapBytes))
+                {
+                    thumbnail = new Bitmap(bitmapStream);
+                }
+            }
+
+            return thumbnail;
+        }
+
+        /// <summary>
+        /// Gets all thumbnails in base64 format found on the G-code data.
+        /// </summary>
+        /// <param name="reader">The TextReader instance for the G-code content.</param>
+        /// <returns>An enumeration of thumbnails in base64 format found on the G-code.</returns>
+        private static IEnumerable<string> GetBase64Thumbnails(TextReader reader)
+        {
+            string line;
+            StringBuilder capturedText = null;
+
+            while ((line = reader.ReadLine()) != null)
+            {
+                if (line.StartsWith("; thumbnail begin", StringComparison.InvariantCulture))
+                {
+                    capturedText = new StringBuilder();
+                }
+                else if (line == "; thumbnail end")
+                {
+                    if (capturedText != null)
+                    {
+                        yield return capturedText.ToString();
+
+                        capturedText = null;
+                    }
+                }
+                else if (capturedText != null)
+                {
+                    capturedText.Append(line[2..]);
+                }
+            }
+        }
+
+        /// <summary>
+        /// Occurs when RichtextBox is resized.
+        /// </summary>
+        /// <param name="sender">Reference to resized control.</param>
+        /// <param name="e">Provides data for the ContentsResized event.</param>
+        private void RTBContentsResized(object sender, ContentsResizedEventArgs e)
+        {
+            var richTextBox = sender as RichTextBox;
+            richTextBox.Height = e.NewRectangle.Height + 5;
+        }
+
+        /// <summary>
+        /// Occurs when form is resized.
+        /// </summary>
+        /// <param name="sender">Reference to resized control.</param>
+        /// <param name="e">Provides data for the resize event.</param>
+        private void FormResized(object sender, EventArgs e)
+        {
+            if (_infoBarAdded)
+            {
+                _textBox.Width = Width;
+            }
+        }
+
+        /// <summary>
+        /// Adds a PictureBox Control to Control Collection.
+        /// </summary>
+        /// <param name="image">Image to display on PictureBox Control.</param>
+        private void AddPictureBoxControl(Image image)
+        {
+            _pictureBox = new PictureBox();
+            _pictureBox.BackgroundImage = image;
+            _pictureBox.BackgroundImageLayout = ImageLayout.Center;
+            _pictureBox.Dock = DockStyle.Fill;
+            Controls.Add(_pictureBox);
+        }
+
+        /// <summary>
+        /// Adds a Text Box in Controls for showing information about blocked elements.
+        /// </summary>
+        /// <param name="message">Message to be displayed in textbox.</param>
+        private void AddTextBoxControl(string message)
+        {
+            _textBox = new RichTextBox();
+            _textBox.Text = message;
+            _textBox.BackColor = Color.LightYellow;
+            _textBox.Multiline = true;
+            _textBox.Dock = DockStyle.Top;
+            _textBox.ReadOnly = true;
+            _textBox.ContentsResized += RTBContentsResized;
+            _textBox.ScrollBars = RichTextBoxScrollBars.None;
+            _textBox.BorderStyle = BorderStyle.None;
+            Controls.Add(_textBox);
+        }
+
+        /// <summary>
+        /// Called when an error occurs during preview.
+        /// </summary>
+        /// <param name="exception">The exception which occurred.</param>
+        /// <param name="dataSource">Stream reference to access source file.</param>
+        private void PreviewError<T>(Exception exception, T dataSource)
+        {
+            PowerToysTelemetry.Log.WriteEvent(new GcodeFilePreviewError { Message = exception.Message });
+            Controls.Clear();
+            _infoBarAdded = true;
+            AddTextBoxControl(Resource.GcodeNotPreviewedError);
+            base.DoPreview(dataSource);
+        }
+    }
+}