Skip to content

Accommodate folding regions in sticky lines provider #1479

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.

Sign up for GitHub

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

Merged
jld01 merged 1 commit into from
Jun 16, 2026
+25 −14
Merged

Accommodate folding regions in sticky lines provider #1479

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
39 changes: 25 additions & 14 deletions ...org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/editor/CSourceStickyLinesProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
import org.eclipse.core.runtime.ILog;
import org.eclipse.core.runtime.Platform;
import org.eclipse.jface.text.AbstractDocument;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.ITextViewerExtension5;
import org.eclipse.jface.text.source.ISourceViewer;
import org.eclipse.swt.custom.StyledText;
Expand All @@ -68,8 +69,11 @@ public List<IStickyLine> getStickyLines(ISourceViewer sourceViewer, int lineNumb
StickyLinesProperties properties) {
final long startTime = System.currentTimeMillis();
final LinkedList<IStickyLine> stickyLines = new LinkedList<>();
// lineNumber in the zero-based line number as known to the IDocument
// textWidgetLineNumber is the the line number as known to the ISourceViewer
final int textWidgetLineNumber = mapLineNumberToWidget(sourceViewer, lineNumber);
final int fileLineNumber = textWidgetLineNumber + 1;
// fileLineNumber is the 1-based line number as known to the AST and the underlying source file
final int fileLineNumber = lineNumber + 1;
if (DEBUG) {
System.out.println("Sticky lines request at source line: " + fileLineNumber); //$NON-NLS-1$
}
Expand Down Expand Up @@ -111,8 +115,14 @@ public List<IStickyLine> getStickyLines(ISourceViewer sourceViewer, int lineNumb
final StyledText textWidget = sourceViewer.getTextWidget();
final IASTNodeSelector nodeSelector = fAst.getNodeSelector(fAst.getFilePath());
final String line = textWidget.getLine(textWidgetLineNumber);
final int offset = textWidget.getOffsetAtLine(textWidgetLineNumber);
IASTNode node = nodeSelector.findEnclosingNode(offset, line.length());
IASTNode node = null;
try {
final int offset = sourceViewer.getDocument().getLineOffset(lineNumber);
node = nodeSelector.findEnclosingNode(offset, line.length());
} catch (BadLocationException e) {
ILog.get().error("Error getting line offset for sticky lines", e); //$NON-NLS-1$
return stickyLines;
}

// process sticky ancestor nodes
while (null != node) {
Expand Down Expand Up @@ -191,21 +201,22 @@ private void processElseClause(IASTIfStatement ifStatement, int fileLineNumber,
final int startingLineNumber = ifStatement.getThenClause().getFileLocation().getEndingLineNumber();
final int endingLineNumber = Math.min(elseClause.getFileLocation().getStartingLineNumber(), fileLineNumber - 1);
final StyledText textWidget = sourceViewer.getTextWidget();
for (int lineNumber = endingLineNumber; lineNumber >= startingLineNumber; lineNumber--) {
if (textWidget.getLine(lineNumber - 1).contains("else")) { //$NON-NLS-1$
addStickyLine(lineNumber, sourceViewer, stickyLines);
for (int fileLineNum = endingLineNumber; fileLineNum >= startingLineNumber; fileLineNum--) {
final int textWidgetLineNumber = mapLineNumberToWidget(sourceViewer, fileLineNum - 1);
if (textWidget.getLine(textWidgetLineNumber).contains("else")) { //$NON-NLS-1$
addStickyLine(fileLineNum, sourceViewer, stickyLines);
}
}
}

private void addStickyLine(int sourceLineNumber, ISourceViewer sourceViewer, LinkedList<IStickyLine> stickyLines) {
final int textWidgetLineNumber = sourceLineNumber - 1;
private void addStickyLine(int fileLineNumber, ISourceViewer sourceViewer, LinkedList<IStickyLine> stickyLines) {
final int lineNumber = fileLineNumber - 1;
// suppress duplicate sticky lines
if (stickyLines.isEmpty() || (stickyLines.getFirst().getLineNumber() > textWidgetLineNumber)) {
if (stickyLines.isEmpty() || (stickyLines.getFirst().getLineNumber() > lineNumber)) {
if (DEBUG) {
System.out.println("> Sticky line: " + sourceLineNumber); //$NON-NLS-1$
System.out.println("> Sticky line: " + fileLineNumber); //$NON-NLS-1$
}
stickyLines.addFirst(new StickyLine(textWidgetLineNumber, sourceViewer));
stickyLines.addFirst(new StickyLine(lineNumber, sourceViewer));
}
}

Expand All @@ -221,11 +232,11 @@ private ICElement getInputElement(IEditorPart part) {
return null;
}

private int mapLineNumberToWidget(ISourceViewer sourceViewer, int line) {
private int mapLineNumberToWidget(ISourceViewer sourceViewer, int lineNumber) {
if (sourceViewer instanceof ITextViewerExtension5 extension) {
return extension.modelLine2WidgetLine(line); // -1 if line not found
return extension.modelLine2WidgetLine(lineNumber); // -1 if line not found
}
return line;
return lineNumber;
}

}
Loading