WPF/WinForms/OffScreen - Reduce Code Duplication Initial

- Add ChromiumWebBrowser.Partial.cs and include in all three projects - Remove InternalsVisibleTo from Cefsharp.dll start moving code into the partial class (We don't want to publish our internals as part of our Ref Assembly so this goings together) #3082 #3197
cefsharp · Aug 7, 2020 · 0183c42 · 0183c42
1 parent 2a96ebc
commit 0183c42
Show file tree

Hide file tree

Showing 18 changed files with 92 additions and 54 deletions.
diff --git a/CefSharp.OffScreen/CefSharp.OffScreen.csproj b/CefSharp.OffScreen/CefSharp.OffScreen.csproj
@@ -17,7 +17,7 @@
   <PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Debug|x64'">
     <DebugSymbols>true</DebugSymbols>
     <OutputPath>bin\x64\Debug\</OutputPath>
-    <DefineConstants>DEBUG;TRACE</DefineConstants>
+    <DefineConstants>DEBUG;TRACE;OFFSCREEN</DefineConstants>
     <DebugType>full</DebugType>
     <PlatformTarget>x64</PlatformTarget>
     <ErrorReport>prompt</ErrorReport>
@@ -27,7 +27,7 @@
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Release|x64'">
     <OutputPath>bin\x64\Release\</OutputPath>
-    <DefineConstants>TRACE</DefineConstants>
+    <DefineConstants>TRACE;OFFSCREEN</DefineConstants>
     <Optimize>true</Optimize>
     <DebugType>pdbonly</DebugType>
     <PlatformTarget>x64</PlatformTarget>
@@ -39,7 +39,7 @@
   <PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Debug|x86'">
     <DebugSymbols>true</DebugSymbols>
     <OutputPath>bin\x86\Debug\</OutputPath>
-    <DefineConstants>DEBUG;TRACE</DefineConstants>
+    <DefineConstants>DEBUG;TRACE;OFFSCREEN</DefineConstants>
     <DebugType>full</DebugType>
     <PlatformTarget>x86</PlatformTarget>
     <ErrorReport>prompt</ErrorReport>
@@ -50,7 +50,7 @@
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Release|x86'">
     <OutputPath>bin\x86\Release\</OutputPath>
-    <DefineConstants>TRACE</DefineConstants>
+    <DefineConstants>TRACE;OFFSCREEN</DefineConstants>
     <Optimize>true</Optimize>
     <DebugType>pdbonly</DebugType>
     <PlatformTarget>x86</PlatformTarget>
@@ -75,6 +75,9 @@
     <Compile Include="BitmapBuffer.cs" />
     <Compile Include="CefSettings.cs" />
     <Compile Include="ChromiumWebBrowser.cs" />
+	<Compile Include="..\CefSharp\Internals\Partial\ChromiumWebBrowser.Partial.cs">
+      <Link>ChromiumWebBrowser.Partial.cs</Link>
+    </Compile>
     <Compile Include="DefaultRenderHandler.cs" />
     <Compile Include="IRenderHandler.cs" />
     <Compile Include="OnPaintEventArgs.cs" />

diff --git a/CefSharp.OffScreen/CefSharp.OffScreen.netcore.csproj b/CefSharp.OffScreen/CefSharp.OffScreen.netcore.csproj
@@ -19,6 +19,7 @@
     <SignAssembly>true</SignAssembly>
     <AssemblyOriginatorKeyFile>..\CefSharp.snk</AssemblyOriginatorKeyFile>
     <CodeAnalysisRuleSet>MinimumRecommendedRules.ruleset</CodeAnalysisRuleSet>
+	<DefineConstants>OFFSCREEN</DefineConstants>
   </PropertyGroup>
 
   <ItemGroup>
@@ -33,5 +34,9 @@
     <Compile Remove="obj/**/*.*" />
   </ItemGroup>
 
+  <ItemGroup>
+    <Compile Include="..\CefSharp\Internals\Partial\ChromiumWebBrowser.Partial.cs" Link="ChromiumWebBrowser.Partial.cs" />
+  </ItemGroup>
+
   <Import Project="Sdk.targets" Sdk="Microsoft.NET.Sdk.WindowsDesktop" />
 </Project>
diff --git a/CefSharp.OffScreen/ChromiumWebBrowser.cs b/CefSharp.OffScreen/ChromiumWebBrowser.cs
@@ -21,7 +21,7 @@ namespace CefSharp.OffScreen
     /// An offscreen instance of Chromium that you can use to take
     /// snapshots or evaluate JavaScript.
     /// </summary>
-    public class ChromiumWebBrowser : IRenderWebBrowser
+    public partial class ChromiumWebBrowser : IRenderWebBrowser
     {
         /// <summary>
         /// The managed cef browser adapter

diff --git a/CefSharp.WinForms/CefSharp.WinForms.csproj b/CefSharp.WinForms/CefSharp.WinForms.csproj
@@ -18,6 +18,7 @@
     <PlatformTarget>x64</PlatformTarget>
     <OutputPath>bin\x64\Debug\</OutputPath>
     <Prefer32Bit>false</Prefer32Bit>
+    <DefineConstants>TRACE;DEBUG;WINFORMS</DefineConstants>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Release|x64'">
     <PlatformTarget>x64</PlatformTarget>
@@ -27,6 +28,7 @@
     <DebugSymbols>true</DebugSymbols>
     <Optimize>true</Optimize>
     <Prefer32Bit>false</Prefer32Bit>
+    <DefineConstants>TRACE;WINFORMS</DefineConstants>
   </PropertyGroup>
   <PropertyGroup>
     <SignAssembly>true</SignAssembly>
@@ -40,6 +42,7 @@
     <PlatformTarget>x86</PlatformTarget>
     <CodeAnalysisRuleSet>MinimumRecommendedRules.ruleset</CodeAnalysisRuleSet>
     <Prefer32Bit>false</Prefer32Bit>
+    <DefineConstants>TRACE;DEBUG;WINFORMS</DefineConstants>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Release|x86'">
     <OutputPath>bin\x86\Release\</OutputPath>
@@ -50,6 +53,7 @@
     <DebugSymbols>true</DebugSymbols>
     <DocumentationFile>bin\x86\Release\CefSharp.WinForms.XML</DocumentationFile>
     <Prefer32Bit>false</Prefer32Bit>
+    <DefineConstants>TRACE;WINFORMS</DefineConstants>
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="System" />
@@ -65,6 +69,10 @@
     <Reference Include="System.Xml" />
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="..\CefSharp\Internals\Partial\ChromiumWebBrowser.Partial.cs">
+      <Link>ChromiumWebBrowser.Partial.cs</Link>
+      <SubType>Component</SubType>
+    </Compile>
     <Compile Include="CefSettings.cs" />
     <Compile Include="ChromiumWebBrowserDesigner.cs" />
     <Compile Include="Internals\DefaultFocusHandler.cs" />

diff --git a/CefSharp.WinForms/CefSharp.WinForms.netcore.csproj b/CefSharp.WinForms/CefSharp.WinForms.netcore.csproj
@@ -19,6 +19,7 @@
     <SignAssembly>true</SignAssembly>
     <AssemblyOriginatorKeyFile>..\CefSharp.snk</AssemblyOriginatorKeyFile>
     <CodeAnalysisRuleSet>MinimumRecommendedRules.ruleset</CodeAnalysisRuleSet>
+	<DefineConstants>WINFORMS</DefineConstants>
   </PropertyGroup>
 
   <ItemGroup>
@@ -41,5 +42,9 @@
     <Compile Remove="obj/**/*.*" />
   </ItemGroup>
 
+  <ItemGroup>
+    <Compile Include="..\CefSharp\Internals\Partial\ChromiumWebBrowser.Partial.cs" Link="ChromiumWebBrowser.Partial.cs" />
+  </ItemGroup>
+
   <Import Project="Sdk.targets" Sdk="Microsoft.NET.Sdk.WindowsDesktop" />
 </Project>
diff --git a/CefSharp.WinForms/ChromiumWebBrowser.cs b/CefSharp.WinForms/ChromiumWebBrowser.cs
@@ -22,7 +22,7 @@ namespace CefSharp.WinForms
     [Docking(DockingBehavior.AutoDock), DefaultEvent("LoadingStateChanged"), ToolboxBitmap(typeof(ChromiumWebBrowser)),
     Description("CefSharp ChromiumWebBrowser - Chromium Embedded Framework .Net wrapper. https://github.com/cefsharp/CefSharp"),
     Designer(typeof(ChromiumWebBrowserDesigner))]
-    public class ChromiumWebBrowser : Control, IWebBrowserInternal, IWinFormsWebBrowser
+    public partial class ChromiumWebBrowser : Control, IWebBrowserInternal, IWinFormsWebBrowser
     {
         //TODO: If we start adding more consts then extract them into a common class
         //Possibly in the CefSharp assembly and move the WPF ones into there as well.

diff --git a/CefSharp.Wpf/CefSharp.Wpf.csproj b/CefSharp.Wpf/CefSharp.Wpf.csproj
@@ -26,7 +26,7 @@
   <PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Debug|x64'">
     <DebugSymbols>true</DebugSymbols>
     <OutputPath>bin\x64\Debug\</OutputPath>
-    <DefineConstants>DEBUG;TRACE</DefineConstants>
+    <DefineConstants>TRACE;DEBUG;WPF</DefineConstants>
     <DebugType>full</DebugType>
     <PlatformTarget>x64</PlatformTarget>
     <ErrorReport>prompt</ErrorReport>
@@ -35,7 +35,7 @@
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Release|x64'">
     <OutputPath>bin\x64\Release\</OutputPath>
-    <DefineConstants>TRACE</DefineConstants>
+    <DefineConstants>TRACE;WPF</DefineConstants>
     <Optimize>true</Optimize>
     <DebugType>pdbonly</DebugType>
     <PlatformTarget>x64</PlatformTarget>
@@ -47,7 +47,7 @@
   <PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Debug|x86'">
     <DebugSymbols>true</DebugSymbols>
     <OutputPath>bin\x86\Debug\</OutputPath>
-    <DefineConstants>DEBUG;TRACE</DefineConstants>
+    <DefineConstants>TRACE;DEBUG;WPF</DefineConstants>
     <DebugType>full</DebugType>
     <PlatformTarget>x86</PlatformTarget>
     <ErrorReport>prompt</ErrorReport>
@@ -56,7 +56,7 @@
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Release|x86'">
     <OutputPath>bin\x86\Release\</OutputPath>
-    <DefineConstants>TRACE</DefineConstants>
+    <DefineConstants>TRACE;WPF</DefineConstants>
     <Optimize>true</Optimize>
     <DebugType>pdbonly</DebugType>
     <PlatformTarget>x86</PlatformTarget>
@@ -78,6 +78,9 @@
     <Reference Include="PresentationFramework" />
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="..\CefSharp\Internals\Partial\ChromiumWebBrowser.Partial.cs">
+      <Link>ChromiumWebBrowser.Partial.cs</Link>
+    </Compile>
     <Compile Include="CefSettings.cs" />
     <Compile Include="Experimental\Accessibility\AccessibilityHandler.cs" />
     <Compile Include="Experimental\Accessibility\AccessibilityNode.cs" />

diff --git a/CefSharp.Wpf/CefSharp.Wpf.netcore.csproj b/CefSharp.Wpf/CefSharp.Wpf.netcore.csproj
@@ -19,6 +19,7 @@
     <SignAssembly>true</SignAssembly>
     <AssemblyOriginatorKeyFile>..\CefSharp.snk</AssemblyOriginatorKeyFile>
     <CodeAnalysisRuleSet>MinimumRecommendedRules.ruleset</CodeAnalysisRuleSet>
+	<DefineConstants>WPF</DefineConstants>
   </PropertyGroup>
 
   <ItemGroup>
@@ -33,5 +34,9 @@
     <Compile Remove="obj/**/*.*" />
   </ItemGroup>
 
+  <ItemGroup>
+    <Compile Include="..\CefSharp\Internals\Partial\ChromiumWebBrowser.Partial.cs" Link="ChromiumWebBrowser.Partial.cs" />
+  </ItemGroup>
+
   <Import Project="Sdk.targets" Sdk="Microsoft.NET.Sdk.WindowsDesktop" />
 </Project>
diff --git a/CefSharp.Wpf/ChromiumWebBrowser.cs b/CefSharp.Wpf/ChromiumWebBrowser.cs
@@ -35,7 +35,7 @@ namespace CefSharp.Wpf
     /// <seealso cref="CefSharp.Wpf.IWpfWebBrowser" />
     [TemplatePart(Name = PartImageName, Type = typeof(Image))]
     [TemplatePart(Name = PartPopupImageName, Type = typeof(Image))]
-    public class ChromiumWebBrowser : Control, IRenderWebBrowser, IWpfWebBrowser
+    public partial class ChromiumWebBrowser : Control, IRenderWebBrowser, IWpfWebBrowser
     {
         /// <summary>
         /// TemplatePart Name constant for the Image used to represent the browser

diff --git a/CefSharp/CefSharp.csproj b/CefSharp/CefSharp.csproj
@@ -317,7 +317,6 @@
     <Compile Include="Internals\JavascriptObjectRepository.cs" />
     <Compile Include="Internals\JavascriptProperty.cs" />
     <Compile Include="CefCustomScheme.cs" />
-    <Compile Include="Internals\InternalWebBrowserExtensions.cs" />
     <Compile Include="Visitor\ICookieVisitor.cs" />
     <Compile Include="Visitor\INavigationEntryVisitor.cs" />
     <Compile Include="Visitor\IStringVisitor.cs" />
@@ -336,6 +335,9 @@
     <Compile Include="Web\HtmlString.cs" />
     <Compile Include="Web\JsonString.cs" />
   </ItemGroup>
+  <ItemGroup>
+    <None Include="Internals\Partial\Readme.md" />
+  </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
   <!-- To modify your build process, add your task inside one of the targets below and uncomment it.
        Other similar extension points exist, see Microsoft.Common.targets.

diff --git a/CefSharp/CefSharp.netcore.csproj b/CefSharp/CefSharp.netcore.csproj
@@ -30,5 +30,9 @@
     <Compile Remove="obj/**/*.*" />
   </ItemGroup>
 
+  <ItemGroup>
+    <Compile Remove="Internals\Partial\ChromiumWebBrowser.Partial.cs" />
+  </ItemGroup>
+
   <Import Project="Sdk.targets" Sdk="Microsoft.NET.Sdk" />
 </Project>
diff --git a/CefSharp/DevToolsExtensions.cs b/CefSharp/DevToolsExtensions.cs
@@ -96,8 +96,8 @@ public static Task<int> ExecuteDevToolsMethodAsync(this IBrowser browser, int me
         /// unsuccessfully submitted for validation, this value will be 0.</returns>
         public static Task<int> ExecuteDevToolsMethodAsync(this IWebBrowser chromiumWebBrowser, int messageId, string method, IDictionary<string, object> parameters = null)
         {
-            chromiumWebBrowser.ThrowExceptionIfDisposed();
-            chromiumWebBrowser.ThrowExceptionIfBrowserNotInitialized();
+            ((IWebBrowserInternal)chromiumWebBrowser).ThrowExceptionIfDisposed();
+            ((IWebBrowserInternal)chromiumWebBrowser).ThrowExceptionIfBrowserNotInitialized();
 
             var browser = chromiumWebBrowser.GetBrowser();
 

diff --git a/CefSharp/Internals/IntPtrExtensions.cs b/CefSharp/Internals/IntPtrExtensions.cs
@@ -6,7 +6,7 @@
 
 namespace CefSharp.Internals
 {
-    internal static class IntPtrExtensions
+    public static class IntPtrExtensions
     {
         /// <summary>
         /// Do an unchecked conversion from IntPtr to int

diff --git a/CefSharp/Internals/InternalWebBrowserExtensions.cs b/CefSharp/Internals/InternalWebBrowserExtensions.cs
diff --git a/CefSharp/Internals/Partial/ChromiumWebBrowser.Partial.cs b/CefSharp/Internals/Partial/ChromiumWebBrowser.Partial.cs
@@ -0,0 +1,36 @@
+// Copyright © 2020 The CefSharp Authors. All rights reserved.
+//
+// Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
+
+
+#if OFFSCREEN
+namespace CefSharp.OffScreen
+#elif WPF
+namespace CefSharp.Wpf
+#elif WINFORMS
+namespace CefSharp.WinForms
+#endif
+{
+    //ChromiumWebBrowser Partial class implementation shared between the 
+    //WPF, Winforms and Offscreen
+    public partial class ChromiumWebBrowser
+    {
+        private void SetHandlersToNullExceptLifeSpan()
+        {
+            AudioHandler = null;
+            DialogHandler = null;
+            FindHandler = null;
+            RequestHandler = null;
+            DisplayHandler = null;
+            LoadHandler = null;
+            KeyboardHandler = null;
+            JsDialogHandler = null;
+            DragHandler = null;
+            DownloadHandler = null;
+            MenuHandler = null;
+            FocusHandler = null;
+            ResourceRequestHandlerFactory = null;
+            RenderProcessMessageHandler = null;
+        }
+    }
+}
diff --git a/CefSharp/Internals/Partial/Readme.md b/CefSharp/Internals/Partial/Readme.md
@@ -0,0 +1,3 @@
+The ChromiumWebBrowser class in this folder is not directly included in CefSharp.dll
+it is shared between the WPF, OffScreen and WinForms implementations with #if def's
+to allow for the partial class to be used between the three implementations.
diff --git a/CefSharp/Properties/AssemblyInfo.cs b/CefSharp/Properties/AssemblyInfo.cs
@@ -1,6 +1,5 @@
 using System;
 using System.Reflection;
-using System.Runtime.CompilerServices;
 using System.Runtime.InteropServices;
 using CefSharp;
 
@@ -18,14 +17,6 @@
 [assembly: AssemblyFileVersion(AssemblyInfo.AssemblyFileVersion)]
 [assembly: CLSCompliant(AssemblyInfo.ClsCompliant)]
 
-[assembly: InternalsVisibleTo(AssemblyInfo.CefSharpCoreProject)]
-[assembly: InternalsVisibleTo(AssemblyInfo.CefSharpBrowserSubprocessProject)]
-[assembly: InternalsVisibleTo(AssemblyInfo.CefSharpBrowserSubprocessCoreProject)]
-[assembly: InternalsVisibleTo(AssemblyInfo.CefSharpWpfProject)]
-[assembly: InternalsVisibleTo(AssemblyInfo.CefSharpWinFormsProject)]
-[assembly: InternalsVisibleTo(AssemblyInfo.CefSharpOffScreenProject)]
-[assembly: InternalsVisibleTo(AssemblyInfo.CefSharpTestProject)]
-
 namespace CefSharp
 {
     /// <exclude />

diff --git a/CefSharp/WebBrowserExtensions.cs b/CefSharp/WebBrowserExtensions.cs
@@ -18,7 +18,7 @@ namespace CefSharp
     /// </summary>
     public static class WebBrowserExtensions
     {
-        internal const string BrowserNotInitializedExceptionErrorMessage =
+        public const string BrowserNotInitializedExceptionErrorMessage =
             "The ChromiumWebBrowser instance creates the underlying Chromium Embedded Framework (CEF) browser instance in an async fashion. " +
             "The undelying CefBrowser instance is not yet initialized. Use the IsBrowserInitializedChanged event and check " +
             "the IsBrowserInitialized property to determine when the browser has been initialized.";
@@ -1169,7 +1169,7 @@ public static string GetScriptForJavascriptMethodWithArgs(string methodName, obj
         /// </remarks>
         /// <exception cref="Exception">Thrown when an exception error condition occurs.</exception>
         /// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>
-        internal static void ThrowExceptionIfBrowserNotInitialized(this IWebBrowser browser)
+        public static void ThrowExceptionIfBrowserNotInitialized(this IWebBrowserInternal browser)
         {
             if (!browser.IsBrowserInitialized)
             {
@@ -1182,7 +1182,7 @@ internal static void ThrowExceptionIfBrowserNotInitialized(this IWebBrowser brow
         /// </summary>
         /// <exception cref="ObjectDisposedException">Thrown when a supplied object has been disposed.</exception>
         /// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>
-        internal static void ThrowExceptionIfDisposed(this IWebBrowser browser)
+        public static void ThrowExceptionIfDisposed(this IWebBrowserInternal browser)
         {
             if (browser.IsDisposed)
             {