1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
%% -*- erlang-indent-level: 4;indent-tabs-mode: nil -*-
%% ex: ts=4 sw=4 et
%% -------------------------------------------------------------------
%%
%% rebar: Erlang Build Tools
%%
%% Copyright (c) 2009 Dave Smith (dizzyd@dizzyd.com)
%%
%% Permission is hereby granted, free of charge, to any person obtaining a copy
%% of this software and associated documentation files (the "Software"), to deal
%% in the Software without restriction, including without limitation the rights
%% to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
%% copies of the Software, and to permit persons to whom the Software is
%% furnished to do so, subject to the following conditions:
%%
%% The above copyright notice and this permission notice shall be included in
%% all copies or substantial portions of the Software.
%%
%% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
%% IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
%% FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
%% AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
%% LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
%% OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
%% THE SOFTWARE.
%% -------------------------------------------------------------------
-module(rebar_protobuffs_compiler).
-export([compile/2,
clean/2]).
%% for internal use only
-export([info/2]).
-include("rebar.hrl").
%% ===================================================================
%% Public API
%% ===================================================================
compile(Config, _AppFile) ->
case rebar_utils:find_files("src", ".*\\.proto$") of
[] ->
ok;
FoundFiles ->
%% Check for protobuffs library -- if it's not present, fail
%% since we have.proto files that need building
case protobuffs_is_present() of
true ->
%% Build a list of output files - { Proto, Beam, Hrl }
Targets = [{Proto, beam_file(Proto), hrl_file(Proto)} ||
Proto <- FoundFiles],
%% Compile each proto file
compile_each(Config, Targets);
false ->
?ERROR("Protobuffs library not present in code path!\n",
[]),
?FAIL
end
end.
clean(_Config, _AppFile) ->
%% Get a list of generated .beam and .hrl files and then delete them
Protos = rebar_utils:find_files("src", ".*\\.proto$"),
BeamFiles = [fq_beam_file(F) || F <- Protos],
HrlFiles = [fq_hrl_file(F) || F <- Protos],
Targets = BeamFiles ++ HrlFiles,
case Targets of
[] ->
ok;
_ ->
delete_each(Targets)
end.
%% ===================================================================
%% Internal functions
%% ===================================================================
info(help, compile) ->
info_help("Build Protobuffs (*.proto) sources");
info(help, clean) ->
info_help("Delete Protobuffs (*.proto) build results").
info_help(Description) ->
?CONSOLE(
"~s.~n"
"~n"
"Valid rebar.config options:~n"
" erl_opts is passed as compile_flags to "
"protobuffs_compile:scan_file/2~n",
[Description]).
protobuffs_is_present() ->
code:which(protobuffs_compile) =/= non_existing.
beam_file(Proto) ->
filename:basename(Proto, ".proto") ++ "_pb.beam".
hrl_file(Proto) ->
filename:basename(Proto, ".proto") ++ "_pb.hrl".
fq_beam_file(Proto) ->
filename:join(["ebin", filename:basename(Proto, ".proto") ++ "_pb.beam"]).
fq_hrl_file(Proto) ->
filename:join(["include", filename:basename(Proto, ".proto") ++ "_pb.hrl"]).
needs_compile(Proto, Beam) ->
ActualBeam = filename:join(["ebin", filename:basename(Beam)]),
filelib:last_modified(ActualBeam) < filelib:last_modified(Proto).
compile_each(_, []) ->
ok;
compile_each(Config, [{Proto, Beam, Hrl} | Rest]) ->
case needs_compile(Proto, Beam) of
true ->
?CONSOLE("Compiling ~s\n", [Proto]),
ErlOpts = rebar_utils:erl_opts(Config),
case protobuffs_compile:scan_file(Proto,
[{compile_flags,ErlOpts}]) of
ok ->
%% Compilation worked, but we need to move the
%% beam and .hrl file into the ebin/ and include/
%% directories respectively
%% TODO: Protobuffs really needs to be better about this
ok = filelib:ensure_dir(filename:join("ebin","dummy")),
ok = rebar_file_utils:mv(Beam, "ebin"),
ok = filelib:ensure_dir(filename:join("include", Hrl)),
ok = rebar_file_utils:mv(Hrl, "include"),
ok;
Other ->
?ERROR("Protobuffs compile of ~s failed: ~p\n",
[Proto, Other]),
?FAIL
end;
false ->
ok
end,
compile_each(Config, Rest).
delete_each([]) ->
ok;
delete_each([File | Rest]) ->
case file:delete(File) of
ok ->
ok;
{error, enoent} ->
ok;
{error, Reason} ->
?ERROR("Failed to delete ~s: ~p\n", [File, Reason])
end,
delete_each(Rest).
|
