OffScreen - IRenderHandler now implements all methods

amaitland · amaitland · commit d49f975f1c4f · 2018-04-23T14:15:25.000+10:00
DefaultRenderHandler handles all the calls required by the OffScreen ChromiumWebBrowser implementation
diff --git a/CefSharp.OffScreen/ChromiumWebBrowser.cs b/CefSharp.OffScreen/ChromiumWebBrowser.cs
@@ -79,13 +79,6 @@ public class ChromiumWebBrowser : IRenderWebBrowser
         /// binding.</remarks>
         public bool CanGoBack { get; private set; }
         /// <summary>
-        /// Gets or sets a value indicating whether the popup is open.
-        /// </summary>
-        /// <value>
-        /// <c>true</c> if popup is opened; otherwise, <c>false</c>.
-        /// </value>
-        public bool PopupOpen { get; protected set; }
-        /// <summary>
         /// A flag that indicates whether the state of the control currently supports the GoForward action (true) or not (false).
         /// </summary>
         /// <value><c>true</c> if this instance can go forward; otherwise, <c>false</c>.</value>
@@ -102,7 +95,6 @@ public class ChromiumWebBrowser : IRenderWebBrowser
         /// </summary>
         /// <value>The request context.</value>
         public IRequestContext RequestContext { get; private set; }
-
         /// <summary>
         /// Implement <see cref="IJsDialogHandler" /> and assign to handle events related to JavaScript Dialogs.
         /// </summary>
@@ -275,16 +267,6 @@ public class ChromiumWebBrowser : IRenderWebBrowser
         /// </summary>
         public bool CanExecuteJavascriptInMainFrame { get; private set; }
 
-        /// <summary>
-        /// Top Left position of the popup.
-        /// </summary>
-        private Point popupPosition;
-
-        /// <summary>
-        ///  Size of the popup.
-        /// </summary>
-        private Size popupSize;
-
         /// <summary>
         /// Create a new OffScreen Chromium Browser
         /// </summary>
@@ -315,9 +297,6 @@ public ChromiumWebBrowser(string address = "", BrowserSettings browserSettings =
                 CreateBrowser(IntPtr.Zero);
             }
 
-            popupPosition = new Point();
-            popupSize = new Size();
-
             RenderHandler = new DefaultRenderHandler(this);
         }
 
@@ -385,22 +364,6 @@ protected virtual void Dispose(bool disposing)
             this.SetHandlersToNull();
         }
 
-        /// <summary>
-        /// Gets the size of the popup.
-        /// </summary>
-        public Size PopupSize
-        {
-            get { return popupSize; }
-        }
-
-        /// <summary>
-        /// Gets the popup position.
-        /// </summary>
-        public Point PopupPosition
-        {
-            get { return popupPosition; }
-        }
-
         /// <summary>
         /// Create the underlying browser. The instance address, browser settings and request context will be used.
         /// </summary>
@@ -475,20 +438,20 @@ public Bitmap ScreenshotOrNull(PopupBlending blend = PopupBlending.Main)
 
                 if (blend == PopupBlending.Popup)
                 {
-                    return PopupOpen ? renderHandler.PopupBuffer.CreateBitmap() : null;
+                    return renderHandler.PopupOpen ? renderHandler.PopupBuffer.CreateBitmap() : null;
                 }
 
 
                 var bitmap = renderHandler.BitmapBuffer.CreateBitmap();
 
-                if (PopupOpen && bitmap != null)
+                if (renderHandler.PopupOpen && bitmap != null)
                 {
                     var popup = renderHandler.PopupBuffer.CreateBitmap();
                     if (popup == null)
                     {
                         return bitmap;
                     }
-                    return MergeBitmaps(bitmap, popup);
+                    return MergeBitmaps(bitmap, popup, renderHandler.PopupPosition);
                 }
 
                 return bitmap;
@@ -667,9 +630,7 @@ public IBrowser GetBrowser()
         /// <returns>ScreenInfo.</returns>
         protected virtual ScreenInfo? GetScreenInfo()
         {
-            var screenInfo = new ScreenInfo(scaleFactor: 1.0F);
-
-            return screenInfo;
+            return RenderHandler?.GetScreenInfo();
         }
 
         /// <summary>
@@ -687,9 +648,7 @@ public IBrowser GetBrowser()
         /// <returns>ViewRect.</returns>
         protected virtual ViewRect? GetViewRect()
         {
-            var viewRect = new ViewRect(size.Width, size.Height);
-
-            return viewRect;
+            return RenderHandler?.GetViewRect();
         }
 
         /// <summary>
@@ -718,7 +677,7 @@ protected virtual bool GetScreenPoint(int viewX, int viewY, out int screenX, out
             screenX = 0;
             screenY = 0;
 
-            return false;
+            return RenderHandler?.GetScreenPoint(viewX, viewY, out screenX, out screenY) ?? false;
         }
 
         /// <summary>
