├── config └── config.exs ├── test ├── test_helper.exs └── lumen_test.exs ├── lib ├── lumen.ex └── compiler.ex ├── README.md ├── .formatter.exs ├── .gitignore ├── mix.exs └── LICENSE.md /config/config.exs: -------------------------------------------------------------------------------- 1 | use Mix.Config 2 | -------------------------------------------------------------------------------- /test/test_helper.exs: -------------------------------------------------------------------------------- 1 | ExUnit.start() 2 | -------------------------------------------------------------------------------- /lib/lumen.ex: -------------------------------------------------------------------------------- 1 | defmodule Lumen do 2 | @moduledoc false 3 | end 4 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Lumen 2 | 3 | Mix support for the Lumen compiler/runtime. 4 | 5 | ## License 6 | 7 | Apache 2.0 8 | -------------------------------------------------------------------------------- /.formatter.exs: -------------------------------------------------------------------------------- 1 | # Used by "mix format" 2 | [ 3 | inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"] 4 | ] 5 | -------------------------------------------------------------------------------- /test/lumen_test.exs: -------------------------------------------------------------------------------- 1 | defmodule Lumen.Test do 2 | use ExUnit.Case 3 | doctest Lumen 4 | 5 | test "the truth" do 6 | assert true 7 | end 8 | end 9 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # The directory Mix will write compiled artifacts to. 2 | /_build/ 3 | 4 | # If you run "mix test --cover", coverage assets end up here. 5 | /cover/ 6 | 7 | # The directory Mix downloads your dependencies sources to. 8 | /deps/ 9 | 10 | # Where 3rd-party dependencies like ExDoc output generated docs. 11 | /doc/ 12 | 13 | # Ignore .fetch files in case you like to edit your project deps locally. 14 | /.fetch 15 | 16 | # If the VM crashes, it generates a dump, let's ignore it too. 17 | erl_crash.dump 18 | 19 | # Also ignore archive artifacts (built via "mix archive.build"). 20 | *.ez 21 | 22 | # Ignore package tarball (built via "mix hex.build"). 23 | lumen-*.tar 24 | 25 | mix.lock 26 | -------------------------------------------------------------------------------- /mix.exs: -------------------------------------------------------------------------------- 1 | defmodule Lumen.MixProject do 2 | use Mix.Project 3 | 4 | def project do 5 | [ 6 | app: :lumen, 7 | description: "Mix support for the Lumen compiler/runtime", 8 | version: "0.1.0", 9 | elixir: "~> 1.7", 10 | start_permanent: Mix.env() == :prod, 11 | deps: deps(), 12 | package: package(), 13 | ] 14 | end 15 | 16 | # Run "mix help compile.app" to learn about applications. 17 | def application do 18 | [ 19 | extra_applications: [] 20 | ] 21 | end 22 | 23 | # Run "mix help deps" to learn about dependencies. 24 | defp deps do 25 | [ 26 | {:ex_doc, ">= 0.0.0", only: [:dev, :docs]}, 27 | ] 28 | end 29 | 30 | defp package do 31 | [ 32 | files: ["lib", "mix.exs", "README.md", "LICENSE.md"], 33 | maintainers: ["Paul Schoenfelder"], 34 | licenses: ["Apache 2.0"], 35 | links: %{ 36 | GitHub: "https://github.com/bitwalker/lumen-elixir", 37 | } 38 | ] 39 | end 40 | end 41 | -------------------------------------------------------------------------------- /lib/compiler.ex: -------------------------------------------------------------------------------- 1 | defmodule Mix.Tasks.Compile.Lumen do 2 | use Mix.Task.Compiler 3 | 4 | @recursive true 5 | @manifest "compile.lumen" 6 | @switches [force: :boolean] 7 | 8 | @manifest_vsn 1 9 | 10 | def manifests() do 11 | [manifest_path()] 12 | end 13 | 14 | def run(args) do 15 | {opts, _, _} = OptionParser.parse(args, switches: @switches) 16 | manifest = manifest_path() 17 | build_dir = Mix.Project.build_path() 18 | beams = 19 | Path.wildcard(Path.join(build_dir, "lib/*/ebin/*.beam")) 20 | compile(manifest, beams, opts) 21 | end 22 | 23 | def clean() do 24 | manifest = manifest_path() 25 | Enum.each(read_manifest(manifest), fn {file, _} -> File.rm(file) end) 26 | File.rm(manifest) 27 | end 28 | 29 | defp compile(manifest, beams, opts) do 30 | stale = for {:stale, src, dest} <- extract_targets(beams, opts), do: {src, dest} 31 | 32 | # Get the previous entries from the manifest 33 | timestamp = :calendar.universal_time() 34 | entries = read_manifest(manifest) 35 | 36 | # Files to remove are the ones in the manifest 37 | # but they no longer have a source 38 | removed = 39 | MapSet.new(beams) 40 | |> MapSet.difference(MapSet.new(Enum.map(entries, fn {dest, _} -> dest end))) 41 | 42 | # Remove manifest entries with no source 43 | Enum.each(removed, &File.rm/1) 44 | verbose = opts[:verbose] 45 | 46 | # Clear stale and removed files from manifest 47 | entries = 48 | Enum.reject(entries, fn {dest, _warnings} -> 49 | MapSet.member?(removed, dest) || Enum.any?(stale, fn {_, stale_dest} -> dest == stale_dest end) 50 | end) 51 | 52 | if opts[:all_warnings], do: show_warnings(entries) 53 | 54 | if stale == [] && MapSet.size(removed) == 0 do 55 | {:noop, manifest_warnings(entries)} 56 | else 57 | Mix.Utils.compiling_n(length(stale), "beam") 58 | 59 | # Compile stale files and print the results 60 | {status, new_entries, errors} = 61 | do_compile(stale, timestamp, verbose) 62 | 63 | write_manifest(manifest, entries ++ new_entries, timestamp) 64 | 65 | case status do 66 | :ok -> 67 | {:ok, []} 68 | 69 | :error -> 70 | {:error, errors} 71 | end 72 | end 73 | end 74 | 75 | defp do_compile(stale, timestamp, verbose) do 76 | do_compile(stale, timestamp, verbose, {:ok, [], []}) 77 | end 78 | 79 | defp do_compile([{input, output} | rest], timestamp, verbose, {status, entries, errors}) do 80 | with {:ok, forms} <- extract_abstract_code(input), 81 | {:ok, erl} <- to_erlang_source(forms) do 82 | File.write!(output, erl) 83 | verbose && Mix.shell().info("Compiled #{input}") 84 | do_compile(rest, timestamp, verbose, {status, [{output, []} | entries], errors}) 85 | else 86 | {:error, reason} -> 87 | error = 88 | %Mix.Task.Compiler.Diagnostic{ 89 | file: input, 90 | severity: :error, 91 | message: "#{reason}", 92 | position: nil, 93 | compiler_name: "lumen", 94 | details: nil, 95 | } 96 | do_compile(rest, timestamp, verbose, {:error, entries, [error | errors]}) 97 | end 98 | end 99 | defp do_compile([], _timestamp, _verbose, result), do: result 100 | 101 | defp extract_abstract_code(path) do 102 | case :beam_lib.chunks(String.to_charlist(path), [:abstract_code]) do 103 | {:ok, {_mod, [{:raw_abstract_v1, forms}]}} -> 104 | {:ok, forms} 105 | {:error, mod, reason} -> 106 | {:error, mod.format_error(reason)} 107 | end 108 | end 109 | 110 | defp to_erlang_source(forms) when is_list(forms) do 111 | :erl_prettypr.format(:erl_syntax.form_list(forms)) 112 | end 113 | 114 | defp extract_targets(beams, opts) do 115 | force = opts[:force] || false 116 | 117 | for beam <- beams do 118 | app = app_name_from_path(beam) 119 | module = module_name_from_path(beam) 120 | dest_dir = Path.join([Mix.Project.build_path(), "lumen", app, "src"]) 121 | target = Path.join(dest_dir, module <> ".erl") 122 | 123 | # Ensure target dir exists 124 | :ok = File.mkdir_p!(dest_dir) 125 | 126 | if force || Mix.Utils.stale?([beam], [target]) do 127 | {:stale, beam, target} 128 | else 129 | {:ok, beam, target} 130 | end 131 | end 132 | end 133 | 134 | 135 | # expecting ..//ebin/.beam 136 | defp module_name_from_path(path) do 137 | path |> Path.basename() |> Path.rootname() 138 | end 139 | 140 | # expecting ..//ebin/.beam 141 | defp app_name_from_path(path) do 142 | path |> Path.dirname() |> Path.dirname() |> Path.basename() 143 | end 144 | 145 | # The manifest file contains a list of {dest, warnings} tuples 146 | defp read_manifest(file) do 147 | try do 148 | file |> File.read!() |> :erlang.binary_to_term() 149 | rescue 150 | _ -> [] 151 | else 152 | {@manifest_vsn, data} when is_list(data) -> data 153 | _ -> [] 154 | end 155 | end 156 | 157 | defp write_manifest(file, entries, timestamp) do 158 | File.mkdir_p!(Path.dirname(file)) 159 | File.write!(file, :erlang.term_to_binary({@manifest_vsn, entries})) 160 | File.touch!(file, timestamp) 161 | end 162 | 163 | defp manifest_warnings(entries) do 164 | Enum.flat_map(entries, fn {_, warnings} -> 165 | to_diagnostics(warnings, :warning) 166 | end) 167 | end 168 | 169 | defp to_diagnostics(warnings_or_errors, severity) do 170 | for {file, issues} <- warnings_or_errors, 171 | {line, module, data} <- issues do 172 | %Mix.Task.Compiler.Diagnostic{ 173 | file: Path.absname(file), 174 | position: line, 175 | message: to_string(module.format_error(data)), 176 | severity: severity, 177 | compiler_name: to_string(module), 178 | details: data 179 | } 180 | end 181 | end 182 | 183 | defp show_warnings(entries) do 184 | for {_, warnings} <- entries, 185 | {file, issues} <- warnings, 186 | {line, module, message} <- issues do 187 | IO.puts("#{file}:#{line}: Warning: #{module.format_error(message)}") 188 | end 189 | end 190 | 191 | defp manifest_path, do: Path.join(Mix.Project.manifest_path, @manifest) 192 | end 193 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2018 Paul Schoenfelder 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------