Add synchronous stop function to wx_object

3 files changed, 53 insertions, 11 deletions

diff --git a/lib/wx/src/wx_object.erl b/lib/wx/src/wx_object.erl
index 80f8937656..249ea1cee3 100644
--- a/lib/wx/src/wx_object.erl
+++ b/lib/wx/src/wx_object.erl
@@ -1,7 +1,7 @@
 %%
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 2008-2011. All Rights Reserved.
+%% Copyright Ericsson AB 2008-2014. All Rights Reserved.
 %%
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -102,6 +102,7 @@
 %% API
 -export([start/3, start/4,
 	 start_link/3, start_link/4,
+	 stop/1, stop/3,
 	 call/2, call/3,
 	 cast/2,
 	 reply/2,
@@ -215,6 +216,42 @@ gen_response({ok, Pid}) ->
 gen_response(Reply) ->
     Reply.
 
+%% @spec (Ref::wxObject()|atom()|pid()) -> ok
+%% @doc Stops a generic wx_object server with reason 'normal'.
+%% Invokes terminate(Reason,State) in the server. The call waits until
+%% the process is terminated. If the process does not exist, an
+%% exception is raised.
+stop(Ref = #wx_ref{state=Pid}) when is_pid(Pid) ->
+    try
+	gen:stop(Pid)
+    catch _:ExitReason ->
+	    erlang:error({ExitReason, {?MODULE, stop, [Ref]}})
+    end;
+stop(Name) when is_atom(Name) orelse is_pid(Name) ->
+    try
+	gen:stop(Name)
+    catch _:ExitReason ->
+	    erlang:error({ExitReason, {?MODULE, stop, [Name]}})
+    end.
+
+%% @spec (Ref::wxObject()|atom()|pid(), Reason::term(), Timeout::timeout()) -> ok
+%% @doc Stops a generic wx_object server with the given Reason.
+%% Invokes terminate(Reason,State) in the server. The call waits until
+%% the process is terminated. If the call times out, or if the process
+%% does not exist, an exception is raised.
+stop(Ref = #wx_ref{state=Pid}, Reason, Timeout) when is_pid(Pid) ->
+    try
+	gen:stop(Pid, Reason, Timeout)
+    catch _:ExitReason ->
+	    erlang:error({ExitReason, {?MODULE, stop, [Ref, Reason, Timeout]}})
+    end;
+stop(Name, Reason, Timeout) when is_atom(Name) orelse is_pid(Name) ->
+    try
+	gen:stop(Name, Reason, Timeout)
+    catch _:ExitReason ->
+	    erlang:error({ExitReason, {?MODULE, stop, [Name, Reason, Timeout]}})
+    end.
+
 %% @spec (Ref::wxObject()|atom()|pid(), Request::term()) -> term()
 %% @doc Make a call to a wx_object server.
 %% The call waits until it gets a result.
diff --git a/lib/wx/test/wx_event_SUITE.erl b/lib/wx/test/wx_event_SUITE.erl
index 076f16ba16..2c6c59bb55 100644
--- a/lib/wx/test/wx_event_SUITE.erl
+++ b/lib/wx/test/wx_event_SUITE.erl
@@ -542,13 +542,14 @@ handler_clean(_Config) ->
     ?mt(wxFrame, Frame1),
     wxWindow:show(Frame1),
     ?m([_|_], lists:sort(wx_test_lib:flush())),
-    ?m({stop,_}, wx_obj_test:stop(Frame1, fun(_) -> normal end)),
+    ?m(ok, wx_obj_test:stop(Frame1)),
     ?m([{terminate,normal}], lists:sort(wx_test_lib:flush())),
 
-    Frame2 = wx_obj_test:start([{init, Init}]),
+    Terminate = fun({Frame,_}) -> wxWindow:destroy(Frame) end,
+    Frame2 = wx_obj_test:start([{init, Init}, {terminate, Terminate}]),
     wxWindow:show(Frame2),
     ?m([_|_], lists:sort(wx_test_lib:flush())),
-    ?m({stop,_}, wx_obj_test:stop(Frame2, fun(_) -> wxWindow:destroy(Frame2), normal end)),
+    ?m(ok, wx_obj_test:stop(Frame2)),
     ?m([{terminate,normal}], lists:sort(wx_test_lib:flush())),
     timer:sleep(104),
     ?m({[],[],[]}, white_box_check_event_handlers()),
diff --git a/lib/wx/test/wx_obj_test.erl b/lib/wx/test/wx_obj_test.erl
index f47f2fbc46..6c648c65f8 100644
--- a/lib/wx/test/wx_obj_test.erl
+++ b/lib/wx/test/wx_obj_test.erl
@@ -1,7 +1,7 @@
 %%
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 2011-2013. All Rights Reserved.
+%% Copyright Ericsson AB 2011-2014. All Rights Reserved.
 %%
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -18,7 +18,7 @@
 -module(wx_obj_test).
 -include_lib("wx/include/wx.hrl").
 
--export([start/1, stop/2]).
+-export([start/1, stop/1]).
 
 %% wx_object callbacks
 -export([init/1, handle_info/2, terminate/2, code_change/3, handle_call/3,
@@ -29,8 +29,8 @@
 start(Opts) ->
     wx_object:start_link(?MODULE, [{parent, self()}| Opts], []).
 
-stop(Object, Fun) ->
-    wx_object:call(Object, {stop, Fun}).
+stop(Object) ->
+    wx_object:stop(Object).
 
 init(Opts) ->
     Parent = proplists:get_value(parent, Opts),
@@ -61,8 +61,6 @@ handle_event(Event, State = #state{parent=Parent}) ->
 handle_call(What, From, State = #state{user_state=US}) when is_function(What) ->
     Result = What(US),
     {reply, {call, Result, From}, State};
-handle_call({stop, Fun}, From, State = #state{user_state=US}) ->
-    {stop, Fun(US), {stop, From}, State};
 handle_call(What, From, State) ->
     {reply, {call, What, From}, State}.
 
@@ -79,7 +77,13 @@ handle_info(What, State = #state{parent=Pid}) ->
     Pid ! {info, What},
     {noreply, State}.
 
-terminate(What, #state{parent=Pid}) ->
+terminate(What, #state{parent=Pid, opts=Opts, user_state=US}) ->
+    case proplists:get_value(terminate, Opts) of
+	undefined ->
+	    ok;
+	Terminate ->
+	    Terminate(US)
+    end,
     Pid ! {terminate, What},
     ok.