Merge branch 'nox/compile-column-numbers' into pu

erlang · Oct 11, 2012 · 98bf395 · 98bf395
2 parents e06c4cc + e869e22
commit 98bf395
Show file tree

Hide file tree

Showing 19 changed files with 1,127 additions and 940 deletions.
diff --git a/erts/doc/src/absform.xml b/erts/doc/src/absform.xml
diff --git a/lib/compiler/doc/src/compile.xml b/lib/compiler/doc/src/compile.xml
@@ -108,6 +108,11 @@
 	    See the <em>Efficiency Guide</em> for further information.</p>
           </item>
 
+          <tag><c>column</c></tag>
+          <item>
+            <p>The compiler will keep the column numbers while parsing.</p>
+          </item>
+
           <tag><c>compressed</c></tag>
           <item>
             <p>The compiler will compress the generated object code,
@@ -823,23 +828,6 @@ pi() -> 3.1416.
       code is then transformed into other Erlang code.</p>
   </section>
 
-  <section>
-    <title>Error Information</title>
-
-    <p>The <c>ErrorInfo</c> mentioned above is the standard
-      <c>ErrorInfo</c> structure which is returned from all IO modules.
-      It has the following format:</p>
-    <code>
-{ErrorLine, Module, ErrorDescriptor}
-    </code>
-
-    <p>A string describing the error is obtained with the following
-      call:</p>
-    <code>
-Module:format_error(ErrorDescriptor)
-    </code>
-  </section>
-
   <section>
     <title>See Also</title>
     <p>

diff --git a/lib/compiler/src/compile.erl b/lib/compiler/src/compile.erl
@@ -41,7 +41,7 @@
 
 -type option() :: atom() | {atom(), term()} | {'d', atom(), term()}.
 
--type err_info() :: {erl_scan:line(), module(), term()}. %% ErrorDescriptor
+-type err_info() :: erl_scan:error_info(). %% ErrorDescriptor
 -type errors()   :: [{file:filename(), [err_info()]}].
 -type warnings() :: [{file:filename(), [err_info()]}].
 -type mod_ret()  :: {'ok', module()}
