Merge pull request #776 from liveforeverx/compile-erl-new

WiP for compiling of erlang/leex/yecc source files

Author: José Valim

lib/mix/lib/mix/project.ex

@@ -134,6 +134,8 @@ defmodule Mix.Project do
       default_task: "run",
       deps_path: "deps",
       erlc_paths: ["src"],
+      erlc_include_path: "include",
+      erlc_options: [:debug_info],
       lockfile: "mix.lock",
       prepare_task: "app.start",
       elixirc_paths: ["lib"],

lib/mix/lib/mix/tasks/clean.ex

@@ -14,6 +14,11 @@ defmodule Mix.Tasks.Clean do
   def run(args) do
     { opts, _ } = OptionParser.parse(args)
     File.rm_rf Mix.project[:compile_path]  || "ebin"
+
+    generated_source = lc source_path inlist Mix.project[:erlc_paths] do
+                         Mix.Utils.check_files(source_path, [:yrl, :xrl], source_path, :erl)
+                       end |> List.flatten
+    lc {_, output} inlist generated_source, do: File.rm_rf output
     if opts[:all], do: Mix.Task.run("deps.clean")
   end
-end
+end

lib/mix/lib/mix/tasks/compile.erlang.ex

@@ -1,4 +1,11 @@
 defmodule Mix.Tasks.Compile.Erlang do
+
+  alias :epp, as: Epp
+  alias :digraph, as: Graph
+  alias :digraph_utils, as: GraphUtils
+  alias :code, as: Code
+  alias :compile, as: Compiler
+  alias Mix.Utils
   use Mix.Task
 
   @hidden true
@@ -7,57 +14,175 @@ defmodule Mix.Tasks.Compile.Erlang do
   @moduledoc """
   A task to compile Erlang source files.
 
+  When this task runs, it will first check the mod times of
+  all of the files. Every file will checked, if file or
+  file dependencies, like include files, was changed.
+  If file of his dependencies haven't been changed since the
+  last compilation, it will not compile. If file or one of his
+  dependency has changed, it will compile.
+
+  For this reason, this task touches your `:compile_path`
+  directory and sets the modification time to the current
+  time and date at the end of each compilation. You can
+  force compilation regardless of mod times by passing
+  the `--force` option.
+
   ## Command line options
 
+  * `--force` - forces compilation regardless of module times;
+
+  ## Configuration
+
   * `ERL_COMPILER_OPTIONS` - can be used to give default compile options.
      It's value must be a valid Erlang term. If the value is a list, it will
      be used as is. If it is not a list, it will be put into a list.
 
-  ## Configuration
+  * `:erlc_paths` - directories to find source files.
+    Defaults to `["src"]`, can be configured as:
+
+        [erlc_paths: ["src", "other"]]
+
+  * `:erlc_include_path` - directory for adding include files.
+    Defaults to `"include"`, can be configured as:
+
+        [`erlc_include_path`: "other"]
+
+  * `:erlc_options` - compilation options that applies
+     to Erlang's compiler.
+     This options are setted:
 
-  * `:erlc_options` - compilation options that applies to Erlang compiler
-     By default, the following options are on: `[:verbose, :report_errors, :report_warnings]`
+     :outdir to a configured :compile_path
+     :i to a configured :include_path
+     :report
+
+     and :debug_info in project configuration
+
+     There are many other available options here:
+     http://www.erlang.org/doc/man/compile.html#file-2
 
   """
-  def run(_) do
+
+  defrecord Erl, file: nil, module: nil, behaviours: [], compile: [],
+    includes: [], mtime: nil, invalid: false
+
+  def run(args) do
+    { opts, _ } = OptionParser.parse(args, switches: [force: :boolean])
+
     project = Mix.project
+    source_paths = project[:erlc_paths]
+    files        = Mix.Utils.extract_files(source_paths, [:erl])
+    compile_path = to_erl_file project[:compile_path]
+    include_path = to_erl_file project[:erlc_include_path]
+
+    erlc_options = [{:outdir, compile_path}, {:i, include_path}, :report
+                    | project[:erlc_options] || []]
+    erlc_options = Enum.map erlc_options, fn(opt) ->
+      case opt do
+        { :i, dir } -> { :i, to_erl_file(dir) }
+        _           -> opt
+      end
+    end
 
-    files        = Mix.Utils.extract_files(project[:erlc_paths], [:erl])
-    compile_path = project[:compile_path]
+    files = files |> scan_sources(include_path, source_paths) |> sort_dependency
+    unless opts[:force], do: files = Enum.filter(files, check_file(compile_path, &1))
 
     if files == [] do
       :noop
     else
