Types and specifications have been modified and added

1 files changed, 60 insertions, 24 deletions

diff --git a/lib/stdlib/src/filename.erl b/lib/stdlib/src/filename.erl
index 24abf1e977..1cb9e4a25e 100644
--- a/lib/stdlib/src/filename.erl
+++ b/lib/stdlib/src/filename.erl
@@ -1,7 +1,7 @@
 %%
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 1997-2010. All Rights Reserved.
+%% Copyright Ericsson AB 1997-2011. 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
@@ -61,12 +61,15 @@
 %% (for WIN32): absname("/") -> "D:/"
 
 
--spec absname(file:name()) -> file:filename().
+-spec absname(Filename) -> file:filename() when
+      Filename :: file:name().
 absname(Name) ->
     {ok, Cwd} = file:get_cwd(),
     absname(Name, Cwd).
 
--spec absname(file:name(), file:filename()) -> file:filename().
+-spec absname(Filename, Dir) -> file:filename() when
+      Filename :: file:name(),
+      Dir :: file:filename().
 absname(Name, AbsBase) when is_binary(Name), is_list(AbsBase) ->
     absname(Name,filename_string_to_binary(AbsBase));
 absname(Name, AbsBase) when is_list(Name), is_binary(AbsBase) ->
@@ -119,7 +122,9 @@ absname_vr([[X, $:]|Name], _, _AbsBase) ->
 %% This is just a join/2, but assumes that 
 %% AbsBase must be absolute and Name must be relative.
 
--spec absname_join(file:filename(), file:name()) -> file:filename().
+-spec absname_join(Dir, Filename) -> file:filename() when
+      Dir :: file:filename(),
+      Filename :: file:name().
 absname_join(AbsBase, Name) ->
     join(AbsBase, flatten(Name)).
 
@@ -131,7 +136,8 @@ absname_join(AbsBase, Name) ->
 %%           basename("/usr/foo/") -> "foo"  (trailing slashes ignored)
 %%           basename("/") -> []
 
--spec basename(file:name()) -> file:filename().
+-spec basename(Filename) -> file:filename() when
+      Filename :: file:name().
 basename(Name) when is_binary(Name) ->
     case os:type() of
 	{win32,_} ->
@@ -192,7 +198,9 @@ skip_prefix(Name, _) ->
 %%	    rootname(basename("xxx.jam")) -> "xxx"
 %%	    rootname(basename("xxx.erl")) -> "xxx"
 
--spec basename(file:name(), file:name()) -> file:filename().
+-spec basename(Filename, Ext) -> file:filename() when
+      Filename :: file:name(),
+      Ext :: file:name().
 basename(Name, Ext) when is_binary(Name), is_list(Ext) ->
     basename(Name,filename_string_to_binary(Ext));
 basename(Name, Ext) when is_list(Name), is_binary(Ext) ->
@@ -240,7 +248,8 @@ basename([], _Ext, Tail, _DrvSep2) ->
 %% Example: dirname("/usr/src/kalle.erl") -> "/usr/src",
 %%	    dirname("kalle.erl") -> "."
 
--spec dirname(file:name()) -> file:filename().
+-spec dirname(Filename) -> file:filename() when
+      Filename :: file:name().
 dirname(Name) when is_binary(Name) ->
     {Dsep,Drivesep} = separators(),
     SList = case Dsep of
@@ -332,7 +341,8 @@ dirjoin1([H|T],Acc,Sep) ->
 %%
 %% On Windows:  fn:dirname("\\usr\\src/kalle.erl") -> "/usr/src"
 
--spec extension(file:name()) -> file:filename().
+-spec extension(Filename) -> file:filename() when
+      Filename :: file:name().
 extension(Name) when is_binary(Name) ->
     {Dsep,_} = separators(),
     SList = case Dsep of
@@ -374,7 +384,8 @@ extension([], Result, _OsType) ->
 
 %% Joins a list of filenames with directory separators.
 
--spec join([file:filename()]) -> file:filename().
+-spec join(Components) -> file:filename() when
+      Components :: [file:filename()].
 join([Name1, Name2|Rest]) ->
     join([join(Name1, Name2)|Rest]);
 join([Name]) when is_list(Name) ->
@@ -386,7 +397,9 @@ join([Name]) when is_atom(Name) ->
 
 %% Joins two filenames with directory separators.
 
--spec join(file:filename(), file:filename()) -> file:filename().
+-spec join(Name1, Name2) -> file:filename() when
+      Name1 :: file:filename(),
+      Name2 :: file:filename().
 join(Name1, Name2) when is_list(Name1), is_list(Name2) ->
     OsType = major_os_type(),
     case pathtype(Name2) of
@@ -494,7 +507,8 @@ append(Dir, Name) ->
 %%		current working volume.  (Windows only)
 %%		Example: a:bar.erl, /temp/foo.erl
 
