Deprecate pre-defined built-in types

The types array(), dict(), digraph(), gb_set(), gb_tree(), queue(),
set(), and tid() have been deprecated. They will be removed in OTP 18.0.

Instead the types array:array(), dict:dict(), digraph:graph(),
gb_set:set(), gb_tree:tree(), queue:queue(), sets:set(), and ets:tid()
can be used. (Note: it has always been necessary to use ets:tid().)

It is allowed in OTP 17.0 to locally re-define the types array(), dict(),
and so on.

New types array:array/1, dict:dict/2, gb_sets:set/1, gb_trees:tree/2,
queue:queue/1, and sets:set/1 have been added.

6 files changed, 420 insertions, 0 deletions

diff --git a/lib/dialyzer/test/opaque_SUITE_data/src/para/para1.erl b/lib/dialyzer/test/opaque_SUITE_data/src/para/para1.erl
new file mode 100644
index 0000000000..68e2c60368
--- /dev/null
+++ b/lib/dialyzer/test/opaque_SUITE_data/src/para/para1.erl
@@ -0,0 +1,93 @@
+-module(para1).
+
+-compile(export_all).
+
+%% Parameterized opaque types
+
+-export_type([t/0, t/1]).
+
+-opaque t() :: {integer(), integer()}.
+
+-opaque t(A) :: {A, A}.
+
+-type y(A) :: {A, A}.
+
+tt1() ->
+    I = t1(),
+    A = t2(),
+    A =:= I. % never 'true'
+
+tt2() ->
+    I = t0(),
+    A = t2(),
+    A =:= I. % never 'true'
+
+tt3() ->
+    I1 = t0(),
+    I2 = t1(),
+    I1 =:= I2. % never true
+
+tt4() ->
+    I1 = y1(),
+    I2 = y2(),
+    I1 =:= I2. % cannot evaluate to true
+
+adt_tt1() ->
+    I = adt_t1(),
+    A = adt_t2(),
+    A =:= I. % opaque attempt
+
+adt_tt2() ->
+    I = adt_t0(),
+    A = adt_t2(),
+    A =:= I. % opaque attempt
+
+adt_tt3() ->
+    I1 = adt_t0(),
+    I2 = adt_t1(),
+    I1 =:= I2. % opaque attempt
+
+adt_tt4() ->
+    I1 = adt_y1(),
+    I2 = adt_y2(),
+    I1 =:= I2. % cannot evaluate to true
+
+-spec t0() -> t().
+
+t0() ->
+    {3, 2}.
+
+-spec t1() -> t(integer()).
+
+t1() ->
+    {3, 3}.
+
+-spec t2() -> t(atom()).
+
+t2() ->
+    {a, b}.
+
+-spec y1() -> y(integer()).
+
+y1() ->
+    {3, 2}.
+
+-spec y2() -> y(atom()).
+
+y2() ->
+    {a, b}.
+
+adt_t0() ->
+    para1_adt:t0().
+
+adt_t1() ->
+    para1_adt:t1().
+
+adt_t2() ->
+    para1_adt:t2().
+
+adt_y1() ->
+    para1_adt:y1().
+
+adt_y2() ->
+    para1_adt:y2().
diff --git a/lib/dialyzer/test/opaque_SUITE_data/src/para/para1_adt.erl b/lib/dialyzer/test/opaque_SUITE_data/src/para/para1_adt.erl
new file mode 100644
index 0000000000..95ac6b7982
--- /dev/null
+++ b/lib/dialyzer/test/opaque_SUITE_data/src/para/para1_adt.erl
@@ -0,0 +1,36 @@
+-module(para1_adt).
+
+-export([t0/0, t1/0, t2/0, y1/0, y2/0]).
+
+-export_type([t/0, t/1, y/1]).
+
+-opaque t() :: {integer(), integer()}.
+
+-opaque t(A) :: {A, A}.
+
+-type y(A) :: {A, A}.
+
+-spec t0() -> t().
+
+t0() ->
+    {3, 2}.
+
+-spec t1() -> t(integer()).
+
+t1() ->
+    {3, 3}.
+
+-spec t2() -> t(atom()).
+
+t2() ->
+    {a, b}.
+
+-spec y1() -> y(integer()).
+
+y1() ->
+    {3, 2}.
+
+-spec y2() -> y(atom()).
+
+y2() ->
+    {a, b}.
diff --git a/lib/dialyzer/test/opaque_SUITE_data/src/para/para2.erl b/lib/dialyzer/test/opaque_SUITE_data/src/para/para2.erl
new file mode 100644
index 0000000000..09b2235fa5
--- /dev/null
+++ b/lib/dialyzer/test/opaque_SUITE_data/src/para/para2.erl
@@ -0,0 +1,123 @@
+-module(para2).
+
+-compile(export_all).
+
+%% More parameterized opaque types
+
+-export_type([strange/1]).
+
+-export_type([c1/0, c2/0]).
+
+-export_type([circ/1, circ/2]).
+
+-opaque strange(A) :: {B, B, A}.
+
+-spec t(strange(integer())) -> strange(atom()).
+
+t({3, 4, 5}) ->
+    {a, b, c}.
+
+-opaque c1() :: c2().
+-opaque c2() :: c1().
+
+c() ->
+    A = c1(),
+    B = c2(),
+    A =:= B.
+
+t() ->
+    A = ct1(),
+    B = ct2(),
+    A =:= B. % can never evaluate to 'true'
+
+-spec c1() -> c1().
+
+c1() ->
+    a.
+
+-spec c2() -> c2().
+
+c2() ->
+    a.
+
+-type ct1() :: ct2().
+-type ct2() :: ct1().
+
+-spec ct1() -> ct1().
+
+ct1() ->
+    a.
+
+-spec ct2() -> ct2().
+
+ct2() ->
+    b.
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+c_adt() ->
+    A = c1_adt(),
+    B = c2_adt(),
+    A =:= B. % opaque attempt
+
+t_adt() ->
+    A = ct1_adt(),
+    B = ct2_adt(),
+    A =:= B. % can never evaluate to true
+
+c1_adt() ->
+    para2_adt:c1().
+
+c2_adt() ->
+    para2_adt:c2().
+
+ct1_adt() ->
+    para2_adt:ct1().
+
+ct2_adt() ->
+    para2_adt:ct2().
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+-opaque circ(A) :: circ(A, A).
+-opaque circ(A, B) :: circ({A, B}).
+
+tcirc() ->
+    A = circ1(),
+    B = circ2(),
+    A =:= B. % can never evaluate to 'true' (but the types are not OK, or?)
+
+-spec circ1() -> circ(integer()).
+
+circ1() ->
+    3.
+
+-spec circ2() -> circ(integer(), integer()).
+
+circ2() ->
+    {3, 3}.
+
+tcirc_adt() ->
+    A = circ1_adt(),
+    B = circ2_adt(),
+    A =:= B. % opaque attempt (one would expect them to be the same...)
+
+circ1_adt() ->
+    para2_adt:circ1().
+
+circ2_adt() ->
+    para2_adt:circ2().
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+u_adt() ->
+    A = u1_adt(),
+    B = u2_adt(),
+    %% The resulting types are equal, but not the parameters:
+    A =:= B. % opaque attempt
+
+u1_adt() ->
+    para2_adt:u1().
+
+u2_adt() ->
+    para2_adt:u2().
diff --git a/lib/dialyzer/test/opaque_SUITE_data/src/para/para2_adt.erl b/lib/dialyzer/test/opaque_SUITE_data/src/para/para2_adt.erl
new file mode 100644
index 0000000000..96df437c67
--- /dev/null
+++ b/lib/dialyzer/test/opaque_SUITE_data/src/para/para2_adt.erl
@@ -0,0 +1,64 @@
+-module(para2_adt).
+
+%% More parameterized opaque types
+
+-export_type([c1/0, c2/0]).
+
+-export_type([ct1/0, ct2/0]).
+
+-export_type([circ/1, circ/2]).
+
+-export_type([un/2]).
+
+-export([c1/0, c2/0, ct1/0, ct2/0, circ1/0, circ2/0, u1/0, u2/0]).
+
+-opaque c1() :: c2().
+-opaque c2() :: c1().
+
+-spec c1() -> c1().
+
+c1() ->
+    a.
+
+-spec c2() -> c2().
+
+c2() ->
+    a.
+
+-type ct1() :: ct2().
+-type ct2() :: ct1().
+
+-spec ct1() -> ct1().
+
+ct1() ->
+    a.
+
+-spec ct2() -> ct2().
+
+ct2() ->
+    b.
+
+-opaque circ(A) :: circ(A, A).
+-opaque circ(A, B) :: circ({A, B}).
+
+-spec circ1() -> circ(integer()).
+
+circ1() ->
+    3.
+
+-spec circ2() -> circ(integer(), integer()).
+
+circ2() ->
+    {3, 3}.
+
+-opaque un(A, B) :: A | B.
+
+-spec u1() -> un(integer(), atom()).
+
+u1() ->
+    3.
+
+-spec u2() -> un(atom(), integer()).
+
+u2() ->
+    3.
diff --git a/lib/dialyzer/test/opaque_SUITE_data/src/para/para3.erl b/lib/dialyzer/test/opaque_SUITE_data/src/para/para3.erl
new file mode 100644
index 0000000000..792ae40d39
--- /dev/null
+++ b/lib/dialyzer/test/opaque_SUITE_data/src/para/para3.erl
@@ -0,0 +1,77 @@
+-module(para3).
+
+-export([t/0, t1/1, t2/0, ot1/1, ot2/0, t1_adt/0, t2_adt/0]).
+
+-export([exp_adt/0]).
+
+%% More opaque tests.
+
+-export_type([ot1/0, ot1/1, ot1/2, ot1/3, ot1/4, ot1/5]).
+
+-opaque ot1() :: {ot1(_)}.
+
+-opaque ot1(A) :: {ot1(A, A)}.
+
+-opaque ot1(A, B) :: {ot1(A, B, A)}.
+
+-opaque ot1(A, B, C) :: {ot1(A, B, C, A)}.
+
+-opaque ot1(A, B, C, D) :: {ot1(A, B, C, D, A)}.
+
+-opaque ot1(A, B, C, D, E) :: {A, B, C, D, E}.
+
+-spec ot1(_) -> ot1().
+
+ot1(A) ->
+    {{{{{A, A, A, A, A}}}}}.
+
+-spec ot2() -> ot1(). % invalid type spec
+
+ot2() ->
+    foo.
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+t() ->
+    {{{17}}} = t1(3). %% pattern can never match
+
+-type t1() :: {t1(_)}.
+
+-type t1(A) :: {t1(A, A)}.
+
+-type t1(A, B) :: {t1(A, B, A)}.
+
+-type t1(A, B, C) :: {t1(A, B, C, A)}.
+
+-type t1(A, B, C, D) :: {t1(A, B, C, D, A)}.
+
+-type t1(A, B, C, D, E) :: {A, B, C, D, E}.
+
+-spec t1(_) -> t1().
+
+t1(A) ->
+    {{{{{A, A, A, A, A}}}}}.
+
+-spec t2() -> t1(). % invalid type spec
+
+t2() ->
+    foo.
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+%% Shows that the list TypeNames in t_from_form must include ArgsLen.
+
+t1_adt() ->
+    {{{{{17}}}}} = para3_adt:t1(3). % breaks the opaqueness
+
+t2_adt() ->
+    {{{{17}}}} = para3_adt:t1(3). % can never match
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+-type exp() :: para3_adt:exp1(para3_adt:exp2()).
+
+-spec exp_adt() -> exp().
+
+exp_adt() ->
+    3.
diff --git a/lib/dialyzer/test/opaque_SUITE_data/src/para/para3_adt.erl b/lib/dialyzer/test/opaque_SUITE_data/src/para/para3_adt.erl
new file mode 100644
index 0000000000..3919b846e6
--- /dev/null
+++ b/lib/dialyzer/test/opaque_SUITE_data/src/para/para3_adt.erl
@@ -0,0 +1,27 @@
+-module(para3_adt).
+
+-export([t1/1]).
+
+-export_type([t1/0, t1/1, t1/2, t1/3, t1/4, ot1/5]).
+
+-export_type([exp1/1, exp2/0]).
+
+-type t1() :: {t1(_)}.
+
+-type t1(A) :: {t1(A, A)}.
+
+-type t1(A, B) :: {t1(A, B, A)}.
+
+-type t1(A, B, C) :: {t1(A, B, C, A)}.
+
+-type t1(A, B, C, D) :: {ot1(A, B, C, D, A)}.
+
+-opaque ot1(A, B, C, D, E) :: {A, B, C, D, E}.
+
+-spec t1(_) -> t1().
+
+t1(A) ->
+    {{{{{A, A, A, A, A}}}}}.
+
+-opaque exp1(T) :: T.
+-opaque exp2() :: integer().