author | jlahoda |
Mon, 21 Oct 2019 15:38:26 +0200 | |
changeset 58713 | ad69fd32778e |
permissions | -rw-r--r-- |
58713
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
1 |
/* |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
2 |
* Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved. |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
4 |
* |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
5 |
* This code is free software; you can redistribute it and/or modify it |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
7 |
* published by the Free Software Foundation. Oracle designates this |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
8 |
* particular file as subject to the "Classpath" exception as provided |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
9 |
* by Oracle in the LICENSE file that accompanied this code. |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
10 |
* |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
15 |
* accompanied this code). |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
16 |
* |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
17 |
* You should have received a copy of the GNU General Public License version |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
20 |
* |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
22 |
* or visit www.oracle.com if you need additional information or have any |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
23 |
* questions. |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
24 |
*/ |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
25 |
|
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
26 |
package build.tools.taglet; |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
27 |
|
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
28 |
import java.util.Arrays; |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
29 |
import java.util.EnumSet; |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
30 |
import java.util.List; |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
31 |
import java.util.Set; |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
32 |
import java.util.function.Predicate; |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
33 |
import javax.lang.model.element.Element; |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
34 |
import com.sun.source.doctree.DocTree; |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
35 |
import com.sun.source.doctree.TextTree; |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
36 |
import com.sun.source.doctree.UnknownInlineTagTree; |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
37 |
import jdk.javadoc.doclet.Taglet; |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
38 |
import static jdk.javadoc.doclet.Taglet.Location.*; |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
39 |
|
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
40 |
/** |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
41 |
* An block tag to insert a standard warning about a preview API. |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
42 |
*/ |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
43 |
public class Preview implements Taglet { |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
44 |
|
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
45 |
/** Returns the set of locations in which a taglet may be used. */ |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
46 |
@Override |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
47 |
public Set<Location> getAllowedLocations() { |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
48 |
return EnumSet.of(MODULE, PACKAGE, TYPE, CONSTRUCTOR, METHOD, FIELD); |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
49 |
} |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
50 |
|
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
51 |
@Override |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
52 |
public boolean isInlineTag() { |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
53 |
return true; |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
54 |
} |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
55 |
|
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
56 |
@Override |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
57 |
public String getName() { |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
58 |
return "preview"; |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
59 |
} |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
60 |
|
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
61 |
@Override |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
62 |
public String toString(List<? extends DocTree> tags, Element elem) { |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
63 |
UnknownInlineTagTree previewTag = (UnknownInlineTagTree) tags.get(0); |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
64 |
List<? extends DocTree> previewContent = previewTag.getContent(); |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
65 |
String previewText = ((TextTree) previewContent.get(0)).getBody(); |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
66 |
String[] summaryAndDetails = previewText.split("\n\r?\n\r?"); |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
67 |
String summary = summaryAndDetails[0]; |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
68 |
String details = summaryAndDetails.length > 1 ? summaryAndDetails[1] : summaryAndDetails[0]; |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
69 |
StackTraceElement[] stackTrace = new Exception().getStackTrace(); |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
70 |
Predicate<StackTraceElement> isSummary = |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
71 |
el -> el.getClassName().endsWith("HtmlDocletWriter") && |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
72 |
el.getMethodName().equals("addSummaryComment"); |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
73 |
if (Arrays.stream(stackTrace).anyMatch(isSummary)) { |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
74 |
return "<div style=\"display:inline-block; font-weight:bold\">" + summary + "</div><br>"; |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
75 |
} |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
76 |
return "<div style=\"border: 1px solid red; border-radius: 5px; padding: 5px; display:inline-block; font-size: larger\">" + details + "</div><br>"; |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
77 |
} |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
78 |
} |
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
diff
changeset
|
79 |