-      Mix.Utils.preserving_mtime(compile_path, fn ->
+      Utils.preserving_mtime(compile_path, fn ->
         File.mkdir_p! compile_path
-        compile_files project, files, compile_path
+        compile_files files, compile_path, erlc_options
       end)
 
       :ok
     end
   end
 
-  defp compile_files(project, files, compile_path) do
-    erlc_options = project[:erlc_options] || []
+  defp scan_sources(files, include_path, source_paths) do
+    include_pathes = [include_path | source_paths]
+    List.foldl(files, [], fn(file, acc) -> scan_source(acc, file, include_pathes) end) |> Enum.reverse
+  end
 
-    erlc_options = Enum.map erlc_options, fn(opt) ->
-      case opt do
-        { :i, dir } -> { :i, Path.expand(dir) |> binary_to_list }
-        _           -> opt
+  defp scan_source(acc, file, include_pathes) do
+    erl_file = Erl[mtime: Utils.last_modified(file),
+                   file: file,
+                   module: Path.basename(file, ".erl")]
+    case Epp.parse_file(to_erl_file(file), include_pathes, []) do
+      {:ok, forms} ->
+        [List.foldl(tl(forms), erl_file, fn(f, acc) -> do_form(file, f, acc) end) | acc]
+      {:error, _error} ->
+        acc
+    end
+  end
+
+  defp do_form(file, form, erl) do
+    case form do
+      {:attribute, _, :file, {include_file, _}} when file != include_file ->
+        erl.update(includes: [include_file | erl.includes])
+      {:attribute, _, :behaviour, behaviour} ->
+        erl.update(behaviour: [behaviour | erl.behaviours])
+      {:attribute, _, :compile, value} ->
+        erl.update(compile: [value | erl.compile])
+      _ ->
+        erl
+    end
+  end
+
+  defp sort_dependency(erls) do
+    graph = Graph.new
+    lc erl inlist erls do
+      Graph.add_vertex(graph, erl.module, erl)
+    end
+    lc erl inlist erls do
+      lc b inlist erl.behaviours, do: Graph.add_edge(graph, b, erl.module)
+      lc a inlist erl.compile do
+        case a do
+          {:parse_transform, transform} -> Graph.add_edge(graph, transform, erl.module);
+          _ -> :ok
+        end
       end
     end
+    result =
+      case GraphUtils.topsort(graph) do
+        :false -> erls;
+        mods   ->
+          lc m inlist mods, do: elem(Graph.vertex(graph, m), 1)
+      end
+    Graph.delete(graph)
+    result
+  end
+
+  defp check_file(compile_path, erl) do
+    beam = Path.join(compile_path, "#{erl.module}#{Code.objfile_extension}")
+    case File.regular?(beam) do
+      :false -> :true
+      :true  ->
+        beammtime = Utils.last_modified(beam)
+        (beammtime <= erl.mtime) or Utils.check_mtime(beammtime, erl.includes)
+    end
+  end
 
-    compile_path = compile_path |> Path.expand |> binary_to_list
-    erlc_options = [{:outdir, compile_path}] ++ erlc_options
+  defp compile_files(files, compile_path, erlc_options) do
     File.mkdir_p!(compile_path)
+    Enum.each files, compile_file(&1, erlc_options)
+  end
 
-    Enum.each files, fn(file) ->
-      file = Path.rootname(file, ".erl") |> Path.expand |> binary_to_list
+  defp compile_file(erl, erlc_options) do
+    file = to_erl_file Path.rootname(erl.file, ".erl")
+    interpret_result file, :compile.file(file, erlc_options), ".erl"
+  end
 
-      case :compile.file(file, erlc_options) do
-        { :ok, _ } -> Mix.shell.info  "Compiled #{file}.erl"
-        :error     -> Mix.shell.error "== Compilation error on file #{file}.erl =="
-      end
+  def interpret_result(file, result, ext // "") do
+    case result do
+      { :ok, _} ->
+        Mix.shell.info  "Compiled #{file}#{ext}"
+      :error     ->
+        :ok
     end
   end
+
+  def to_erl_file file do
+    to_char_list(file)
+  end
+
 end

lib/mix/lib/mix/tasks/compile.ex

@@ -80,9 +80,9 @@ defmodule Mix.Tasks.Compile do
 
   defp get_compilers do
     Mix.project[:compilers] || if Mix.Project.get do
-      [:erlang, :elixir, :app]
+      [:yecc, :leex, :erlang, :elixir, :app]
     else
-      [:erlang, :elixir]
+      [:yecc, :leex, :erlang, :elixir]
     end
   end
 

lib/mix/lib/mix/tasks/compile.leex.ex

@@ -0,0 +1,79 @@
+defmodule Mix.Tasks.Compile.Leex do
+
+  alias :compile, as: Compiler
+  alias :leex, as: Leex
+  alias Mix.Utils
+  alias Mix.Tasks.Compile.Erlang
+  use Mix.Task
+
+  @hidden true
+  @shortdoc "Compile Leex source files"
+
+  @moduledoc """
+  A task to compile Leex source files.
+
+  When this task runs, it will check the mod time of every file, and
+  if it has changed, then file will be compiled. Files will be
+  compiled in the same source directory with .erl extension.
+  You can force compilation regardless of mod times by passing
+  the `--force` option.
+
+  ## Command line options
+
+  * `--force` - forces compilation regardless of module times;
+
+  ## Configuration
+
+  * `:erlc_paths` - directories to find source files.
+    Defaults to `["src"]`, can be configured as:
+
+        [erlc_paths: ["src", "other"]]
+
+  * `:leex_options` - compilation options that applies
+     to Leex's compiler.
+     This options are setted:
+
+     :scannerfile
+     {:report, true}
+
+     There are many other available options here:
+     http://www.erlang.org/doc/man/leex.html#file-2
+
+  """
+
+  def run(args) do
+    { opts, _ } = OptionParser.parse(args, switches: [force: :boolean])
+
+    project = Mix.project
+    source_paths = project[:erlc_paths]
+
+    checkfun = if opts[:force] do
+        fn(_, _) -> true end
+      else
+        fn(f1, f2) ->
+          mtime = Utils.last_modified(f2)
+          Utils.check_mtime(mtime, [f1])
+        end
+      end
+
+    files = lc source_path inlist source_paths do
+              Utils.check_files(source_path, :xrl, source_path, :erl, checkfun)
+            end |> List.flatten
+    if files == [] do
+      :noop
+    else
+      compile_files(files, project[:leex_options] || [])
+      :ok
+    end
+  end
+
+  def compile_files(files, options) do
+    lc {input, output} inlist files do
+      Erlang.interpret_result(input, Leex.file(Erlang.to_erl_file(input),
+                                               [{:scannerfile, Erlang.to_erl_file(output)},
+                                                {:report, true} | options]))
+    end
+  end
+
+end
+