Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add JAR manifest header folding #2755

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions java/manifest/src/META-INF/ManifestSupport.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
</extensionPoints>
<extensions defaultExtensionNs="com.intellij">
<fileType name="Manifest" implementationClass="org.jetbrains.lang.manifest.ManifestFileType" fileNamesCaseInsensitive="manifest.mf" fieldName="INSTANCE" language="Manifest"/>
<lang.foldingBuilder language="Manifest" implementationClass="org.jetbrains.lang.manifest.folding.ManifestFoldingBuilder" />
<lang.parserDefinition language="Manifest" implementationClass="org.jetbrains.lang.manifest.parser.ManifestParserDefinition"/>
<lang.syntaxHighlighterFactory language="Manifest" implementationClass="org.jetbrains.lang.manifest.highlighting.ManifestSyntaxHighlighterFactory"/>
<annotator language="Manifest" implementationClass="org.jetbrains.lang.manifest.highlighting.HeaderAnnotator"/>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
// Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
package org.jetbrains.lang.manifest.folding;

import com.intellij.lang.ASTNode;
import com.intellij.lang.folding.FoldingBuilderEx;
import com.intellij.lang.folding.FoldingDescriptor;
import com.intellij.openapi.editor.Document;
import com.intellij.openapi.project.DumbAware;
import com.intellij.openapi.util.TextRange;
import com.intellij.psi.PsiElement;
import com.intellij.psi.PsiRecursiveElementVisitor;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.lang.manifest.psi.Header;

import java.util.ArrayList;
import java.util.List;

public class ManifestFoldingBuilder extends FoldingBuilderEx implements DumbAware {

/**
* The <a href="https://docs.oracle.com/en/java/javase/22/docs/specs/jar/jar.html#notes-on-manifest-and-signature-files">JAR file
* specification</a> states each line should be no longer than 72 bytes
*/
private static final int MAX_BYTES_PER_LINE = 72;
private static final String ELLIPSIS = "...";

@Override
public FoldingDescriptor @NotNull [] buildFoldRegions(@NotNull PsiElement root, @NotNull Document document, boolean quick) {
List<FoldingDescriptor> descriptors = new ArrayList<>();

root.accept(new PsiRecursiveElementVisitor() {
@Override
public void visitElement(@NotNull PsiElement element) {
super.visitElement(element);

if (element instanceof Header header) {
// Prevent collapsing the new lines too
var textRange = TextRange.from(header.getTextRange().getStartOffset(), getTextLengthWithoutFinalNewline(header));
descriptors.add(new FoldingDescriptor(element, textRange));
}
}
});

return descriptors.toArray(FoldingDescriptor.EMPTY_ARRAY);
}

@Nullable
@Override
public String getPlaceholderText(@NotNull ASTNode node) {
if (node.getPsi() instanceof Header) {
String usefulText = node.getText().trim();
if (usefulText.length() <= MAX_BYTES_PER_LINE) {
Copy link
Author

Choose a reason for hiding this comment

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

Seems like a useful proxy, the viewer cuts off placeholders that are too long with soft-wrapping (well you can still horizontally scroll).

In this case, adding more detail in the placeholder shouldn't add more cognitive load

return node.getText();
}
int endIndex = Math.min(MAX_BYTES_PER_LINE - ELLIPSIS.length(), usefulText.length());
return node.getText().substring(0, endIndex) + ELLIPSIS;
}

return null;
}

@Override
public boolean isCollapsedByDefault(@NotNull ASTNode node) {
return false; // no change in existing behaviour
Copy link
Author

Choose a reason for hiding this comment

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

I think we can avoid this discussion for now. What the heuristic should be, should probably be discussed in an issue IMO

}

private static int getTextLengthWithoutFinalNewline(PsiElement psiElement) {
int lengthOfTextWithoutFinalNewline = psiElement.getTextLength();
if (psiElement.getText().endsWith("\n") || psiElement.getText().endsWith("\r")) {
lengthOfTextWithoutFinalNewline -= 1;
}
else if (psiElement.getText().endsWith("\r\n")) {
lengthOfTextWithoutFinalNewline -= 2;
}
return lengthOfTextWithoutFinalNewline;
}
}