Funktion außerhalb des Angebotsblocks in Elixir definieren

Question

Ich habe ein einfaches Makro, das eine Funktion in das aufrufende Modul einfügt.

defmodule MyModule do 
    defmacro __using__(_opts) do 
    quote do 
     def run do 
     IO.puts "Hello world" 
     end 
    end 
    end 
end 

Dies funktioniert soll als aber aufgrund der Tatsache, dass die Lauffunktion innerhalb des Kursblock verschachtelt ist, ich bin nicht in der Lage Dokumentation hinzufügen ExDoc verwenden. Ich möchte auch die Run-Funktion außerhalb definieren, da ich fühle, dass der Code besser aussieht. So etwas wie dieses:

defmodule MyModule do 
    def run do 
    IO.puts "Hello world" 
    end 

    defmacro __using__(_opts) do 
    quote do 
     # Some code to inject the run function 
    end 
    end 
end 

Wie gehe ich dabei vor? Wie füge ich außerdem Dokumentation hinzu, die ExDoc für eine geschachtelte Funktion verwendet?

Answer 1

Sie können defdelegate innerhalb der quote verwenden und dann run im Hauptmodul definieren.

defmodule MyModule do 
    @doc """ 
    Prints "Hello world" 
    """ 
    def run do 
    IO.puts "Hello world" 
    end 

    defmacro __using__(_opts) do 
    quote do 
     defdelegate run, to: MyModule 
    end 
    end 
end 

defmodule A do 
    use MyModule 
end 

A.run/0 wird ein Auto erzeugt doc standardmäßig erhalten, die den Benutzer auf MyModule.run/0 verweisen. Dies kann angepasst werden, indem bei Bedarf ein @doc "" vor defdelegate hinzugefügt wird.

iex(1)> MyModule.run 
Hello world 
:ok 
iex(2)> A.run 
Hello world 
:ok 
iex(3)> h(MyModule.run) 

            def run() 

Prints "Hello world" 

iex(4)> h(A.run) 

            def run() 

See MyModule.run/0.