@@ -755,11 +714,10 @@ void IRenderWebBrowser.OnPaint(PaintElementType type, Rect dirtyRect, IntPtr buf
         /// <param name="buffer">The bitmap will be will be  width * height *4 bytes in size and represents a BGRA image with an upper-left origin</param>
         /// <param name="width">width</param>
         /// <param name="height">height</param>
+        [Obsolete("This method will be removed, implement IRenderHandler and assign browser.RenderHandler")]
         protected virtual void OnPaint(PaintElementType type, Rect dirtyRect, IntPtr buffer, int width, int height)
         {
-            var isPopup = type == PaintElementType.Popup;
-
-            RenderHandler?.OnPaint(isPopup, dirtyRect, buffer, width, height);
+            RenderHandler?.OnPaint(type, dirtyRect, buffer, width, height);
         }
 
         /// <summary>
@@ -779,8 +737,10 @@ void IRenderWebBrowser.OnCursorChange(IntPtr cursor, CursorType type, CursorInfo
         /// <param name="cursor">If type is Custom then customCursorInfo will be populated with the custom cursor information</param>
         /// <param name="type">cursor type</param>
         /// <param name="customCursorInfo">custom cursor Information</param>
+        [Obsolete("This method will be removed, implement IRenderHandler and assign browser.RenderHandler")]
         protected virtual void OnCursorChange(IntPtr cursor, CursorType type, CursorInfo customCursorInfo)
         {
+            RenderHandler?.OnCursorChange(cursor, type, customCursorInfo);
         }
 
         /// <summary>
@@ -804,19 +764,21 @@ bool IRenderWebBrowser.StartDragging(IDragData dragData, DragOperationsMask mask
         /// <param name="x">The x.</param>
         /// <param name="y">The y.</param>
         /// <returns><c>true</c> if XXXX, <c>false</c> otherwise.</returns>
+        [Obsolete("This method will be removed, implement IRenderHandler and assign browser.RenderHandler")]
         protected virtual bool StartDragging(IDragData dragData, DragOperationsMask mask, int x, int y)
         {
-            return false;
+            return RenderHandler?.StartDragging(dragData, mask, x, y) ?? false;
         }
 
         void IRenderWebBrowser.UpdateDragCursor(DragOperationsMask operation)
         {
             UpdateDragCursor(operation);
         }
 
+        [Obsolete("This method will be removed, implement IRenderHandler and assign browser.RenderHandler")]
         protected virtual void UpdateDragCursor(DragOperationsMask operation)
         {
-            
+            RenderHandler?.UpdateDragCursor(operation);
         }
 
         /// <summary>
@@ -828,9 +790,10 @@ void IRenderWebBrowser.OnPopupShow(bool show)
             OnPopupShow(show);
         }
 
+        [Obsolete("This method will be removed, implement IRenderHandler and assign browser.RenderHandler")]
         protected virtual void OnPopupShow(bool show)
         {
-            PopupOpen = show;
+            RenderHandler?.OnPopupShow(show);
         }
 
         /// <summary>
@@ -846,22 +809,21 @@ void IRenderWebBrowser.OnPopupSize(Rect rect)
         /// Called when the browser wants to move or resize the popup widget. 
         /// </summary>
         /// <param name="rect">contains the new location and size in view coordinates. </param>
+        [Obsolete("This method will be removed, implement IRenderHandler and assign browser.RenderHandler")]
         protected virtual void OnPopupSize(Rect rect)
         {
-            popupPosition.X = rect.X;
-            popupPosition.Y = rect.Y;
-            popupSize.Width = rect.Width;
-            popupSize.Height = rect.Height;
+            RenderHandler?.OnPopupSize(rect);
         }
 
         void IRenderWebBrowser.OnImeCompositionRangeChanged(Range selectedRange, Rect[] characterBounds)
         {
             OnImeCompositionRangeChanged(selectedRange, characterBounds);
         }
 
+        [Obsolete("This method will be removed, implement IRenderHandler and assign browser.RenderHandler")]
         protected virtual void OnImeCompositionRangeChanged(Range selectedRange, Rect[] characterBounds)
         {
-            
+            RenderHandler?.OnImeCompositionRangeChanged(selectedRange, characterBounds);
         }
 
         /// <summary>
@@ -990,14 +952,15 @@ void IWebBrowserInternal.SetCanExecuteJavascriptOnMainFrame(bool canExecute)
         /// </summary>
         /// <param name="firstBitmap">First bitmap, this will be the first image drawn</param>
         /// <param name="secondBitmap">Second bitmap, this image will be drawn on the first</param>
+        /// <param name="secondBitmapPosition">Position of the second bitmap</param>
         /// <returns>The merged bitmap, size of firstBitmap</returns>
-        private Bitmap MergeBitmaps(Bitmap firstBitmap, Bitmap secondBitmap)
+        private Bitmap MergeBitmaps(Bitmap firstBitmap, Bitmap secondBitmap, Point secondBitmapPosition)
         {
             var mergedBitmap = new Bitmap(firstBitmap.Width, firstBitmap.Height, PixelFormat.Format32bppPArgb);
             using (var g = Graphics.FromImage(mergedBitmap))
             {
                 g.DrawImage(firstBitmap, new Rectangle(0, 0, firstBitmap.Width, firstBitmap.Height));
-                g.DrawImage(secondBitmap, new Rectangle(popupPosition.X, popupPosition.Y, secondBitmap.Width, secondBitmap.Height));
+                g.DrawImage(secondBitmap, new Rectangle(secondBitmapPosition.X, secondBitmapPosition.Y, secondBitmap.Width, secondBitmap.Height));
             }
             return mergedBitmap;
         }
diff --git a/CefSharp.OffScreen/DefaultRenderHandler.cs b/CefSharp.OffScreen/DefaultRenderHandler.cs
@@ -3,14 +3,35 @@
 // Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
 
 using System;
+using CefSharp.Enums;
 using CefSharp.Structs;
 
+using Point = System.Drawing.Point;
+using Size = System.Drawing.Size;
+
 namespace CefSharp.OffScreen
 {
 	public class DefaultRenderHandler : IRenderHandler
 	{
 		private ChromiumWebBrowser browser;
 
+		private Size popupSize;
+		private Point popupPosition;
+
+		/// <summary>
+		/// Need a lock because the caller may be asking for the bitmap
+		/// while Chromium async rendering has returned on another thread.
+		/// </summary>
+		public readonly object BitmapLock = new object();
+
+		/// <summary>
+		/// Gets or sets a value indicating whether the popup is open.
+		/// </summary>
+		/// <value>
+		/// <c>true</c> if popup is opened; otherwise, <c>false</c>.
+		/// </value>
+		public bool PopupOpen { get; protected set; }
+
 		/// <summary>
 		/// Contains the last bitmap buffer. Direct access
 		/// to the underlying buffer - there is no locking when trying
@@ -25,30 +46,102 @@ public class DefaultRenderHandler : IRenderHandler
 		public BitmapBuffer PopupBuffer { get; private set; }
 
 		/// <summary>
-		/// Need a lock because the caller may be asking for the bitmap
-		/// while Chromium async rendering has returned on another thread.
+		/// Gets the size of the popup.
 		/// </summary>
-		public readonly object BitmapLock = new object();
+		public Size PopupSize
+		{
+			get { return popupSize; }
+		}
+
+		/// <summary>
+		/// Gets the popup position.
+		/// </summary>
+		public Point PopupPosition
+		{
+			get { return popupPosition; }
+		}
 
 		public DefaultRenderHandler(ChromiumWebBrowser browser)
 		{
 			this.browser = browser;
 
+			popupPosition = new Point();
+			popupSize = new Size();
+
 			BitmapBuffer = new BitmapBuffer(BitmapLock);
 			PopupBuffer = new BitmapBuffer(BitmapLock);
-
 		}
 
 		public void Dispose()
 		{
 			browser = null;
 		}
 
-		public virtual void OnPaint(bool isPopup, Rect dirtyRect, IntPtr buffer, int width, int height)
+		public virtual ScreenInfo? GetScreenInfo()
 		{
+			var screenInfo = new ScreenInfo(scaleFactor: 1.0F);
+
+			return screenInfo;
+		}
+
+		public virtual ViewRect? GetViewRect()
+		{
+			//TODO: See if this can be refactored and remove browser reference
+			var size = browser.Size;
+
+			var viewRect = new ViewRect(size.Width, size.Height);
+
+			return viewRect;
+		}
+
+		public virtual bool GetScreenPoint(int viewX, int viewY, out int screenX, out int screenY)
+		{
+			screenX = 0;
+			screenY = 0;
+
+			return false;
+		}
+
+		public virtual void OnPaint(PaintElementType type, Rect dirtyRect, IntPtr buffer, int width, int height)
+		{
+			var isPopup = type == PaintElementType.Popup;
+
 			var bitmapBuffer = isPopup ? PopupBuffer : BitmapBuffer;
 
 			bitmapBuffer.UpdateBuffer(width, height, buffer, dirtyRect);
 		}
+
+		public virtual void OnCursorChange(IntPtr cursor, CursorType type, CursorInfo customCursorInfo)
+		{
+			
+		}
+
+		public virtual bool StartDragging(IDragData dragData, DragOperationsMask mask, int x, int y)
+		{
+			return false;
+		}
+
+		public virtual void UpdateDragCursor(DragOperationsMask operation)
+		{
+			
+		}
+
+		public virtual void OnPopupShow(bool show)
+		{
+			PopupOpen = show;
+		}
+
+		public virtual void OnPopupSize(Rect rect)
+		{
+			popupPosition.X = rect.X;
+			popupPosition.Y = rect.Y;
+			popupSize.Width = rect.Width;
+			popupSize.Height = rect.Height;
+		}
+
+		public virtual void OnImeCompositionRangeChanged(Range selectedRange, Rect[] characterBounds)
+		{
+			
+		}
 	}
 }
diff --git a/CefSharp.OffScreen/IRenderHandler.cs b/CefSharp.OffScreen/IRenderHandler.cs
