MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-09-27 10:03:11 +07:00
Code Issues Packages Projects Releases Wiki Activity

external javadoc: support for jdk7 style; tests (IDEA-78052 )

Browse Source
This commit is contained in:
anna
2011-12-07 20:42:11 +01:00
parent 5d35b1b62e
commit ab056dc0cc
8 changed files with 7013 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
java/java-tests/testData/codeInsight/externalJavadoc/String/6/expected.html
+99
View File
@@ -0,0 +1,99 @@
<HTML><style type="text/css"> ul.inheritance {
margin:0;
padding:0;
}
ul.inheritance li {
display:inline;
list-style:none;
}
ul.inheritance li ul.inheritance {
margin-left:15px;
padding-left:15px;
padding-top:1px;
}
</style><!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
java.lang</FONT>
<BR>
Class String</H2>
<PRE>
<A HREF="../../java/lang/Object.html" title="class in java.lang">java.lang.Object</A>
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>java.lang.String</B>
</PRE>
<DL><DL>
<DT><BR><PRE>public final class <B>String</B><DT><BR>extends <A HREF="../../java/lang/Object.html" title="class in java.lang">Object</A><DT><BR>implements <A HREF="../../java/io/Serializable.html" title="interface in java.io">Serializable</A>, <A HREF="../../java/lang/Comparable.html" title="interface in java.lang">Comparable</A>&lt;<A HREF="../../java/lang/String.html" title="class in java.lang">String</A>&gt;, <A HREF="../../java/lang/CharSequence.html" title="interface in java.lang">CharSequence</A></DL>
</PRE>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../java/io/Serializable.html" title="interface in java.io">Serializable</A>, <A HREF="../../java/lang/CharSequence.html" title="interface in java.lang">CharSequence</A>, <A HREF="../../java/lang/Comparable.html" title="interface in java.lang">Comparable</A>&lt;<A HREF="../../java/lang/String.html" title="class in java.lang">String</A>&gt;</DD>
</DL>
<P> The <code>String</code> class represents character strings. All
string literals in Java programs, such as <code>"abc"</code>, are
implemented as instances of this class.
<p>
Strings are constant; their values cannot be changed after they
are created. String buffers support mutable strings.
Because String objects are immutable they can be shared. For example:
<p><blockquote><pre>
String str = "abc";
</pre></blockquote><p>
is equivalent to:
<p><blockquote><pre>
char data[] = {'a', 'b', 'c'};
String str = new String(data);
</pre></blockquote><p>
Here are some more examples of how strings can be used:
<p><blockquote><pre>
System.out.println("abc");
String cde = "cde";
System.out.println("abc" + cde);
String c = "abc".substring(2,3);
String d = cde.substring(1, 2);
</pre></blockquote>
<p>
The class <code>String</code> includes methods for examining
individual characters of the sequence, for comparing strings, for
searching strings, for extracting substrings, and for creating a
copy of a string with all characters translated to uppercase or to
lowercase. Case mapping is based on the Unicode Standard version
specified by the <A HREF="../../java/lang/Character.html" title="class in java.lang"><CODE>Character</CODE></A> class.
<p>
The Java language provides special support for the string
concatenation operator (&nbsp;+&nbsp;), and for conversion of
other objects to strings. String concatenation is implemented
through the <code>StringBuilder</code>(or <code>StringBuffer</code>)
class and its <code>append</code> method.
String conversions are implemented through the method
<code>toString</code>, defined by <code>Object</code> and
inherited by all classes in Java. For additional information on
string concatenation and conversion, see Gosling, Joy, and Steele,
<i>The Java Language Specification</i>.
<p> Unless otherwise noted, passing a <tt>null</tt> argument to a constructor
or method in this class will cause a <A HREF="../../java/lang/NullPointerException.html" title="class in java.lang"><CODE>NullPointerException</CODE></A> to be
thrown.
<p>A <code>String</code> represents a string in the UTF-16 format
in which <em>supplementary characters</em> are represented by <em>surrogate
pairs</em> (see the section <a href="Character.html#unicode">Unicode
Character Representations</a> in the <code>Character</code> class for
more information).
Index values refer to <code>char</code> code units, so a supplementary
character uses two positions in a <code>String</code>.
<p>The <code>String</code> class provides methods for dealing with
Unicode code points (i.e., characters), in addition to those for
dealing with Unicode code units (i.e., <code>char</code> values).
<P>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>JDK1.0</DD>
<DT><B>See Also:</B><DD><A HREF="../../java/lang/Object.html#toString()"><CODE>Object.toString()</CODE></A>,
<A HREF="../../java/lang/StringBuffer.html" title="class in java.lang"><CODE>StringBuffer</CODE></A>,
<A HREF="../../java/lang/StringBuilder.html" title="class in java.lang"><CODE>StringBuilder</CODE></A>,
<A HREF="../../java/nio/charset/Charset.html" title="class in java.nio.charset"><CODE>Charset</CODE></A>,
<A HREF="../../serialized-form.html#java.lang.String">Serialized Form</A></DL>
<P>
</HTML>
java/java-tests/testData/codeInsight/externalJavadoc/String/6/expectedToLowerCase.html
+44
View File
@@ -0,0 +1,44 @@
<HTML><style type="text/css"> ul.inheritance {
margin:0;
padding:0;
}
ul.inheritance li {
display:inline;
list-style:none;
}
ul.inheritance li ul.inheritance {
margin-left:15px;
padding-left:15px;
padding-top:1px;
}
</style><A NAME="toLowerCase()"><!-- --></A><H3>
toLowerCase</H3>
<PRE>
public <A HREF="../../java/lang/String.html" title="class in java.lang">String</A> <B>toLowerCase</B>()</PRE>
<DL>
<DD>Converts all of the characters in this <code>String</code> to lower
case using the rules of the default locale. This is equivalent to calling
<code>toLowerCase(Locale.getDefault())</code>.
<p>
<b>Note:</b> This method is locale sensitive, and may produce unexpected
results if used for strings that are intended to be interpreted locale
independently.
Examples are programming language identifiers, protocol keys, and HTML
tags.
For instance, <code>"TITLE".toLowerCase()</code> in a Turkish locale
returns <code>"t?tle"</code>, where '?' is the LATIN SMALL
LETTER DOTLESS I character.
To obtain correct results for locale insensitive strings, use
<code>toLowerCase(Locale.ENGLISH)</code>.
<p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the <code>String</code>, converted to lowercase.<DT><B>See Also:</B><DD><A HREF="../../java/lang/String.html#toLowerCase(java.util.Locale)"><CODE>toLowerCase(Locale)</CODE></A></DL>
</DD>
</DL>
</HTML>
java/java-tests/testData/codeInsight/externalJavadoc/String/6/page.html
+3544
View File
File diff suppressed because it is too large Load Diff
java/java-tests/testData/codeInsight/externalJavadoc/String/7/expected.html
+105
View File
@@ -0,0 +1,105 @@
<HTML><style type="text/css"> ul.inheritance {
margin:0;
padding:0;
}
ul.inheritance li {
display:inline;
list-style:none;
}
ul.inheritance li ul.inheritance {
margin-left:15px;
padding-left:15px;
padding-top:1px;
}
</style><!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">java.lang</div>
<h2 title="Class String" class="title">Class String</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="../../java/lang/Object.html" title="class in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>java.lang.String</li>
</ul>
</li>
</ul>
<DL> <ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../java/io/Serializable.html" title="interface in java.io">Serializable</a>, <a href="../../java/lang/CharSequence.html" title="interface in java.lang">CharSequence</a>, <a href="../../java/lang/Comparable.html" title="interface in java.lang">Comparable</a>&lt;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public final class <span class="strong">String</span>
extends <a href="../../java/lang/Object.html" title="class in java.lang">Object</a>
implements <a href="../../java/io/Serializable.html" title="interface in java.io">Serializable</a>, <a href="../../java/lang/Comparable.html" title="interface in java.lang">Comparable</a>&lt;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&gt;, <a href="../../java/lang/CharSequence.html" title="interface in java.lang">CharSequence</a></pre>
<div class="block">The <code>String</code> class represents character strings. All
string literals in Java programs, such as <code>"abc"</code>, are
implemented as instances of this class.
<p>
Strings are constant; their values cannot be changed after they
are created. String buffers support mutable strings.
Because String objects are immutable they can be shared. For example:
<p><blockquote><pre>
String str = "abc";
</pre></blockquote><p>
is equivalent to:
<p><blockquote><pre>
char data[] = {'a', 'b', 'c'};
String str = new String(data);
</pre></blockquote><p>
Here are some more examples of how strings can be used:
<p><blockquote><pre>
System.out.println("abc");
String cde = "cde";
System.out.println("abc" + cde);
String c = "abc".substring(2,3);
String d = cde.substring(1, 2);
</pre></blockquote>
<p>
The class <code>String</code> includes methods for examining
individual characters of the sequence, for comparing strings, for
searching strings, for extracting substrings, and for creating a
copy of a string with all characters translated to uppercase or to
lowercase. Case mapping is based on the Unicode Standard version
specified by the <a href="../../java/lang/Character.html" title="class in java.lang"><code>Character</code></a> class.
<p>
The Java language provides special support for the string
concatenation operator (&nbsp;+&nbsp;), and for conversion of
other objects to strings. String concatenation is implemented
through the <code>StringBuilder</code>(or <code>StringBuffer</code>)
class and its <code>append</code> method.
String conversions are implemented through the method
<code>toString</code>, defined by <code>Object</code> and
inherited by all classes in Java. For additional information on
string concatenation and conversion, see Gosling, Joy, and Steele,
<i>The Java Language Specification</i>.
<p> Unless otherwise noted, passing a <tt>null</tt> argument to a constructor
or method in this class will cause a <a href="../../java/lang/NullPointerException.html" title="class in java.lang"><code>NullPointerException</code></a> to be
thrown.
<p>A <code>String</code> represents a string in the UTF-16 format
in which <em>supplementary characters</em> are represented by <em>surrogate
pairs</em> (see the section <a href="Character.html#unicode">Unicode
Character Representations</a> in the <code>Character</code> class for
more information).
Index values refer to <code>char</code> code units, so a supplementary
character uses two positions in a <code>String</code>.
<p>The <code>String</code> class provides methods for dealing with
Unicode code points (i.e., characters), in addition to those for
dealing with Unicode code units (i.e., <code>char</code> values).</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>JDK1.0</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../java/lang/Object.html#toString()"><code>Object.toString()</code></a>,
<a href="../../java/lang/StringBuffer.html" title="class in java.lang"><code>StringBuffer</code></a>,
<a href="../../java/lang/StringBuilder.html" title="class in java.lang"><code>StringBuilder</code></a>,
<a href="../../java/nio/charset/Charset.html" title="class in java.nio.charset"><code>Charset</code></a>,
<a href="../../serialized-form.html#java.lang.String">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
</HTML>
java/java-tests/testData/codeInsight/externalJavadoc/String/7/expectedToLowerCase.html
+37
View File
@@ -0,0 +1,37 @@
<HTML><style type="text/css"> ul.inheritance {
margin:0;
padding:0;
}
ul.inheritance li {
display:inline;
list-style:none;
}
ul.inheritance li ul.inheritance {
margin-left:15px;
padding-left:15px;
padding-top:1px;
}
</style><a name="toLowerCase()">
<!-- -->
</a>
<h4>toLowerCase</h4>
<pre>public&nbsp;<a href="../../java/lang/String.html" title="class in java.lang">String</a>&nbsp;toLowerCase()</pre>
<div class="block">Converts all of the characters in this <code>String</code> to lower
case using the rules of the default locale. This is equivalent to calling
<code>toLowerCase(Locale.getDefault())</code>.
<p>
<b>Note:</b> This method is locale sensitive, and may produce unexpected
results if used for strings that are intended to be interpreted locale
independently.
Examples are programming language identifiers, protocol keys, and HTML
tags.
For instance, <code>"TITLE".toLowerCase()</code> in a Turkish locale
returns <code>"t\u0131tle"</code>, where '\u0131' is the
LATIN SMALL LETTER DOTLESS I character.
To obtain correct results for locale insensitive strings, use
<code>toLowerCase(Locale.ENGLISH)</code>.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the <code>String</code>, converted to lowercase.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../java/lang/String.html#toLowerCase(java.util.Locale)"><code>toLowerCase(Locale)</code></a></dd></dl>
</li>
</ul>
</HTML>
java/java-tests/testData/codeInsight/externalJavadoc/String/7/page.html
+3071
View File
File diff suppressed because it is too large Load Diff
java/java-tests/testSrc/com/intellij/codeInsight/javadoc/ExternalJavadocPresentationTest.java
+78
View File
@@ -0,0 +1,78 @@
/*
* Copyright 2000-2011 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.intellij.codeInsight.javadoc;
import com.intellij.JavaTestUtil;
import com.intellij.openapi.fileEditor.impl.LoadTextUtil;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.vfs.LocalFileSystem;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.testFramework.LightCodeInsightTestCase;
import org.jetbrains.annotations.NonNls;
import java.io.IOException;
import java.io.Reader;
import java.io.StringReader;
/**
* User: anna
* Date: 12/7/11
*/
public class ExternalJavadocPresentationTest extends LightCodeInsightTestCase {
private static final String TEST_ROOT = "/codeInsight/externalJavadoc/";
@Override
protected String getTestDataPath() {
return JavaTestUtil.getJavaTestDataPath();
}
public void testStringClass() throws Exception {
doTest("", "String/7/page.html", "String/7/expected.html");
doTest("", "String/6/page.html", "String/6/expected.html");
}
public void testToLowerCase() throws Exception {
doTest("lang/String.html#toLowerCase()", "String/7/page.html", "String/7/expectedToLowerCase.html");
doTest("lang/String.html#toLowerCase()", "String/6/page.html", "String/6/expectedToLowerCase.html");
}
private void doTest(@NonNls String url, @NonNls String pageText, @NonNls String expected) throws Exception {
final String basePath = getTestDataPath() + TEST_ROOT;
final VirtualFile pageTextFile = LocalFileSystem.getInstance().findFileByPath(basePath + pageText);
assertNotNull(pageTextFile);
final VirtualFile expectedTextFile = LocalFileSystem.getInstance().findFileByPath(basePath + expected);
assertNotNull(expectedTextFile);
class JavadocExternalTestFilter extends JavaDocExternalFilter {
public JavadocExternalTestFilter(Project project) {
super(project);
}
@Override
public void doBuildFromStream(String surl, Reader input, StringBuffer data, boolean search4Encoding) throws IOException {
super.doBuildFromStream(surl, input, data, search4Encoding);
}
}
JavadocExternalTestFilter filter = new JavadocExternalTestFilter(getProject());
final StringBuffer extractedData = new StringBuffer();
filter.doBuildFromStream(url, new StringReader(LoadTextUtil.loadText(pageTextFile).toString()), extractedData, false);
assertEquals(LoadTextUtil.loadText(expectedTextFile).toString(), extractedData.toString());
}
}
platform/lang-impl/src/com/intellij/codeInsight/documentation/AbstractExternalFilter.java
+35 -3
View File
@@ -69,7 +69,9 @@ public abstract class AbstractExternalFilter {
@NonNls private static final String DT = "<DT>";
private static final Pattern CHARSET_META_PATTERN =
Pattern.compile("<meta.*content\\s*=\".*[;|\\s]*charset=\\s*(.*)\\s*[;|\\s]*\">", Pattern.CASE_INSENSITIVE);
private final HttpConfigurable myHttpConfigurable = HttpConfigurable.getInstance();
private static final String FIELD_SUMMARY = "<!-- =========== FIELD SUMMARY =========== -->";
private static final String CLASS_SUMMARY = "<div class=\"summary\">";
private final HttpConfigurable myHttpConfigurable = HttpConfigurable.getInstance();
protected static abstract class RefConvertor {
private final Pattern mySelector;
@@ -228,6 +230,21 @@ public abstract class AbstractExternalFilter {
}
data.append(HTML);
data.append( "<style type=\"text/css\">" +
" ul.inheritance {\n" +
" margin:0;\n" +
" padding:0;\n" +
" }\n" +
" ul.inheritance li {\n" +
" display:inline;\n" +
" list-style:none;\n" +
" }\n" +
" ul.inheritance li ul.inheritance {\n" +
" margin-left:15px;\n" +
" padding-left:15px;\n" +
" padding-top:1px;\n" +
" }\n" +
"</style>");
String read;
String contentEncoding = null;
@@ -267,7 +284,8 @@ public abstract class AbstractExternalFilter {
if (isClassDoc) {
boolean skip = false;
while (((read = buf.readLine()) != null) && !read.toUpperCase().trim().equals(DL)) {
while (((read = buf.readLine()) != null) && !read.toUpperCase().trim().equals(DL) &&
!StringUtil.containsIgnoreCase(read, "<div class=\"description\"")) {
if (read.toUpperCase().contains(H2) && !read.toUpperCase().contains("H2")) { // read=class name in <H2>
data.append(H2);
skip = true;
@@ -286,10 +304,12 @@ public abstract class AbstractExternalFilter {
StringBuffer classDetails = new StringBuffer();
while (((read = buf.readLine()) != null) && !read.toUpperCase().equals(HR) && !read.toUpperCase().equals(P)) {
if (reachTheEnd(data, read, classDetails)) return;
appendLine(classDetails, read);
}
while (((read = buf.readLine()) != null) && !read.toUpperCase().equals(P) && !read.toUpperCase().equals(HR)) {
if (reachTheEnd(data, read, classDetails)) return;
appendLine(data, read.replaceAll(DT, DT + BR));
}
@@ -300,7 +320,9 @@ public abstract class AbstractExternalFilter {
while (((read = buf.readLine()) != null) &&
StringUtil.indexOfIgnoreCase(read, endSection, 0) == -1 &&
StringUtil.indexOfIgnoreCase(read, greatestEndSection, 0) == -1) {
if (read.toUpperCase().indexOf(HR) == -1) {
if (read.toUpperCase().indexOf(HR) == -1
&& !StringUtil.containsIgnoreCase(read, "<ul class=\"blockList\">")
&& !StringUtil.containsIgnoreCase(read, "<li class=\"blockList\">")) {
appendLine(data, read);
}
}
@@ -308,6 +330,16 @@ public abstract class AbstractExternalFilter {
data.append(HTML_CLOSE);
}
private static boolean reachTheEnd(StringBuffer data, String read, StringBuffer classDetails) {
if (StringUtil.indexOfIgnoreCase(read, FIELD_SUMMARY, 0) != -1 ||
StringUtil.indexOfIgnoreCase(read, CLASS_SUMMARY, 0) != -1) {
data.append(classDetails);
data.append(HTML_CLOSE);
return true;
}
return false;
}
@Nullable
private static String parseContentEncoding(String charset) {
final Matcher matcher = CHARSET_META_PATTERN.matcher(charset);