--spec pathtype(file:name()) -> 'absolute' | 'relative' | 'volumerelative'.
+-spec pathtype(Path) -> 'absolute' | 'relative' | 'volumerelative' when
+      Path :: file:name().
 pathtype(Atom) when is_atom(Atom) ->
     pathtype(atom_to_list(Atom));
 pathtype(Name) when is_list(Name) or is_binary(Name) ->
@@ -547,7 +561,8 @@ win32_pathtype(_) 		  -> relative.
 %% Examples: rootname("/jam.src/kalle") -> "/jam.src/kalle"
 %%           rootname("/jam.src/foo.erl") -> "/jam.src/foo"
 
--spec rootname(file:name()) -> file:filename().
+-spec rootname(Filename) -> file:filename() when
+      Filename :: file:name().
 rootname(Name) when is_binary(Name) ->
     list_to_binary(rootname(binary_to_list(Name))); % No need to handle unicode, . is < 128
 rootname(Name0) ->
@@ -576,7 +591,9 @@ rootname([], Root, _Ext, _OsType) ->
 %% Examples: rootname("/jam.src/kalle.jam", ".erl") -> "/jam.src/kalle.jam"
 %%           rootname("/jam.src/foo.erl", ".erl") -> "/jam.src/foo"
 
--spec rootname(file:name(), file:name()) -> file:filename().
+-spec rootname(Filename, Ext) -> file:filename() when
+      Filename :: file:name(),
+      Ext :: file:name().
 rootname(Name, Ext) when is_binary(Name), is_binary(Ext) ->
     list_to_binary(rootname(binary_to_list(Name),binary_to_list(Ext)));
 rootname(Name, Ext) when is_binary(Name) ->
@@ -602,7 +619,9 @@ rootname2([Char|Rest], Ext, Result) when is_integer(Char) ->
 %% split("foo/bar") -> ["foo", "bar"]
 %% split("a:\\msdev\\include") -> ["a:/", "msdev", "include"]
 
--spec split(file:name()) -> [file:filename()].
+-spec split(Filename) -> Components when
+      Filename :: file:name(),
+      Components :: [file:filename()].
 split(Name) when is_binary(Name) ->
     case os:type() of
 	{win32, _} -> win32_splitb(Name);
@@ -695,7 +714,8 @@ split([], Comp, Components, OsType) ->
 %% will be converted to backslashes.  On all platforms, the
 %% name will be normalized as done by join/1.
 
--spec nativename(file:filename()) -> file:filename().
+-spec nativename(Path) -> file:filename() when
+      Path :: file:filename().
 nativename(Name0) ->
     Name = join([Name0]),			%Normalize.
     case os:type() of
@@ -747,12 +767,17 @@ separators() ->
 %% The paths in the {outdir, Path} and {i, Path} options are guaranteed
 %% to be absolute.
 
--type rule()   :: {string(), string()}.
--type ecode()  :: 'non_existing' | 'preloaded' | 'interpreted'.
--type option() :: {'i', string()} | {'outdir', string()} | {'d', atom()}.
-
--spec find_src(atom() | string()) ->
-	     {string(), [option()]} | {'error', {ecode(), atom()}}.
+-spec find_src(Beam) -> {SourceFile, Options}
+                      | {error, {ErrorReason, Module}} when
+      Beam :: Module | Filename,
+      Filename :: atom() | string(),
+      Module :: module(),
+      SourceFile :: string(),
+      Options :: [Option],
+      Option :: {'i', Path :: string()}
+              | {'outdir', Path :: string()}
+              | {'d', atom()},
+      ErrorReason :: 'non_existing' | 'preloaded' | 'interpreted'.
 find_src(Mod) ->
     Default = [{"", ""}, {"ebin", "src"}, {"ebin", "esrc"}],
     Rules = 
@@ -763,8 +788,18 @@ find_src(Mod) ->
 	end,
     find_src(Mod, Rules).
 
--spec find_src(atom() | string(), [rule()]) ->
-	     {string(), [option()]} | {'error', {ecode(), atom()}}.
+-spec find_src(Beam, Rules) -> {SourceFile, Options}
+                             | {error, {ErrorReason, Module}} when
+      Beam :: Module | Filename,
+      Filename :: atom() | string(),
+      Rules :: [{BinSuffix :: string(), SourceSuffix :: string()}],
+      Module :: module(),
+      SourceFile :: string(),
+      Options :: [Option],
+      Option :: {'i', Path :: string()}
+              | {'outdir', Path :: string()}
+              | {'d', atom()},
+      ErrorReason :: 'non_existing' | 'preloaded' | 'interpreted'.
 find_src(Mod, Rules) when is_atom(Mod) ->
     find_src(atom_to_list(Mod), Rules);
 find_src(File0, Rules) when is_list(File0) ->
@@ -890,7 +925,8 @@ major_os_type() ->
 %% flatten(List)
 %%  Flatten a list, also accepting atoms.
 
--spec flatten(file:name()) -> file:filename().
+-spec flatten(Filename) -> file:filename() when
+      Filename :: file:name().
 flatten(Bin) when is_binary(Bin) ->
     Bin;
 flatten(List) ->