Skip to content

Commit ab412d7

Browse files
committed
Switch to Platform.getDebugBoolean(String) where appropriate
With 3b76d20, a convenience method `getDebugBoolean(String)` was added, which returns `true` if the given tracing option is enabled. Using this method avoids a lot of the boilerplate code that comes with using `getDebugOption(String)` and which usually looks something like: `"true".equals(Platform.getDebugOption("..."))`
1 parent 2faab29 commit ab412d7

21 files changed

Lines changed: 36 additions & 73 deletions

File tree

docs/FAQ/FAQ_How_do_I_use_the_platform_debug_tracing_facility.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ If you do not need dynamic trace enablement or if you are concerned about code c
3434

3535

3636
```java
37-
private static final boolean DEBUG_TWO = "true".equalsIgnoreCase(Platform.getDebugOption(
37+
private static final boolean DEBUG_TWO = Platform.getDebugBoolean(
3838
"org.eclipse.faq.examples/debug/option2"));
3939
...
4040
if (DEBUG_TWO)

runtime/bundles/org.eclipse.core.expressions/src/org/eclipse/core/internal/expressions/Expressions.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ public class Expressions {
5656
private static WeakHashMap<ClassLoader, Set<String>> fgNotFoundClasses;
5757

5858
/* debugging flag to enable tracing */
59-
public static final boolean TRACING= "true".equalsIgnoreCase(Platform.getDebugOption("org.eclipse.core.expressions/tracePropertyResolving")); //$NON-NLS-1$ //$NON-NLS-2$
59+
public static final boolean TRACING= Platform.getDebugBoolean("org.eclipse.core.expressions/tracePropertyResolving"); //$NON-NLS-1$
6060

6161

6262
private Expressions() {

runtime/bundles/org.eclipse.core.expressions/src/org/eclipse/core/internal/expressions/TypeExtensionManager.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public class TypeExtensionManager implements IRegistryChangeListener {
4040
*
4141
* @since 3.5
4242
*/
43-
private static boolean DEBUG= "true".equalsIgnoreCase(Platform.getDebugOption("org.eclipse.core.expressions/debug/TypeExtensionManager")); //$NON-NLS-1$//$NON-NLS-2$
43+
private static boolean DEBUG = Platform.getDebugBoolean("org.eclipse.core.expressions/debug/TypeExtensionManager"); //$NON-NLS-1$
4444

4545
private static final String TYPE= "type"; //$NON-NLS-1$
4646

terminal/bundles/org.eclipse.terminal.control/src/org/eclipse/terminal/connector/Logger.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,10 @@ public static void setUnderTest(boolean underTest) {
5959

6060
static {
6161
// Any of the known debugging options turns on the creation of the log file
62-
boolean createLogFile = TerminalPlugin.isOptionEnabled(TRACE_DEBUG_LOG)
63-
|| TerminalPlugin.isOptionEnabled(TRACE_DEBUG_LOG_CHAR)
64-
|| TerminalPlugin.isOptionEnabled(TRACE_DEBUG_LOG_VT100BACKEND)
65-
|| TerminalPlugin.isOptionEnabled(TRACE_DEBUG_LOG_HOVER);
62+
boolean createLogFile = Platform.getDebugBoolean(TRACE_DEBUG_LOG)
63+
|| Platform.getDebugBoolean(TRACE_DEBUG_LOG_CHAR)
64+
|| Platform.getDebugBoolean(TRACE_DEBUG_LOG_VT100BACKEND)
65+
|| Platform.getDebugBoolean(TRACE_DEBUG_LOG_HOVER);
6666

6767
// Log only if tracing is enabled
6868
if (createLogFile && TerminalPlugin.getDefault() != null) {

terminal/bundles/org.eclipse.terminal.control/src/org/eclipse/terminal/internal/control/impl/TerminalPlugin.java

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@
2020
*******************************************************************************/
2121
package org.eclipse.terminal.internal.control.impl;
2222

23-
import org.eclipse.core.runtime.Platform;
2423
import org.eclipse.ui.plugin.AbstractUIPlugin;
2524
import org.osgi.framework.BundleContext;
2625

@@ -54,13 +53,4 @@ public void stop(BundleContext context) throws Exception {
5453
super.stop(context);
5554
}
5655

57-
public static boolean isOptionEnabled(String strOption) {
58-
String strEnabled = Platform.getDebugOption(strOption);
59-
if (strEnabled == null) {
60-
return false;
61-
}
62-
63-
return Boolean.parseBoolean(strEnabled);
64-
}
65-
6656
}

terminal/bundles/org.eclipse.terminal.control/src/org/eclipse/terminal/internal/emulator/VT100Emulator.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,14 @@
4242
import java.io.Reader;
4343
import java.util.Arrays;
4444

45+
import org.eclipse.core.runtime.Platform;
4546
import org.eclipse.swt.events.ControlEvent;
4647
import org.eclipse.swt.events.ControlListener;
4748
import org.eclipse.swt.graphics.RGB;
4849
import org.eclipse.terminal.connector.ITerminalConnector;
4950
import org.eclipse.terminal.connector.Logger;
5051
import org.eclipse.terminal.control.TerminalTitleRequestor;
5152
import org.eclipse.terminal.internal.control.impl.ITerminalControlForText;
52-
import org.eclipse.terminal.internal.control.impl.TerminalPlugin;
5353
import org.eclipse.terminal.model.ITerminalTextData;
5454
import org.eclipse.terminal.model.TerminalStyle;
5555

@@ -168,7 +168,7 @@ public VT100Emulator(ITerminalTextData data, ITerminalControlForText terminal, R
168168
ansiParameters[i] = new StringBuffer();
169169
}
170170
setInputStreamReader(reader);
171-
if (TerminalPlugin.isOptionEnabled(Logger.TRACE_DEBUG_LOG_VT100BACKEND)) {
171+
if (Platform.getDebugBoolean(Logger.TRACE_DEBUG_LOG_VT100BACKEND)) {
172172
text = new VT100BackendTraceDecorator(new VT100EmulatorBackend(data), System.out);
173173
} else {
174174
text = new VT100EmulatorBackend(data);

terminal/bundles/org.eclipse.terminal.control/src/org/eclipse/terminal/internal/emulator/VT100TerminalControl.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@
5858
import org.eclipse.core.runtime.Assert;
5959
import org.eclipse.core.runtime.IProgressMonitor;
6060
import org.eclipse.core.runtime.IStatus;
61+
import org.eclipse.core.runtime.Platform;
6162
import org.eclipse.core.runtime.Status;
6263
import org.eclipse.core.runtime.jobs.Job;
6364
import org.eclipse.jface.bindings.Binding;
@@ -828,7 +829,7 @@ public OutputStream getRemoteToTerminalOutputStream() {
828829
}
829830

830831
protected boolean isLogCharEnabled() {
831-
return TerminalPlugin.isOptionEnabled(Logger.TRACE_DEBUG_LOG_CHAR);
832+
return Platform.getDebugBoolean(Logger.TRACE_DEBUG_LOG_CHAR);
832833
}
833834

834835
@Override

terminal/bundles/org.eclipse.terminal.control/src/org/eclipse/terminal/internal/textcanvas/AbstractTextCanvasModel.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@
1818
import java.util.Iterator;
1919
import java.util.List;
2020

21+
import org.eclipse.core.runtime.Platform;
2122
import org.eclipse.swt.graphics.Point;
2223
import org.eclipse.terminal.connector.Logger;
23-
import org.eclipse.terminal.internal.control.impl.TerminalPlugin;
2424
import org.eclipse.terminal.model.ITerminalTextDataReadOnly;
2525
import org.eclipse.terminal.model.ITerminalTextDataSnapshot;
2626
import org.eclipse.terminal.model.TextRange;
2727

2828
abstract public class AbstractTextCanvasModel implements ITextCanvasModel {
29-
private static final boolean DEBUG_HOVER = TerminalPlugin.isOptionEnabled(Logger.TRACE_DEBUG_LOG_HOVER);
29+
private static final boolean DEBUG_HOVER = Platform.getDebugBoolean(Logger.TRACE_DEBUG_LOG_HOVER);
3030
protected List<ITextCanvasModelListener> fListeners = new ArrayList<>();
3131
private int fCursorLine;
3232
private int fCursorColumn;

terminal/bundles/org.eclipse.terminal.control/src/org/eclipse/terminal/internal/textcanvas/TextLineRenderer.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@
1919
import java.util.Map;
2020
import java.util.function.Supplier;
2121

22+
import org.eclipse.core.runtime.Platform;
2223
import org.eclipse.swt.graphics.Color;
2324
import org.eclipse.swt.graphics.Drawable;
2425
import org.eclipse.swt.graphics.Font;
2526
import org.eclipse.swt.graphics.GC;
2627
import org.eclipse.swt.graphics.Point;
2728
import org.eclipse.terminal.connector.Logger;
28-
import org.eclipse.terminal.internal.control.impl.TerminalPlugin;
2929
import org.eclipse.terminal.model.ITerminalTextDataReadOnly;
3030
import org.eclipse.terminal.model.LineSegment;
3131
import org.eclipse.terminal.model.TerminalColor;
@@ -35,7 +35,7 @@
3535
*
3636
*/
3737
public class TextLineRenderer implements ILinelRenderer {
38-
private static final boolean DEBUG_HOVER = TerminalPlugin.isOptionEnabled(Logger.TRACE_DEBUG_LOG_HOVER);
38+
private static final boolean DEBUG_HOVER = Platform.getDebugBoolean(Logger.TRACE_DEBUG_LOG_HOVER);
3939
private final ITextCanvasModel fModel;
4040
private final StyleMap fStyleMap;
4141

terminal/bundles/org.eclipse.terminal.control/src/org/eclipse/terminal/model/TerminalStyle.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@
1515
import java.util.Map;
1616

1717
import org.eclipse.core.runtime.Assert;
18+
import org.eclipse.core.runtime.Platform;
1819
import org.eclipse.swt.graphics.RGB;
1920
import org.eclipse.terminal.connector.Logger;
20-
import org.eclipse.terminal.internal.control.impl.TerminalPlugin;
2121

2222
/**
2323
* @author scharf
@@ -43,7 +43,7 @@ public class TerminalStyle {
4343
protected boolean removeEldestEntry(Map.Entry<TerminalStyle, TerminalStyle> eldest) {
4444
int size = size();
4545
boolean removeEldest = size >= 1000;
46-
if (TerminalPlugin.isOptionEnabled(Logger.TRACE_DEBUG_LOG_VT100BACKEND)) {
46+
if (Platform.getDebugBoolean(Logger.TRACE_DEBUG_LOG_VT100BACKEND)) {
4747
if (removeEldest) {
4848
Logger.log("Removing eldest Style from style cache, size = " + size); //$NON-NLS-1$
4949
} else {

0 commit comments

Comments
 (0)