Merge branch 'hawk/escript-add-create-and-extract' into dev

* hawk/escript-add-create-and-extract:
  Add type info for record fields
  Remove the undocumented function escript:foldl/3
  Make reltool independent of the function escript:foldl/3
  Add functions to create and extract escripts
  Add function zip:foldl/3 to iterate over zip archives

OTP-8521 hawk/escript-add-create-and-extract

Added function zip:foldl/3 to iterate over zip archives.

Added functions to create and extract escripts. See escript:create/2 and
escript:extract/2.

The undocumented function escript:foldl/3 has been removed. The same
functionality can be achieved with the more flexible functions
escript:extract/2 and zip:foldl/3.

Record fields has been annotated with type info. Source files as been
adapted to fit within 80 chars and trailing whitespace hasd been removed.

1 files changed, 40 insertions, 114 deletions

diff --git a/lib/reltool/src/reltool.erl b/lib/reltool/src/reltool.erl
index e6548bfe68..e6a8bca069 100644
--- a/lib/reltool/src/reltool.erl
+++ b/lib/reltool/src/reltool.erl
@@ -1,19 +1,19 @@
 %%
 %% %CopyrightBegin%
-%% 
-%% Copyright Ericsson AB 2009. All Rights Reserved.
-%% 
+%%
+%% Copyright Ericsson AB 2009-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(reltool).
@@ -24,106 +24,16 @@
          start/0, start/1, start_link/1, debug/0, % GUI
          start_server/1, get_server/1, stop/1,
          get_config/1, get_config/3, get_rel/2, get_script/2,
-         create_target/2, get_target_spec/1, eval_target_spec/3, 
+         create_target/2, get_target_spec/1, eval_target_spec/3,
          install/2
         ]).
 
--type file()             :: string().
--type dir()              :: string().
--type mod_cond()         :: all | app | ebin | derived | none.
--type incl_cond()        :: include | exclude | derived.
--type debug_info()       :: keep | strip.
--type app_file()         :: keep | strip | all.
--type re_regexp()        :: string().
--type regexps()          :: [re_regexp()] | {add, [re_regexp()]} | {del, [re_regexp()]} .
--type incl_sys_filters() :: regexps().
--type excl_sys_filters() :: regexps().
--type incl_app_filters() :: regexps().
--type excl_app_filters() :: regexps().
--type incl_archive_filters() :: regexps().
--type excl_archive_filters() :: regexps().
--type archive_opt()      :: term().
--type root_dir()         :: dir().
--type lib_dir()          :: dir().
--type profile()          :: development | embedded | standalone.
--type relocatable()      :: boolean().
--type escript_file()     :: file().
--type mod_name()         :: atom().
--type app_name()         :: atom().
--type app_vsn()          :: string().
--type app_type()         :: permanent | transient | temporary | load | none.
--type incl_app()         :: app_name().
--type rel_name()         :: string().
--type rel_vsn()          :: string().
--type boot_rel()         :: rel_name().
--type rel_app()          :: app_name()
-                          | {app_name(), app_type()} 
-                          | {app_name(), [incl_app()]}
-                          | {app_name(), app_type(), [incl_app()]}.
--type mod()              :: {incl_cond, incl_cond()}
-                          | {debug_info, debug_info()}.
--type app()              :: {vsn, app_vsn()}
-                          | {mod, mod_name(), mod()}
-                          | {mod_cond, mod_cond()}
-                          | {incl_cond, incl_cond()}
-                          | {app_file, app_file()}
-                          | {debug_info, debug_info()}
-                          | {incl_app_filters, incl_app_filters()}
-                          | {excl_app_filters, excl_app_filters()}
-                          | {incl_archive_filters, incl_archive_filters()}
-                          | {excl_archive_filters, excl_archive_filters()}.
--type escript()          :: {incl_cond, incl_cond()}.
--type sys()              :: {mod_cond, mod_cond()} 
-                          | {incl_cond, incl_cond()}
-                          | {debug_info, debug_info()}
-                          | {app_file, app_file()}
-                          | {profile, profile()}
-                          | {incl_sys_filters, incl_sys_filters()}
-                          | {excl_sys_filters, excl_sys_filters()}
-                          | {incl_app_filters, incl_app_filters()}
-                          | {excl_app_filters, excl_app_filters()}
-                          | {incl_archive_filters, incl_archive_filters()}
-                          | {excl_archive_filters, excl_archive_filters()}
-                          | {archive_opts, [archive_opt()]}
-                          | {root_dir, root_dir()}
-                          | {lib_dirs, [lib_dir()]}
-                          | {boot_rel, boot_rel()}
-                          | {rel, rel_name(), rel_vsn(), [rel_app()]}
-                          | {relocatable, relocatable()}
-                          | {erts, app()}
-                          | {escript, escript_file(), [escript()]}
-                          | {app, app_name(), [app()]}.
--type config()           :: {sys, [sys()]}.
--type option()           :: {wx_debug, term()} | {trap_exit, boolean()} | config() | {config, config() | file()}.
--type options()          :: [option()].
--type server_pid()       :: pid().
--type window_pid()       :: pid().
--type server()           :: server_pid() | options().
--type rel_file()         :: term().
--type script_file()      :: term().
--type reason()           :: string().
--type escript_arg()      :: string().
-%%-type base_dir()         :: dir().
-%%-type base_file()        :: file().
-%%-type top_dir()          :: file().
-%%-type top_file()         :: file().
-%%-type target_spec()      :: [target_spec()]
-%%                         | {create_dir, base_dir(), [target_spec()]}
-%%                         | {create_dir, base_dir(), top_dir(), [target_spec()]}
-%%                         | {archive, base_file(), [archive_opt()], [target_spec()]}
-%%                         | {copy_file, base_file()}
-%%                         | {copy_file, base_file(), top_file()}
-%%                         | {write_file, base_file(), iolist()}
-%%                         | {strip_beam_file, base_file()}.
--type target_spec()     :: term().
--type target_dir()      :: dir().
--type incl_defaults()   :: boolean().
--type incl_derived()    :: boolean().
+-include("reltool.hrl").
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 %% Main function for escript
--spec main([escript_arg()]) -> ok.   
+-spec main([escript_arg()]) -> ok.
 main(_) ->
     process_flag(trap_exit, true),
     {ok, WinPid} = start_link([]),
