Skip to content

Commit

Permalink
Fix folding of 2 consecutive methods
Browse files Browse the repository at this point in the history
If the second method starts in the same line the first one ends then
there will still be 2 foldings.

Fixes #1539
  • Loading branch information
jakub-suliga committed Jan 22, 2025
1 parent 07237c8 commit d011021
Show file tree
Hide file tree
Showing 3 changed files with 126 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import org.eclipse.jdt.text.tests.codemining.CodeMiningTriggerTest;
import org.eclipse.jdt.text.tests.codemining.ParameterNamesCodeMiningTest;
import org.eclipse.jdt.text.tests.contentassist.ContentAssistTestSuite;
import org.eclipse.jdt.text.tests.folding.FoldingTest;
import org.eclipse.jdt.text.tests.semantictokens.SemanticTokensProviderTest;
import org.eclipse.jdt.text.tests.spelling.SpellCheckEngineTestCase;
import org.eclipse.jdt.text.tests.templates.TemplatesTestSuite;
Expand Down Expand Up @@ -70,6 +71,7 @@
JavaElementPrefixPatternMatcherTest.class,
CodeMiningTriggerTest.class,
ParameterNamesCodeMiningTest.class,
FoldingTest.class
})
public class JdtTextTestSuite {
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
/*******************************************************************************
* Copyright (c) 2025 Vector Informatik GmbH and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* Vector Informatik GmbH - initial API and implementation
*******************************************************************************/
package org.eclipse.jdt.text.tests.folding;

import static org.junit.jupiter.api.Assertions.assertTrue;

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

import org.junit.After;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;

import org.eclipse.jdt.testplugin.JavaProjectHelper;

import org.eclipse.core.runtime.CoreException;

import org.eclipse.jface.text.IRegion;
import org.eclipse.jface.text.Position;
import org.eclipse.jface.text.Region;
import org.eclipse.jface.text.source.Annotation;
import org.eclipse.jface.text.source.projection.ProjectionAnnotation;
import org.eclipse.jface.text.source.projection.ProjectionAnnotationModel;

import org.eclipse.ui.PartInitException;

import org.eclipse.jdt.core.ICompilationUnit;
import org.eclipse.jdt.core.IJavaProject;
import org.eclipse.jdt.core.IPackageFragment;
import org.eclipse.jdt.core.IPackageFragmentRoot;
import org.eclipse.jdt.core.JavaModelException;

import org.eclipse.jdt.ui.tests.core.rules.ProjectTestSetup;

import org.eclipse.jdt.internal.ui.javaeditor.EditorUtility;
import org.eclipse.jdt.internal.ui.javaeditor.JavaEditor;

public class FoldingTest {
@Rule
public ProjectTestSetup projectSetup= new ProjectTestSetup();

private IJavaProject jProject;

private IPackageFragmentRoot sourceFolder;

private IPackageFragment packageFragment;

@Before
public void setUp() throws CoreException {
jProject= projectSetup.getProject();
sourceFolder= jProject.findPackageFragmentRoot(jProject.getResource().getFullPath().append("src"));
if (sourceFolder == null) {
sourceFolder= JavaProjectHelper.addSourceContainer(jProject, "src");
}
packageFragment= sourceFolder.createPackageFragment("org.example.test", false, null);
}

@After
public void tearDown() throws CoreException {
JavaProjectHelper.delete(jProject);
}

@Test
public void testMethodDeclarationFoldingWithSameLineStart() throws JavaModelException, PartInitException {
String str= """
package org.example.test;
public class Q {
void a() {
int i = 0;
}void b() {
}
}
""";
List<IRegion> regions= getProjectionRangesOfFile(str);
assertTrue(regions.size() == 2, String.format("Expected %d regions but saw %d.", 2, regions.size()));

regions.sort((r1, r2) -> Integer.compare(r1.getOffset(), r2.getOffset()));
IRegion methodARegion= regions.get(0);
IRegion methodBRegion= regions.get(1);
int methodAEnd= methodARegion.getOffset() + methodARegion.getLength();
int methodBStart= methodBRegion.getOffset();
assertTrue(methodBStart >= methodAEnd, String.format("void b() should start void a(){}, but it wasnt. void b() started at %d and void a() ended at %d", methodBStart, methodAEnd));
}

private List<IRegion> getProjectionRangesOfFile(String str) throws JavaModelException, PartInitException {
ICompilationUnit cu= packageFragment.createCompilationUnit("TestFolding.java", str, true, null);
JavaEditor editor= (JavaEditor) EditorUtility.openInEditor(cu);
ProjectionAnnotationModel model= editor.getAdapter(ProjectionAnnotationModel.class);
List<IRegion> regions= new ArrayList<>();
Iterator<Annotation> it= model.getAnnotationIterator();
while (it.hasNext()) {
Annotation a= it.next();
if (a instanceof ProjectionAnnotation) {
Position p= model.getPosition(a);
regions.add(new Region(p.getOffset(), p.getLength()));
}
}
return regions;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -721,6 +721,8 @@ public void projectionDisabled() {
}
}

boolean includelastLine = false;

/* context and listeners */
private JavaEditor fEditor;
private ProjectionListener fProjectionListener;
Expand Down Expand Up @@ -1035,13 +1037,13 @@ private void computeFoldingStructure(IJavaElement[] elements, FoldingStructureCo
* @param ctx the computation context
*/
protected void computeFoldingStructure(IJavaElement element, FoldingStructureComputationContext ctx) {

boolean collapse= false;
boolean collapseCode= true;
switch (element.getElementType()) {

case IJavaElement.IMPORT_CONTAINER:
collapse= ctx.collapseImportContainer();
includelastLine = true;
break;
case IJavaElement.TYPE:
collapseCode= isInnerType((IType) element) && !isAnonymousEnum((IType) element);
Expand Down Expand Up @@ -1271,6 +1273,7 @@ protected final Position createMemberPosition(IRegion aligned, IMember member) {
* @return a region equal or greater than <code>region</code> that is aligned with line
* offsets, <code>null</code> if the region is too small to be foldable (e.g. covers
* only one line)
* @since 3.34
*/
protected final IRegion alignRegion(IRegion region, FoldingStructureComputationContext ctx) {
if (region == null)
Expand All @@ -1279,23 +1282,22 @@ protected final IRegion alignRegion(IRegion region, FoldingStructureComputationC
IDocument document= ctx.getDocument();

try {

int start= document.getLineOfOffset(region.getOffset());
int end= document.getLineOfOffset(region.getOffset() + region.getLength());
int end= document.getLineOfOffset(region.getOffset() - 1 + region.getLength());
if (start >= end)
return null;

int offset= document.getLineOffset(start);
int endOffset;
if (document.getNumberOfLines() > end + 1)
if (includelastLine) {
endOffset= document.getLineOffset(end + 1);
else
endOffset= document.getLineOffset(end) + document.getLineLength(end);
includelastLine = false;
}
else {
endOffset= document.getLineOffset(end);
}

return new Region(offset, endOffset - offset);

} catch (BadLocationException x) {
// concurrent modification
return null;
}
}
Expand Down

0 comments on commit d011021

Please sign in to comment.