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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
|
%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 2010-2018. All Rights Reserved.
%%
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%% http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%
%% %CopyrightEnd%
%%
%%
%% Module alternative to diameterc for dictionary compilation.
%%
%% Eg. 1> diameter_make:codec("mydict.dia").
%%
%% $ erl -noinput \
%% -boot start_clean \
%% -eval 'ok = diameter_make:codec("mydict.dia")' \
%% -s init stop
%%
-module(diameter_make).
-export([codec/2,
codec/1,
format/1,
flatten/1,
format_error/1]).
-export_type([opt/0]).
-include("diameter_vsn.hrl").
%% Options passed to codec/2.
-type opt() :: {include|outdir|name|prefix|inherits, string()}
| return
| verbose
| parse %% internal parsed form
| forms %% abstract format for compile:forms/1,2
| erl
| hrl.
%% Internal parsed format with a version tag.
-type parsed() :: list().
%% Literal dictionary or path. A NL of CR identifies the former.
-type dict() :: iolist()
| binary()
| parsed(). %% as returned by codec/2
%% Name of a literal dictionary if otherwise unspecified.
-define(DEFAULT_DICT_FILE, "dictionary.dia").
%% ===========================================================================
%% codec/1-2
%%
%% Parse a dictionary file and generate a codec module. Input
%% dictionary can be either a path or the dictionary itself: the
%% occurrence of \n or \r in the argument is used to distinguish the
%% two.
-spec codec(File, [opt()])
-> ok
| {ok, list()} %% with option 'return', one element for each output
| {error, Reason}
when File :: dict()
| {path, file:name_all()},
Reason :: string().
codec(File, Opts) ->
{Dict, Path} = identify(File),
case parse(Dict, Opts) of
{ok, ParseD} ->
make(Path, default(Opts), ParseD);
{error, _} = E ->
E
end.
codec(File) ->
codec(File, []).
%% format/1
%%
%% Turn an orddict returned by dict/1-2 back into a dictionary.
-spec format(parsed())
-> iolist().
format([?VERSION | Dict]) ->
diameter_dict_util:format(Dict).
%% flatten/1
%%
%% Reconstitute a dictionary without @inherits.
-spec flatten(parsed())
-> parsed().
flatten([?VERSION = V | Dict]) ->
[V | lists:foldl(fun flatten/2,
Dict,
[avp_vendor_id,
custom_types,
codecs,
[avp_types, import_avps],
[grouped, import_groups],
[enum, import_enums]])].
%% format_error/1
format_error(T) ->
diameter_dict_util:format_error(T).
%% ===========================================================================
%% flatten/2
flatten([_,_] = Keys, Dict) ->
[Values, Imports] = [orddict:fetch(K, Dict) || K <- Keys],
Vs = lists:append([Values | [V || {_Mod, V} <- Imports]]),
lists:foldl(fun({K,V},D) -> orddict:store(K,V,D) end,
Dict,
lists:zip([inherits | Keys], [[], Vs, []]));
%% Inherited avp's setting the 'V' flag get their value either from
%% @avp_vendor_id in the inheriting dictionary or from @vendor in the
%% *inherited* (not inheriting) dictionary: add the latter to
%% @avp_vendor_id as required.
flatten(avp_vendor_id = Key, Dict) ->
Def = orddict:find(vendor, Dict),
ModD = imports(Dict),
Vids = orddict:fetch(Key, Dict),
Avps = lists:append([As || {_,As} <- Vids]),
orddict:store(Key,
dict:fold(fun(M, As, A) -> vid(M, As -- Avps, Def, A) end,
Vids,
ModD),
Dict);
%% Import @codecs and @custom_types from inherited dictionaries as
%% required.
flatten(Key, Dict) ->
ImportAvps = orddict:fetch(import_avps, Dict),
ImportItems = [{M, As}
|| {Mod, Avps} <- ImportAvps,
[_|D] <- [Mod:dict()],
{M,As0} <- orddict:fetch(Key, D),
F <- [fun(A) -> lists:keymember(A, 1, Avps) end],
[_|_] = As <- [lists:filter(F, As0)]],
orddict:store(Key,
lists:foldl(fun merge/2,
orddict:fetch(Key, Dict),
ImportItems),
Dict).
%% merge/2
merge({Mod, _Avps} = T, Acc) ->
merge(lists:keyfind(Mod, 1, Acc), T, Acc).
merge({Mod, Avps}, {Mod, As}, Acc) ->
lists:keyreplace(Mod, 1, Acc, {Mod, Avps ++ As});
merge(false, T, Acc) ->
[T | Acc].
%% imports/1
%%
%% Return a module() -> [AVP] dict of inherited AVP's setting the V flag.
imports(Dict) ->
lists:foldl(fun imports/2,
dict:new(),
orddict:fetch(import_avps, Dict)).
imports({Mod, Avps}, Dict) ->
dict:store(Mod,
[A || {A,_,_,Fs} <- Avps, lists:member($V, Fs)],
Dict).
%% vid/4
vid(_, [], _, Acc) ->
Acc;
vid(Mod, Avps, Def, Acc) ->
v(Mod:vendor_id(), Avps, Def, Acc).
v(Vid, _, {ok, {Vid, _}}, Acc) -> %% same id as inheriting dictionary's
Acc;
v(Vid, Avps, _, Acc) ->
case lists:keyfind(Vid, 1, Acc) of
{Vid, As} ->
lists:keyreplace(Vid, 1, Acc, {Vid, As ++ Avps});
false ->
[{Vid, Avps} | Acc]
end.
%% ===========================================================================
parse({dict, ParseD}, _) ->
{ok, ParseD};
parse(File, Opts) ->
diameter_dict_util:parse(File, Opts).
default(Opts) ->
def(modes(Opts), Opts).
def([], Opts) ->
[erl, hrl | Opts];
def(_, Opts) ->
Opts.
modes(Opts) ->
lists:filter(fun is_mode/1, Opts).
is_mode(T) ->
lists:member(T, [erl, hrl, parse, forms]).
identify([Vsn | [T|_] = ParseD])
when is_tuple(T) ->
?VERSION == Vsn orelse erlang:error({version, {Vsn, ?VERSION}}),
{{dict, ParseD}, ?DEFAULT_DICT_FILE};
identify({path, File} = T) ->
{T, File};
identify(File) ->
case is_path([File]) of
true -> {{path, File}, File};
false -> {File, ?DEFAULT_DICT_FILE}
end.
%% Interpret anything containing \n or \r as a literal dictionary.
is_path([<<C,B/binary>> | T]) ->
is_path([C, B | T]);
is_path([[C|L] | T]) ->
is_path([C, L | T]);
is_path([C|_])
when $\n == C;
$\r == C ->
false;
is_path([_|T]) ->
is_path(T);
is_path([]) ->
true.
make(File, Opts, Dict) ->
ok(lists:foldl(fun(M,A) -> [make(File, Opts, Dict, M) | A] end,
[],
modes(Opts))).
ok([ok|_]) ->
ok;
ok([_|_] = L) ->
{ok, lists:reverse(L)}.
make(File, Opts, Dict, Mode) ->
try
diameter_codegen:from_dict(File, Dict, Opts, Mode)
catch
error: Reason: Stack ->
erlang:error({Reason, Mode, Stack})
end.
|
