Skip to content

Commit

Permalink
8236048: Cleanup use of Utils.normalizeNewlines
Browse files Browse the repository at this point in the history 
Reviewed-by: hannesw
  • Loading branch information
@jonathan-gibbons
jonathan-gibbons committed Aug 18, 2022
1 parent 97e2689 commit 1b756bf
Show file tree
Hide file tree
Showing 26 changed files with 170 additions and 169 deletions.
12 changes: 6 additions & 6 deletions ...are/classes/jdk/javadoc/internal/doclets/formats/html/AbstractExecutableMemberWriter.java
View file
Expand Up @@ -42,8 +42,8 @@
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;

import static jdk.javadoc.internal.doclets.formats.html.HtmlLinkInfo.Kind.EXECUTABLE_MEMBER_PARAM;
import static jdk.javadoc.internal.doclets.formats.html.HtmlLinkInfo.Kind.MEMBER;
Expand Down Expand Up @@ -211,7 +211,7 @@ protected Content getParameters(ExecutableElement member, boolean includeAnnotat
TypeMirror rcvrType = member.getReceiverType();
if (includeAnnotations && rcvrType != null && isAnnotatedReceiver(rcvrType)) {
addReceiver(member, rcvrType, result);
sep = "," + DocletConstants.NL + " ";
sep = "," + Text.NL + " ";
}
int paramstart;
ExecutableType instMeth = utils.asInstantiatedMethodType(typeElement, member);
Expand All @@ -225,7 +225,7 @@ protected Content getParameters(ExecutableElement member, boolean includeAnnotat
Content annotationInfo = writer.getAnnotationInfo(param, false);
if (!annotationInfo.isEmpty()) {
result.add(annotationInfo)
.add(DocletConstants.NL)
.add(Text.NL)
.add(" ");
}
}
Expand All @@ -237,14 +237,14 @@ protected Content getParameters(ExecutableElement member, boolean includeAnnotat

for (int i = paramstart + 1; i < parameters.size(); i++) {
result.add(",");
result.add(DocletConstants.NL);
result.add(Text.NL);
result.add(" ");

if (includeAnnotations) {
Content annotationInfo = writer.getAnnotationInfo(parameters.get(i), false);
if (!annotationInfo.isEmpty()) {
result.add(annotationInfo)
.add(DocletConstants.NL)
.add(Text.NL)
.add(" ");
}
}
Expand All @@ -268,7 +268,7 @@ protected Content getExceptions(ExecutableElement member) {
for (TypeMirror t : exceptions) {
if (!result.isEmpty()) {
result.add(",");
result.add(DocletConstants.NL);
result.add(Text.NL);
}
Content link = writer.getLink(new HtmlLinkInfo(configuration, THROWS_TYPE, t));
result.add(link);
Expand Down
5 changes: 2 additions & 3 deletions ....javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/DocFilesHandlerImpl.java
View file
Expand Up @@ -38,7 +38,6 @@
import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
import jdk.javadoc.internal.doclets.toolkit.util.Utils;
import jdk.javadoc.internal.doclint.HtmlTag;

Expand Down Expand Up @@ -232,7 +231,7 @@ private List<? extends DocTree> getLocalHeaderTags(List<? extends DocTree> dtree
default:
if (inHead) {
localTags.add(startElem);
localTags.add(docTreeFactory.newTextTree(DocletConstants.NL));
localTags.add(docTreeFactory.newTextTree("\n"));
}
}
break;
Expand All @@ -248,7 +247,7 @@ private List<? extends DocTree> getLocalHeaderTags(List<? extends DocTree> dtree
default:
if (inHead) {
localTags.add(endElem);
localTags.add(docTreeFactory.newTextTree(DocletConstants.NL));
localTags.add(docTreeFactory.newTextTree("\n"));
}
}
break;
Expand Down
11 changes: 5 additions & 6 deletions ...jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlDocletWriter.java
View file
Expand Up @@ -104,7 +104,6 @@
import jdk.javadoc.internal.doclets.toolkit.util.DocLink;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
import jdk.javadoc.internal.doclets.toolkit.util.Utils;
import jdk.javadoc.internal.doclets.toolkit.util.Utils.DeclarationPreviewLanguageFeatures;
import jdk.javadoc.internal.doclets.toolkit.util.Utils.ElementFlag;
Expand Down Expand Up @@ -1169,7 +1168,7 @@ public Content commentTagsToContent(Element element,
final Content result = new ContentBuilder() {
@Override
public ContentBuilder add(CharSequence text) {
return super.add(utils.normalizeNewlines(text));
return super.add(Text.normalizeNewlines(text));
}
};
CommentHelper ch = utils.getCommentHelper(element);
Expand Down Expand Up @@ -1357,7 +1356,7 @@ public Boolean visitLink(LinkTree node, Content content) {
@Override
public Boolean visitLiteral(LiteralTree node, Content content) {
String s = node.getBody().getBody();
Content t = Text.of(utils.normalizeNewlines(s));
Content t = Text.of(Text.normalizeNewlines(s));
content.add(node.getKind() == CODE ? HtmlTree.CODE(t) : t);
return false;
}
Expand Down Expand Up @@ -1405,7 +1404,7 @@ private CharSequence textCleanup(String text, boolean isLast, boolean stripLeadi
text = text.stripTrailing();
}
text = utils.replaceTabs(text);
return utils.normalizeNewlines(text);
return Text.normalizeNewlines(text);
}

@Override
Expand Down Expand Up @@ -1732,7 +1731,7 @@ public Void visitArray(List<? extends AnnotationValue> vals, List<AnnotationValu
else {
addAnnotations(annotationElement, linkInfo, annotation, pairs, lineBreak);
}
annotation.add(lineBreak ? DocletConstants.NL : "");
annotation.add(lineBreak ? Text.NL : "");
results.add(annotation);
}
return results;
Expand Down Expand Up @@ -1764,7 +1763,7 @@ private void addAnnotations(TypeElement annotationDoc, HtmlLinkInfo linkInfo,
} else {
annotation.add(",");
if (linkBreak) {
annotation.add(DocletConstants.NL);
annotation.add(Text.NL);
int spaces = annotationDoc.getSimpleName().length() + 2;
for (int k = 0; k < (spaces); k++) {
annotation.add(" ");
Expand Down
4 changes: 2 additions & 2 deletions src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlLinkFactory.java
View file
Expand Up @@ -39,12 +39,12 @@
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.BaseConfiguration;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.Resources;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
import jdk.javadoc.internal.doclets.toolkit.util.Utils.ElementFlag;
import jdk.javadoc.internal.doclets.toolkit.util.links.LinkFactory;
import jdk.javadoc.internal.doclets.toolkit.util.links.LinkInfo;
Expand Down Expand Up @@ -178,7 +178,7 @@ protected Content getTypeParameterLinks(LinkInfo linkInfo) {
links.add(",");
links.add(new HtmlTree(TagName.WBR));
if (((HtmlLinkInfo) linkInfo).getContext() == HtmlLinkInfo.Kind.MEMBER_TYPE_PARAMS) {
links.add(DocletConstants.NL);
links.add(Text.NL);
}
}
links.add(getTypeParameterLink(linkInfo, t));
Expand Down
13 changes: 6 additions & 7 deletions src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/Signatures.java
View file
Expand Up @@ -33,7 +33,6 @@
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
import jdk.javadoc.internal.doclets.toolkit.util.Utils;

import javax.lang.model.element.Element;
Expand Down Expand Up @@ -150,7 +149,7 @@ public Content toContent() {
if (!utils.isPlainInterface(typeElement)) {
TypeMirror superclass = utils.getFirstVisibleSuperClass(typeElement);
if (superclass != null) {
content.add(DocletConstants.NL);
content.add(Text.NL);
extendsImplements.add("extends ");
Content link = writer.getLink(new HtmlLinkInfo(configuration,
HtmlLinkInfo.Kind.CLASS_SIGNATURE_PARENT_NAME,
Expand All @@ -167,7 +166,7 @@ public Content toContent() {
continue;
}
if (isFirst) {
extendsImplements.add(DocletConstants.NL);
extendsImplements.add(Text.NL);
extendsImplements.add(utils.isPlainInterface(typeElement) ? "extends " : "implements ");
isFirst = false;
} else {
Expand All @@ -192,7 +191,7 @@ public Content toContent() {
boolean isFirst = true;
for (TypeMirror type : linkablePermits) {
if (isFirst) {
content.add(DocletConstants.NL);
content.add(Text.NL);
permitsSpan.add("permits");
permitsSpan.add(" ");
isFirst = false;
Expand Down Expand Up @@ -221,7 +220,7 @@ private Content getRecordComponents() {
for (RecordComponentElement e : typeElement.getRecordComponents()) {
content.add(sep);
writer.getAnnotations(e.getAnnotationMirrors(), false)
.forEach(a -> { content.add(a).add(" "); });
.forEach(a -> content.add(a).add(" "));
Content link = writer.getLink(new HtmlLinkInfo(configuration, HtmlLinkInfo.Kind.RECORD_COMPONENT,
e.asType()));
content.add(link);
Expand Down Expand Up @@ -544,7 +543,7 @@ private int appendTypeParameters(Content target, int lastLineSeparator) {

// sum below includes length of modifiers plus type params added above
if (lineLength + returnType.charCount() > RETURN_TYPE_MAX_LINE_LENGTH) {
target.add(DocletConstants.NL);
target.add(Text.NL);
newLastLineSeparator = target.charCount();
} else {
target.add(Entity.NO_BREAK_SPACE);
Expand Down Expand Up @@ -574,7 +573,7 @@ private void appendParametersAndExceptions(Content target, int lastLineSeparator
// Exceptions
if (exceptions != null && !exceptions.isEmpty()) {
CharSequence indent = " ".repeat(Math.max(0, indentSize + 1 - 7));
target.add(DocletConstants.NL)
target.add(Text.NL)
.add(indent)
.add("throws ")
.add(HtmlTree.SPAN(HtmlStyle.exceptions, exceptions));
Expand Down
7 changes: 3 additions & 4 deletions ...avadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/SourceToHTMLConverter.java
View file
Expand Up @@ -50,7 +50,6 @@
import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
import jdk.javadoc.internal.doclets.toolkit.util.SimpleDocletException;
import jdk.javadoc.internal.doclets.toolkit.util.Utils;

Expand All @@ -69,7 +68,7 @@ public class SourceToHTMLConverter {
/**
* New line to be added to the documentation.
*/
private static final String NEW_LINE = DocletConstants.NL;
private static final String NEW_LINE = Text.NL;

private final HtmlConfiguration configuration;
private final HtmlOptions options;
Expand Down Expand Up @@ -289,9 +288,9 @@ private static Content getHeader() {
private static void addLineNo(Content pre, int lineno) {
var span = HtmlTree.SPAN(HtmlStyle.sourceLineNo);
if (lineno < 10) {
span.add("00" + Integer.toString(lineno));
span.add("00" + lineno);
} else if (lineno < 100) {
span.add("0" + Integer.toString(lineno));
span.add("0" + lineno);
} else {
span.add(Integer.toString(lineno));
}
Expand Down
6 changes: 2 additions & 4 deletions src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/Table.java
View file
Expand Up @@ -30,9 +30,7 @@
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.Predicate;

Expand Down Expand Up @@ -354,8 +352,8 @@ public boolean isEmpty() {
}

@Override
public boolean write(Writer out, boolean atNewline) throws IOException {
return toContent().write(out, atNewline);
public boolean write(Writer out, String newline, boolean atNewline) throws IOException {
return toContent().write(out, newline, atNewline);
}

/**
Expand Down
4 changes: 2 additions & 2 deletions src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/TableHeader.java
View file
Expand Up @@ -140,8 +140,8 @@ public boolean isEmpty() {
}

@Override
public boolean write(Writer out, boolean atNewline) throws IOException {
return toContent().write(out, atNewline);
public boolean write(Writer out, String newline, boolean atNewline) throws IOException {
return toContent().write(out, newline, atNewline);
}

/**
Expand Down
27 changes: 13 additions & 14 deletions ...jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/TagletWriterImpl.java
View file
Expand Up @@ -208,7 +208,7 @@ public Content getOutputInstance() {

@Override
protected Content codeTagOutput(Element element, LiteralTree tag) {
return HtmlTree.CODE(Text.of(utils.normalizeNewlines(tag.getBody().getBody())));
return HtmlTree.CODE(Text.of(Text.normalizeNewlines(tag.getBody().getBody())));
}

@Override
Expand Down Expand Up @@ -309,18 +309,17 @@ public Content linkTagOutput(Element element, LinkTree tag) {

@Override
protected Content literalTagOutput(Element element, LiteralTree tag) {
return Text.of(utils.normalizeNewlines(tag.getBody().getBody()));
return Text.of(Text.normalizeNewlines(tag.getBody().getBody()));
}

@Override
public Content getParamHeader(ParamTaglet.ParamKind kind) {
Content header;
switch (kind) {
case PARAMETER: header = contents.parameters ; break;
case TYPE_PARAMETER: header = contents.typeParameters ; break;
case RECORD_COMPONENT: header = contents.recordComponents ; break;
default: throw new IllegalArgumentException(kind.toString());
}
Content header = switch (kind) {
case PARAMETER -> contents.parameters;
case TYPE_PARAMETER -> contents.typeParameters;
case RECORD_COMPONENT -> contents.recordComponents;
default -> throw new IllegalArgumentException(kind.toString());
};
return HtmlTree.DT(header);
}

Expand Down Expand Up @@ -384,9 +383,9 @@ public Content seeTagOutput(Element holder, List<? extends SeeTree> seeTags) {
// Use a different style if any link label is longer than 30 chars or contains commas.
boolean hasLongLabels = links.stream().anyMatch(this::isLongOrHasComma);
var seeList = HtmlTree.UL(hasLongLabels ? HtmlStyle.seeListLong : HtmlStyle.seeList);
links.stream().filter(Predicate.not(Content::isEmpty)).forEach(item -> {
seeList.add(HtmlTree.LI(item));
});
links.stream()
.filter(Predicate.not(Content::isEmpty))
.forEach(item -> seeList.add(HtmlTree.LI(item)));

return new ContentBuilder(
HtmlTree.DT(contents.seeAlso),
Expand Down Expand Up @@ -630,7 +629,7 @@ protected Content snippetTagOutput(Element element, SnippetTree tag, StyledText
}

content.consumeBy((styles, sequence) -> {
CharSequence text = utils.normalizeNewlines(sequence);
CharSequence text = Text.normalizeNewlines(sequence);
if (styles.isEmpty()) {
code.add(text);
} else {
Expand Down Expand Up @@ -778,7 +777,7 @@ protected Content invalidTagOutput(String summary, Optional<String> detail) {
return htmlWriter.invalidTagOutput(summary,
detail.isEmpty() || detail.get().isEmpty()
? Optional.empty()
: Optional.of(Text.of(utils.normalizeNewlines(detail.get()))));
: Optional.of(Text.of(Text.normalizeNewlines(detail.get()))));
}

@Override
Expand Down
6 changes: 3 additions & 3 deletions ....javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/BodyContents.java
View file
Expand Up @@ -42,7 +42,7 @@
*/
public class BodyContents extends Content {

private List<Content> mainContents = new ArrayList<>();
private final List<Content> mainContents = new ArrayList<>();
private HtmlTree header = null;
private HtmlTree footer = null;

Expand Down Expand Up @@ -74,8 +74,8 @@ public boolean isEmpty() {
}

@Override
public boolean write(Writer out, boolean atNewline) throws IOException {
return toContent().write(out, atNewline);
public boolean write(Writer out, String newline, boolean atNewline) throws IOException {
return toContent().write(out, newline, atNewline);
}

/**
Expand Down

1 comment on commit 1b756bf

@openjdk-notifier
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review

Issues

Please sign in to comment.