Skip to content

Refactor debug conditionals for improved readability in content assist #3355

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
merged 1 commit into from
Oct 2, 2025
Merged

Refactor debug conditionals for improved readability in content assist #3355

Show file tree
Hide file tree
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
54 changes: 36 additions & 18 deletions ....text/src/org/eclipse/jface/contentassist/AbstractControlContentAssistSubjectAdapter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,9 @@ public AbstractControlContentAssistSubjectAdapter() {
public void addKeyListener(KeyListener keyListener) {
fKeyListeners.add(keyListener);

if (DEBUG)
if (DEBUG) {
System.out.println("AbstractControlContentAssistSubjectAdapter#addKeyListener()"); //$NON-NLS-1$
}

installControlListener();
}
Expand All @@ -110,8 +111,9 @@ public void removeKeyListener(KeyListener keyListener) {
boolean deleted= fKeyListeners.remove(keyListener);

if (DEBUG) {
if (!deleted)
if (!deleted) {
System.out.println("removeKeyListener -> wasn't here"); //$NON-NLS-1$
}
System.out.println("AbstractControlContentAssistSubjectAdapter#removeKeyListener() -> " + fKeyListeners.size()); //$NON-NLS-1$
}

Expand All @@ -127,8 +129,9 @@ public boolean supportsVerifyKeyListener() {
public boolean appendVerifyKeyListener(final VerifyKeyListener verifyKeyListener) {
fVerifyKeyListeners.add(verifyKeyListener);

if (DEBUG)
if (DEBUG) {
System.out.println("AbstractControlContentAssistSubjectAdapter#appendVerifyKeyListener() -> " + fVerifyKeyListeners.size()); //$NON-NLS-1$
}

installControlListener();
return true;
Expand All @@ -138,8 +141,9 @@ public boolean appendVerifyKeyListener(final VerifyKeyListener verifyKeyListener
public boolean prependVerifyKeyListener(final VerifyKeyListener verifyKeyListener) {
fVerifyKeyListeners.add(0, verifyKeyListener);

if (DEBUG)
if (DEBUG) {
System.out.println("AbstractControlContentAssistSubjectAdapter#prependVerifyKeyListener() -> " + fVerifyKeyListeners.size()); //$NON-NLS-1$
}

installControlListener();
return true;
Expand All @@ -149,17 +153,19 @@ public boolean prependVerifyKeyListener(final VerifyKeyListener verifyKeyListene
public void removeVerifyKeyListener(VerifyKeyListener verifyKeyListener) {
fVerifyKeyListeners.remove(verifyKeyListener);

if (DEBUG)
if (DEBUG) {
System.out.println("AbstractControlContentAssistSubjectAdapter#removeVerifyKeyListener() -> " + fVerifyKeyListeners.size()); //$NON-NLS-1$
}

uninstallControlListener();
}

@Override
public void setEventConsumer(IEventConsumer eventConsumer) {
// this is not supported
if (DEBUG)
if (DEBUG) {
System.out.println("AbstractControlContentAssistSubjectAdapter#setEventConsumer()"); //$NON-NLS-1$
}
}

@Override
Expand All @@ -172,38 +178,44 @@ public String getLineDelimiter() {
* passing them to {@link #fVerifyKeyListeners} and {@link #fKeyListeners}.
*/
private void installControlListener() {
if (DEBUG)
if (DEBUG) {
System.out.println("AbstractControlContentAssistSubjectAdapter#installControlListener() -> k: " + fKeyListeners.size() + ", v: " + fVerifyKeyListeners.size()); //$NON-NLS-1$ //$NON-NLS-2$
}

if (fControlListener != null)
if (fControlListener != null) {
return;
}

fControlListener= new Listener() {
@Override
public void handleEvent(Event e) {
if (! getControl().isFocusControl())
if (! getControl().isFocusControl()) {
return; //SWT.TRAVERSE_MNEMONIC events can also come in to inactive widgets
}
VerifyEvent verifyEvent= new VerifyEvent(e);
KeyEvent keyEvent= new KeyEvent(e);
switch (e.type) {
case SWT.Traverse :

if (DEBUG)
if (DEBUG) {
dump("before traverse", e, verifyEvent); //$NON-NLS-1$
}

verifyEvent.doit= true;
for (VerifyKeyListener verifyKeyListener : fVerifyKeyListeners) {
verifyKeyListener.verifyKey(verifyEvent);
if (! verifyEvent.doit) {
e.detail= SWT.TRAVERSE_NONE;
e.doit= true;
if (DEBUG)
if (DEBUG) {
dump("traverse eaten by verify", e, verifyEvent); //$NON-NLS-1$
}
return;
}

if (DEBUG)
if (DEBUG) {
dump("traverse OK", e, verifyEvent); //$NON-NLS-1$
}
}
break;

Expand All @@ -212,14 +224,16 @@ public void handleEvent(Event e) {
verifyKeyListener.verifyKey(verifyEvent);
if (! verifyEvent.doit) {
e.doit= verifyEvent.doit;
if (DEBUG)
if (DEBUG) {
dump("keyDown eaten by verify", e, verifyEvent); //$NON-NLS-1$
}
return;
}
}

if (DEBUG)
if (DEBUG) {
dump("keyDown OK", e, verifyEvent); //$NON-NLS-1$
}

for (KeyListener keyListener : fKeyListeners) {
keyListener.keyPressed(keyEvent);
Expand Down Expand Up @@ -263,8 +277,9 @@ private String hex(int i) {
getControl().addListener(SWT.Traverse, fControlListener);
getControl().addListener(SWT.KeyDown, fControlListener);

if (DEBUG)
if (DEBUG) {
System.out.println("AbstractControlContentAssistSubjectAdapter#installControlListener() - installed"); //$NON-NLS-1$
}
}

/**
Expand All @@ -275,17 +290,19 @@ private String hex(int i) {
private void uninstallControlListener() {
if (fControlListener == null || fKeyListeners.size() + fVerifyKeyListeners.size() != 0) {

if (DEBUG)
if (DEBUG) {
System.out.println("AbstractControlContentAssistSubjectAdapter#uninstallControlListener() -> k: " + fKeyListeners.size() + ", v: " + fVerifyKeyListeners.size()); //$NON-NLS-1$ //$NON-NLS-2$
}

return;
}
getControl().removeListener(SWT.Traverse, fControlListener);
getControl().removeListener(SWT.KeyDown, fControlListener);
fControlListener= null;

if (DEBUG)
if (DEBUG) {
System.out.println("AbstractControlContentAssistSubjectAdapter#uninstallControlListener() - done"); //$NON-NLS-1$
}
}

/**
Expand Down Expand Up @@ -349,8 +366,9 @@ public void setContentAssistCueProvider(final ILabelProvider labelProvider) {
ILabelProviderListener listener= event -> {
fControlDecoration.setDescriptionText(labelProvider.getText(getControl()));
Image image= labelProvider.getImage(getControl());
if (image == null)
if (image == null) {
image= getDefaultCueImage();
}
fControlDecoration.setImage(image);
};
labelProvider.addListener(listener);
Expand Down
3 changes: 2 additions & 1 deletion ...ipse.jface.text/src/org/eclipse/jface/contentassist/ComboContentAssistSubjectAdapter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,8 @@ public boolean addSelectionListener(final SelectionListener selectionListener) {
public void removeSelectionListener(SelectionListener selectionListener) {
fCombo.removeSelectionListener(selectionListener);
Listener listener= fModifyListeners.get(selectionListener);
if (listener != null)
if (listener != null) {
fCombo.removeListener(SWT.Modify, listener);
}
}
}
3 changes: 2 additions & 1 deletion ...e.text/src/org/eclipse/jface/contentassist/SubjectControlContextInformationValidator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,9 @@ public boolean isContextInformationValid(int offset) {
IContextInformation[] infos= ((ISubjectControlContentAssistProcessor)fProcessor).computeContextInformation(fContentAssistSubjectControl, offset);
if (infos != null && infos.length > 0) {
for (IContextInformation info : infos) {
if (fContextInformation.equals(info))
if (fContextInformation.equals(info)) {
return true;
}
}
}
}
Expand Down
3 changes: 2 additions & 1 deletion ...lipse.jface.text/src/org/eclipse/jface/contentassist/TextContentAssistSubjectAdapter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,8 @@ public boolean addSelectionListener(final SelectionListener selectionListener) {
public void removeSelectionListener(SelectionListener selectionListener) {
fText.removeSelectionListener(selectionListener);
Listener listener= fModifyListeners.get(selectionListener);
if (listener != null)
if (listener != null) {
fText.removeListener(SWT.Modify, listener);
}
}
}
13 changes: 8 additions & 5 deletions ...rg.eclipse.jface.text/src/org/eclipse/jface/internal/text/InformationControlReplacer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,10 +89,11 @@ public void replaceInformationControl(IInformationControlCreator informationPres

try {
fIsReplacing= true;
if (! fDelayedInformationSet)
if (! fDelayedInformationSet) {
fReplacableInformation= information;
else
} else {
takeFocus= true; // delayed input has been set, so the original info control must have been focused
}
fContentBounds= contentBounds;
fReplaceableArea= subjectArea;

Expand All @@ -117,8 +118,9 @@ protected void computeInformation() {
return;
}

if (DEBUG)
if (DEBUG) {
System.out.println("InformationControlReplacer: no active replaceable"); //$NON-NLS-1$
}
}

/**
Expand All @@ -136,10 +138,11 @@ public void showInformationControl(Rectangle subjectArea, Object information) {
// Caveat: some IInformationControls fail unless setSizeConstraints(..) is called with concrete values
informationControl.setSizeConstraints(controlBounds.width, controlBounds.height);

if (informationControl instanceof IInformationControlExtension2)
if (informationControl instanceof IInformationControlExtension2) {
((IInformationControlExtension2) informationControl).setInput(information);
else
} else {
informationControl.setInformation(information.toString());
}

// need to recompute the bounds because trim might have changed based on input
controlBounds= computeBoundsFromContent(informationControl, fContentBounds);
Expand Down
3 changes: 2 additions & 1 deletion ...rg.eclipse.jface.text/src/org/eclipse/jface/internal/text/NonDeletingPositionUpdater.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,9 @@ public void update(DocumentEvent event) {

Position position= positions[i];

if (position.isDeleted())
if (position.isDeleted()) {
continue;
}

int offset= position.getOffset();
int length= position.getLength();
Expand Down
Loading
Loading