From 8682e6b3db55f7f021e529b2134f223b4cc70ace Mon Sep 17 00:00:00 2001
From: Stavros Aronis <aronisstav@gmail.com>
Date: Fri, 11 Nov 2011 16:35:28 +0100
Subject: Detection of callback-spec discrepancies

---
 .../src/callbacks_and_specs/my_behaviour.erl       | 11 ++++
 .../callbacks_and_specs/my_callbacks_correct.erl   | 59 +++++++++++++++++++++
 .../src/callbacks_and_specs/my_callbacks_wrong.erl | 61 ++++++++++++++++++++++
 3 files changed, 131 insertions(+)
 create mode 100644 lib/dialyzer/test/behaviour_SUITE_data/src/callbacks_and_specs/my_behaviour.erl
 create mode 100644 lib/dialyzer/test/behaviour_SUITE_data/src/callbacks_and_specs/my_callbacks_correct.erl
 create mode 100644 lib/dialyzer/test/behaviour_SUITE_data/src/callbacks_and_specs/my_callbacks_wrong.erl

(limited to 'lib/dialyzer/test/behaviour_SUITE_data/src')

diff --git a/lib/dialyzer/test/behaviour_SUITE_data/src/callbacks_and_specs/my_behaviour.erl b/lib/dialyzer/test/behaviour_SUITE_data/src/callbacks_and_specs/my_behaviour.erl
new file mode 100644
index 0000000000..c4e5203448
--- /dev/null
+++ b/lib/dialyzer/test/behaviour_SUITE_data/src/callbacks_and_specs/my_behaviour.erl
@@ -0,0 +1,11 @@
+-module(my_behaviour).
+
+-callback callback_init(Parent :: pid()) -> {'ok', State::term()}.
+
+-callback callback_cast(State::term(), From::pid(), Msg::term()) ->
+    {'noreply', NewState::term()}.
+
+-callback callback_call(State::term(), From::pid(), Msg::term()) ->
+    {'reply', NewState::term(), Reply::term()}.
+
+-callback callback_exit(State::term()) -> 'ok'.
diff --git a/lib/dialyzer/test/behaviour_SUITE_data/src/callbacks_and_specs/my_callbacks_correct.erl b/lib/dialyzer/test/behaviour_SUITE_data/src/callbacks_and_specs/my_callbacks_correct.erl
new file mode 100644
index 0000000000..041b4ac56c
--- /dev/null
+++ b/lib/dialyzer/test/behaviour_SUITE_data/src/callbacks_and_specs/my_callbacks_correct.erl
@@ -0,0 +1,59 @@
+-module(my_callbacks_correct).
+
+-export([
+	 callback_init/1
+	 , callback_call/3
+	 , callback_cast/3
+	 , callback_exit/1
+	]).
+
+-record(state, {
+	  parent           :: pid(),
+	  status    = init :: 'init' | 'open' | 'closed',
+	  subscribe = []   :: list({pid(), integer()}),
+	  counter   = 1    :: integer()
+	 }).
+
+-type state()        :: #state{}.
+
+-type cast_message() :: 'open' | 'closed'.
+
+-type call_message() :: 'subscribe' | 'unsubscribe'.
+-type call_reply()   :: 'accepted' | 'rejected'.
+
+-spec callback_init(Parent::pid()) -> {'ok', state()}.
+
+callback_init(Parent) ->
+    {ok, #state{parent = Parent}}.
+
+-spec callback_cast(state(), pid(), cast_message()) -> {'noreply', state()}.
+
+callback_cast(#state{parent = Pid} = State, Pid, Message)
+  when Message =:= 'open'; Message =:= 'close' ->
+    {noreply, State#state{status = Message}};
+callback_cast(State, _Pid, _Message) ->
+    {noreply, State}.
+
+-spec callback_call(state(), pid(), call_message()) ->
+			   {'reply', state(), call_reply()}.
+
+callback_call(#state{status = open, subscribe = Subscribers} = State,
+	      Pid, Message)
+  when Message =:= 'subscribe';
+       Message =:= 'unsubscribe' ->
+    NewState =
+	case Message of
+	    subscribe ->
+		N = State#state.counter,
+		State#state{subscribe = [{Pid, N}|Subscribers], counter = N+1};
+	    unsubscribe ->
+		State#state{subscribe = lists:keydelete(Pid, 1, Subscribers)}
+	end,
+    {reply, NewState, accepted};
+callback_call(State, _Pid, _Message) ->
+    {reply, State, rejected}.
+
+-spec callback_exit(state()) -> 'ok'.
+
+callback_exit(_State) ->
+    ok.
diff --git a/lib/dialyzer/test/behaviour_SUITE_data/src/callbacks_and_specs/my_callbacks_wrong.erl b/lib/dialyzer/test/behaviour_SUITE_data/src/callbacks_and_specs/my_callbacks_wrong.erl
new file mode 100644
index 0000000000..0459622dc1
--- /dev/null
+++ b/lib/dialyzer/test/behaviour_SUITE_data/src/callbacks_and_specs/my_callbacks_wrong.erl
@@ -0,0 +1,61 @@
+-module(my_callbacks_wrong).
+
+-export([
+	 callback_init/1
+	 , callback_call/3
+	 , callback_cast/3
+	 , callback_exit/1
+	]).
+
+-behaviour(my_behaviour).
+
+-record(state, {
+	  parent           :: pid(),
+	  status    = init :: 'init' | 'open' | 'closed',
+	  subscribe = []   :: list({pid(), integer()}),
+	  counter   = 1    :: integer()
+	 }).
+
+-type state()        :: #state{}.
+
+-type cast_message() :: 'open' | 'closed'.
+
+-type call_message() :: 'subscribe' | 'unsubscribe'.
+-type call_reply()   :: 'accepted' | 'rejected'.
+
+-spec callback_init(Parent::pid()) -> state().    %% Wrong return spec
+
+callback_init(Parent) -> #state{parent = Parent}. %% Wrong return
+
+-spec callback_cast(state(), pid() | atom(), cast_message()) ->
+			   {'noreply' | 'reply', state()}. %% More generic spec
+
+callback_cast(#state{parent = Pid} = State, Pid, Message)
+  when Message =:= 'open'; Message =:= 'close' ->
+    {noreply, State#state{status = Message}};
+callback_cast(State, _Pid, _Message) ->
+    {noreply, State}.
+
+-spec callback_call(state(), atom(), call_message()) ->      %% Wrong arg spec
+			   {'reply', state(), call_reply()}.
+
+callback_call(#state{status = open, subscribe = Subscribers} = State,
+	      Pid, Message)
+  when Message =:= 'subscribe';
+       Message =:= 'unsubscribe' ->
+    NewState =
+	case Message of
+	    subscribe ->
+		N = State#state.counter,
+		State#state{subscribe = [{Pid, N}|Subscribers], counter = N+1};
+	    unsubscribe ->
+		State#state{subscribe = lists:keydelete(Pid, 1, Subscribers)}
+	end,
+    {reply, NewState, accepted};
+callback_call(State, _Pid, _Message) ->
+    {reply, State, rejected}.
+
+-spec callback_exit(state()) -> ok.
+
+callback_exit(_State) ->
+    ok.
-- 
cgit v1.2.3