MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-09-27 10:03:11 +07:00
Code Issues Packages Projects Releases Wiki Activity

Cleanup (RunnerWinProcess made unnecessary)

Browse Source
This commit is contained in:
Roman Shevchenko
2015-09-18 13:58:09 +03:00
parent f1c9933bad
commit d7ea9c4e90
5 changed files with 64 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files
java/execution/impl/src/com/intellij/execution/application/BaseJavaApplicationCommandLineState.java
+4 -14
View File
@@ -1,5 +1,5 @@
/*
* Copyright 2000-2014 JetBrains s.r.o.
* Copyright 2000-2015 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -22,13 +22,11 @@ import com.intellij.execution.RunConfigurationExtension;
import com.intellij.execution.configurations.JavaCommandLineState;
import com.intellij.execution.configurations.JavaParameters;
import com.intellij.execution.configurations.RunConfigurationBase;
import com.intellij.execution.configurations.RunnerSettings;
import com.intellij.execution.process.KillableColoredProcessHandler;
import com.intellij.execution.process.OSProcessHandler;
import com.intellij.execution.process.ProcessTerminatedListener;
import com.intellij.execution.runners.ExecutionEnvironment;
import com.intellij.execution.util.JavaParametersUtil;
import com.intellij.openapi.util.SystemInfo;
import org.jetbrains.annotations.NotNull;
/**
@@ -53,17 +51,9 @@ public abstract class BaseJavaApplicationCommandLineState<T extends RunConfigura
@NotNull
@Override
protected OSProcessHandler startProcess() throws ExecutionException {
OSProcessHandler handler;
if (SystemInfo.isWindows) {
handler = super.startProcess();
}
else {
handler = KillableColoredProcessHandler.create(createCommandLine());
ProcessTerminatedListener.attach(handler);
}
RunnerSettings runnerSettings = getRunnerSettings();
JavaRunConfigurationExtensionManager.getInstance().attachExtensionsToProcess(getConfiguration(), handler, runnerSettings);
OSProcessHandler handler = new KillableColoredProcessHandler(createCommandLine());
ProcessTerminatedListener.attach(handler);
JavaRunConfigurationExtensionManager.getInstance().attachExtensionsToProcess(getConfiguration(), handler, getRunnerSettings());
return handler;
}
platform/platform-impl/src/com/intellij/execution/process/KillableColoredProcessHandler.java
+45 -42
View File
@@ -1,5 +1,5 @@
/*
* Copyright 2000-2011 JetBrains s.r.o.
* Copyright 2000-2015 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,39 +19,67 @@ import com.intellij.execution.ExecutionException;
import com.intellij.execution.KillableProcess;
import com.intellij.execution.configurations.GeneralCommandLine;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.util.Key;
import com.intellij.openapi.util.SystemInfo;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.io.IOException;
import java.nio.charset.Charset;
/**
* This process handler supports ANSI coloring and "soft-kill" feature.
* At first "stop" button send SIGINT signal to process, if it still hangs user can terminate it recursively with SIGKILL signal.
* <p>
* Soft kill works on Unix, and also on Windows if a mediator process was used.
*
* @author Roman.Chernyatchik
* <p/>
* This process handler supports ANSI coloring and soft-kill feature. Soft kill works only on Unix.
* At first "stop" button send SIGINT signal to process, if it still hangs user can termintate it recursively with SIGKILL signal.
* <p/>
* P.S: probably OSProcessHandler is better place for this feature but it can affect other run configurations and should be tested
*/
public class KillableColoredProcessHandler extends ColoredProcessHandler implements KillableProcess {
private static final Logger LOG = Logger.getInstance(KillableColoredProcessHandler .class);
private static final Logger LOG = Logger.getInstance(KillableColoredProcessHandler.class);
private static final Key<Boolean> MEDIATOR_KEY = Key.create("KillableColoredProcessHandler.Mediator.Process");
private boolean myShouldKillProcessSoftly = true;
private boolean myMediatedProcess = false;
public KillableColoredProcessHandler(@NotNull GeneralCommandLine commandLine) throws ExecutionException {
super(commandLine);
}
public KillableColoredProcessHandler(final Process process, final String commandLine, @NotNull final Charset charset) {
/**
* Starts a process with a {@link RunnerMediator mediator} when {@code withMediator} is set to {@code true} and the platform is Windows.
*/
public KillableColoredProcessHandler(@NotNull GeneralCommandLine commandLine, boolean withMediator) throws ExecutionException {
super(mediate(commandLine, withMediator).createProcess(), commandLine.getCommandLineString(), commandLine.getCharset());
myMediatedProcess = withMediator && MEDIATOR_KEY.get(commandLine) == Boolean.TRUE;
}
public KillableColoredProcessHandler(@NotNull Process process, @Nullable String commandLine) {
super(process, commandLine);
}
public KillableColoredProcessHandler(@NotNull Process process, @Nullable String commandLine, @NotNull Charset charset) {
super(process, commandLine, charset);
}
public KillableColoredProcessHandler(final Process process, final String commandLine) {
super(process, commandLine);
private static GeneralCommandLine mediate(GeneralCommandLine commandLine, boolean withMediator) {
if (withMediator && SystemInfo.isWindows) {
boolean mediatorInjected = RunnerMediator.injectRunnerCommand(commandLine);
MEDIATOR_KEY.set(commandLine, mediatorInjected);
}
return commandLine;
}
/**
* @return true, if graceful process termination should be attempted first
*/
protected boolean shouldKillProcessSoftly() {
return myShouldKillProcessSoftly;
}
/**
* Sets whether the process will be terminated gracefully.
*
* @param shouldKillProcessSoftly true, if graceful process termination should be attempted first (i.e. soft kill)
*/
public void setShouldKillProcessSoftly(boolean shouldKillProcessSoftly) {
@@ -60,14 +88,12 @@ public class KillableColoredProcessHandler extends ColoredProcessHandler impleme
/**
* This method shouldn't be overridden, see shouldKillProcessSoftly
*
* @return
*/
private boolean canKillProcessSoftly() {
if (processCanBeKilledByOS(myProcess)) {
if (SystemInfo.isWindows) {
// runnerw.exe can send Ctrl+C events to a wrapped process
return myProcess instanceof RunnerWinProcess;
return myMediatedProcess;
}
else if (SystemInfo.isUnix) {
// 'kill -SIGINT <pid>' will be executed
@@ -104,10 +130,7 @@ public class KillableColoredProcessHandler extends ColoredProcessHandler impleme
@Override
protected void doDestroyProcess() {
boolean gracefulTerminationAttempted = false;
if (canKillProcessSoftly() && shouldKillProcessSoftly()) {
gracefulTerminationAttempted = destroyProcessGracefully();
}
boolean gracefulTerminationAttempted = shouldKillProcessSoftly() && canKillProcessSoftly() && destroyProcessGracefully();
if (!gracefulTerminationAttempted) {
// execute default process destroy
super.doDestroyProcess();
@@ -115,12 +138,8 @@ public class KillableColoredProcessHandler extends ColoredProcessHandler impleme
}
protected boolean destroyProcessGracefully() {
if (SystemInfo.isWindows) {
if (myProcess instanceof RunnerWinProcess) {
RunnerWinProcess runnerWinProcess = (RunnerWinProcess) myProcess;
runnerWinProcess.destroyGracefully(true);
return true;
}
if (SystemInfo.isWindows && myMediatedProcess) {
return RunnerMediator.destroyProcess(myProcess, true);
}
else if (SystemInfo.isUnix) {
return UnixProcessManager.sendSigIntToProcessTree(myProcess);
@@ -128,13 +147,6 @@ public class KillableColoredProcessHandler extends ColoredProcessHandler impleme
return false;
}
/**
* @return true, if graceful process termination should be attempted first
*/
protected boolean shouldKillProcessSoftly() {
return myShouldKillProcessSoftly;
}
@Override
public boolean canKillProcess() {
return processCanBeKilledByOS(getProcess());
@@ -146,18 +158,9 @@ public class KillableColoredProcessHandler extends ColoredProcessHandler impleme
killProcessTree(getProcess());
}
@NotNull
/** @deprecated use {@link #KillableColoredProcessHandler(GeneralCommandLine, boolean)} (to be removed in IDEA 17) */
@SuppressWarnings("unused")
public static KillableColoredProcessHandler create(@NotNull GeneralCommandLine commandLine) throws ExecutionException {
final Process process;
if (SystemInfo.isWindows) {
process = RunnerWinProcess.create(commandLine);
}
else {
process = commandLine.createProcess();
}
return new KillableColoredProcessHandler(process,
commandLine.getCommandLineString(),
commandLine.getCharset());
return new KillableColoredProcessHandler(commandLine, true);
}
}
platform/platform-impl/src/com/intellij/execution/process/RunnerMediator.java
+9 -11
View File
@@ -1,5 +1,5 @@
/*
* Copyright 2000-2013 JetBrains s.r.o.
* Copyright 2000-2015 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -28,6 +28,9 @@ import java.io.OutputStream;
import java.io.PrintWriter;
/**
* Utility class to start a process with a runner mediator (runnerw.exe) injected into a command line,
* which adds a capability to terminate process tree gracefully by sending it a Ctrl+Break through stdin.
*
* @author traff
*/
public class RunnerMediator {
@@ -147,19 +150,14 @@ public class RunnerMediator {
public static class CustomDestroyProcessHandler extends ColoredProcessHandler {
private final boolean mySoftKill;
/**
* @deprecated use CustomDestroyProcessHandler(GeneralCommandLine commandLine)
* @deprecated remove in IDEA 16
*/
/** @deprecated use CustomDestroyProcessHandler(GeneralCommandLine commandLine) (to remove in IDEA 16) */
public CustomDestroyProcessHandler(@NotNull Process process, @NotNull GeneralCommandLine commandLine) {
this(process, commandLine, false);
super(process, commandLine.getCommandLineString());
mySoftKill = false;
}
/**
* @deprecated use CustomDestroyProcessHandler(GeneralCommandLine commandLine, boolean softKill)
* @deprecated remove in IDEA 16
*/
public CustomDestroyProcessHandler(@NotNull Process process, @NotNull GeneralCommandLine commandLine, final boolean softKill) {
/** @deprecated use CustomDestroyProcessHandler(GeneralCommandLine commandLine, boolean softKill) (to remove in IDEA 16) */
public CustomDestroyProcessHandler(@NotNull Process process, @NotNull GeneralCommandLine commandLine, boolean softKill) {
super(process, commandLine.getCommandLineString());
mySoftKill = softKill;
}
platform/platform-impl/src/com/intellij/execution/process/RunnerWinProcess.java
+4 -2
View File
@@ -1,5 +1,5 @@
/*
* Copyright 2000-2013 JetBrains s.r.o.
* Copyright 2000-2015 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -20,6 +20,8 @@ import com.intellij.execution.configurations.GeneralCommandLine;
import com.intellij.openapi.util.SystemInfo;
import org.jetbrains.annotations.NotNull;
/** @deprecated use {@link KillableColoredProcessHandler#KillableColoredProcessHandler(GeneralCommandLine, boolean)} (to be removed in IDEA 16) */
@SuppressWarnings({"unused", "deprecation"})
public class RunnerWinProcess extends ProcessWrapper {
private RunnerWinProcess(@NotNull Process originalProcess) {
@@ -37,7 +39,7 @@ public class RunnerWinProcess extends ProcessWrapper {
@NotNull
public static Process create(@NotNull GeneralCommandLine commandLine) throws ExecutionException {
if (!SystemInfo.isWindows) {
throw new RuntimeException(RunnerWinProcess.class.getSimpleName() + " works on Windows only!");
throw new RuntimeException("RunnerWinProcess works on Windows only!");
}
boolean success = RunnerMediator.injectRunnerCommand(commandLine);
Process process = commandLine.createProcess();
platform/platform-impl/src/com/intellij/execution/process/impl/OSProcessManagerImpl.java
+2 -4
View File
@@ -57,12 +57,10 @@ public class OSProcessManagerImpl extends OSProcessManager {
return false;
}
@SuppressWarnings("deprecation")
@NotNull
private static WinProcess createWinProcess(@NotNull Process process) {
if (process instanceof RunnerWinProcess) {
RunnerWinProcess runnerWinProcess = (RunnerWinProcess) process;
return new WinProcess(runnerWinProcess.getOriginalProcess());
}
if (process instanceof RunnerWinProcess) process = ((RunnerWinProcess)process).getOriginalProcess();
return new WinProcess(process);
}