@@ -164,7 +74,7 @@ start_link(Options) when is_list(Options) ->
             {ok, WinPid};
         {error, Reason} ->
             {error, lists:flatten(io_lib:format("~p", [Reason]))}
-    end.        
+    end.
 
 %% Start server process with options
 -spec start_server(options()) -> {ok, server_pid()} | {error, reason()}.
@@ -200,7 +110,8 @@ stop(Pid) when is_pid(Pid) ->
     end.
 
 %% Internal library function
--spec eval_server(server(), fun((server_pid()) -> term())) -> {ok, server_pid()} | {error, reason()}.
+-spec eval_server(server(), fun((server_pid()) -> term())) ->
+ {ok, server_pid()} | {error, reason()}.
 eval_server(Pid, Fun) when is_pid(Pid) ->
     Fun(Pid);
 eval_server(Options, Fun) when is_list(Options), is_function(Fun, 1) ->
@@ -212,39 +123,54 @@ eval_server(Options, Fun) when is_list(Options), is_function(Fun, 1) ->
         {error, Reason} ->
             {error, Reason}
     end.
-    
+
 %% Get reltool configuration
 -spec get_config(server()) -> {ok, config()} | {error, reason()}.
 get_config(PidOrOption) ->
     get_config(PidOrOption, false, false).
 
--spec get_config(server(), incl_defaults(), incl_derived()) -> {ok, config()} | {error, reason()}.
-get_config(PidOrOptions, InclDefaults, InclDerived) when is_pid(PidOrOptions); is_list(PidOrOptions) ->
-    eval_server(PidOrOptions, fun(Pid) -> reltool_server:get_config(Pid, InclDefaults, InclDerived) end).
+-spec get_config(server(), incl_defaults(), incl_derived()) ->
+			{ok, config()} | {error, reason()}.
+get_config(PidOrOptions, InclDef, InclDeriv)
+  when is_pid(PidOrOptions); is_list(PidOrOptions) ->
+    eval_server(PidOrOptions,
+		fun(Pid) ->
+			reltool_server:get_config(Pid, InclDef, InclDeriv)
+		end).
 
 %% Get contents of release file
 -spec get_rel(server(), rel_name()) -> {ok, rel_file()} | {error, reason()}.
-get_rel(PidOrOptions, RelName) when is_pid(PidOrOptions); is_list(PidOrOptions) ->
-    eval_server(PidOrOptions, fun(Pid) -> reltool_server:get_rel(Pid, RelName) end).
+get_rel(PidOrOptions, RelName)
+  when is_pid(PidOrOptions); is_list(PidOrOptions) ->
+    eval_server(PidOrOptions,
+		fun(Pid) -> reltool_server:get_rel(Pid, RelName) end).
 
 %% Get contents of boot script file
--spec get_script(server(), rel_name()) -> {ok, script_file()} | {error, reason()}.
-get_script(PidOrOptions, RelName) when is_pid(PidOrOptions); is_list(PidOrOptions) ->
-   eval_server(PidOrOptions, fun(Pid) ->  reltool_server:get_script(Pid, RelName) end).
+-spec get_script(server(), rel_name()) ->
+			{ok, script_file()} | {error, reason()}.
+get_script(PidOrOptions, RelName)
+  when is_pid(PidOrOptions); is_list(PidOrOptions) ->
+   eval_server(PidOrOptions,
+	       fun(Pid) -> reltool_server:get_script(Pid, RelName) end).
 
 %% Generate a target system
 -spec create_target(server(), target_dir()) -> ok | {error, reason()}.
-create_target(PidOrOptions, TargetDir) when is_pid(PidOrOptions); is_list(PidOrOptions) ->
-    eval_server(PidOrOptions, fun(Pid) -> reltool_server:gen_target(Pid, TargetDir) end).
+create_target(PidOrOptions, TargetDir)
+  when is_pid(PidOrOptions); is_list(PidOrOptions) ->
+    eval_server(PidOrOptions,
+		fun(Pid) -> reltool_server:gen_target(Pid, TargetDir) end).
 
 %% Generate a target system
 -spec get_target_spec(server()) -> {ok, target_spec()} | {error, reason()}.
-get_target_spec(PidOrOptions) when is_pid(PidOrOptions); is_list(PidOrOptions) ->
+get_target_spec(PidOrOptions)
+  when is_pid(PidOrOptions); is_list(PidOrOptions) ->
     eval_server(PidOrOptions, fun(Pid) -> reltool_server:gen_spec(Pid) end).
 
 %% Generate a target system
--spec eval_target_spec(target_spec(), root_dir(), target_dir()) -> ok | {error, reason()}.
-eval_target_spec(Spec, SourceDir, TargetDir) when is_list(SourceDir), is_list(TargetDir) ->
+-spec eval_target_spec(target_spec(), root_dir(), target_dir()) ->
+			      ok | {error, reason()}.
+eval_target_spec(Spec, SourceDir, TargetDir)
+  when is_list(SourceDir), is_list(TargetDir) ->
     reltool_target:eval_spec(Spec, SourceDir, TargetDir).
 
 %% Install a target system