refactor to extract common code for running a process and showing the output in a Run toolwindow tab

2026-09-27 10:03:11 +07:00 · 2011-06-24 10:29:11 +02:00
parent 547acb79ea
commit 3e90ecbbea
1 changed files with 136 additions and 0 deletions
@@ -0,0 +1,136 @@
+package com.intellij.execution;
+
+import com.intellij.execution.executors.DefaultRunExecutor;
+import com.intellij.execution.filters.Filter;
+import com.intellij.execution.filters.TextConsoleBuilder;
+import com.intellij.execution.filters.TextConsoleBuilderFactory;
+import com.intellij.execution.process.ProcessAdapter;
+import com.intellij.execution.process.ProcessEvent;
+import com.intellij.execution.process.ProcessHandler;
+import com.intellij.execution.ui.ConsoleView;
+import com.intellij.execution.ui.RunContentDescriptor;
+import com.intellij.execution.ui.actions.CloseAction;
+import com.intellij.openapi.actionSystem.*;
+import com.intellij.openapi.application.ApplicationManager;
+import com.intellij.openapi.fileEditor.FileDocumentManager;
+import com.intellij.openapi.project.DumbAware;
+import com.intellij.openapi.project.Project;
+import com.intellij.openapi.util.IconLoader;
+import com.intellij.openapi.wm.ToolWindowId;
+import com.intellij.openapi.wm.ToolWindowManager;
+
+import javax.swing.*;
+import java.awt.*;
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Runs a process and prints the output in a content tab within the Run toolwindow.
+ *
+ * @author yole
+ */
+public class RunContentExecutor {
+  private final Project myProject;
+  private final ProcessHandler myProcess;
+  private final List<Filter> myFilterList = new ArrayList<Filter>();
+  private Runnable myRerun;
+  private Runnable myAfterCompletion;
+  private String myTitle = "Output";
+
+  public RunContentExecutor(Project project, ProcessHandler process) {
+    myProject = project;
+    myProcess = process;
+  }
+
+  public RunContentExecutor withFilter(Filter filter) {
+    myFilterList.add(filter);
+    return this;
+  }
+
+  public RunContentExecutor withTitle(String title) {
+    myTitle = title;
+    return this;
+  }
+
+  public RunContentExecutor withRerun(Runnable rerun) {
+    myRerun = rerun;
+    return this;
+  }
+
+  public RunContentExecutor withAfterCompletion(Runnable afterCompletion) {
+    myAfterCompletion = afterCompletion;
+    return this;
+  }
+
+  private ConsoleView createConsole(Project project, ProcessHandler processHandler) {
+    TextConsoleBuilder consoleBuilder = TextConsoleBuilderFactory.getInstance().createBuilder(project);
+    for (Filter filter : myFilterList) {
+      consoleBuilder.addFilter(filter);
+    }
+    ConsoleView console = consoleBuilder.getConsole();
+    console.attachToProcess(processHandler);
+    return console;
+  }
+
+  public void run() {
+    FileDocumentManager.getInstance().saveAllDocuments();
+
+    ConsoleView view = createConsole(myProject, myProcess);
+    Executor executor = ExecutorRegistry.getInstance().getExecutorById(DefaultRunExecutor.EXECUTOR_ID);
+    DefaultActionGroup actions = new DefaultActionGroup();
+
+    final JComponent consolePanel = createConsolePanel(view, actions);
+    RunContentDescriptor descriptor = new RunContentDescriptor(view, myProcess, consolePanel, myTitle);
+
+    actions.add(new RerunAction(consolePanel));
+    actions.add(new CloseAction(executor, descriptor, myProject));
+
+    ExecutionManager.getInstance(myProject).getContentManager().showRunContent(executor, descriptor);
+
+    ApplicationManager.getApplication().invokeLater(new Runnable() {
+      public void run() {
+        ToolWindowManager.getInstance(myProject).getToolWindow(ToolWindowId.RUN).activate(null);
+      }
+    });
+
+    if (myAfterCompletion != null) {
+      myProcess.addProcessListener(new ProcessAdapter() {
+        public void processTerminated(ProcessEvent event) {
+          SwingUtilities.invokeLater(myAfterCompletion);
+        }
+      });
+    }
+
+    myProcess.startNotify();
+  }
+
+  private static JComponent createConsolePanel(ConsoleView view,   ActionGroup actions) {
+    JPanel panel = new JPanel();
+    panel.setLayout(new BorderLayout());
+    panel.add(view.getComponent(), BorderLayout.CENTER);
+    panel.add(createToolbar(actions), BorderLayout.WEST);
+    return panel;
+  }
+
+  private static JComponent createToolbar(ActionGroup actions) {
+    ActionToolbar actionToolbar = ActionManager.getInstance().createActionToolbar(ActionPlaces.UNKNOWN, actions, false);
+    return actionToolbar.getComponent();
+  }
+
+  private class RerunAction extends AnAction implements DumbAware {
+    public RerunAction(JComponent consolePanel) {
+      super("Rerun", "Rerun",
+            IconLoader.getIcon("/actions/refreshUsages.png"));
+      registerCustomShortcutSet(CommonShortcuts.getRerun(), consolePanel);
+    }
+
+    public void actionPerformed(AnActionEvent e) {
+      myRerun.run();
+    }
+
+    @Override
+    public void update(AnActionEvent e) {
+      e.getPresentation().setVisible(myRerun != null);
+    }
+  }
+}