Skip to content

Commit b4e3cb5

Browse files
Erik Schillingoliverbock
Erik Schilling
authored and
oliverbock
committed
Add support for registered constructors
This allows to register a function (delegate in .NET) as constructor function in JavaScript. In order to support this a new method `SetConstructor` was introduced which allows to register a constructor function for a specific type under a name. This fuction is then available to the executed JavaScript code and invoking `new` with this function results in the objects being registered as `instanceof` the registered function. Additionally, objects which are created in .NET code are also converted to V8 while preserving the `instanceof` relation if the type is registered. Part of #60
1 parent 33209b1 commit b4e3cb5

File tree

6 files changed

+133
-32
lines changed

6 files changed

+133
-32
lines changed

‎Source/Noesis.Javascript/JavascriptContext.cpp

+41-10
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,15 @@ namespace Noesis { namespace Javascript {
114114
}
115115
#pragma managed(pop)
116116

117+
v8::Local<v8::String> ToV8String(Isolate* isolate, System::String^ value) {
118+
if (value == nullptr)
119+
throw gcnew System::ArgumentNullException("value");
120+
pin_ptr<const wchar_t> namePtr = PtrToStringChars(value);
121+
wchar_t* name = (wchar_t*)namePtr;
122+
123+
return String::NewFromTwoByte(isolate, (uint16_t*)name, v8::NewStringType::kNormal).ToLocalChecked();
124+
}
125+
117126
static JavascriptContext::JavascriptContext()
118127
{
119128
System::Threading::Mutex mutex(true, "FA12B681-E968-4D3A-833D-43B25865BEF1");
@@ -163,6 +172,7 @@ JavascriptContext::JavascriptContext()
163172
isolate->SetFatalErrorHandler(FatalErrorCallback);
164173

165174
mExternals = gcnew System::Collections::Generic::Dictionary<System::Object ^, WrappedJavascriptExternal>();
175+
mTypeToConstructorMapping = gcnew System::Collections::Generic::Dictionary<System::Type ^, System::IntPtr>();
166176
mFunctions = gcnew System::Collections::Generic::List<System::WeakReference ^>();
167177
HandleScope scope(isolate);
168178
mContext = new Persistent<Context>(isolate, Context::New(isolate));
@@ -182,9 +192,13 @@ JavascriptContext::~JavascriptContext()
182192
JavascriptFunction ^function = safe_cast<JavascriptFunction ^>(f->Target);
183193
if (function != nullptr)
184194
delete function;
195+
}
196+
for each (System::IntPtr p in mTypeToConstructorMapping->Values) {
197+
delete (void *)p;
185198
}
186199
delete mContext;
187200
delete mExternals;
201+
delete mTypeToConstructorMapping;
188202
delete mFunctions;
189203
}
190204
if (isolate != NULL)
@@ -244,10 +258,6 @@ JavascriptContext::SetParameter(System::String^ iName, System::Object^ iObject)
244258
void
245259
JavascriptContext::SetParameter(System::String^ iName, System::Object^ iObject, SetParameterOptions options)
246260
{
247-
if (iName == nullptr)
248-
throw gcnew System::ArgumentNullException("iName");
249-
pin_ptr<const wchar_t> namePtr = PtrToStringChars(iName);
250-
wchar_t* name = (wchar_t*) namePtr;
251261
JavascriptScope scope(this);
252262
v8::Isolate *isolate = JavascriptContext::GetCurrentIsolate();
253263
HandleScope handleScope(isolate);
@@ -265,12 +275,27 @@ JavascriptContext::SetParameter(System::String^ iName, System::Object^ iObject,
265275
}
266276
}
267277

268-
v8::Local<v8::String> key = String::NewFromTwoByte(isolate, (uint16_t*)name, v8::NewStringType::kNormal).ToLocalChecked();
278+
v8::Local<v8::String> key = ToV8String(isolate, iName);
269279
Local<Context>::New(isolate, *mContext)->Global()->Set(isolate->GetCurrentContext(), key, value).ToChecked();
270280
}
271281

272282
////////////////////////////////////////////////////////////////////////////////////////////////////
273283

