Add a --fullpath option to Dialyzer

This change adds a --fullpath option to Dialyzer, which makes the
warning messages contain the full path of the corresponding file.

Original patch submitted by Magnus Henoch (legoscia) on 15/9/2010
and cooked to death in the 'pu' branch all this time.

The patch was essentially correct and most of it has been used as
is, but there have been some changes to make the code slightly
prettier, avoid some code duplication, and add documentation to
dialyzer's doc files and to its help message.

5 files changed, 54 insertions, 20 deletions

diff --git a/lib/dialyzer/src/dialyzer.erl b/lib/dialyzer/src/dialyzer.erl
index 471f9fccd2..f4b3cff19c 100644
--- a/lib/dialyzer/src/dialyzer.erl
+++ b/lib/dialyzer/src/dialyzer.erl
@@ -2,7 +2,7 @@
 %%-----------------------------------------------------------------------
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 2006-2010. All Rights Reserved.
+%% Copyright Ericsson AB 2006-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
@@ -38,7 +38,8 @@
 	 gui/0,
 	 gui/1,
 	 plt_info/1,
-	 format_warning/1]).
+	 format_warning/1,
+	 format_warning/2]).
 
 -include("dialyzer.hrl").
 
@@ -48,6 +49,8 @@
 %%  - run/1:            Erlang interface for a command line-like analysis
 %%  - gui/0/1:          Erlang interface for the gui.
 %%  - format_warning/1: Get the string representation of a warning.
+%%  - format_warning/1: Likewise, but with an option whether
+%%			to display full path names or not
 %%  - plt_info/1:       Get information of the specified plt.
 %%--------------------------------------------------------------------
 
@@ -281,11 +284,19 @@ cl_check_log(Output) ->
 
 -spec format_warning(dial_warning()) -> string().
 
-format_warning({_Tag, {File, Line}, Msg}) when is_list(File),
-					       is_integer(Line) ->
-  BaseName = filename:basename(File),
+format_warning(W) ->
+  format_warning(W, basename).
+
+-spec format_warning(dial_warning(), fopt()) -> string().
+
+format_warning({_Tag, {File, Line}, Msg}, FOpt) when is_list(File),
+						     is_integer(Line) ->
+  F = case FOpt of
+	fullpath -> File;
+	basename -> filename:basename(File)
+      end,
   String = lists:flatten(message_to_string(Msg)),
-  lists:flatten(io_lib:format("~s:~w: ~s", [BaseName, Line, String])).
+  lists:flatten(io_lib:format("~s:~w: ~s", [F, Line, String])).
 
 
 %%-----------------------------------------------------------------------------
diff --git a/lib/dialyzer/src/dialyzer.hrl b/lib/dialyzer/src/dialyzer.hrl
index 1d98574585..aa3f703af2 100644
--- a/lib/dialyzer/src/dialyzer.hrl
+++ b/lib/dialyzer/src/dialyzer.hrl
@@ -2,7 +2,7 @@
 %%%
 %%% %CopyrightBegin%
 %%%
-%%% Copyright Ericsson AB 2006-2010. All Rights Reserved.
+%%% Copyright Ericsson AB 2006-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
@@ -31,7 +31,7 @@
 -define(RET_DISCREPANCIES, 2).
 
 -type dial_ret() :: ?RET_NOTHING_SUSPICIOUS
-                  | ?RET_INTERNAL_ERROR 
+                  | ?RET_INTERNAL_ERROR
                   | ?RET_DISCREPANCIES.
 
 %%--------------------------------------------------------------------
@@ -87,7 +87,7 @@
 %%--------------------------------------------------------------------
 %% THIS TYPE SHOULD ONE DAY DISAPPEAR -- IT DOES NOT BELONG HERE
 %%--------------------------------------------------------------------
- 
+
 -type ordset(T)      :: [T] .      %% XXX: temporarily
 
 %%--------------------------------------------------------------------
