diff options
Diffstat (limited to 'api/dotty/tools/dotc/printing/Formatting$.html')
| -rw-r--r-- | api/dotty/tools/dotc/printing/Formatting$.html | 307 |
1 files changed, 290 insertions, 17 deletions
diff --git a/api/dotty/tools/dotc/printing/Formatting$.html b/api/dotty/tools/dotc/printing/Formatting$.html index 7ed749bc9..9f4c9afe6 100644 --- a/api/dotty/tools/dotc/printing/Formatting$.html +++ b/api/dotty/tools/dotc/printing/Formatting$.html @@ -5321,6 +5321,9 @@ <div id="entity-container"> <div id="entity-title"> + <span id="entity-annotations"> + + </span> <span id="entity-modifiers"> final </span> @@ -5330,16 +5333,29 @@ <span id="entity-name"> Formatting </span> + + </div> - <h1 class="section ">Members</h1> + <h1 class="section empty"> + Constructors + </h1> + + <div id="entity-constructors" class="entity-section empty"> + + </div> + + <h1 class="section "> + Members + </h1> <div id="entity-members" class="entity-section "> <div id="ErrorMessageFormatter" class="member "> <div class="member-title"> + <span class="expand-button" onclick="toggleMemberBody(this, 'ErrorMessageFormatter');">[+]</span> <span class="member-annotations"> </span> @@ -5363,16 +5379,39 @@ </div><!-- end member-title --> <div class="member-body"> - <p>The <code>em</code> string interpolator works like the <code>i</code> string interpolator, but marks nonsensical errors + <div class="member-body-short" id="short-body-ErrorMessageFormatter"> + <p>The <code>em</code> string interpolator works like the <code>i</code> string interpolator, but marks nonsensical errors using <code><nonsensical>...</nonsensical></code> tags. Note: Instead o... </p> + </div> + <div class="member-body-long" id ="long-body-ErrorMessageFormatter"> + <p>The <code>em</code> string interpolator works like the <code>i</code> string interpolator, but marks nonsensical errors +using <code><nonsensical>...</nonsensical></code> tags. +Note: Instead of these tags, it would be nicer to return a data structure containing the message string +and a boolean indicating whether the message is sensical, but then we cannot use string operations +like concatenation, stripMargin etc on the values returned by em"...", and in the current error +message composition methods, this is crucial.</p> + + </div> </div> + <script> + function toggleMemberBody(span, sig) { + var shortBody = document.getElementById("short-body-" + sig); + var longBody = document.getElementById("long-body-" + sig); + + shortBody.classList.toggle("toggled") + longBody.classList.toggle("toggled") + + span.innerHTML = (span.innerHTML == "[+]") ? "[-]" : "[+]"; + } + </script> </div><!-- end member --> <div id="ExplainingPrinter" class="member private"> <div class="member-title"> + <span class="expand-button" onclick="toggleMemberBody(this, 'ExplainingPrinter');">[+]</span> <span class="member-annotations"> </span> @@ -5396,12 +5435,29 @@ Note: Instead o... </div><!-- end member-title --> <div class="member-body"> - + <div class="member-body-short" id="short-body-ExplainingPrinter"> + + </div> + <div class="member-body-long" id ="long-body-ExplainingPrinter"> + + </div> </div> + <script> + function toggleMemberBody(span, sig) { + var shortBody = document.getElementById("short-body-" + sig); + var longBody = document.getElementById("long-body-" + sig); + + shortBody.classList.toggle("toggled") + longBody.classList.toggle("toggled") + + span.innerHTML = (span.innerHTML == "[+]") ? "[-]" : "[+]"; + } + </script> </div><!-- end member --> <div id="Seen" class="member private"> <div class="member-title"> + <span class="expand-button" onclick="toggleMemberBody(this, 'Seen');">[+]</span> <span class="member-annotations"> </span> @@ -5425,12 +5481,29 @@ Note: Instead o... </div><!-- end member-title --> <div class="member-body"> - + <div class="member-body-short" id="short-body-Seen"> + + </div> + <div class="member-body-long" id ="long-body-Seen"> + + </div> </div> + <script> + function toggleMemberBody(span, sig) { + var shortBody = document.getElementById("short-body-" + sig); + var longBody = document.getElementById("long-body-" + sig); + + shortBody.classList.toggle("toggled") + longBody.classList.toggle("toggled") + + span.innerHTML = (span.innerHTML == "[+]") ? "[-]" : "[+]"; + } + </script> </div><!-- end member --> <div id="StringFormatter" class="member "> <div class="member-title"> + <span class="expand-button" onclick="toggleMemberBody(this, 'StringFormatter');">[+]</span> <span class="member-annotations"> </span> @@ -5454,17 +5527,42 @@ Note: Instead o... </div><!-- end member-title --> <div class="member-body"> - <p>General purpose string formatter, with the following features:</p> + <div class="member-body-short" id="short-body-StringFormatter"> + <p>General purpose string formatter, with the following features:</p> <p>1) On all Showables, <code>show</code> is called instead of <code>toString</code> 2) Exceptions raised by a <code>show</code> ar... <em></em> </p> + </div> + <div class="member-body-long" id ="long-body-StringFormatter"> + <p>General purpose string formatter, with the following features:</p> +<p>1) On all Showables, <code>show</code> is called instead of <code>toString</code> +2) Exceptions raised by a <code>show</code> are handled by falling back to <code>toString</code>. +3) Sequences can be formatted using the desired separator between two <code>%</code> signs, +eg <code>i"myList = (${myList}%, %)"</code> +4) Safe handling of multi-line margins. Left margins are skipped om the parts +of the string context <em>before</em> inserting the arguments. That way, we guard +against accidentally treating an interpolated value as a margin.</p> + + </div> </div> + <script> + function toggleMemberBody(span, sig) { + var shortBody = document.getElementById("short-body-" + sig); + var longBody = document.getElementById("long-body-" + sig); + + shortBody.classList.toggle("toggled") + longBody.classList.toggle("toggled") + + span.innerHTML = (span.innerHTML == "[+]") ? "[-]" : "[+]"; + } + </script> </div><!-- end member --> <div id="SyntaxFormatter" class="member "> <div class="member-title"> + <span class="expand-button" onclick="toggleMemberBody(this, 'SyntaxFormatter');">[+]</span> <span class="member-annotations"> </span> @@ -5488,12 +5586,29 @@ Note: Instead o... </div><!-- end member-title --> <div class="member-body"> - + <div class="member-body-short" id="short-body-SyntaxFormatter"> + + </div> + <div class="member-body-long" id ="long-body-SyntaxFormatter"> + + </div> </div> + <script> + function toggleMemberBody(span, sig) { + var shortBody = document.getElementById("short-body-" + sig); + var longBody = document.getElementById("long-body-" + sig); + + shortBody.classList.toggle("toggled") + longBody.classList.toggle("toggled") + + span.innerHTML = (span.innerHTML == "[+]") ? "[-]" : "[+]"; + } + </script> </div><!-- end member --> <div id="Recorded" class="member private"> <div class="member-title"> + <span class="expand-button" onclick="toggleMemberBody(this, 'Recorded');">[+]</span> <span class="member-annotations"> </span> @@ -5522,12 +5637,29 @@ Note: Instead o... </div><!-- end member-title --> <div class="member-body"> - + <div class="member-body-short" id="short-body-Recorded"> + + </div> + <div class="member-body-long" id ="long-body-Recorded"> + + </div> </div> + <script> + function toggleMemberBody(span, sig) { + var shortBody = document.getElementById("short-body-" + sig); + var longBody = document.getElementById("long-body-" + sig); + + shortBody.classList.toggle("toggled") + longBody.classList.toggle("toggled") + + span.innerHTML = (span.innerHTML == "[+]") ? "[-]" : "[+]"; + } + </script> </div><!-- end member --> <div id="disambiguateTypes(args)(ctx)" class="member "> <div class="member-title"> + <span class="expand-button" onclick="toggleMemberBody(this, 'disambiguateTypes(args)(ctx)');">[+]</span> <span class="member-annotations"> </span> @@ -5577,18 +5709,43 @@ Note: Instead o... - <span class="no-left">: </span> + <span class="no-left">: <span class="no-right">(</span> +String<span>, </span><a href="../../../../.././api/dotty/tools/dotc/core/Contexts$/Context.html">Context</a> +<span class="no-left">)</span></span> </div><!-- end member-title --> <div class="member-body"> - <p>When getting a type mismatch it is useful to disambiguate placeholders like:</p> + <div class="member-body-short" id="short-body-disambiguateTypes(args)(ctx)"> + <p>When getting a type mismatch it is useful to disambiguate placeholders like:</p> + + </div> + <div class="member-body-long" id ="long-body-disambiguateTypes(args)(ctx)"> + <p>When getting a type mismatch it is useful to disambiguate placeholders like:</p> +<pre><code>found: List[Int] +required: List[T] +where: T is a type in the initalizer of value s which is an alias of + String +</code></pre> + </div> </div> + <script> + function toggleMemberBody(span, sig) { + var shortBody = document.getElementById("short-body-" + sig); + var longBody = document.getElementById("long-body-" + sig); + + shortBody.classList.toggle("toggled") + longBody.classList.toggle("toggled") + + span.innerHTML = (span.innerHTML == "[+]") ? "[-]" : "[+]"; + } + </script> </div><!-- end member --> <div id="explainCtx(seen)(ctx)" class="member private"> <div class="member-title"> + <span class="expand-button" onclick="toggleMemberBody(this, 'explainCtx(seen)(ctx)');">[+]</span> <span class="member-annotations"> </span> @@ -5635,18 +5792,36 @@ Note: Instead o... - <span class="no-left">: Context</span> + <span class="no-left">: <a href="../../../../.././api/dotty/tools/dotc/core/Contexts$/Context.html">Context</a></span> </div><!-- end member-title --> <div class="member-body"> - <p>Context with correct printer set for explanations</p> + <div class="member-body-short" id="short-body-explainCtx(seen)(ctx)"> + <p>Context with correct printer set for explanations</p> + </div> + <div class="member-body-long" id ="long-body-explainCtx(seen)(ctx)"> + <p>Context with correct printer set for explanations</p> + + </div> </div> + <script> + function toggleMemberBody(span, sig) { + var shortBody = document.getElementById("short-body-" + sig); + var longBody = document.getElementById("long-body-" + sig); + + shortBody.classList.toggle("toggled") + longBody.classList.toggle("toggled") + + span.innerHTML = (span.innerHTML == "[+]") ? "[-]" : "[+]"; + } + </script> </div><!-- end member --> <div id="explained2(op)(ctx)" class="member "> <div class="member-title"> + <span class="expand-button" onclick="toggleMemberBody(this, 'explained2(op)(ctx)');">[+]</span> <span class="member-annotations"> </span> @@ -5698,13 +5873,33 @@ Note: Instead o... </div><!-- end member-title --> <div class="member-body"> - <p>Entrypoint for explanation string interpolator:</p> + <div class="member-body-short" id="short-body-explained2(op)(ctx)"> + <p>Entrypoint for explanation string interpolator:</p> + + </div> + <div class="member-body-long" id ="long-body-explained2(op)(ctx)"> + <p>Entrypoint for explanation string interpolator:</p> +<pre><code>ex"disambiguate $tpe1 and $tpe2" +</code></pre> + </div> </div> + <script> + function toggleMemberBody(span, sig) { + var shortBody = document.getElementById("short-body-" + sig); + var longBody = document.getElementById("long-body-" + sig); + + shortBody.classList.toggle("toggled") + longBody.classList.toggle("toggled") + + span.innerHTML = (span.innerHTML == "[+]") ? "[-]" : "[+]"; + } + </script> </div><!-- end member --> <div id="explanation(entry)(ctx)" class="member "> <div class="member-title"> + <span class="expand-button" onclick="toggleMemberBody(this, 'explanation(entry)(ctx)');">[+]</span> <span class="member-annotations"> </span> @@ -5756,13 +5951,31 @@ Note: Instead o... </div><!-- end member-title --> <div class="member-body"> - <p>Create explanation for single <code>Recorded</code> type or symbol</p> + <div class="member-body-short" id="short-body-explanation(entry)(ctx)"> + <p>Create explanation for single <code>Recorded</code> type or symbol</p> + + </div> + <div class="member-body-long" id ="long-body-explanation(entry)(ctx)"> + <p>Create explanation for single <code>Recorded</code> type or symbol</p> + </div> </div> + <script> + function toggleMemberBody(span, sig) { + var shortBody = document.getElementById("short-body-" + sig); + var longBody = document.getElementById("long-body-" + sig); + + shortBody.classList.toggle("toggled") + longBody.classList.toggle("toggled") + + span.innerHTML = (span.innerHTML == "[+]") ? "[-]" : "[+]"; + } + </script> </div><!-- end member --> <div id="explanations(seen)(ctx)" class="member private"> <div class="member-title"> + <span class="expand-button" onclick="toggleMemberBody(this, 'explanations(seen)(ctx)');">[+]</span> <span class="member-annotations"> </span> @@ -5814,14 +6027,33 @@ Note: Instead o... </div><!-- end member-title --> <div class="member-body"> - <p>Turns a <code>Seen</code> into a <code>String</code> to produce an explanation for types on the + <div class="member-body-short" id="short-body-explanations(seen)(ctx)"> + <p>Turns a <code>Seen</code> into a <code>String</code> to produce an explanation for types on the +form <code>where: T is...</code></p> + + </div> + <div class="member-body-long" id ="long-body-explanations(seen)(ctx)"> + <p>Turns a <code>Seen</code> into a <code>String</code> to produce an explanation for types on the form <code>where: T is...</code></p> + </div> </div> + <script> + function toggleMemberBody(span, sig) { + var shortBody = document.getElementById("short-body-" + sig); + var longBody = document.getElementById("long-body-" + sig); + + shortBody.classList.toggle("toggled") + longBody.classList.toggle("toggled") + + span.innerHTML = (span.innerHTML == "[+]") ? "[-]" : "[+]"; + } + </script> </div><!-- end member --> <div id="typeDiff(found,expected)(ctx)" class="member "> <div class="member-title"> + <span class="expand-button" onclick="toggleMemberBody(this, 'typeDiff(found,expected)(ctx)');">[+]</span> <span class="member-annotations"> </span> @@ -5876,22 +6108,47 @@ form <code>where: T is...</code></p> - <span class="no-left">: </span> + <span class="no-left">: <span class="no-right">(</span> +String<span>, </span>String +<span class="no-left">)</span></span> </div><!-- end member-title --> <div class="member-body"> - <p>This method will produce a colored type diff from the given arguments. + <div class="member-body-short" id="short-body-typeDiff(found,expected)(ctx)"> + <p>This method will produce a colored type diff from the given arguments. The idea is to do this for known cases that are useful and then fall back on regu...</p> <p> </p> + </div> + <div class="member-body-long" id ="long-body-typeDiff(found,expected)(ctx)"> + <p>This method will produce a colored type diff from the given arguments. +The idea is to do this for known cases that are useful and then fall back +on regular syntax highlighting for the cases which are unhandled.</p> +<p>Please not that if used in combination with <code>disambiguateTypes</code> the +correct <code>Context</code> for printing should also be passed when calling the +method.</p> + + </div> </div> + <script> + function toggleMemberBody(span, sig) { + var shortBody = document.getElementById("short-body-" + sig); + var longBody = document.getElementById("long-body-" + sig); + + shortBody.classList.toggle("toggled") + longBody.classList.toggle("toggled") + + span.innerHTML = (span.innerHTML == "[+]") ? "[-]" : "[+]"; + } + </script> </div><!-- end member --> <div id="wrapNonSensical(arg,str)(ctx)" class="member private"> <div class="member-title"> + <span class="expand-button" onclick="toggleMemberBody(this, 'wrapNonSensical(arg,str)(ctx)');">[+]</span> <span class="member-annotations"> </span> @@ -5951,8 +6208,24 @@ on regu...</p> </div><!-- end member-title --> <div class="member-body"> - + <div class="member-body-short" id="short-body-wrapNonSensical(arg,str)(ctx)"> + + </div> + <div class="member-body-long" id ="long-body-wrapNonSensical(arg,str)(ctx)"> + + </div> </div> + <script> + function toggleMemberBody(span, sig) { + var shortBody = document.getElementById("short-body-" + sig); + var longBody = document.getElementById("long-body-" + sig); + + shortBody.classList.toggle("toggled") + longBody.classList.toggle("toggled") + + span.innerHTML = (span.innerHTML == "[+]") ? "[-]" : "[+]"; + } + </script> </div><!-- end member --> </div> |