Add JavascriptBindingCompleteEventArgs - Use for IJavascriptObjectRepository.ObjectsBound event

This contains the breaking changes required for #2362

Author: amaitland

CefSharp/CefSharp.csproj

@@ -97,6 +97,7 @@
     <Compile Include="CdmRegistration.cs" />
     <Compile Include="Enums\AlphaType.cs" />
     <Compile Include="Enums\ColorType.cs" />
+    <Compile Include="Event\JavascriptBindingCompleteEventArgs.cs" />
     <Compile Include="Event\JavascriptBindingEventArgs.cs" />
     <Compile Include="Handler\DefaultRequestHandler.cs" />
     <Compile Include="Enums\UrlRequestFlags.cs" />

CefSharp/Event/JavascriptBindingCompleteEventArgs.cs

@@ -0,0 +1,43 @@
+// Copyright © 2010-2017 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.
+
+using System;
+
+namespace CefSharp.Event
+{
+    /// <summary>
+    /// Event arguments for the <see cref="IJavascriptObjectRepository.ObjectBoundInJavascript"/> event
+    /// </summary>
+    public class JavascriptBindingCompleteEventArgs : EventArgs
+    {
+        /// <summary>
+        /// The javascript object repository, used to register objects
+        /// </summary>
+        public IJavascriptObjectRepository ObjectRepository { get; private set; }
+        
+        /// <summary>
+        /// Name of the object
+        /// </summary>
+        public string ObjectName { get; private set; }
+
+        /// <summary>
+        /// Was the object already bound. The default is false for the first js call to 
+        /// CefSharp.BindObjectAsync, and subsiquently true if already bound in a given context.
+        /// </summary>
+        public bool AlreadyBound { get; private set; }
+
+        /// <summary>
+        /// Is the object cached
+        /// </summary>
+        public bool IsCached { get; private set; }
+
+        public JavascriptBindingCompleteEventArgs(IJavascriptObjectRepository objectRepository, string name, bool alreadyBound, bool isCached)
+        {
+            ObjectRepository = objectRepository;
+            ObjectName = name;
+            AlreadyBound = alreadyBound;
+            IsCached = isCached;
+        }
+    }
+}

CefSharp/Event/JavascriptBindingEventArgs.cs

@@ -2,15 +2,12 @@
 //
 // Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
 
-using CefSharp;
 using System;
-using System.Collections.Generic;
 
 namespace CefSharp.Event
 {
     /// <summary>
-    /// Event arguments for the <see cref="IJavascriptObjectRepository.ResolveObject"/> and
-    /// <see cref="IJavascriptObjectRepository.ObjectBoundInJavascript"/> events
+    /// Event arguments for the <see cref="IJavascriptObjectRepository.ResolveObject"/> event
     /// </summary>
     public class JavascriptBindingEventArgs : EventArgs
     {
@@ -24,6 +21,11 @@ public class JavascriptBindingEventArgs : EventArgs
         /// </summary>
         public string ObjectName { get; private set; }
 
+        /// <summary>
+        /// Constructor
+        /// </summary>
+        /// <param name="objectRepository">object repository</param>
+        /// <param name="name">object name</param>
         public JavascriptBindingEventArgs(IJavascriptObjectRepository objectRepository, string name)
         {
             ObjectRepository = objectRepository;

CefSharp/IJavascriptObjectRepository.cs

@@ -53,6 +53,6 @@ public interface IJavascriptObjectRepository : IDisposable
         /// <summary>
         /// Event handler is triggered when a object has been successfully bound on javascript
         /// </summary>
-        event EventHandler<JavascriptBindingEventArgs> ObjectBoundInJavascript;
+        event EventHandler<JavascriptBindingCompleteEventArgs> ObjectBoundInJavascript;
     }
 }

CefSharp/Internals/JavascriptObjectRepository.cs

@@ -7,7 +7,6 @@
 using System.Linq;
 using System.Reflection;
 using System.Threading;
-using CefSharp.ModelBinding;
 using CefSharp.Event;
 using System.Threading.Tasks;
 
@@ -37,7 +36,7 @@ public class JavascriptObjectRepository : IJavascriptObjectRepository
         private static long lastId;
 
         public event EventHandler<JavascriptBindingEventArgs> ResolveObject;
-        public event EventHandler<JavascriptBindingEventArgs> ObjectBoundInJavascript;		
+        public event EventHandler<JavascriptBindingCompleteEventArgs> ObjectBoundInJavascript;		
 
         /// <summary>
         /// A hash from assigned object ids to the objects,
@@ -67,6 +66,8 @@ public bool IsBound(string name)
             return objects.Values.Any(x => x.Name == name); 
         }
 
+        //Ideally this would internal, unfurtunately it's used in C++
+        //and it's hard to expose internals
         public List<JavascriptObject> GetObjects(List<string> names = null)
         {
             //If there are no objects names or the count is 0 then we will raise
@@ -96,23 +97,17 @@ public List<JavascriptObject> GetObjects(List<string> names = null)
         }
 
 
-        public void ObjectsBound(List<string> names)
+        public void ObjectsBound(List<string> objs)
         {
-            //TODO: JSB Should this be a single event invocation or
-            // one per object that was bound??? (Currently one per object)
-            
             //Execute on Threadpool so we don't unnessicarily block the CEF IO thread
             var handler = ObjectBoundInJavascript;
             if(handler != null)
             { 
                 Task.Run(() =>
                 {
-                    foreach (var name in names)
+                    foreach (var obj in objs)
                     {
-                        if (handler != null)
-                        {
-                            handler(this, new JavascriptBindingEventArgs(this, name));
-                        }
+                        handler?.Invoke(this, new JavascriptBindingCompleteEventArgs(this, obj, false, false));
                     }
                 });			
             }
@@ -161,7 +156,7 @@ public void Register(string name, object value, bool isAsync, BindingOptions opt
             AnalyseObjectForBinding(jsObject, analyseMethods: true, analyseProperties: !isAsync, readPropertyValue: false, camelCaseJavascriptNames: camelCaseJavascriptNames);
         }
 
-        public bool TryCallMethod(long objectId, string name, object[] parameters, out object result, out string exception)
+        internal bool TryCallMethod(long objectId, string name, object[] parameters, out object result, out string exception)
         {
             exception = "";
             result = null;
@@ -297,7 +292,7 @@ public bool TryCallMethod(long objectId, string name, object[] parameters, out o
             return false;
         }
 
-        public bool TryGetProperty(long objectId, string name, out object result, out string exception)
+        internal bool TryGetProperty(long objectId, string name, out object result, out string exception)
         {
             exception = "";
             result = null;
@@ -327,7 +322,7 @@ public bool TryGetProperty(long objectId, string name, out object result, out st
             return false;
         }
 
-        public bool TrySetProperty(long objectId, string name, object value, out string exception)
+        internal bool TrySetProperty(long objectId, string name, object value, out string exception)
         {
             exception = "";
             JavascriptObject obj;
@@ -429,12 +424,7 @@ private void AnalyseObjectForBinding(JavascriptObject obj, bool analyseMethods,
 
         private void RaiseResolveObjectEvent(string name)
         {
-            var handler = ResolveObject;
-
-            if(handler != null)
-            {
-                handler(this, new JavascriptBindingEventArgs(this, name));
-            }
+            ResolveObject?.Invoke(this, new JavascriptBindingEventArgs(this, name));
         }
 
         private static JavascriptMethod CreateJavaScriptMethod(MethodInfo methodInfo, bool camelCaseJavascriptNames)