284+
285+
void JavascriptContext::SetConstructor(System::String^ name, System::Type^ associatedType, System::Delegate^ constructor)
286+
{
287+
JavascriptScope scope(this);
288+
v8::Isolate *isolate = JavascriptContext::GetCurrentIsolate();
289+
HandleScope handleScope(isolate);
290+
291+
Handle<FunctionTemplate> functionTemplate = JavascriptInterop::GetFunctionTemplateFromSystemDelegate(constructor);
292+
JavascriptInterop::InitObjectWrapperTemplate(functionTemplate->InstanceTemplate());
293+
mTypeToConstructorMapping[associatedType] = System::IntPtr(new Persistent<FunctionTemplate>(isolate, functionTemplate));
294+
Local<Context>::New(isolate, *mContext)->Global()->Set(isolate->GetCurrentContext(), ToV8String(isolate, name), functionTemplate->GetFunction());
295+
}
296+
297+
////////////////////////////////////////////////////////////////////////////////////////////////////
298+
274299
System::Object^
275300
JavascriptContext::GetParameter(System::String^ iName)
276301
{
@@ -489,12 +514,18 @@ JavascriptContext::WrapObject(System::Object^ iObject)
489514

490515
////////////////////////////////////////////////////////////////////////////////////////////////////
491516

492-
Handle<ObjectTemplate>
493-
JavascriptContext::GetObjectWrapperTemplate()
517+
Handle<FunctionTemplate>
518+
JavascriptContext::GetObjectWrapperConstructorTemplate(System::Type ^type)
494519
{
495-
if (objectWrapperTemplate == NULL)
496-
objectWrapperTemplate = new Persistent<ObjectTemplate>(isolate, JavascriptInterop::NewObjectWrapperTemplate());
497-
return Local<ObjectTemplate>::New(isolate, *objectWrapperTemplate);
520+
System::IntPtr ptrToConstructor;
521+
if (!mTypeToConstructorMapping->TryGetValue(type, ptrToConstructor)) {
522+
Local<FunctionTemplate> constructor = FunctionTemplate::New(GetCurrentIsolate());
523+
JavascriptInterop::InitObjectWrapperTemplate(constructor->InstanceTemplate());
524+
mTypeToConstructorMapping[type] = System::IntPtr(new Persistent<FunctionTemplate>(isolate, constructor));
525+
return constructor;
526+
}
527+
Persistent<FunctionTemplate> *constructor = (Persistent<FunctionTemplate> *)(void *)ptrToConstructor;
528+
return constructor->Get(isolate);
498529
}
499530

500531
////////////////////////////////////////////////////////////////////////////////////////////////////

‎Source/Noesis.Javascript/JavascriptContext.h

+9-4
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,8 @@ public ref class JavascriptContext: public System::IDisposable
141141

142142
void SetParameter(System::String^ iName, System::Object^ iObject, SetParameterOptions options);
143143

144+
void SetConstructor(System::String^ name, System::Type^ associatedType, System::Delegate^ constructor);
145+
144146
System::Object^ GetParameter(System::String^ iName);
145147

146148
virtual System::Object^ Run(System::String^ iSourceCode);
@@ -191,7 +193,7 @@ public ref class JavascriptContext: public System::IDisposable
191193

192194
JavascriptExternal* WrapObject(System::Object^ iObject);
193195

194-
Handle<ObjectTemplate> GetObjectWrapperTemplate();
196+
Handle<FunctionTemplate> GetObjectWrapperConstructorTemplate(System::Type ^type);
195197

196198
void RegisterFunction(System::Object^ f);
197199

@@ -209,15 +211,18 @@ public ref class JavascriptContext: public System::IDisposable
209211
// v8 context required to be active for all v8 operations.
210212
Persistent<Context>* mContext;
211213

212-
// Avoids us recreating these too often.
213-
Persistent<ObjectTemplate> *objectWrapperTemplate;
214-
215214
// Stores every JavascriptExternal we create. This saves time if the same
216215
// objects are recreated frequently, and stops us building up a huge
217216
// collection of JavascriptExternal objects that won't be freed until
218217
// the context is destroyed.
219218
System::Collections::Generic::Dictionary<System::Object ^, WrappedJavascriptExternal> ^mExternals;
220219

220+
// Maps types to their constructor function templates
221+
// The mapping will either be defined by the user calling `SetConstructor` or autogenerated if no
222+
// mapping was provided.
223+
// The `IntPtr` points to a `Persistent<FunctionTemplate>`.
224+
System::Collections::Generic::Dictionary<System::Type ^, System::IntPtr> ^mTypeToConstructorMapping;
225+
221226
// Stores every JavascriptFunction we create. Ensures we dispose of them
222227
// all.
223228
System::Collections::Generic::List<System::WeakReference ^> ^mFunctions;

‎Source/Noesis.Javascript/JavascriptInterop.cpp

+20-16
Original file line numberDiff line numberDiff line change
@@ -49,19 +49,15 @@ using namespace System::Collections::Generic;
4949

5050
////////////////////////////////////////////////////////////////////////////////////////////////////
5151

52-
Handle<ObjectTemplate>
53-
JavascriptInterop::NewObjectWrapperTemplate()
52+
void JavascriptInterop::InitObjectWrapperTemplate(Handle<ObjectTemplate> &object)
5453
{
55-
Handle<ObjectTemplate> result = ObjectTemplate::New(JavascriptContext::GetCurrentIsolate());
56-
result->SetInternalFieldCount(1);
54+
object->SetInternalFieldCount(1);
5755

5856
NamedPropertyHandlerConfiguration namedPropertyConfig((GenericNamedPropertyGetterCallback) Getter, (GenericNamedPropertySetterCallback) Setter, nullptr, nullptr, nullptr, Local<Value>(), PropertyHandlerFlags::kOnlyInterceptStrings);
59-
result->SetHandler(namedPropertyConfig);
57+
object->SetHandler(namedPropertyConfig);
6058

6159
IndexedPropertyHandlerConfiguration indexedPropertyConfig((IndexedPropertyGetterCallback) IndexGetter, (IndexedPropertySetterCallback) IndexSetter);
62-
result->SetHandler(indexedPropertyConfig);
63-
64-
return result;
60+
object->SetHandler(indexedPropertyConfig);
6561
}
6662

6763
////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -271,9 +267,10 @@ JavascriptInterop::WrapObject(System::Object^ iObject)
271267

272268
if (context != nullptr)
273269
{
274-
Handle<ObjectTemplate> templ = context->GetObjectWrapperTemplate();
270+
Handle<FunctionTemplate> templ = context->GetObjectWrapperConstructorTemplate(iObject->GetType());
275271
v8::Isolate *isolate = JavascriptContext::GetCurrentIsolate();
276-
Handle<Object> object = templ->NewInstance(isolate->GetCurrentContext()).ToLocalChecked();
272+
Handle<ObjectTemplate> instanceTemplate = templ->InstanceTemplate();
273+
Handle<Object> object = instanceTemplate->NewInstance(isolate->GetCurrentContext()).ToLocalChecked();
277274
object->SetInternalField(0, External::New(isolate, context->WrapObject(iObject)));
278275

279276
return object;
@@ -475,15 +472,22 @@ JavascriptInterop::ConvertFromSystemList(System::Object^ iObject)
475472

476473
////////////////////////////////////////////////////////////////////////////////////////////////////
477474

475+
v8::Handle<v8::FunctionTemplate>
476+
JavascriptInterop::GetFunctionTemplateFromSystemDelegate(System::Delegate^ iDelegate)
477+
{
478+
JavascriptContext^ context = JavascriptContext::GetCurrent();
479+
v8::Isolate *isolate = JavascriptContext::GetCurrentIsolate();
480+
v8::Handle<v8::External> external = v8::External::New(isolate, context->WrapObject(iDelegate));
481+
482+
return v8::FunctionTemplate::New(isolate, DelegateInvoker, external);
483+
}
484+
485+
////////////////////////////////////////////////////////////////////////////////////////////////////
486+
478487
v8::Handle<v8::Value>
479488
JavascriptInterop::ConvertFromSystemDelegate(System::Delegate^ iDelegate)
480489
{
481-
JavascriptContext^ context = JavascriptContext::GetCurrent();
482-
v8::Isolate *isolate = JavascriptContext::GetCurrentIsolate();
483-
v8::Handle<v8::External> external = v8::External::New(isolate, context->WrapObject(iDelegate));
484-
485-
v8::Handle<v8::FunctionTemplate> method = v8::FunctionTemplate::New(isolate, DelegateInvoker, external);
486-
return method->GetFunction();
490+
return GetFunctionTemplateFromSystemDelegate(iDelegate)->GetFunction();
487491
}
488492

489493
////////////////////////////////////////////////////////////////////////////////////////////////////

‎Source/Noesis.Javascript/JavascriptInterop.h

+3-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ class JavascriptInterop
7171
////////////////////////////////////////////////////////////
7272
public:
7373

74-
static Handle<ObjectTemplate> NewObjectWrapperTemplate();
74+
static void InitObjectWrapperTemplate(Handle<ObjectTemplate> &object);
7575

7676
static System::Object^ ConvertFromV8(Handle<Value> iValue);
7777

@@ -83,6 +83,8 @@ class JavascriptInterop
8383

8484
static Handle<Value> HandleTargetInvocationException(System::Reflection::TargetInvocationException^ exception);
8585

86+
static v8::Handle<v8::FunctionTemplate> GetFunctionTemplateFromSystemDelegate(System::Delegate^ iDelegate);
87+
8688
private:
8789
static System::Object^ ConvertFromV8(Handle<Value> iValue, ConvertedObjects &already_converted);
8890

‎Tests/Noesis.Javascript.Tests/InstanceOfTest.cs

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+

2+
using FluentAssertions;
3+
using Microsoft.VisualStudio.TestTools.UnitTesting;
4+
using System;
5+
6+
namespace Noesis.Javascript.Tests
7+
{
8+
[TestClass]
9+
public class InstanceOfTest
10+
{
11+
private JavascriptContext _context;
12+
13+
private class TestClass
14+
{
15+
public int foo { get; set; }
16+
}
17+
18+
[TestInitialize]
19+
public void SetUp()
20+
{
21+
_context = new JavascriptContext();
22+
}
23+
24+
[TestMethod]
25+
public void RegisteredConstructorInstanceOfTest()
26+
{
27+
_context.SetConstructor("Test", typeof(TestClass), new Func<TestClass>(() => new TestClass()));
28+
_context.Run("(new Test()) instanceof Test").Should().Be(true);
29+
}
30+
31+
[TestMethod]
32+
public void RegisteredConstructorInstanceOfWorksWithCSharpObjectTest()
33+
{
34+
_context.SetConstructor("Test", typeof(TestClass), new Func<TestClass>(() => new TestClass()));
35+
_context.SetParameter("test", new TestClass());
36+
_context.Run("test instanceof Test").Should().Be(true);
37+
}
38+
39+
[TestMethod]
40+
public void ManipulatingPropertyWorks()
41+
{
42+
_context.SetConstructor("Test", typeof(TestClass), new Func<TestClass>(() => new TestClass()));
43+
var testObject = new TestClass { foo = 42 };
44+
_context.SetParameter("test", testObject);
45+
_context.Run("test.foo").Should().Be(42);
46+
_context.Run("test.foo = 1");
47+
testObject.foo.Should().Be(1);
48+
}
49+
50+
[TestMethod]
51+
public void UnregisteredObjectInstanceOfTest()
52+
{
53+
_context.SetParameter("test", new TestClass());
54+
_context.Invoking(x => x.Run("test instanceof Test"))
55+
.ShouldThrow<JavascriptException>().WithMessage("ReferenceError: Test is not defined");
56+
}
57+
}
58+
}

‎Tests/Noesis.Javascript.Tests/Noesis.Javascript.Tests.csproj

+2-1
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@
8585
<Compile Include="ExceptionTests.cs" />
8686
<Compile Include="FatalErrorHandlerTests.cs" />
8787
<Compile Include="FlagsTest.cs" />
88+
<Compile Include="InstanceOfTest.cs" />
8889
<Compile Include="InternationalizationTests.cs" />
8990
<Compile Include="IsolationTests.cs" />
9091
<Compile Include="JavascriptFunctionTests.cs" />
@@ -121,4 +122,4 @@ copy $(ProjectDir)..\..\$(V8Platform)\$(Configuration)\icu*.* $(ProjectDir)$(Out
121122
copy $(ProjectDir)..\..\$(V8Platform)\$(Configuration)\*.bin $(ProjectDir)$(OutDir)
122123
</PostBuildEvent>
123124
</PropertyGroup>
124-
</Project>
125+
</Project>

0 commit comments

Comments
 (0)