Skip to content

Accommodate pre-processor lines in sticky lines provider #1480

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 20, 2026
+65 −2
Merged

Accommodate pre-processor lines in sticky lines provider #1480

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
67 changes: 65 additions & 2 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 @@ -14,6 +14,8 @@
*******************************************************************************/
package org.eclipse.cdt.internal.ui.editor;

import java.util.ArrayDeque;
import java.util.Deque;
import java.util.LinkedList;
import java.util.List;

Expand All @@ -29,6 +31,13 @@
import org.eclipse.cdt.core.dom.ast.IASTIfStatement;
import org.eclipse.cdt.core.dom.ast.IASTNode;
import org.eclipse.cdt.core.dom.ast.IASTNodeSelector;
import org.eclipse.cdt.core.dom.ast.IASTPreprocessorElifStatement;
import org.eclipse.cdt.core.dom.ast.IASTPreprocessorElseStatement;
import org.eclipse.cdt.core.dom.ast.IASTPreprocessorEndifStatement;
import org.eclipse.cdt.core.dom.ast.IASTPreprocessorIfStatement;
import org.eclipse.cdt.core.dom.ast.IASTPreprocessorIfdefStatement;
import org.eclipse.cdt.core.dom.ast.IASTPreprocessorIfndefStatement;
import org.eclipse.cdt.core.dom.ast.IASTPreprocessorStatement;
import org.eclipse.cdt.core.dom.ast.IASTReturnStatement;
import org.eclipse.cdt.core.dom.ast.IASTStatement;
import org.eclipse.cdt.core.dom.ast.IASTSwitchStatement;
Expand Down Expand Up @@ -68,7 +77,7 @@ public class CSourceStickyLinesProvider implements IStickyLinesProvider {
public List<IStickyLine> getStickyLines(ISourceViewer sourceViewer, int lineNumber,
StickyLinesProperties properties) {
final long startTime = System.currentTimeMillis();
final LinkedList<IStickyLine> stickyLines = new LinkedList<>();
List<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);
Expand Down Expand Up @@ -119,23 +128,33 @@ public List<IStickyLine> getStickyLines(ISourceViewer sourceViewer, int lineNumb
try {
final int offset = sourceViewer.getDocument().getLineOffset(lineNumber);
node = nodeSelector.findEnclosingNode(offset, line.length());
if (node instanceof IASTPreprocessorStatement) {
// find enclosing non-preprocessor node using adjusted offset
final int nodeOffset = node.getFileLocation().getNodeOffset();
node = nodeSelector.findEnclosingNode(nodeOffset - 1, 2);
}
} catch (BadLocationException e) {
ILog.get().error("Error getting line offset for sticky lines", e); //$NON-NLS-1$
return stickyLines;
}

// process sticky ancestor nodes
final LinkedList<IStickyLine> ancestorLines = new LinkedList<>();
while (null != node) {
if (DEBUG) {
System.out.printf("> Examining AST node: %s (lines %d-%d)\n", node.getClass().getSimpleName(), //$NON-NLS-1$
node.getFileLocation().getStartingLineNumber(),
node.getFileLocation().getEndingLineNumber());
}
if (nodeInstanceOfStickyClass(node)) {
processStickyNode(node, fileLineNumber, sourceViewer, stickyLines);
processStickyNode(node, fileLineNumber, sourceViewer, ancestorLines);
}
node = node.getParent();
}

// process sticky pre-processor nodes and merge with ancestor nodes
final List<IStickyLine> preprocessorLines = findPreprocessorStickyLines(fileLineNumber, sourceViewer);
stickyLines = mergeStickyLines(ancestorLines, preprocessorLines);
}
if (DEBUG) {
System.out.println("> Sticky line count: " + stickyLines.size()); //$NON-NLS-1$
Expand All @@ -144,6 +163,45 @@ public List<IStickyLine> getStickyLines(ISourceViewer sourceViewer, int lineNumb
return stickyLines;
}

private List<IStickyLine> findPreprocessorStickyLines(int fileLineNumber, ISourceViewer sourceViewer) {
final Deque<IASTPreprocessorStatement> stack = new ArrayDeque<>();
for (IASTPreprocessorStatement statement : fAst.getAllPreprocessorStatements()) {
if (statement.getFileLocation().getStartingLineNumber() >= fileLineNumber) {
break;
}
if (nodeInstanceOfPreprocessorIfClass(statement) || statement instanceof IASTPreprocessorElifStatement
|| statement instanceof IASTPreprocessorElseStatement) {
stack.push(statement);
} else if (statement instanceof IASTPreprocessorEndifStatement) {
IASTPreprocessorStatement previous = statement;
while (!stack.isEmpty() && !nodeInstanceOfPreprocessorIfClass(previous)) {
previous = stack.pop();
}
}
}
final LinkedList<IStickyLine> stickyLines = new LinkedList<>();
stack.forEach(statement -> addStickyLine(statement.getFileLocation().getStartingLineNumber(), sourceViewer,
stickyLines));
return stickyLines;
}

private List<IStickyLine> mergeStickyLines(List<IStickyLine> lines1, List<IStickyLine> lines2) {
final Deque<IStickyLine> deque1 = new ArrayDeque<>(lines1);
final Deque<IStickyLine> deque2 = new ArrayDeque<>(lines2);
final List<IStickyLine> mergedLines = new LinkedList<>();
while (null != deque1.peek() && null != deque2.peek()) {
// assume both lists are sorted in ascending line number order
if (deque1.peek().getLineNumber() < deque2.peek().getLineNumber()) {
mergedLines.add(deque1.pop());
} else {
mergedLines.add(deque2.pop());
}
}
mergedLines.addAll(deque1);
mergedLines.addAll(deque2);
return mergedLines;
}

private void processStickyNode(IASTNode node, int fileLineNumber, ISourceViewer sourceViewer,
LinkedList<IStickyLine> stickyLines) {
final int startingLineNumber = node.getFileLocation().getStartingLineNumber();
Expand Down Expand Up @@ -224,6 +282,11 @@ private boolean nodeInstanceOfStickyClass(IASTNode node) {
return STICKY_NODE_CLASSES.stream().anyMatch(nodeClass -> nodeClass.isInstance(node));
}

private boolean nodeInstanceOfPreprocessorIfClass(IASTNode node) {
return node instanceof IASTPreprocessorIfStatement || node instanceof IASTPreprocessorIfdefStatement
|| node instanceof IASTPreprocessorIfndefStatement;
}

private ICElement getInputElement(IEditorPart part) {
final IEditorInput editorInput = part.getEditorInput();
if (null != editorInput) {
Expand Down
Loading