timer: Update specs and apply tidier cleanups

1 files changed, 38 insertions, 28 deletions

diff --git a/lib/stdlib/src/timer.erl b/lib/stdlib/src/timer.erl
index 36fdb48c75..6ee837c3e6 100644
--- a/lib/stdlib/src/timer.erl
+++ b/lib/stdlib/src/timer.erl
@@ -1,19 +1,19 @@
 %%
 %% %CopyrightBegin%
-%% 
-%% Copyright Ericsson AB 1996-2009. All Rights Reserved.
-%% 
+%%
+%% Copyright Ericsson AB 1996-2010. 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
 %% compliance with the License. You should have received a copy of the
 %% Erlang Public License along with this software. If not, it can be
 %% retrieved online at http://www.erlang.org/.
-%% 
+%%
 %% Software distributed under the License is distributed on an "AS IS"
 %% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 %% the License for the specific language governing rights and limitations
 %% under the License.
-%% 
+%%
 %% %CopyrightEnd%
 %%
 -module(timer).
@@ -41,54 +41,54 @@
 %%
 %% Time is in milliseconds.
 %%
--opaque tref()    :: any().
+-opaque tref()    :: {integer(), reference()}.
 -type time()      :: non_neg_integer().
 -type timestamp() :: {non_neg_integer(), non_neg_integer(), non_neg_integer()}.
 
 %%
 %% Interface functions
 %%
--spec apply_after(time(), atom(), atom(), [_]) -> {'ok', tref()} | {'error', _}.
+-spec apply_after(time(), atom(), atom(), [term()]) -> {'ok', tref()} | {'error', term()}.
 apply_after(Time, M, F, A) ->
     req(apply_after, {Time, {M, F, A}}).
 
--spec send_after(time(), pid() | atom(), term()) -> {'ok', tref()} | {'error', _}.
+-spec send_after(time(), pid() | atom(), term()) -> {'ok', tref()} | {'error', term()}.
 send_after(Time, Pid, Message) ->
     req(apply_after, {Time, {?MODULE, send, [Pid, Message]}}).
 
--spec send_after(time(), _) -> {'ok', tref()} | {'error', _}.
+-spec send_after(time(), term()) -> {'ok', tref()} | {'error', term()}.
 send_after(Time, Message) ->
     send_after(Time, self(), Message).
 
--spec exit_after(time(), pid() | atom(), _) -> {'ok', tref()} | {'error', _}.
+-spec exit_after(time(), pid() | atom(), term()) -> {'ok', tref()} | {'error', term()}.
 exit_after(Time, Pid, Reason) ->
     req(apply_after, {Time, {erlang, exit, [Pid, Reason]}}).
 
--spec exit_after(time(), term()) -> {'ok', tref()} | {'error', _}.
+-spec exit_after(time(), term()) -> {'ok', tref()} | {'error', term()}.
 exit_after(Time, Reason) ->
     exit_after(Time, self(), Reason).
 
--spec kill_after(time(), pid() | atom()) -> {'ok', tref()} | {'error', _}.
+-spec kill_after(time(), pid() | atom()) -> {'ok', tref()} | {'error', term()}.
 kill_after(Time, Pid) ->
     exit_after(Time, Pid, kill).
 
--spec kill_after(time()) -> {'ok', tref()} | {'error', _}.
+-spec kill_after(time()) -> {'ok', tref()} | {'error', term()}.
 kill_after(Time) ->
     exit_after(Time, self(), kill).
 
--spec apply_interval(time(), atom(), atom(), [_]) -> {'ok', tref()} | {'error', _}.
+-spec apply_interval(time(), atom(), atom(), [term()]) -> {'ok', tref()} | {'error', term()}.
 apply_interval(Time, M, F, A) ->
     req(apply_interval, {Time, self(), {M, F, A}}).
 
--spec send_interval(time(), pid() | atom(), term()) -> {'ok', tref()} | {'error', _}.
+-spec send_interval(time(), pid() | atom(), term()) -> {'ok', tref()} | {'error', term()}.
 send_interval(Time, Pid, Message) ->
     req(apply_interval, {Time, Pid, {?MODULE, send, [Pid, Message]}}).
 
--spec send_interval(time(), term()) -> {'ok', tref()} | {'error', _}.
+-spec send_interval(time(), term()) -> {'ok', tref()} | {'error', term()}.
 send_interval(Time, Message) ->
     send_interval(Time, self(), Message).
 
--spec cancel(tref()) -> {'ok', 'cancel'} | {'error', _}.
+-spec cancel(tref()) -> {'ok', 'cancel'} | {'error', term()}.
 cancel(BRef) ->
     req(cancel, BRef).
 
@@ -101,7 +101,7 @@ sleep(T) ->
 %%
 %% Measure the execution time (in microseconds) for an MFA.
 %%
--spec tc(atom(), atom(), [_]) -> {time(), term()}.
+-spec tc(atom(), atom(), [term()]) -> {time(), term()}.
 tc(M, F, A) ->
     Before = erlang:now(),
     Val = (catch apply(M, F, A)),
@@ -141,7 +141,7 @@ hms(H, M, S) ->
 start() ->
     ensure_started().
 
--spec start_link() -> {'ok', pid()} | {'error', _}.
+-spec start_link() -> {'ok', pid()} | {'error', term()}.
 start_link() ->
     gen_server:start_link({local, timer_server}, ?MODULE, [], []).    
 
