Module rebar_base_compiler

Data Types
Function Index
Function Details

Data Types

compile_fn()

compile_fn() = fun((file:filename(), [{term(), term()}] | rebar_dict()) -> compile_fn_ret())

compile_fn3()

compile_fn3() = fun((file:filename(), file:filename(), [{term(), term()}] | rebar_dict()) -> compile_fn_ret())

compile_fn_ret()

compile_fn_ret() = ok | {ok, [string()]} | skipped | term()

error_tuple()

error_tuple() = {error, [string()], [string()]}

Function Index

error_tuple/4	format error and warning strings for a given source file according to user preferences.
error_tuple/5	format error and warning strings for a given source file according to user preferences.
format_error_source/2	from a given path, and based on the user-provided options, format the file path according to the preferences.
ok_tuple/2	Format good compiler results with warnings to work with module internals.
ok_tuple/4	Format good compiler results with warnings to work with module internals.
run/4	Runs a compile job, applying `compile_fn()` to all files, starting with `First` files, and then `RestFiles`.
run/7	Runs a compile job, applying `compile_fn3()` to all files, starting with `First` files, and then the other content of `SourceDir`.
run/8	Runs a compile job, applying `compile_fn3()` to all files, starting with `First` files, and then the other content of `SourceDir`.

Function Details

error_tuple/4

error_tuple(Source::file:filename(), Es::[Err], Ws::[Warn], Opts::rebar_dict() | [{term(), term()}]) -> error_tuple()

Err = string()
Warn = string()

format error and warning strings for a given source file according to user preferences.

error_tuple/5

error_tuple(Source::file:filename(), Es::[Err], Ws::[Warn], Config::rebar_dict(), Opts::[{term(), term()}]) -> error_tuple()

Err = string()
Warn = string()

format error and warning strings for a given source file according to user preferences.

format_error_source/2

format_error_source(Path::file:filename(), Opts::rebar_dict() | [{term(), term()}]) -> file:filename()

from a given path, and based on the user-provided options, format the file path according to the preferences.

ok_tuple/2

ok_tuple(Source::file:filename(), Ws::[string()]) -> {ok, [string()]}

Format good compiler results with warnings to work with module internals. Assumes that warnings are not treated as errors.

ok_tuple/4

ok_tuple(Source::file:filename(), Ws::[string()], Config::rebar_dict(), Opts::[{term(), term()}]) -> {ok, [string()]}

Format good compiler results with warnings to work with module internals. Assumes that warnings are not treated as errors.

run/4

run(Config::rebar_dict() | [{term(), term()}], FirstFiles::[First], RestFiles::[Next], CompileFn::compile_fn()) -> compile_fn_ret()

First = file:filename()
Next = file:filename()

Runs a compile job, applying compile_fn() to all files, starting with First files, and then RestFiles.

run/7

run(Config::rebar_dict() | [{term(), term()}], FirstFiles::[First], SourceDir, SourceExt, TargetDir, TargetExt, Compile3Fn::compile_fn3()) -> compile_fn_ret()

First = file:filename()
SourceDir = file:filename()
TargetDir = file:filename()
SourceExt = string()
TargetExt = string()

Runs a compile job, applying compile_fn3() to all files, starting with First files, and then the other content of SourceDir. Files looked for are those ending in SourceExt. Results of the compilation are put in TargetDir with the base file names postfixed with SourceExt.

run/8

run(Config::rebar_dict() | [{term(), term()}], FirstFiles::[First], SourceDir, SourceExt, TargetDir, TargetExt, Compile3Fn::compile_fn3(), Opts::[term()]) -> compile_fn_ret()

First = file:filename()
SourceDir = file:filename()
TargetDir = file:filename()
SourceExt = string()
TargetExt = string()

Generated by EDoc