summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorFred Hebert <mononcqc@ferd.ca>2019-07-04 19:35:42 -0400
committerGitHub <noreply@github.com>2019-07-04 19:35:42 -0400
commita5d777a2d75953fbadada2814f858aadd4cf0b8d (patch)
treeedf64ba3a94f0363ccf5d9cb55debd5d55e7a3f1 /src
parent892f5704bc6bfd822366b7bb9810ff8654a145f8 (diff)
parent67e799af051cc7868b263f8f29a820c57e7c3c99 (diff)
Merge pull request #2118 from ferd/fix-internal-compiler-type
Fix custom compiler mods typespecs, add edoc
Diffstat (limited to 'src')
-rw-r--r--src/rebar_state.erl22
1 files changed, 17 insertions, 5 deletions
diff --git a/src/rebar_state.erl b/src/rebar_state.erl
index 31d3a08..e7d772f 100644
--- a/src/rebar_state.erl
+++ b/src/rebar_state.erl
@@ -71,7 +71,7 @@
all_plugin_deps = [] :: [rebar_app_info:t()],
all_deps = [] :: [rebar_app_info:t()],
- compilers = [] :: [{compiler_type(), extension(), extension(), compile_fun()}],
+ compilers = [] :: [module()],
project_builders = [] :: [{rebar_app_info:project_type(), module()}],
resources = [],
providers = [],
@@ -81,10 +81,6 @@
-type t() :: #state_t{}.
--type compiler_type() :: atom().
--type extension() :: string().
--type compile_fun() :: fun(([file:filename()], rebar_app_info:t(), list()) -> ok).
-
-spec new() -> t().
new() ->
BaseState = base_state(dict:new()),
@@ -407,15 +403,31 @@ warn_old_resource(ResourceModule) ->
?WARN("Using custom resource ~s that implements a deprecated api. "
"It should be upgraded to rebar_resource_v2.", [ResourceModule]).
+%% @doc get a list of all registered compiler modules, which should implement
+%% the `rebar_compiler' behaviour
+-spec compilers(t()) -> [module()].
compilers(#state_t{compilers=Compilers}) ->
Compilers.
+%% @doc register compiler modules prior to the existing ones. Each compiler
+%% module should implement the `rebar_compiler' behaviour. Use this when
+%% your custom compiler generates .erl files (or files of another type) and
+%% that should run before other compiler modules.
+-spec prepend_compilers(t(), [module()]) -> t().
prepend_compilers(State=#state_t{compilers=Compilers}, NewCompilers) ->
State#state_t{compilers=NewCompilers++Compilers}.
+%% @doc register compiler modules. Each compiler
+%% module should implement the `rebar_compiler' behaviour. Use this when
+%% your custom compiler generates binary artifacts and does not have
+%% a particular need to run before any other compiler.
+-spec append_compilers(t(), [module()]) -> t().
append_compilers(State=#state_t{compilers=Compilers}, NewCompilers) ->
State#state_t{compilers=Compilers++NewCompilers}.
+%% @private reset all compiler modules by replacing them by a list of
+%% modules that implement the `rebar_compiler' behaviour.
+-spec compilers(t(), [module()]) -> t().
compilers(State, Compilers) ->
State#state_t{compilers=Compilers}.