maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

Code modification hints have been known as fix-it hints for almost 

a year now.  Update the internals manual.

llvm-svn: 127983
This commit is contained in:
Peter Collingbourne 2011-03-21 01:45:18 +00:00
parent 8e15a661bf
commit e4c02400ad
1 changed files with 25 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
clang/docs/InternalsManual.html
View File

@ -412,7 +412,7 @@ it is rendered.
</p> </p>
<!-- ==================================================== --> <!-- ==================================================== -->
<h4 id="code-modification-hints">Code Modification Hints</h4> <h4 id="fix-it-hints">Fix-It Hints</h4>
<!-- ==================================================== --> <!-- ==================================================== -->
<p>In some cases, the front end emits diagnostics when it is clear <p>In some cases, the front end emits diagnostics when it is clear
@ -423,13 +423,13 @@ Clang tries very hard to emit the diagnostic and recover gracefully
in these and other cases.</p> in these and other cases.</p>
<p>However, for these cases where the fix is obvious, the diagnostic <p>However, for these cases where the fix is obvious, the diagnostic
can be annotated with a code can be annotated with a hint (referred to as a "fix-it hint") that
modification "hint" that describes how to change the code referenced describes how to change the code referenced by the diagnostic to fix
by the diagnostic to fix the problem. For example, it might add the the problem. For example, it might add the missing semicolon at the
missing semicolon at the end of the statement or rewrite the use of a end of the statement or rewrite the use of a deprecated construct
deprecated construct into something more palatable. Here is one such into something more palatable. Here is one such example from the C++
example C++ front end, where we warn about the right-shift operator front end, where we warn about the right-shift operator changing
changing meaning from C++98 to C++0x:</p> meaning from C++98 to C++0x:</p>
<pre> <pre>
test.cpp:3:7: warning: use of right-shift operator ('&gt;&gt;') in template argument will require parentheses in C++0x test.cpp:3:7: warning: use of right-shift operator ('&gt;&gt;') in template argument will require parentheses in C++0x
@ -438,33 +438,31 @@ A&lt;100 &gt;&gt; 2&gt; *a;
( ) ( )
</pre> </pre>
<p>Here, the code modification hint is suggesting that parentheses be <p>Here, the fix-it hint is suggesting that parentheses be added,
added, and showing exactly where those parentheses would be inserted and showing exactly where those parentheses would be inserted into the
into the source code. The code modification hints themselves describe source code. The fix-it hints themselves describe what changes to make
what changes to make to the source code in an abstract manner, which to the source code in an abstract manner, which the text diagnostic
the text diagnostic printer renders as a line of "insertions" below printer renders as a line of "insertions" below the caret line. <a
the caret line. <a href="#DiagnosticClient">Other diagnostic href="#DiagnosticClient">Other diagnostic clients</a> might choose
clients</a> might choose to render the code differently (e.g., as to render the code differently (e.g., as markup inline) or even give
markup inline) or even give the user the ability to automatically fix the user the ability to automatically fix the problem.</p>
the problem.</p>
<p>All code modification hints are described by the <p>All fix-it hints are described by the <code>FixItHint</code> class,
<code>CodeModificationHint</code> class, instances of which should be instances of which should be attached to the diagnostic using the
attached to the diagnostic using the &lt;&lt; operator in the same way &lt;&lt; operator in the same way that highlighted source ranges and
that highlighted source ranges and arguments are passed to the arguments are passed to the diagnostic. Fix-it hints can be created
diagnostic. Code modification hints can be created with one of three with one of three constructors:</p>
constructors:</p>
<dl> <dl>
<dt><code>CodeModificationHint::CreateInsertion(Loc, Code)</code></dt> <dt><code>FixItHint::CreateInsertion(Loc, Code)</code></dt>
<dd>Specifies that the given <code>Code</code> (a string) should be inserted <dd>Specifies that the given <code>Code</code> (a string) should be inserted
before the source location <code>Loc</code>.</dd> before the source location <code>Loc</code>.</dd>
<dt><code>CodeModificationHint::CreateRemoval(Range)</code></dt> <dt><code>FixItHint::CreateRemoval(Range)</code></dt>
<dd>Specifies that the code in the given source <code>Range</code> <dd>Specifies that the code in the given source <code>Range</code>
should be removed.</dd> should be removed.</dd>
<dt><code>CodeModificationHint::CreateReplacement(Range, Code)</code></dt> <dt><code>FixItHint::CreateReplacement(Range, Code)</code></dt>
<dd>Specifies that the code in the given source <code>Range</code> <dd>Specifies that the code in the given source <code>Range</code>
should be removed, and replaced with the given <code>Code</code> string.</dd> should be removed, and replaced with the given <code>Code</code> string.</dd>
</dl> </dl>