Skip to content

Switch to Platform.getDebugBoolean(String) where appropriate #2785

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

Open
ptziegler wants to merge 1 commit into
base: master
Choose a base branch
from
+36 −73
Open

Switch to Platform.getDebugBoolean(String) where appropriate #2785

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
2 changes: 1 addition & 1 deletion docs/FAQ/FAQ_How_do_I_use_the_platform_debug_tracing_facility.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ If you do not need dynamic trace enablement or if you are concerned about code c


```java
private static final boolean DEBUG_TWO = "true".equalsIgnoreCase(Platform.getDebugOption(
private static final boolean DEBUG_TWO = Platform.getDebugBoolean(
"org.eclipse.faq.examples/debug/option2"));
...
if (DEBUG_TWO)
Expand Down
2 changes: 1 addition & 1 deletion ...s/org.eclipse.core.expressions/src/org/eclipse/core/internal/expressions/Expressions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public class Expressions {
private static WeakHashMap<ClassLoader, Set<String>> fgNotFoundClasses;

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


private Expressions() {
Expand Down
2 changes: 1 addition & 1 deletion ...ipse.core.expressions/src/org/eclipse/core/internal/expressions/TypeExtensionManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public class TypeExtensionManager implements IRegistryChangeListener {
*
* @since 3.5
*/
private static boolean DEBUG= "true".equalsIgnoreCase(Platform.getDebugOption("org.eclipse.core.expressions/debug/TypeExtensionManager")); //$NON-NLS-1$//$NON-NLS-2$
private static boolean DEBUG = Platform.getDebugBoolean("org.eclipse.core.expressions/debug/TypeExtensionManager"); //$NON-NLS-1$

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

Expand Down
8 changes: 4 additions & 4 deletions terminal/bundles/org.eclipse.terminal.control/src/org/eclipse/terminal/connector/Logger.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,10 @@ public static void setUnderTest(boolean underTest) {

static {
// Any of the known debugging options turns on the creation of the log file
boolean createLogFile = TerminalPlugin.isOptionEnabled(TRACE_DEBUG_LOG)
|| TerminalPlugin.isOptionEnabled(TRACE_DEBUG_LOG_CHAR)
|| TerminalPlugin.isOptionEnabled(TRACE_DEBUG_LOG_VT100BACKEND)
|| TerminalPlugin.isOptionEnabled(TRACE_DEBUG_LOG_HOVER);
boolean createLogFile = Platform.getDebugBoolean(TRACE_DEBUG_LOG)
|| Platform.getDebugBoolean(TRACE_DEBUG_LOG_CHAR)
|| Platform.getDebugBoolean(TRACE_DEBUG_LOG_VT100BACKEND)
|| Platform.getDebugBoolean(TRACE_DEBUG_LOG_HOVER);

// Log only if tracing is enabled
if (createLogFile && TerminalPlugin.getDefault() != null) {
Expand Down
10 changes: 0 additions & 10 deletions ...lipse.terminal.control/src/org/eclipse/terminal/internal/control/impl/TerminalPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
*******************************************************************************/
package org.eclipse.terminal.internal.control.impl;

import org.eclipse.core.runtime.Platform;
import org.eclipse.ui.plugin.AbstractUIPlugin;
import org.osgi.framework.BundleContext;

Expand Down Expand Up @@ -54,13 +53,4 @@ public void stop(BundleContext context) throws Exception {
super.stop(context);
}

public static boolean isOptionEnabled(String strOption) {
String strEnabled = Platform.getDebugOption(strOption);
if (strEnabled == null) {
return false;
}

return Boolean.parseBoolean(strEnabled);
}

}
4 changes: 2 additions & 2 deletions ...rg.eclipse.terminal.control/src/org/eclipse/terminal/internal/emulator/VT100Emulator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,14 @@
import java.io.Reader;
import java.util.Arrays;

import org.eclipse.core.runtime.Platform;
import org.eclipse.swt.events.ControlEvent;
import org.eclipse.swt.events.ControlListener;
import org.eclipse.swt.graphics.RGB;
import org.eclipse.terminal.connector.ITerminalConnector;
import org.eclipse.terminal.connector.Logger;
import org.eclipse.terminal.control.TerminalTitleRequestor;
import org.eclipse.terminal.internal.control.impl.ITerminalControlForText;
import org.eclipse.terminal.internal.control.impl.TerminalPlugin;
import org.eclipse.terminal.model.ITerminalTextData;
import org.eclipse.terminal.model.TerminalStyle;

Expand Down Expand Up @@ -168,7 +168,7 @@ public VT100Emulator(ITerminalTextData data, ITerminalControlForText terminal, R
ansiParameters[i] = new StringBuffer();
}
setInputStreamReader(reader);
if (TerminalPlugin.isOptionEnabled(Logger.TRACE_DEBUG_LOG_VT100BACKEND)) {
if (Platform.getDebugBoolean(Logger.TRACE_DEBUG_LOG_VT100BACKEND)) {
text = new VT100BackendTraceDecorator(new VT100EmulatorBackend(data), System.out);
} else {
text = new VT100EmulatorBackend(data);
Expand Down
3 changes: 2 additions & 1 deletion ...pse.terminal.control/src/org/eclipse/terminal/internal/emulator/VT100TerminalControl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@
import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.jobs.Job;
import org.eclipse.jface.bindings.Binding;
Expand Down Expand Up @@ -828,7 +829,7 @@ public OutputStream getRemoteToTerminalOutputStream() {
}

protected boolean isLogCharEnabled() {
return TerminalPlugin.isOptionEnabled(Logger.TRACE_DEBUG_LOG_CHAR);
return Platform.getDebugBoolean(Logger.TRACE_DEBUG_LOG_CHAR);
}

@Override
Expand Down
4 changes: 2 additions & 2 deletions ...erminal.control/src/org/eclipse/terminal/internal/textcanvas/AbstractTextCanvasModel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@
import java.util.Iterator;
import java.util.List;

import org.eclipse.core.runtime.Platform;
import org.eclipse.swt.graphics.Point;
import org.eclipse.terminal.connector.Logger;
import org.eclipse.terminal.internal.control.impl.TerminalPlugin;
import org.eclipse.terminal.model.ITerminalTextDataReadOnly;
import org.eclipse.terminal.model.ITerminalTextDataSnapshot;
import org.eclipse.terminal.model.TextRange;

abstract public class AbstractTextCanvasModel implements ITextCanvasModel {
private static final boolean DEBUG_HOVER = TerminalPlugin.isOptionEnabled(Logger.TRACE_DEBUG_LOG_HOVER);
private static final boolean DEBUG_HOVER = Platform.getDebugBoolean(Logger.TRACE_DEBUG_LOG_HOVER);
protected List<ITextCanvasModelListener> fListeners = new ArrayList<>();
private int fCursorLine;
private int fCursorColumn;
Expand Down
4 changes: 2 additions & 2 deletions ...lipse.terminal.control/src/org/eclipse/terminal/internal/textcanvas/TextLineRenderer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@
import java.util.Map;
import java.util.function.Supplier;

import org.eclipse.core.runtime.Platform;
import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.graphics.Drawable;
import org.eclipse.swt.graphics.Font;
import org.eclipse.swt.graphics.GC;
import org.eclipse.swt.graphics.Point;
import org.eclipse.terminal.connector.Logger;
import org.eclipse.terminal.internal.control.impl.TerminalPlugin;
import org.eclipse.terminal.model.ITerminalTextDataReadOnly;
import org.eclipse.terminal.model.LineSegment;
import org.eclipse.terminal.model.TerminalColor;
Expand All @@ -35,7 +35,7 @@
*
*/
public class TextLineRenderer implements ILinelRenderer {
private static final boolean DEBUG_HOVER = TerminalPlugin.isOptionEnabled(Logger.TRACE_DEBUG_LOG_HOVER);
private static final boolean DEBUG_HOVER = Platform.getDebugBoolean(Logger.TRACE_DEBUG_LOG_HOVER);
private final ITextCanvasModel fModel;
private final StyleMap fStyleMap;

Expand Down
4 changes: 2 additions & 2 deletions ...al/bundles/org.eclipse.terminal.control/src/org/eclipse/terminal/model/TerminalStyle.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
import java.util.Map;

import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.Platform;
import org.eclipse.swt.graphics.RGB;
import org.eclipse.terminal.connector.Logger;
import org.eclipse.terminal.internal.control.impl.TerminalPlugin;

/**
* @author scharf
Expand All @@ -43,7 +43,7 @@ public class TerminalStyle {
protected boolean removeEldestEntry(Map.Entry<TerminalStyle, TerminalStyle> eldest) {
int size = size();
boolean removeEldest = size >= 1000;
if (TerminalPlugin.isOptionEnabled(Logger.TRACE_DEBUG_LOG_VT100BACKEND)) {
if (Platform.getDebugBoolean(Logger.TRACE_DEBUG_LOG_VT100BACKEND)) {
if (removeEldest) {
Logger.log("Removing eldest Style from style cache, size = " + size); //$NON-NLS-1$
} else {
Expand Down
2 changes: 1 addition & 1 deletion .../org.eclipse.terminal.view.ui/src/org/eclipse/terminal/view/ui/internal/TraceHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ protected int getDebugMode() {
* @return <code>true</code> if the slot is defined and enabled, <code>false</code> otherwise.
*/
protected boolean isSlotEnabled(String slotId) {
return fIdentifier != null ? Boolean.parseBoolean(Platform.getDebugOption(fIdentifier + "/" + slotId)) //$NON-NLS-1$
return fIdentifier != null ? Platform.getDebugBoolean(fIdentifier + "/" + slotId) //$NON-NLS-1$
: false;
}

Expand Down
10 changes: 0 additions & 10 deletions ...dles/org.eclipse.terminal.view.ui/src/org/eclipse/terminal/view/ui/internal/UIPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
import java.util.ArrayList;
import java.util.List;

import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.preferences.InstanceScope;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jface.resource.ImageRegistry;
Expand Down Expand Up @@ -265,15 +264,6 @@ public static ImageDescriptor getImageDescriptor(String key) {
return getDefault().getImageRegistry().getDescriptor(key);
}

public static boolean isOptionEnabled(String strOption) {
String strEnabled = Platform.getDebugOption(strOption);
if (strEnabled == null) {
return false;
}

return Boolean.parseBoolean(strEnabled);
}

public static ITerminalService getTerminalService() {
UIPlugin plugin = getDefault();
if (plugin == null) {
Expand Down
3 changes: 1 addition & 2 deletions ...terminal.view.ui/src/org/eclipse/terminal/view/ui/internal/tabs/OpenFileMouseHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@
import org.eclipse.terminal.control.ITerminalMouseListener;
import org.eclipse.terminal.control.ITerminalViewControl;
import org.eclipse.terminal.model.ITerminalTextDataReadOnly;
import org.eclipse.terminal.view.ui.internal.UIPlugin;
import org.eclipse.ui.IEditorInput;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.IWorkbenchPage;
Expand All @@ -54,7 +53,7 @@
* @noreference This class is not intended to be referenced by clients.
*/
public class OpenFileMouseHandler implements ITerminalMouseListener {
private static final boolean DEBUG_HOVER = UIPlugin.isOptionEnabled(Logger.TRACE_DEBUG_LOG_HOVER);
private static final boolean DEBUG_HOVER = Platform.getDebugBoolean(Logger.TRACE_DEBUG_LOG_HOVER);
private static final List<String> NEEDED_BUNDLES = //
List.of("org.eclipse.core.resources", //$NON-NLS-1$
"org.eclipse.ui.ide", //$NON-NLS-1$
Expand Down
2 changes: 1 addition & 1 deletion ua/org.eclipse.help.ui/src/org/eclipse/help/ui/internal/HelpUIPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ public void start(BundleContext context) throws Exception {
// Setup debugging options
DEBUG = isDebugging();
if (DEBUG) {
DEBUG_INFOPOP = "true".equalsIgnoreCase(Platform.getDebugOption(PLUGIN_ID + "/debug/infopop")); //$NON-NLS-1$ //$NON-NLS-2$
DEBUG_INFOPOP = Platform.getDebugBoolean(PLUGIN_ID + "/debug/infopop"); //$NON-NLS-1$
}

if (BaseHelpSystem.getMode() == BaseHelpSystem.MODE_WORKBENCH) {
Expand Down
2 changes: 1 addition & 1 deletion ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/HelpWebappPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public void start(BundleContext context) throws Exception {
// Setup debugging options
DEBUG = isDebugging();
if (DEBUG) {
DEBUG_WORKINGSETS = "true".equalsIgnoreCase(Platform.getDebugOption("org.eclipse.help.webapp/debug/workingsets")); //$NON-NLS-1$ //$NON-NLS-2$
DEBUG_WORKINGSETS = Platform.getDebugBoolean("org.eclipse.help.webapp/debug/workingsets"); //$NON-NLS-1$
}
}

Expand Down
10 changes: 5 additions & 5 deletions ua/org.eclipse.help/src/org/eclipse/help/internal/HelpPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,11 +147,11 @@ public void start(BundleContext context) throws Exception {
// Setup debugging options
DEBUG = isDebugging();
if (DEBUG) {
DEBUG_CONTEXT = "true".equalsIgnoreCase(Platform.getDebugOption(PLUGIN_ID + "/debug/context")); //$NON-NLS-1$ //$NON-NLS-2$
DEBUG_SEARCH = "true".equalsIgnoreCase(Platform.getDebugOption(PLUGIN_ID + "/debug/search")); //$NON-NLS-1$ //$NON-NLS-2$
DEBUG_TOC = "true".equalsIgnoreCase(Platform.getDebugOption(PLUGIN_ID + "/debug/toc")); //$NON-NLS-1$ //$NON-NLS-2$
DEBUG_INDEX = "true".equalsIgnoreCase(Platform.getDebugOption(PLUGIN_ID + "/debug/index")); //$NON-NLS-1$ //$NON-NLS-2$
DEBUG_CRITERIA = "true".equalsIgnoreCase(Platform.getDebugOption(PLUGIN_ID + "/debug/criteria")); //$NON-NLS-1$ //$NON-NLS-2$
DEBUG_CONTEXT = Platform.getDebugBoolean(PLUGIN_ID + "/debug/context"); //$NON-NLS-1$
DEBUG_SEARCH = Platform.getDebugBoolean(PLUGIN_ID + "/debug/search"); //$NON-NLS-1$
DEBUG_TOC = Platform.getDebugBoolean(PLUGIN_ID + "/debug/toc"); //$NON-NLS-1$
DEBUG_INDEX = Platform.getDebugBoolean(PLUGIN_ID + "/debug/index"); //$NON-NLS-1$
DEBUG_CRITERIA = Platform.getDebugBoolean(PLUGIN_ID + "/debug/criteria"); //$NON-NLS-1$
}
}

Expand Down
5 changes: 1 addition & 4 deletions ...g.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/CheatSheetStopWatch.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,10 +108,7 @@ private Map<String, Entry> getTable() {

public static boolean isTracing() {
if (CheatSheetPlugin.getPlugin().isDebugging()) {
String traceTimes = Platform.getDebugOption("org.eclipse.ui.cheatsheets/trace/creation/times"); //$NON-NLS-1$
if (traceTimes != null && traceTimes.equalsIgnoreCase("true")) { //$NON-NLS-1$
return true;
}
return Platform.getDebugBoolean("org.eclipse.ui.cheatsheets/trace/creation/times"); //$NON-NLS-1$
}
return false;
}
Expand Down
9 changes: 2 additions & 7 deletions ua/org.eclipse.ui.intro.universal/src/org/eclipse/ui/internal/intro/universal/util/Log.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,17 +55,12 @@ public class Log implements IUniversalIntroConstants {
// the plugin is not in debug mode, no point setting debug options.
if (UniversalIntroPlugin.getDefault().isDebugging()) {
logWarning = true;
logInfo = getDebugOption("/trace/logInfo"); //$NON-NLS-1$
logPerformance = getDebugOption("/trace/logPerformance"); //$NON-NLS-1$
logInfo = Platform.getDebugBoolean(PLUGIN_ID + "/trace/logInfo"); //$NON-NLS-1$
logPerformance = Platform.getDebugBoolean(PLUGIN_ID + "/trace/logPerformance"); //$NON-NLS-1$
}

}

private static boolean getDebugOption(String option) {
return "true".equalsIgnoreCase(//$NON-NLS-1$
Platform.getDebugOption(PLUGIN_ID + option));
}

/**
* Log an Error message with an exception. Note that the message should
* already be localized to proper local. Errors are always logged.
Expand Down
10 changes: 4 additions & 6 deletions ua/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/IntroPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,8 @@ public class IntroPlugin extends AbstractUIPlugin {
public static final String PLUGIN_ID = "org.eclipse.ui.intro"; //$NON-NLS-1$

// Debug control variables
public static boolean LOG_WARN =
"true".equalsIgnoreCase(Platform.getDebugOption(PLUGIN_ID+"/debug/warn")); //$NON-NLS-1$ //$NON-NLS-2$
public static boolean LOG_INFO =
"true".equalsIgnoreCase(Platform.getDebugOption(PLUGIN_ID+"/debug/info")); //$NON-NLS-1$ //$NON-NLS-2$
public static boolean LOG_WARN = Platform.getDebugBoolean(PLUGIN_ID + "/debug/warn"); //$NON-NLS-1$
public static boolean LOG_INFO = Platform.getDebugBoolean(PLUGIN_ID + "/debug/info"); //$NON-NLS-1$

// The static shared instance.
private static IntroPlugin inst;
Expand Down Expand Up @@ -176,10 +174,10 @@ public void start(BundleContext context) throws Exception {
// Setup debugging options
DEBUG = isDebugging();
if (DEBUG) {
DEBUG_NO_BROWSER = "true".equalsIgnoreCase(Platform.getDebugOption(PLUGIN_ID + "/flags/noBrowser")); //$NON-NLS-1$ //$NON-NLS-2$
DEBUG_NO_BROWSER = Platform.getDebugBoolean(PLUGIN_ID + "/flags/noBrowser"); //$NON-NLS-1$
}
if (DEBUG) {
DEBUG_TOOLBAR = "true".equalsIgnoreCase(Platform.getDebugOption(PLUGIN_ID + "/debug/toolbar")); //$NON-NLS-1$ //$NON-NLS-2$
DEBUG_TOOLBAR = Platform.getDebugBoolean(PLUGIN_ID + "/debug/toolbar"); //$NON-NLS-1$
}

}
Expand Down
4 changes: 1 addition & 3 deletions .../src/org/eclipse/ui/internal/intro/impl/presentations/BrowserIntroPartImplementation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -388,9 +388,7 @@ public void changed(LocationEvent event) {

// print the HTML if we are in debug mode and have tracing turned on
if (IntroPlugin.getDefault().isDebugging()) {
String printHtml = Platform
.getDebugOption("org.eclipse.ui.intro/trace/printHTML"); //$NON-NLS-1$
if (printHtml != null && printHtml.equalsIgnoreCase("true")) { //$NON-NLS-1$
if (Platform.getDebugBoolean("org.eclipse.ui.intro/trace/printHTML")) { //$NON-NLS-1$
System.out.println(content);
}
if (IntroPlugin.DEBUG_TOOLBAR) {
Expand Down
9 changes: 2 additions & 7 deletions ua/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/Log.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,17 +55,12 @@ public class Log implements IIntroConstants {
// the plugin is not in debug mode, no point setting debug options.
if (IntroPlugin.getDefault().isDebugging()) {
logWarning = true;
logInfo = getDebugOption("/trace/logInfo"); //$NON-NLS-1$
logPerformance = getDebugOption("/trace/logPerformance"); //$NON-NLS-1$
logInfo = Platform.getDebugBoolean(PLUGIN_ID + "/trace/logInfo"); //$NON-NLS-1$
logPerformance = Platform.getDebugBoolean(PLUGIN_ID + "/trace/logPerformance"); //$NON-NLS-1$
}

}

private static boolean getDebugOption(String option) {
return "true".equalsIgnoreCase(//$NON-NLS-1$
Platform.getDebugOption(PLUGIN_ID + option));
}

/**
* Log an Error message with an exception. Note that the message should
* already be localized to proper local. Errors are always logged.
Expand Down
Loading