@@ -102,6 +102,8 @@
 -type dial_define()   :: {atom(), term()}.
 -type dial_option()   :: {atom(), term()}.
 -type dial_options()  :: [dial_option()].
+-type fopt()          :: 'basename' | 'fullpath'.
+-type format()        :: 'formatted' | 'raw'.
 -type label()	      :: non_neg_integer().
 -type rep_mode()      :: 'quiet' | 'normal' | 'verbose'.
 -type start_from()    :: 'byte_code' | 'src_code'.
@@ -137,10 +139,10 @@
 		  erlang_mode     = false	   :: boolean(),
 		  use_contracts   = true           :: boolean(),
 		  output_file     = none	   :: 'none' | file:filename(),
-		  output_format   = formatted      :: 'raw' | 'formatted',
+		  output_format   = formatted      :: format(),
+		  filename_opt	  = basename       :: fopt(),
 		  callgraph_file  = ""             :: file:filename(),
-		  check_plt       = true           :: boolean()
-		 }).
+		  check_plt       = true           :: boolean()}).
 
 -record(contract, {contracts	  = []		   :: [contract_pair()],
 		   args		  = []		   :: [erl_types:erl_type()],
diff --git a/lib/dialyzer/src/dialyzer_cl.erl b/lib/dialyzer/src/dialyzer_cl.erl
index 1987c1732c..86f1ba4696 100644
--- a/lib/dialyzer/src/dialyzer_cl.erl
+++ b/lib/dialyzer/src/dialyzer_cl.erl
@@ -2,7 +2,7 @@
 %%-------------------------------------------------------------------
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 2006-2010. All Rights Reserved.
+%% Copyright Ericsson AB 2006-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
@@ -46,7 +46,8 @@
 	 legal_warnings  = ordsets:new()  :: [dial_warn_tag()],
 	 mod_deps        = dict:new()     :: dict(),
 	 output          = standard_io	  :: io:device(),
-	 output_format   = formatted      :: 'raw' | 'formatted',
+	 output_format   = formatted      :: format(),
+	 filename_opt    = basename       :: fopt(),
 	 output_plt      = none           :: 'none' | file:filename(),
 	 plt_info        = none           :: 'none' | dialyzer_plt:plt_info(),
 	 report_mode     = normal         :: rep_mode(),
@@ -532,8 +533,10 @@ hc(Mod) ->
 new_state() ->
   #cl_state{}.
 
-init_output(State0, #options{output_file = OutFile, output_format = OutFormat}) ->
-  State = State0#cl_state{output_format = OutFormat},
+init_output(State0, #options{output_file = OutFile,
+			     output_format = OutFormat,
+			     filename_opt = FOpt}) ->
+  State = State0#cl_state{output_format = OutFormat, filename_opt = FOpt},
   case OutFile =:= none of
     true ->
       State;
@@ -766,6 +769,7 @@ print_warnings(#cl_state{stored_warnings = []}) ->
   ok;
 print_warnings(#cl_state{output = Output,
 			 output_format = Format,
+			 filename_opt = FOpt,
 			 stored_warnings = Warnings}) ->
   PrWarnings = process_warnings(Warnings),
   case PrWarnings of
@@ -773,7 +777,7 @@ print_warnings(#cl_state{output = Output,
     [_|_] ->
       S = case Format of
 	    formatted ->
-	      [dialyzer:format_warning(W) || W <- PrWarnings];
+	      [dialyzer:format_warning(W, FOpt) || W <- PrWarnings];
 	    raw ->
 	      [io_lib:format("~p. \n", [W]) || W <- PrWarnings]
 	  end,
diff --git a/lib/dialyzer/src/dialyzer_cl_parse.erl b/lib/dialyzer/src/dialyzer_cl_parse.erl
index 5ca7599b35..f9baf36822 100644
--- a/lib/dialyzer/src/dialyzer_cl_parse.erl
+++ b/lib/dialyzer/src/dialyzer_cl_parse.erl
@@ -2,7 +2,7 @@
 %%-----------------------------------------------------------------------
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 2006-2010. All Rights Reserved.
+%% Copyright Ericsson AB 2006-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
@@ -133,6 +133,9 @@ cl(["-o"++Output|T]) ->
 cl(["--raw"|T]) ->
   put(dialyzer_output_format, raw),
   cl(T);
+cl(["--fullpath"|T]) ->
+  put(dialyzer_filename_opt, fullpath),
+  cl(T);
 cl(["-pa", Path|T]) ->
   case code:add_patha(Path) of
     true -> cl(T);
@@ -243,6 +246,7 @@ init() ->
   put(dialyzer_options_defines,   DefaultOpts#options.defines),
   put(dialyzer_options_files,     DefaultOpts#options.files),
   put(dialyzer_output_format,     formatted),
+  put(dialyzer_filename_opt,      basename),
   put(dialyzer_options_check_plt, DefaultOpts#options.check_plt),
   ok.
 
@@ -281,6 +285,7 @@ cl_options() ->
    {files_rec, get(dialyzer_options_files_rec)},
    {output_file, get(dialyzer_output)},
    {output_format, get(dialyzer_output_format)},
+   {filename_opt, get(dialyzer_filename_opt)},
    {analysis_type, get(dialyzer_options_analysis_type)},
    {get_warnings, get(dialyzer_options_get_warnings)},
    {callgraph_file, get(dialyzer_callgraph_file)}
@@ -335,7 +340,7 @@ help_message() ->
                 [--apps applications] [-o outfile]
 		[--build_plt] [--add_to_plt] [--remove_from_plt]
 		[--check_plt] [--no_check_plt] [--plt_info] [--get_warnings]
-                [--no_native]
+                [--no_native] [--fullpath]
 Options:
   files_or_dirs (for backwards compatibility also as: -c files_or_dirs)
       Use Dialyzer from the command line to detect defects in the
@@ -437,6 +442,8 @@ Options:
       Bypass the native code compilation of some key files that Dialyzer
       heuristically performs when dialyzing many files; this avoids the
       compilation time but it may result in (much) longer analysis time.
+  --fullpath
+      Display the full path names of files for which warnings are emitted.
   --gui
       Use the gs-based GUI.
   --wx
diff --git a/lib/dialyzer/src/dialyzer_options.erl b/lib/dialyzer/src/dialyzer_options.erl
index 2c0afa6e2b..b5cefd16ca 100644
--- a/lib/dialyzer/src/dialyzer_options.erl
+++ b/lib/dialyzer/src/dialyzer_options.erl
@@ -2,7 +2,7 @@
 %%-----------------------------------------------------------------------
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 2006-2010. All Rights Reserved.
+%% Copyright Ericsson AB 2006-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
@@ -169,6 +169,9 @@ build_options([{OptionName, Value} = Term|Rest], Options) ->
     output_format ->
       assert_output_format(Value),
       build_options(Rest, Options#options{output_format = Value});
+    filename_opt ->
+      assert_filename_opt(Value),
+      build_options(Rest, Options#options{filename_opt = Value});
     output_plt ->
       assert_filename(Value),
       build_options(Rest, Options#options{output_plt = Value});
@@ -218,6 +221,13 @@ assert_output_format(formatted) ->
 assert_output_format(Term) ->
   bad_option("Illegal value for output_format", Term).
 
+assert_filename_opt(basename) ->
+  ok;
+assert_filename_opt(fullpath) ->
+  ok;
+assert_filename_opt(Term) ->
+  bad_option("Illegal value for filename_opt", Term).
+
 assert_plt_op(#options{analysis_type = OldVal}, 
 	      #options{analysis_type = NewVal}) ->
   case is_plt_mode(OldVal) andalso is_plt_mode(NewVal) of