@@ -152,6 +152,7 @@ init([]) ->
     ?INTERVAL_TAB = ets:new(?INTERVAL_TAB, [named_table,protected]),
     {ok, [], infinity}.
 
+-spec ensure_started() -> 'ok'.
 ensure_started() ->
     case whereis(timer_server) of
 	undefined -> 
@@ -175,6 +176,10 @@ req(Req, Arg) ->
 %%
 %% Time and Timeout is in milliseconds. Started is in microseconds.
 %%
+-type timers() :: term(). % XXX: refine?
+
+-spec handle_call(term(), term(), timers()) ->
+        {'reply', term(), timers(), timeout()} | {'noreply', timers(), timeout()}.
 handle_call({apply_after, {Time, Op}, Started}, _From, _Ts) 
   when is_integer(Time), Time >= 0 ->
     BRef = {Started + 1000*Time, make_ref()},
@@ -194,7 +199,7 @@ handle_call({apply_interval, {Time, To, MFA}, Started}, _From, _Ts)
 	    Interval = Time*1000,
 	    BRef2 = {Started + Interval, Ref},
 	    Timer = {BRef2, {repeat, Interval, Pid}, MFA},
-	    ets:insert(?INTERVAL_TAB,{BRef1,BRef2,Pid}),
+	    ets:insert(?INTERVAL_TAB, {BRef1,BRef2,Pid}),
 	    ets:insert(?TIMER_TAB, Timer),
 	    Timeout = timer_timeout(SysTime),
 	    {reply, {ok, BRef1}, [], Timeout};
@@ -202,7 +207,7 @@ handle_call({apply_interval, {Time, To, MFA}, Started}, _From, _Ts)
 	    {reply, {error, badarg}, [], next_timeout()}
     end;
 handle_call({cancel, BRef = {_Time, Ref}, _}, _From, Ts) 
-                                           when is_reference(Ref) ->
+  when is_reference(Ref) ->
     delete_ref(BRef),
     {reply, {ok, cancel}, Ts, next_timeout()};
 handle_call({cancel, _BRef, _}, _From, Ts) ->
@@ -214,6 +219,7 @@ handle_call({apply_interval, _, _}, _From, Ts) ->
 handle_call(_Else, _From, Ts) ->		  % Catch anything else
     {noreply, Ts, next_timeout()}.
 
+-spec handle_info(term(), timers()) -> {'noreply', timers(), timeout()}.
 handle_info(timeout, Ts) ->                       % Handle timeouts 
     Timeout = timer_timeout(system_time()),
     {noreply, Ts, Timeout};
@@ -223,19 +229,21 @@ handle_info({'EXIT',  Pid, _Reason}, Ts) ->       % Oops, someone died
 handle_info(_OtherMsg, Ts) ->                     % Other Msg's
     {noreply, Ts, next_timeout()}.
 
+-spec handle_cast(term(), timers()) -> {'noreply', timers(), timeout()}.
 handle_cast(_Req, Ts) ->                          % Not predicted but handled
     {noreply, Ts, next_timeout()}.
 
--spec terminate(_, _) -> 'ok'.
+-spec terminate(term(), _State) -> 'ok'.
 terminate(_Reason, _State) ->
     ok.
 
+-spec code_change(term(), State, term()) -> {'ok', State}.
 code_change(_OldVsn, State, _Extra) ->
     %% According to the man for gen server no timer can be set here.
     {ok, State}.				
 
 %% 
-%% timer_timeout(Timers, SysTime)
+%% timer_timeout(SysTime)
 %%
 %% Apply and remove already timed-out timers. A timer is a tuple
 %% {Time, BRef, Op, MFA}, where Time is in microseconds.
@@ -279,12 +287,13 @@ delete_ref(BRef = {interval, _}) ->
 	    ok
     end;
 delete_ref(BRef) ->
-    ets:delete(?TIMER_TAB,BRef).
+    ets:delete(?TIMER_TAB, BRef).
 
 %%
 %% pid_delete
 %%
 
+-spec pid_delete(pid()) -> 'ok'.
 pid_delete(Pid) ->
     IntervalTimerList = 
 	ets:select(?INTERVAL_TAB,
@@ -292,13 +301,14 @@ pid_delete(Pid) ->
 		     [{'==','$1',Pid}],
 		     ['$_']}]),
     lists:foreach(fun({IntKey, TimerKey, _ }) ->
-			  ets:delete(?INTERVAL_TAB,IntKey),
-			  ets:delete(?TIMER_TAB,TimerKey) 
+			  ets:delete(?INTERVAL_TAB, IntKey),
+			  ets:delete(?TIMER_TAB, TimerKey)
 		  end, IntervalTimerList).
 
 %% Calculate time to the next timeout. Returned timeout must fit in a 
 %% small int.
 
+-spec next_timeout() -> timeout().
 next_timeout() ->
     case ets:first(?TIMER_TAB) of
 	'$end_of_table' -> 
@@ -358,7 +368,7 @@ get_pid(_) ->
 
 get_status() ->
     Info1 = ets:info(?TIMER_TAB),
-    {value,{size,TotalNumTimers}} = lists:keysearch(size, 1, Info1),
+    {size,TotalNumTimers} = lists:keyfind(size, 1, Info1),
     Info2 = ets:info(?INTERVAL_TAB),
-    {value,{size,NumIntervalTimers}} = lists:keysearch(size, 1, Info2),
+    {size,NumIntervalTimers} = lists:keyfind(size, 1, Info2),
     {{?TIMER_TAB,TotalNumTimers},{?INTERVAL_TAB,NumIntervalTimers}}.