Document global option on FFI module

bryanjos · bryanjos · commit 4666746253c8 · 2017-08-03T21:39:44.000-05:00
Add name option. The value is used as the module name when
creating the function call in JavaScript
diff --git a/lib/elixir_script/ffi.ex b/lib/elixir_script/ffi.ex
@@ -29,6 +29,13 @@ defmodule ElixirScript.FFI do
     parse: JSON.parse
   }
   ```
+
+  `ElixirScript.FFI` takes the following options
+  * `global`: If the module is defined in the global state or not. If this is set to `true`,
+  nothing is imported and instead ElixirScript will use the name of the module to call a module and
+  function in the global scope.
+  * `name`: Only applicable with `global` is set to `true`. This will use the name defined here
+  instead of the module name for calling modules and functions in the global scope
   """
 
   defmacro __using__(opts) do
@@ -37,7 +44,7 @@ defmodule ElixirScript.FFI do
       Module.register_attribute __MODULE__, :__foreign_info__, persist: true
       @__foreign_info__ %{
         path: Macro.underscore(__MODULE__),
-        name: Enum.join(Module.split(__MODULE__), "_"),
+        name: unquote(Keyword.get(opts, :name, nil)),
         global: unquote(Keyword.get(opts, :global, false))
       }
     end
@@ -54,7 +61,7 @@ defmodule ElixirScript.FFI do
   """
   defmacro defexternal({name, _, args}) do
     args = Enum.map(args, fn
-      {:\\, meta0, [{name, meta, atom}, value]}->
+      {:\\, meta0, [{name, meta, atom}, value]} ->
         name = String.to_atom("_" <> Atom.to_string(name))
         {:\\, meta0, [{name, meta, atom}, value]}
 
diff --git a/lib/elixir_script/passes/find_used_modules.ex b/lib/elixir_script/passes/find_used_modules.ex
@@ -26,8 +26,14 @@ defmodule ElixirScript.FindUsedModules do
   end
 
   defp walk_module(module, %{attributes: [__foreign_info__: %{path: path, name: name, global: global}]} = info, pid) do
-    path = if global, do: nil, else: path
-    name = if global, do: module, else: name
+    {name, path} = if global do
+      name = if name, do: name, else: module
+      path = nil
+      {name, path}
+    else
+      name = Enum.join(Module.split(module), "_")
+      {name, path}
+    end
 
     ModuleState.put_javascript_module(pid, module, name, path)
     ModuleState.put_module(pid, module, info)
diff --git a/lib/elixir_script/passes/translate/forms/remote.ex b/lib/elixir_script/passes/translate/forms/remote.ex
@@ -99,11 +99,16 @@ defmodule ElixirScript.Translate.Forms.Remote do
 
   defp process_js_module_name(module, state) do
     case ModuleState.get_js_module_name(state.pid, module) do
-      name when is_atom(name) ->
-        members = Module.split(module)
-        Identifier.make_namespace_members(members)
-      name ->
+      name when is_binary(name) ->
         J.identifier(name)
+      name when is_atom(name) ->
+        case to_string(name) do
+          "Elixir." <> _ ->
+            members = Module.split(module)
+            Identifier.make_namespace_members(members)
+          x ->
+            J.identifier(x)
+        end
     end
   end
 
diff --git a/lib/elixir_script/passes/translate/module.ex b/lib/elixir_script/passes/translate/module.ex
@@ -14,8 +14,14 @@ defmodule ElixirScript.Translate.Module do
   end
 
   def compile(module, %{attributes: [__foreign_info__: %{path: path, name: name, global: global}]}, pid) do
-    path = if global, do: nil, else: path
-    name = if global, do: module, else: name
+    {name, path} = if global do
+      name = if name, do: name, else: module
+      path = nil
+      {name, path}
+    else
+      name = Enum.join(Module.split(module), "_")
+      {name, path}
+    end
 
     ModuleState.put_javascript_module(pid, module, name, path)
 
