Merge pull request #285 from NativeScript/slavchev/require-native-modules

add support for native modules

Author: Mihail Slavchev

src/jni/Module.cpp

@@ -17,6 +17,7 @@
 #include <sstream>
 #include <assert.h>
 #include <libgen.h>
+#include <dlfcn.h>
 
 using namespace v8;
 using namespace std;
@@ -170,13 +171,20 @@ void Module::RequireCallback(const v8::FunctionCallbackInfo<v8::Value>& args)
 	}
 }
 
+void Module::RequireNativeCallback(const v8::FunctionCallbackInfo<v8::Value>& args)
+{
+	auto ext = args.Data().As<External>();
+	auto funcPtr = reinterpret_cast<FunctionCallback>(ext->Value());
+	funcPtr(args);
+}
+
 Local<Object> Module::Load(const string& path, bool& isData)
 {
 	Local<Object> result;
 
 	auto isolate = Isolate::GetCurrent();
 
-	if (Util::EndsWith(path, ".js"))
+	if (Util::EndsWith(path, ".js") || Util::EndsWith(path, ".so"))
 	{
 		isData = false;
 		result = LoadModule(isolate, path);
@@ -213,12 +221,44 @@ Local<Object> Module::LoadModule(Isolate *isolate, const string& modulePath)
 
 	Local<Function> moduleFunc;
 
-	auto script = LoadScript(isolate, modulePath, fullRequiredModulePath);
+	if (Util::EndsWith(modulePath, ".js"))
+	{
+		auto script = LoadScript(isolate, modulePath, fullRequiredModulePath);
 
-	moduleFunc = script->Run().As<Function>();
-	if (tc.HasCaught())
+		moduleFunc = script->Run().As<Function>();
+		if (tc.HasCaught())
+		{
+			throw NativeScriptException(tc, "Error running script " + modulePath);
+		}
+	}
+	else if (Util::EndsWith(modulePath, ".so"))
 	{
-		throw NativeScriptException(tc, "Error running script " + modulePath);
+		auto handle = dlopen (modulePath.c_str(), RTLD_LAZY);
+		if (handle == nullptr)
+		{
+			auto error = dlerror();
+			string errMsg(error);
+			throw NativeScriptException(errMsg);
+		}
+		auto func = dlsym(handle, "NSMain");
+		if (func == nullptr)
+		{
+			string errMsg("Cannot find 'NSMain' in " + modulePath);
+			throw NativeScriptException(errMsg);
+		}
+		auto extFunc = External::New(isolate, func);
+		auto ft = FunctionTemplate::New(isolate, RequireNativeCallback, extFunc);
+		auto maybeFunc = ft->GetFunction(isolate->GetCurrentContext());
+		if (maybeFunc.IsEmpty() || tc.HasCaught())
+		{
+			throw NativeScriptException(tc, "Cannot create native module function callback");
+		}
+		moduleFunc = maybeFunc.ToLocalChecked();
+	}
+	else
+	{
+		string errMsg = "Unsupported file extension: " + modulePath;
+		throw NativeScriptException(errMsg);
 	}
 
 	auto fileName = ConvertToV8String(modulePath);

src/jni/Module.h

@@ -36,6 +36,8 @@ namespace tns
 
 			static void RequireCallback(const v8::FunctionCallbackInfo<v8::Value>& args);
 
+			static void RequireNativeCallback(const v8::FunctionCallbackInfo<v8::Value>& args);
+
 			static v8::Local<v8::Function> GetRequireFunction(v8::Isolate *isolate, const std::string& dirName);
 
 			static v8::ScriptCompiler::CachedData* TryLoadScriptCache(const std::string& path);

src/src/com/tns/Module.java

@@ -203,9 +203,10 @@ private static File getFileWithExtension(String path)
 		String fallbackExtension;
 
 		boolean isJSFile = path.endsWith(".js");
+		boolean isSOFile = path.endsWith(".so");
 		boolean isJSONFile = path.endsWith(".json");
 
-		if (isJSFile || isJSONFile)
+		if (isJSFile || isJSONFile || isSOFile)
 		{
 			fallbackExtension = "";
 		}

test-app/assets/app/mainpage.js

@@ -22,6 +22,7 @@ require("./tests/extendedClassesTests");
 require("./tests/extendClassNameTests");
 require("./tests/testJniReferenceLeak");
 require("./tests/testRequireJSON");
+require("./tests/testNativeModules");
 require("./tests/requireExceptionTests");
 
 var MainActivity = {

test-app/assets/app/modules/libCalc-arm.so

@@ -0,0 +1,25 @@
+describe("Tests native modules)", function () {
+	
+	it("should load native module", function () {
+		var x = 12;
+		var y = 34;
+		
+		var arch;
+		var sysArch = java.lang.System.getProperty("os.arch");
+		var lcArch = sysArch.toLowerCase();
+		if (lcArch.indexOf("arm") > -1) {
+			arch = "arm";
+		} else if (lcArch.indexOf("i686") > -1) {
+			arch = "x86";
+		} else {
+			throw new Error("Unsupported architecture=" + sysArch);
+		}
+		
+		var calc = require("../modules/libCalc-" + arch + ".so");
+		
+		var sum = calc.add(x, y);
+		
+		expect(sum).toBe(46);
+	});
+
+});