Merge branch 'maint'

Author: Mikaka27

lib/diameter/bin/diameterc

@@ -43,9 +43,10 @@ usage() ->
       "~n"
       "  options:~n"
       "~n"
-      "      --name name       = set @name~n"
-      "      --prefix prefix   = set @prefix~n"
-      "      --inherits dict|- = set/clear @inherits~n"
+      "      --name name         = set @name~n"
+      "      --prefix prefix     = set @prefix~n"
+      "      --inherits dict|-   = set/clear @inherits~n"
+      "      --indirect-inherits = enable indirect_inherits option~n"
       "~n"
       "      -h        = print this message~n"
       "      -v        = verbose output~n"
@@ -125,6 +126,9 @@ arg(["--prefix", Name | Args], #argv{options = Opts} = A) ->
 arg(["--inherits", Dict | Args], #argv{options = Opts} = A) ->
     arg(Args, A#argv{options = Opts ++ [{inherits, Dict}]});
 
+arg(["--indirect-inherits" | Args], #argv{options = Opts} = A) ->
+    arg(Args, A#argv{options = [indirect_inherits | Opts]});
+
 arg(["-E" | Args], #argv{output = Output} = A) ->
     arg(Args, A#argv{output = lists:delete(erl, Output)});
 

lib/diameter/doc/references/diameter_dict.md

@@ -163,6 +163,57 @@ order in which sections are specified is unimportant.
   @inherits diameter_gen_base_rfc6733
   ```
 
+  When using the `indirect_inherits` option from [codec/2](`diameter_make:codec/2`), 
+  only `@vendor` from the dictionary that defined the AVPs and `@avp_vendor_id`
+  in the currently compiled dictionary is used. All other dictionaries along the
+  chain are ignored, so for example:
+
+  `a.dia`:
+  ```text
+  @vendor 1 A
+  @avp_types
+      AAA 111 Unsigned32 V
+      BBB 222 Unsigned32 V
+  ```
+  `a.dia` will see:
+    - AAA vendor_id = 1
+    - BBB vendor_id = 1
+
+  `b.dia`:
+  ```text
+  @vendor 2 B
+  @avp_types
+      CCC 333 Unsigned32 V
+  @inherits diameter_a
+  @avp_vendor_id 4
+      AAA
+  ```
+
+  `b.dia` will see:
+    - AAA vendor_id = 4
+    - BBB vendor_id = 1
+    - CCC vendor_id = 2
+
+  `c.dia`:
+  ```text
+  @vendor 3 C
+  @avp_types
+      DDD 444 Unsigned32 V
+  @inherits diameter_b
+  @avp_vendor_id 5
+      BBB
+      CCC
+  ```
+
+  `c.dia` will see:
+    - AAA vendor_id = 1
+    - BBB vendor_id = 5
+    - CCC vendor_id = 5
+    - DDD vendor_id = 3
+
+  In particular `b.dia`'s override of `AAA` to vendor_id = 4 is ignored by `c.dia` and `AAA` is
+  back to having vendor_id = 1.
+
 - **`@avp_types`{: #avp_types }** - Defines the name, code, type and flags of
   individual AVPs. The section consists of definitions of the form
 
@@ -291,6 +342,56 @@ order in which sections are specified is unimportant.
   REMOVE_SIP_SERVER        3
   ```
 
+  If `indirect_inherits` option from [codec/2](`diameter_make:codec/2`) is used,
+  new enum values can also be added in each `.dia` file along the inheritance chain,
+  example:
+
+  `a.dia`:
+  ```text
+  @avp_types
+      AAA 111 Enumerated V
+  @enum AAA
+      A 0
+      B 1
+  ```
+
+  `a.dia` will see following enum values:
+    - A 0
+    - B 1
+
+  `b.dia`:
+  ```text
+  @inherits diameter_a
+  @enum AAA
+      C 2
+      D 3
+  ```
+
+  `b.dia` will see following enum values:
+    - A 0
+    - B 1
+    - C 2
+    - D 3
+
+  `c.dia`:
+  ```text
+  @inherits diameter_b
+  @enum AAA
+      E 4
+      F 5
+  ```
+
+  `c.dia` will see:
+    - A 0
+    - B 1
+    - C 2
+    - D 3
+    - E 4
+    - F 5
+
+  Warning: messages are not shown in this example, but it is required to add
+  enum AVPs to messages in order for the code to encode/decode them to be generated!
+
 - **`@end`{: #end }** - Causes parsing of the dictionary to terminate: any
   remaining content is ignored.
 

lib/diameter/doc/references/diameterc_cmd.md

@@ -45,7 +45,7 @@ source. Valid options are as follows.
 
 - **\-i <dir>** - Prepend the specified directory to the code path. Use to
   point at beam files compiled from inherited dictionaries,
-  `[@inherits](diameter_dict.md#inherits)` in a dictionary file creating a
+  [@inherits](diameter_dict.md#inherits) in a dictionary file creating a
   beam dependency, not an erl/hrl dependency.
 
   Multiple `-i` options can be specified.
@@ -60,11 +60,11 @@ source. Valid options are as follows.
 - **\--name <name>** - Name the output module.
 
 - **\--prefix <prefix>** - Transform the input dictionary before compilation,
-  setting `[@name](diameter_dict.md#name)` or
-  `[@prefix](diameter_dict.md#prefix)` to the specified string.
+  setting [@name](diameter_dict.md#name) or
+  [@prefix](diameter_dict.md#prefix) to the specified string.
 
 - **\--inherits <arg>** - Transform the input dictionary before compilation,
-  appending `[@inherits](diameter_dict.md#inherits)` of the specified string.
+  appending [@inherits](diameter_dict.md#inherits) of the specified string.
 
   Two forms of `--inherits` have special meaning:
 
@@ -80,6 +80,9 @@ source. Valid options are as follows.
 
   Multiple `--inherits` options can be specified.
 
+- **\--indirect-inherits** - Enables indirect inherits feature, see more
+  [here](`diameter_make:codec/2`).
+
 # EXIT STATUS
 
 Returns 0 on success, non-zero on failure.

lib/diameter/src/compiler/diameter_codegen.erl

@@ -594,9 +594,24 @@ f_enumerated_avp(ParseD) ->
 
 enumerated_avp(ParseD) ->
     Enums = get_value(enum, ParseD),
-    lists:flatmap(fun cs_enumerated_avp/1, Enums)
-        ++ lists:flatmap(fun({M,Es}) -> enumerated_avp(M, Es, Enums) end,
-                         get_value(import_enums, ParseD)).
+    CurrentEnums = lists:flatmap(fun cs_enumerated_avp/1, Enums),
+    ImportedEnums = lists:flatmap(fun({M,Es}) -> enumerated_avp(M, Es, Enums) end,
+                         get_value(import_enums, ParseD)),
+    %% Remove duplicate clauses in the imported enums. This is important to generate correct
+    %% code when multiple dictionaries in the inheritance chain add values to the same
+    %% enumerated AVP. The last in the list is the one that is closest to the current module
+    %% in the inheritance chain and the one which should be kept.
+    Fun = fun({_, Id, [_, {_, _, Name}, _], _, _} = Elem, AccIn) ->
+                  case lists:search(fun({_, SId, [_, {_, _, SName}, _], _, _}) ->
+                                            Id == SId andalso Name == SName end, AccIn) of
+                      {value, Previous} ->
+                          lists:delete(Previous, AccIn) ++ [Elem];
+                      false ->
+                          AccIn ++ [Elem]
+                  end
+          end,
+    FilteredEnums = lists:foldl(Fun, [], ImportedEnums),
+    CurrentEnums ++ FilteredEnums.
 
 enumerated_avp(Mod, Es, Enums) ->
     lists:flatmap(fun({N,_}) ->
@@ -734,7 +749,19 @@ empty_value(ParseD) ->
     Enums = [T || {N,_} = T <- get_value(enum, ParseD),
                   not lists:keymember(N, 1, Imported)]
         ++ Imported,
-    lists:map(fun c_empty_value/1, Groups ++ Enums)
+    %% Here we need to remove duplicate empty_value clauses that are generated when
+    %% multiple dictionaries in the inheritance chain define values for the same
+    %% enumerated AVP.
+    lists:foldl(fun(Elem, AccIn) ->
+                        Name = element(1, Elem),
+                        case lists:any(fun({clause, _, [{_, _, SearchName}, _], _, _}) ->
+                                               ?A(Name) == SearchName end, AccIn) of
+                            true ->
+                                AccIn;
+                            false ->
+                                AccIn ++ [c_empty_value(Elem)]
+                        end
+                end, [], Groups ++ Enums)
         ++ [{?clause, [?VAR('Name'), ?VAR('Opts')],
              [],
              [?CALL(empty, [?VAR('Name'), ?VAR('Opts')])]}].