@@ -773,7 +773,8 @@ parse_module(St) ->
     Opts = St#compile.options,
     Cwd = ".",
     IncludePath = [Cwd, St#compile.dir|inc_paths(Opts)],
-    R =  epp:parse_file(St#compile.ifile, IncludePath, pre_defs(Opts)),
+    AtPos = initial_position(Opts),
+    R =  epp:parse_file(St#compile.ifile, AtPos, IncludePath, pre_defs(Opts)),
     case R of
 	{ok,Forms} ->
 	    {ok,St#compile{code=Forms}};
@@ -1486,6 +1487,12 @@ objfile(Base, St) ->
 tmpfile(Ofile) ->
     reverse([$#|tl(reverse(Ofile))]).
 
+initial_position(Opts) ->
+    case lists:member(column, Opts) of
+        true -> {1, 1};
+        false -> 1
+    end.
+
 %% pre_defs(Options)
 %% inc_paths(Options)
 %%  Extract the predefined macros and include paths from the option list.

diff --git a/lib/compiler/src/v3_core.erl b/lib/compiler/src/v3_core.erl
@@ -2158,6 +2158,10 @@ format_error(nomatch) ->
 format_error(bad_binary) ->
     "binary construction will fail because of a type mismatch".
 
-add_warning(Line, Term, #core{ws=Ws,file=[{file,File}]}=St) when Line >= 0 ->
+add_warning({Line,_}=Loc, Term, #core{ws=Ws,file=[{file,File}]}=St)
+		   when Line >= 0 ->
+    St#core{ws=[{File,[{location(Loc),?MODULE,Term}]}|Ws]};
+add_warning(Line, Term, #core{ws=Ws,file=[{file,File}]}=St)
+		   when is_integer(Line), Line >= 0 ->
     St#core{ws=[{File,[{location(Line),?MODULE,Term}]}|Ws]};
 add_warning(_, _, St) -> St.
diff --git a/lib/compiler/test/error_SUITE.erl b/lib/compiler/test/error_SUITE.erl
@@ -22,13 +22,15 @@
 
 -export([all/0, suite/0,groups/0,init_per_suite/1, end_per_suite/1, 
 	 init_per_group/2,end_per_group/2,
-	 head_mismatch_line/1,warnings_as_errors/1, bif_clashes/1]).
+	 head_mismatch_line/1,warnings_as_errors/1, bif_clashes/1,
+	 column_number/1
+   ]).
 
 suite() -> [{ct_hooks,[ts_install_cth]}].
 
 all() -> 
     test_lib:recompile(?MODULE),
-    [head_mismatch_line, warnings_as_errors, bif_clashes].
+    [head_mismatch_line, warnings_as_errors, bif_clashes, column_number].
 
 groups() -> 
     [].
@@ -166,6 +168,15 @@ bif_clashes(Config) when is_list(Config) ->
 
 
 
+%% Tests that messages are correctly reported with column numbers
+%% if the column option is set.
+column_number(Config) when is_list(Config) ->
+    Ts1 = [{column_number_warning,
+	   <<"\nt(X) -> ok.">>,
+	   [return_warnings, export_all, column],
+	   {warning, [{{2, 3}, erl_lint, {unused_var, 'X'}}]}}],
+    ?line [] = run(Config, Ts1),
+    ok.
 
 %% Tests that a head mismatch is reported on the correct line (OTP-2125).
 head_mismatch_line(Config) when is_list(Config) ->

diff --git a/lib/stdlib/doc/src/epp.xml b/lib/stdlib/doc/src/epp.xml
@@ -51,6 +51,7 @@
     <func>
       <name name="open" arity="2"/>
       <name name="open" arity="3"/>
+      <name name="open" arity="4"/>
       <fsummary>Open a file for preprocessing</fsummary>
       <desc>
         <p>Opens a file for preprocessing.</p>
@@ -68,17 +69,18 @@
       <fsummary>Return the next Erlang form from the opened Erlang source file</fsummary>
       <desc>
         <p>Returns the next Erlang form from the opened Erlang source file.
-          The tuple <c>{eof, <anno>Line</anno>}</c> is returned at end-of-file. The first
+          The tuple <c>{eof, <anno>Loc</anno>}</c> is returned at end-of-file. The first
           form corresponds to an implicit attribute <c>-file(File,1).</c>, where
           <c>File</c> is the name of the file.</p>
       </desc>
     </func>
     <func>
       <name name="parse_file" arity="3"/>
+      <name name="parse_file" arity="4"/>
       <fsummary>Preprocess and parse an Erlang source file</fsummary>
       <desc>
         <p>Preprocesses and parses an Erlang source file.
-          Note that the tuple <c>{eof, <anno>Line</anno>}</c> returned at end-of-file is
+          Note that the tuple <c>{eof, <anno>Loc</anno>}</c> returned at end-of-file is
           included as a "form".</p>
       </desc>
     </func>

diff --git a/lib/stdlib/doc/src/erl_lint.xml b/lib/stdlib/doc/src/erl_lint.xml
@@ -60,14 +60,6 @@
       functions separately unless you have written your own Erlang
       compiler.</p>
   </description>
-  <datatypes>
-    <datatype>
-      <name name="error_info"/>
-    </datatype>
-    <datatype>
-      <name name="error_description"/>
-    </datatype>
-  </datatypes>
   <funcs>
     <func>
       <name name="module" arity="1"/>
@@ -125,29 +117,17 @@
         <p>Takes an <c><anno>ErrorDescriptor</anno></c> and returns a string which
           describes the error or warning. This function is usually
           called implicitly when processing an <c>ErrorInfo</c>
-          structure (see below).</p>
+          structure (see
+          <seealso marker="erl_scan#error_information">erl_scan(3)</seealso>).
+        </p>
       </desc>
     </func>
   </funcs>
 
-  <section>
-    <title>Error Information</title>
-    <p>The <c>ErrorInfo</c> mentioned above is the standard
-      <c>ErrorInfo</c> structure which is returned from all IO
-      modules. It has the following format:
-      </p>
-    <code type="none">
-    {ErrorLine, Module, ErrorDescriptor}    </code>
-    <p>A string which describes the error is obtained with the following call:
-      </p>
-    <code type="none">
-    Module:format_error(ErrorDescriptor)    </code>
-  </section>
-
   <section>
     <title>See Also</title>
     <p><seealso marker="erl_parse">erl_parse(3)</seealso>,
-      <seealso marker="epp">epp(3)</seealso></p>
+      <seealso marker="epp">epp(3)</seealso>, <seealso marker="erl_scan">erl_scan(3)</seealso></p>
   </section>
 </erlref>
 
diff --git a/lib/stdlib/doc/src/erl_parse.xml b/lib/stdlib/doc/src/erl_parse.xml
@@ -57,12 +57,6 @@
       <desc><p>Parse tree for Erlang form.</p>
       </desc>
     </datatype>
-    <datatype>
-      <name name="error_description"></name>
-    </datatype>
-    <datatype>
-      <name name="error_info"></name>
-    </datatype>
     <datatype>
       <name name="token"></name>
     </datatype>
@@ -130,14 +124,16 @@
       <fsummary>Format an error descriptor</fsummary>
       <type>
         <v>ErrorDescriptor = <seealso
-          marker="#type-error_info">error_description()</seealso></v>
+          marker="erl_scan#type-error_description">erl_scan:error_description()</seealso></v>
         <v>Chars = [char() | Chars]</v>
       </type>
       <desc>
         <p>Uses an <c>ErrorDescriptor</c> and returns a string
           which describes the error. This function is usually called
           implicitly when an <c>ErrorInfo</c> structure is processed
-          (see below).</p>
+          (see
+          <seealso marker="erl_scan#error_information">erl_scan(3)</seealso>).
+        </p>
       </desc>
     </func>
     <func>
@@ -171,20 +167,6 @@
     </func>
   </funcs>
 
-  <section>
-    <title>Error Information</title>
-    <p>The <c>ErrorInfo</c> mentioned above is the standard
-      <c>ErrorInfo</c> structure which is returned from all IO
-      modules. It has the format:
-      </p>
-    <code type="none">
-    {ErrorLine, Module, ErrorDescriptor}    </code>
-    <p>A string which describes the error is obtained with the following call:
-      </p>
-    <code type="none">
-    Module:format_error(ErrorDescriptor)    </code>
-  </section>
-
   <section>
     <title>See Also</title>
     <p><seealso marker="io">io(3)</seealso>,

diff --git a/lib/stdlib/doc/src/erl_scan.xml b/lib/stdlib/doc/src/erl_scan.xml
@@ -284,6 +284,9 @@
             column()</seealso>}</c></tag>
           <item><p>The column where the token begins.</p>
           </item>
+          <tag><c>{file, string()}</c></tag>
+          <item><p>The file in which the token is.</p>
+          </item>
           <tag><c>{length, integer() > 0}</c></tag>
           <item><p>The length of the token's text.</p>
           </item>
@@ -351,6 +354,9 @@
             column()</seealso>}</c></tag>
           <item><p>The column where the token begins.</p>
           </item>
+          <tag><c>{file, string()}</c></tag>
+          <item><p>The file in which the token is.</p>
+          </item>
           <tag><c>{length, integer() > 0}</c></tag>
           <item><p>The length of the token's text.</p>
           </item>
@@ -373,11 +379,14 @@
       <name name="set_attribute" arity="3"/>
       <fsummary>Set a token attribute value</fsummary>
       <desc>
-        <p>Sets the value of the <c>line</c> attribute of the token
+        <p>Sets the value of the <c>line</c> or <c>file</c> attribute of the
-          attributes <c><anno>Attributes</anno></c>.</p>
+          token attributes <c><anno>Attributes</anno></c>.</p>
         <p>The <c><anno>SetAttributeFun</anno></c> is called with the value of
-          the <c>line</c> attribute, and is to return the new value of
+          the <c>line</c> or <c>file</c> attribute, and is to return its new
-          the <c>line</c> attribute.</p>
+          value.</p>
+        <p>When setting the value of the <c>file</c> attribute,
+          <c><anno>SetAttributeFun</anno></c> may be given or return
+          <c>undefined</c> as an absence of value.</p>
       </desc>
     </func>
     <func>
@@ -394,6 +403,7 @@
   </funcs>
 
   <section>
+    <marker id="error_information"/>
     <title>Error Information</title>
     <p>The <c>ErrorInfo</c> mentioned above is the standard
       <c>ErrorInfo</c> structure which is returned from all IO