Merge branch 'hb/dialyzer/fix_opaque_types/OTP-12493'

* hb/dialyzer/fix_opaque_types/OTP-12493:
  dialyzer: Fix a minor bug concerning opaque types
  dialyzer: Modify warning for comparison of opaque types
  dialyzer: Modify the handling of parametrized opaque types

9 files changed, 336 insertions, 13 deletions

diff --git a/lib/dialyzer/test/opaque_SUITE_data/results/para b/lib/dialyzer/test/opaque_SUITE_data/results/para
index 3aaa238de6..8fe67e39ad 100644
--- a/lib/dialyzer/test/opaque_SUITE_data/results/para
+++ b/lib/dialyzer/test/opaque_SUITE_data/results/para
@@ -7,15 +7,27 @@ para1.erl:38: Attempt to test for equality between a term of type para1_adt:t(in
 para1.erl:43: Attempt to test for equality between a term of type para1_adt:t() and a term of opaque type para1_adt:t(atom())
 para1.erl:48: Attempt to test for equality between a term of type para1_adt:t(integer()) and a term of opaque type para1_adt:t()
 para1.erl:53: The test {3,2} =:= {'a','b'} can never evaluate to 'true'
-para2.erl:103: Attempt to test for equality between a term of type para2_adt:circ({{integer(),integer()},{integer(),integer()}},{{integer(),integer()},{integer(),integer()}}) and a term of opaque type para2_adt:circ({{integer(),integer()},{integer(),integer()}})
+para2.erl:103: Attempt to test for equality between a term of type para2_adt:circ(integer(),integer()) and a term of opaque type para2_adt:circ(integer())
 para2.erl:117: Attempt to test for equality between a term of type para2_adt:un(atom(),integer()) and a term of opaque type para2_adt:un(integer(),atom())
 para2.erl:31: The test 'a' =:= 'b' can never evaluate to 'true'
 para2.erl:61: Attempt to test for equality between a term of type para2_adt:c2() and a term of opaque type para2_adt:c1()
 para2.erl:66: The test 'a' =:= 'b' can never evaluate to 'true'
-para2.erl:88: The test para2:circ({{integer(),integer()},{integer(),integer()}}) =:= para2:circ({{integer(),integer()},{integer(),integer()}},{{integer(),integer()},{integer(),integer()}}) can never evaluate to 'true'
+para2.erl:88: The test para2:circ(integer()) =:= para2:circ(integer(),integer()) can never evaluate to 'true'
 para3.erl:28: Invalid type specification for function para3:ot2/0. The success typing is () -> 'foo'
 para3.erl:36: The pattern {{{17}}} can never match the type {{{{{{_,_,_,_,_}}}}}}
 para3.erl:55: Invalid type specification for function para3:t2/0. The success typing is () -> 'foo'
 para3.erl:65: The attempt to match a term of type {{{{{para3_adt:ot1(_,_,_,_,_)}}}}} against the pattern {{{{{17}}}}} breaks the opaqueness of para3_adt:ot1(_,_,_,_,_)
 para3.erl:68: The pattern {{{{17}}}} can never match the type {{{{{para3_adt:ot1(_,_,_,_,_)}}}}}
 para3.erl:74: Invalid type specification for function para3:exp_adt/0. The success typing is () -> 3
+para4.erl:21: Invalid type specification for function para4:a/1. The success typing is (dict:dict(atom() | integer(),atom() | integer()) | para4:d_all()) -> [{atom() | integer(),atom() | integer()}]
+para4.erl:26: Invalid type specification for function para4:i/1. The success typing is (dict:dict(atom() | integer(),atom() | integer()) | para4:d_all()) -> [{atom() | integer(),atom() | integer()}]
+para4.erl:31: Invalid type specification for function para4:t/1. The success typing is (dict:dict(atom() | integer(),atom() | integer()) | para4:d_all()) -> [{atom() | integer(),atom() | integer()}]
+para4.erl:59: Attempt to test for equality between a term of type para4_adt:t(atom() | integer()) and a term of opaque type para4_adt:t(integer())
+para4.erl:64: Attempt to test for equality between a term of type para4_adt:t(atom() | integer()) and a term of opaque type para4_adt:t(atom())
+para4.erl:69: Attempt to test for equality between a term of type para4_adt:int(1 | 2 | 3 | 4) and a term of opaque type para4_adt:int(1 | 2)
+para4.erl:74: Attempt to test for equality between a term of type para4_adt:int(2 | 3 | 4) and a term of opaque type para4_adt:int(1 | 2)
+para4.erl:79: Attempt to test for equality between a term of type para4_adt:int(2 | 3 | 4) and a term of opaque type para4_adt:int(5 | 6 | 7)
+para4.erl:84: Attempt to test for equality between a term of type para4_adt:un(3 | 4) and a term of opaque type para4_adt:un(1 | 2)
+para4.erl:89: Attempt to test for equality between a term of type para4_adt:tup({_,_}) and a term of opaque type para4_adt:tup(tuple())
+para5.erl:13: Attempt to test for inequality between a term of type para5_adt:dd(atom()) and a term of opaque type para5_adt:d()
+para5.erl:8: The test para5_adt:d() =:= para5_adt:d() can never evaluate to 'true'
diff --git a/lib/dialyzer/test/opaque_SUITE_data/results/simple b/lib/dialyzer/test/opaque_SUITE_data/results/simple
index 29864d6065..1a7a139d6e 100644
--- a/lib/dialyzer/test/opaque_SUITE_data/results/simple
+++ b/lib/dialyzer/test/opaque_SUITE_data/results/simple
@@ -28,11 +28,11 @@ rec_api.erl:99: Record construction #r2{f1::10} violates the declared type of fi
 simple1_api.erl:113: The test simple1_api:d1() =:= simple1_api:d2() can never evaluate to 'true'
 simple1_api.erl:118: Guard test simple1_api:d2() =:= A::simple1_api:d1() can never succeed
 simple1_api.erl:142: Attempt to test for equality between a term of type simple1_adt:o2() and a term of opaque type simple1_adt:o1()
-simple1_api.erl:148: Guard test simple1_adt:o2() =:= A::simple1_adt:o1() contains an opaque term as 1st argument
+simple1_api.erl:148: Guard test simple1_adt:o2() =:= A::simple1_adt:o1() contains opaque terms as 1st and 2nd arguments
 simple1_api.erl:154: Attempt to test for inequality between a term of type simple1_adt:o2() and a term of opaque type simple1_adt:o1()
 simple1_api.erl:160: Attempt to test for inequality between a term of type simple1_adt:o2() and a term of opaque type simple1_adt:o1()
 simple1_api.erl:165: Attempt to test for equality between a term of type simple1_adt:c2() and a term of opaque type simple1_adt:c1()
-simple1_api.erl:181: Guard test A::simple1_adt:d1() =< B::simple1_adt:d2() contains an opaque term as 1st argument
+simple1_api.erl:181: Guard test A::simple1_adt:d1() =< B::simple1_adt:d2() contains opaque terms as 1st and 2nd arguments
 simple1_api.erl:185: Guard test 'a' =< B::simple1_adt:d2() contains an opaque term as 2nd argument
 simple1_api.erl:189: Guard test A::simple1_adt:d1() =< 'd' contains an opaque term as 1st argument
 simple1_api.erl:197: The type test is_integer(A::simple1_adt:d1()) breaks the opaqueness of the term A::simple1_adt:d1()
@@ -72,12 +72,12 @@ simple1_api.erl:499: The call 'foo':A(A::simple1_api:i()) requires that A is of
 simple1_api.erl:503: The call 'foo':A(A::simple1_adt:i()) requires that A is of type atom() not simple1_adt:i()
 simple1_api.erl:507: The call A:'foo'(A::simple1_api:i()) requires that A is of type atom() | tuple() not simple1_api:i()
 simple1_api.erl:511: The call A:'foo'(A::simple1_adt:i()) requires that A is of type atom() | tuple() not simple1_adt:i()
-simple1_api.erl:519: Guard test A::simple1_adt:d2() == B::simple1_adt:d1() contains an opaque term as 1st argument
+simple1_api.erl:519: Guard test A::simple1_adt:d2() == B::simple1_adt:d1() contains opaque terms as 1st and 2nd arguments
 simple1_api.erl:534: Guard test A::simple1_adt:d1() >= 3 contains an opaque term as 1st argument
 simple1_api.erl:536: Guard test A::simple1_adt:d1() == 3 contains an opaque term as 1st argument
 simple1_api.erl:538: Guard test A::simple1_adt:d1() =:= 3 contains an opaque term as 1st argument
 simple1_api.erl:548: The call erlang:'<'(A::simple1_adt:d1(),3) contains an opaque term as 1st argument when terms of different types are expected in these positions
-simple1_api.erl:558: The call erlang:'=<'(A::simple1_adt:d1(),B::simple1_adt:d2()) contains an opaque term as 1st argument when terms of different types are expected in these positions
+simple1_api.erl:558: The call erlang:'=<'(A::simple1_adt:d1(),B::simple1_adt:d2()) contains opaque terms as 1st and 2nd arguments when terms of different types are expected in these positions
 simple1_api.erl:565: Guard test {digraph:graph(),3} > {digraph:graph(),atom() | ets:tid()} contains an opaque term as 2nd argument
 simple1_api.erl:91: Invalid type specification for function simple1_api:tup/0. The success typing is () -> {'a','b'}
 simple2_api.erl:100: The call lists:flatten(A::simple1_adt:tuple1()) contains an opaque term as 1st argument when a structured term of type [any()] is expected
diff --git a/lib/dialyzer/test/opaque_SUITE_data/src/para/para2.erl b/lib/dialyzer/test/opaque_SUITE_data/src/para/para2.erl
index 09b2235fa5..4461ff291c 100644
--- a/lib/dialyzer/test/opaque_SUITE_data/src/para/para2.erl
+++ b/lib/dialyzer/test/opaque_SUITE_data/src/para/para2.erl
@@ -85,7 +85,7 @@ ct2_adt() ->
 tcirc() ->
     A = circ1(),
     B = circ2(),
-    A =:= B. % can never evaluate to 'true' (but the types are not OK, or?)
+    A =:= B. % can never evaluate to 'true'
 
 -spec circ1() -> circ(integer()).
 
@@ -100,7 +100,7 @@ circ2() ->
 tcirc_adt() ->
     A = circ1_adt(),
     B = circ2_adt(),
-    A =:= B. % opaque attempt (one would expect them to be the same...)
+    A =:= B. % opaque attempt (number of parameters differs)
 
 circ1_adt() ->
     para2_adt:circ1().
diff --git a/lib/dialyzer/test/opaque_SUITE_data/src/para/para3.erl b/lib/dialyzer/test/opaque_SUITE_data/src/para/para3.erl
index 792ae40d39..102215b28d 100644
--- a/lib/dialyzer/test/opaque_SUITE_data/src/para/para3.erl
+++ b/lib/dialyzer/test/opaque_SUITE_data/src/para/para3.erl
@@ -71,7 +71,7 @@ t2_adt() ->
 
 -type exp() :: para3_adt:exp1(para3_adt:exp2()).
 
--spec exp_adt() -> exp().
+-spec exp_adt() -> exp(). % invalid type spec
 
 exp_adt() ->
     3.
diff --git a/lib/dialyzer/test/opaque_SUITE_data/src/para/para4.erl b/lib/dialyzer/test/opaque_SUITE_data/src/para/para4.erl
new file mode 100644
index 0000000000..b9794672a9
--- /dev/null
+++ b/lib/dialyzer/test/opaque_SUITE_data/src/para/para4.erl
@@ -0,0 +1,134 @@
+-module(para4).
+
+-compile(export_all).
+
+-export_type([d_atom/0, d_integer/0, d_tuple/0, d_all/0]).
+
+-export_type([t/1]).
+
+-type ai() :: atom() | integer().
+
+-type d(T) :: dict:dict(T, T).
+
+-opaque d_atom() :: d(atom()).
+-opaque d_integer() :: d(integer()).
+-opaque d_tuple() :: d(tuple()).
+-opaque d_all() :: d(ai()).
+
+b(D) ->
+    a(D) ++ i(D).
+
+-spec a(d_atom()) -> [{atom(), atom()}]. % Invalid type spec
+
+a(D) ->
+    c(D).
+
+-spec i(d_integer()) -> [{integer(), integer()}]. % Invalid type spec
+
+i(D) ->
+    c(D).
+
+-spec t(d_tuple()) -> [{tuple(), tuple()}]. % Invalid type spec.
+
+t(D) ->
+    c(D).
+
+-spec c(d_all()) -> [{ai(), ai()}].
+
+c(D) ->
+    dict:to_list(D).
+
+
+
+
+-opaque t(A) :: {A, A}.
+
+adt_tt5() ->
+    I1 = adt_y1(),
+    I2 = adt_y3(),
+    I1 =:= I2.
+
+adt_tt6() ->
+    I1 = adt_y2(),
+    I2 = adt_y3(),
+    I1 =:= I2.
+
+adt_tt7() ->
+    I1 = adt_t1(),
+    I2 = adt_t3(),
+    I1 =:= I2. % opaque attempt
+
+adt_tt8() ->
+    I1 = adt_t2(),
+    I2 = adt_t3(),
+    I1 =:= I2. % opaque attempt
+
+adt_tt9() ->
+    I1 = adt_int2(),
+    I2 = adt_int4(),
+    I1 =:= I2. % opaque attempt
+
+adt_tt10() ->
+    I1 = adt_int2(),
+    I2 = adt_int2_4(),
+    I1 =:= I2. % opaque attempt
+
+adt_tt11() ->
+    I1 = adt_int5_7(),
+    I2 = adt_int2_4(),
+    I1 =:= I2. % opaque attempt
+
+adt_tt12() ->
+    I1 = adt_un1_2(),
+    I2 = adt_un3_4(),
+    I1 =:= I2. % opaque attempt
+
+adt_tt13() ->
+    I1 = adt_tup(),
+    I2 = adt_tup2(),
+    I1 =:= I2. % opaque attempt
+
+y3() ->
+    {a, 3}.
+
+adt_t1() ->
+    para4_adt:t1().
+
+adt_t2() ->
+    para4_adt:t2().
+
+adt_t3() ->
+    para4_adt:t3().
+
+adt_y1() ->
+    para4_adt:y1().
+
+adt_y2() ->
+    para4_adt:y2().
+
+adt_y3() ->
+    para4_adt:y3().
+
+adt_int2() ->
+    para4_adt:int2().
+
+adt_int4() ->
+    para4_adt:int4().
+
+adt_int2_4() ->
+    para4_adt:int2_4().
+
+adt_int5_7() ->
+    para4_adt:int5_7().
+
+adt_un1_2() ->
+    para4_adt:un1_2().
+
+adt_un3_4() ->
+    para4_adt:un3_4().
+
+adt_tup() ->
+    para4_adt:tup().
+
+adt_tup2() ->
+    para4_adt:tup2().
diff --git a/lib/dialyzer/test/opaque_SUITE_data/src/para/para4_adt.erl b/lib/dialyzer/test/opaque_SUITE_data/src/para/para4_adt.erl
new file mode 100644
index 0000000000..407dd198a7
--- /dev/null
+++ b/lib/dialyzer/test/opaque_SUITE_data/src/para/para4_adt.erl
@@ -0,0 +1,108 @@
+-module(para4_adt).
+
+-export([t1/0, t2/0, t3/0, y1/0, y2/0, y3/0]).
+
+-export([int2/0, int4/0, int2_4/0, int5_7/0]).
+
+-export([un1_2/0, un3_4/0]).
+
+-export([tup/0, tup2/0]).
+
+-export_type([t/1, y/1, int/1, tup/1, un/1]).
+
+-type ai() :: atom() | integer().
+
+-opaque t(A) :: {A, A}.
+
+-type y(A) :: {A, A}.
+
+-opaque int(I) :: I.
+
+-opaque un(I) :: atom() | I.
+
+-opaque tup(T) :: T.
+
+-spec t1() -> t(integer()).
+
+t1() ->
+    {i(), i()}.
+
+-spec t2() -> t(atom()).
+
+t2() ->
+    {a(), a()}.
+
+-spec t3() -> t(ai()).
+
+t3() ->
+    {ai(), ai()}.
+
+-spec y1() -> y(integer()).
+
+y1() ->
+    {i(), i()}.
+
+-spec y2() -> y(atom()).
+
+y2() ->
+    {a(), a()}.
+
+-spec y3() -> y(ai()).
+
+y3() ->
+    {ai(), ai()}.
+
+-spec a() -> atom().
+
+a() ->
+    foo:a().
+
+-spec i() -> integer().
+
+i() ->
+    foo:i().
+
+-spec ai() -> ai().
+
+ai() ->
+    foo:ai().
+
+-spec int2() -> int(1..2).
+
+int2() ->
+    foo:int2().
+
+-spec int4() -> int(1..4).
+
+int4() ->
+    foo:int4().
+
+-spec int2_4() -> int(2..4).
+
+int2_4() ->
+    foo:int2_4().
+
+-spec int5_7() -> int(5..7).
+
+int5_7() ->
+    foo:int5_7().
+
+-spec un1_2() -> un(1..2).
+
+un1_2() ->
+    foo:un1_2().
+
+-spec un3_4() -> un(3..4).
+
+un3_4() ->
+    foo:un3_4().
+
+-spec tup() -> tup(tuple()).
+
+tup() ->
+    foo:tup().
+
+-spec tup2() -> tup({_, _}).
+
+tup2() ->
+    foo:tup2().
diff --git a/lib/dialyzer/test/opaque_SUITE_data/src/para/para5.erl b/lib/dialyzer/test/opaque_SUITE_data/src/para/para5.erl
new file mode 100644
index 0000000000..76ea3e76b5
--- /dev/null
+++ b/lib/dialyzer/test/opaque_SUITE_data/src/para/para5.erl
@@ -0,0 +1,33 @@
+-module(para5).
+
+-export([d/0, dd/0, da1/0]).
+
+d() ->
+    I1 = adt_d1(),
+    I2 = adt_d2(),
+    I1 =:= I2. % can never evaluate to true
+
+dd() ->
+    I1 = adt_d1(),
+    I2 = adt_dd(),
+    I1 =/= I2. % incompatible opaque types
+
+da1() ->
+    I1 = adt_da1(),
+    I2 = adt_da2(),
+    I1 =:= I2.
+
+adt_d1() ->
+    para5_adt:d1().
+
+adt_d2() ->
+    para5_adt:d2().
+
+adt_dd() ->
+    para5_adt:dd().
+
+adt_da1() ->
+    para5_adt:da1().
+
+adt_da2() ->
+    para5_adt:da2().
diff --git a/lib/dialyzer/test/opaque_SUITE_data/src/para/para5_adt.erl b/lib/dialyzer/test/opaque_SUITE_data/src/para/para5_adt.erl
new file mode 100644
index 0000000000..a62e0488e0
--- /dev/null
+++ b/lib/dialyzer/test/opaque_SUITE_data/src/para/para5_adt.erl
@@ -0,0 +1,36 @@
+-module(para5_adt).
+
+-export([d1/0, d2/0, dd/0, da1/0, da2/0]).
+
+-export_type([d/0, dd/1, da/2]).
+
+-opaque d() :: 1 | 2.
+
+-spec d1() -> d().
+
+d1() ->
+    1.
+
+-spec d2() -> d().
+
+d2() ->
+    2.
+
+-opaque dd(A) :: A.
+
+-spec dd() -> dd(atom()).
+
+dd() ->
+    foo:atom().
+
+-opaque da(A, B) :: {A, B}.
+
+-spec da1() -> da(any(), atom()).
+
+da1() ->
+    {3, a}.
+
+-spec da2() -> da(integer(), any()).
+
+da2() ->
+    {3, a}.
diff --git a/lib/dialyzer/test/opaque_SUITE_data/src/simple/simple1_api.erl b/lib/dialyzer/test/opaque_SUITE_data/src/simple/simple1_api.erl
index eef2074e0c..7db1100597 100644
--- a/lib/dialyzer/test/opaque_SUITE_data/src/simple/simple1_api.erl
+++ b/lib/dialyzer/test/opaque_SUITE_data/src/simple/simple1_api.erl
@@ -145,7 +145,7 @@ adt_t4() ->
     A = simple1_adt:n1(),
     B = simple1_adt:n2(),
     A = A, % OK
-    A = B. % opaque term
+    A = B. % opaque terms
 
 adt_t7() ->
     A = simple1_adt:n1(),
@@ -178,7 +178,7 @@ c2(A, B) ->
 c2() ->
     A = simple1_adt:d1(),
     B = simple1_adt:d2(),
-    if A =< B -> ok end. % opaque term
+    if A =< B -> ok end. % opaque terms
 
 c3() ->
     B = simple1_adt:d2(),
@@ -516,7 +516,7 @@ eq1() ->
     A = simple1_adt:d2(),
     B = simple1_adt:d1(),
     if
-        A == B -> % opaque term
+        A == B -> % opaque terms
             0;
         A == A ->
             1;
@@ -555,7 +555,7 @@ c6(A, B) ->
 c7(A, B) ->
     A = simple1_adt:d1(),
     B = simple1_adt:d2(),
-    A =< B. % opaque term
+    A =< B. % opaque terms
 
 c8() ->
     D = digraph:new(),