From 44eb815397d0fd34e0a596f32b18ff97358aada1 Mon Sep 17 00:00:00 2001
From: Kostis Sagonas <kostis@cs.ntua.gr>
Date: Tue, 26 Oct 2010 13:16:41 +0300
Subject: syntax_tools: Fix an erroneous type and strengthen some specs

The declaration of the stubDescriptop() type in 'igor' was erroneous,
both in the -type and in the published documentation of the module.

While fixing this some specs where strengthened and used a remote
type to refer to ordsets:ordset(T). Consequently, this patch depends
on the ordsets module exporting the ordset/1 type.
---
 lib/syntax_tools/src/erl_syntax.erl     |  4 ++--
 lib/syntax_tools/src/erl_syntax_lib.erl |  6 +-----
 lib/syntax_tools/src/igor.erl           | 34 +++++++++++++++------------------
 3 files changed, 18 insertions(+), 26 deletions(-)

(limited to 'lib')

diff --git a/lib/syntax_tools/src/erl_syntax.erl b/lib/syntax_tools/src/erl_syntax.erl
index a40bf83c5a..9df5f26454 100644
--- a/lib/syntax_tools/src/erl_syntax.erl
+++ b/lib/syntax_tools/src/erl_syntax.erl
@@ -1818,7 +1818,7 @@ char_value(Node) ->
 %%
 %% @see char/1
 
--spec char_literal(syntaxTree()) -> string().
+-spec char_literal(syntaxTree()) -> nonempty_string().
 
 char_literal(Node) ->
     io_lib:write_char(char_value(Node)).
@@ -1908,7 +1908,7 @@ string_value(Node) ->
 %%
 %% @see string/1
 
--spec string_literal(syntaxTree()) -> string().
+-spec string_literal(syntaxTree()) -> nonempty_string().
 
 string_literal(Node) ->
     io_lib:write_string(string_value(Node)).
diff --git a/lib/syntax_tools/src/erl_syntax_lib.erl b/lib/syntax_tools/src/erl_syntax_lib.erl
index daef74e874..97dfbfd7cd 100644
--- a/lib/syntax_tools/src/erl_syntax_lib.erl
+++ b/lib/syntax_tools/src/erl_syntax_lib.erl
@@ -48,10 +48,6 @@
 
 -export_type([info_pair/0]).
 
-%% =====================================================================
-
--type ordset(X) :: [X].  % XXX: TAKE ME OUT
-
 %% =====================================================================
 %% @spec map(Function, Tree::syntaxTree()) -> syntaxTree()
 %%
@@ -480,7 +476,7 @@ new_variable_names(0, Names, _, _, _) ->
 %% @see annotate_bindings/1
 %% @see //stdlib/ordsets
 
--spec annotate_bindings(erl_syntax:syntaxTree(), ordset(atom())) ->
+-spec annotate_bindings(erl_syntax:syntaxTree(), ordsets:ordset(atom())) ->
         erl_syntax:syntaxTree().
 
 annotate_bindings(Tree, Env) ->
diff --git a/lib/syntax_tools/src/igor.erl b/lib/syntax_tools/src/igor.erl
index 7ec62f1dba..aa933eb54b 100644
--- a/lib/syntax_tools/src/igor.erl
+++ b/lib/syntax_tools/src/igor.erl
@@ -119,20 +119,16 @@
 
 %% =====================================================================
 
--type ordset(X) :: [X].  % XXX: TAKE ME OUT
-
-%% =====================================================================
-
 %% Data structure for module information
 
 -record(module, {name        :: atom(),
 		 vars = none :: [atom()] | 'none',
-		 functions   :: ordset({atom(), arity()}),
-		 exports     :: ordset({atom(), arity()})
-			      | ordset({{atom(), arity()}, term()}),
-		 aliases     :: ordset({{atom(), arity()},
-					{atom(), {atom(), arity()}}}),
-		 attributes  :: ordset({atom(), term()}),
+		 functions   :: ordsets:ordset({atom(), arity()}),
+		 exports     :: ordsets:ordset({atom(), arity()})
+			      | ordsets:ordset({{atom(), arity()}, term()}),
+		 aliases     :: ordsets:ordset({{atom(), arity()},
+						{atom(), {atom(), arity()}}}),
+		 attributes  :: ordsets:ordset({atom(), term()}),
 		 records     :: [{atom(), [{atom(), term()}]}]
 		}).
 
@@ -149,7 +145,7 @@ default_printer(Tree, Options) ->
 -type moduleName()     :: atom().
 -type functionName()   :: {atom(), arity()}.
 -type functionPair()   :: {functionName(), {moduleName(), functionName()}}.
--type stubDescriptor() :: [{moduleName(), [functionPair()], [attribute()]}].
+-type stubDescriptor() :: {moduleName(), [functionPair()], [attribute()]}.
 
 -type notes() :: 'always' | 'yes' | 'no'.
 
@@ -209,7 +205,7 @@ parse_transform(Forms, Options) ->
 %% @spec merge(Name::atom(), Files::[filename()]) -> [filename()]
 %% @equiv merge(Name, Files, [])
 
--spec merge(atom(), [file:filename()]) -> [file:filename()].
+-spec merge(atom(), [file:filename()]) -> [file:filename(),...].
 
 merge(Name, Files) ->
     merge(Name, Files, []).
@@ -343,7 +339,7 @@ merge(Name, Files) ->
 	 {suffix, ?DEFAULT_SUFFIX},
 	 {verbose, false}]).
 
--spec merge(atom(), [file:filename()], [option()]) -> [file:filename()].
+-spec merge(atom(), [file:filename()], [option()]) -> [file:filename(),...].
 
 merge(Name, Files, Opts) ->
     Opts1 = Opts ++ ?DEFAULT_MERGE_OPTS,
@@ -484,7 +480,7 @@ merge_files(Name, Trees, Files, Opts) ->
 %%
 %%     Forms = syntaxTree() | [syntaxTree()]
 %%
-%% @type stubDescriptor() = [{ModuleName, Functions, [Attribute]}]
+%% @type stubDescriptor() = {ModuleName, Functions, [Attribute]}
 %%	    ModuleName = atom()
 %%	    Functions = [{FunctionName, {ModuleName, FunctionName}}]
 %%	    FunctionName = {atom(), integer()}
@@ -687,15 +683,15 @@ merge_files(Name, Trees, Files, Opts) ->
 %% Data structure for merging environment.
 
 -record(merge, {target     :: atom(),
-		sources    :: ordset(atom()),
-		export     :: ordset(atom()),
-		static     :: ordset(atom()),
-		safe       :: ordset(atom()),
+		sources    :: ordsets:ordset(atom()),
+		export     :: ordsets:ordset(atom()),
+		static     :: ordsets:ordset(atom()),
+		safe       :: ordsets:ordset(atom()),
 		preserved  :: boolean(),
 		no_headers :: boolean(),
 		notes      :: notes(),
 		redirect   :: dict(),	% = dict(atom(), atom())
-		no_imports :: ordset(atom()),
+		no_imports :: ordsets:ordset(atom()),
 		options	   :: [option()]
 	       }).
 
-- 
cgit v1.2.3