-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
mkem114
wants to merge
1
commit into
JetBrains:master
Choose a base branch
from
mkem114:jar-manifest-folding
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
78 changes: 78 additions & 0 deletions
78
java/manifest/src/org/jetbrains/lang/manifest/folding/ManifestFoldingBuilder.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) { | ||
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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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; | ||
} | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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