/*
* Copyright 2000-2016 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.intellij.debugger.actions;
import com.intellij.debugger.DebuggerBundle;
import com.intellij.debugger.engine.DebugProcessImpl;
import com.intellij.debugger.engine.JavaStackFrame;
import com.intellij.debugger.engine.JavaValue;
import com.intellij.debugger.engine.evaluation.EvaluateException;
import com.intellij.debugger.engine.events.DebuggerCommandImpl;
import com.intellij.debugger.engine.events.DebuggerContextCommandImpl;
import com.intellij.debugger.impl.DebuggerContextImpl;
import com.intellij.debugger.jdi.StackFrameProxyImpl;
import com.intellij.debugger.jdi.ThreadReferenceProxyImpl;
import com.intellij.idea.ActionsBundle;
import com.intellij.openapi.actionSystem.ActionPlaces;
import com.intellij.openapi.actionSystem.AnActionEvent;
import com.intellij.openapi.application.ApplicationManager;
import com.intellij.openapi.application.ModalityState;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.ui.DialogWrapper;
import com.intellij.openapi.ui.Messages;
import com.intellij.util.ui.UIUtil;
import com.intellij.xdebugger.XDebuggerBundle;
import com.intellij.xdebugger.XExpression;
import com.intellij.xdebugger.evaluation.XDebuggerEditorsProvider;
import com.intellij.xdebugger.evaluation.XDebuggerEvaluator;
import com.intellij.xdebugger.frame.XValue;
import com.intellij.xdebugger.impl.breakpoints.XExpressionImpl;
import com.intellij.xdebugger.impl.ui.XDebuggerExpressionEditor;
import com.sun.jdi.Method;
import com.sun.jdi.Value;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import javax.swing.*;
public class ForceEarlyReturnAction extends DebuggerAction {
public void actionPerformed(@NotNull AnActionEvent e) {
final Project project = e.getProject();
final JavaStackFrame stackFrame = PopFrameAction.getStackFrame(e);
if (stackFrame == null || project == null) {
return;
}
final DebuggerContextImpl debuggerContext = DebuggerAction.getDebuggerContext(e.getDataContext());
final DebugProcessImpl debugProcess = debuggerContext.getDebugProcess();
if (debugProcess == null) {
return;
}
final StackFrameProxyImpl proxy = stackFrame.getStackFrameProxy();
final ThreadReferenceProxyImpl thread = proxy.threadProxy();
debugProcess.getManagerThread().schedule(new DebuggerContextCommandImpl(debuggerContext, thread) {
@Override
public void threadAction() {
Method method;
try {
method = proxy.location().method();
}
catch (EvaluateException e) {
showError(project, DebuggerBundle.message("error.early.return", e.getLocalizedMessage()));
return;
}
if ("void".equals(method.returnTypeName())) {
forceEarlyReturnWithFinally(thread.getVirtualMachine().mirrorOfVoid(), stackFrame, debugProcess, null);
}
else {
ApplicationManager.getApplication().invokeLater(
() -> new ReturnExpressionDialog(project, debugProcess.getXdebugProcess().getEditorsProvider(), debugProcess, stackFrame).show());
}
}
});
}
private static void forceEarlyReturnWithFinally(final Value value,
final JavaStackFrame frame,
final DebugProcessImpl debugProcess,
@Nullable final DialogWrapper dialog) {
//noinspection SSBasedInspection
SwingUtilities.invokeLater(() -> {
if (PopFrameAction.evaluateFinallyBlocks(debugProcess.getProject(),
UIUtil.removeMnemonic(ActionsBundle.actionText("Debugger.ForceEarlyReturn")),
frame,
new XDebuggerEvaluator.XEvaluationCallback() {
@Override
public void evaluated(@NotNull XValue result) {
forceEarlyReturn(value, frame.getDescriptor().getFrameProxy().threadProxy(), debugProcess, dialog);
}
@Override
public void errorOccurred(@NotNull String errorMessage) {
showError(debugProcess.getProject(),
DebuggerBundle.message("error.executing.finally", errorMessage));
}
})) {
return;
}
forceEarlyReturn(value, frame.getDescriptor().getFrameProxy().threadProxy(), debugProcess, dialog);
});
}
private static void forceEarlyReturn(final Value value,
final ThreadReferenceProxyImpl thread,
final DebugProcessImpl debugProcess,
@Nullable final DialogWrapper dialog) {
debugProcess.getManagerThread().schedule(new DebuggerCommandImpl() {
@Override
protected void action() throws Exception {
try {
thread.forceEarlyReturn(value);
}
catch (Exception e) {
showError(debugProcess.getProject(), DebuggerBundle.message("error.early.return", e.getLocalizedMessage()));
return;
}
//noinspection SSBasedInspection
SwingUtilities.invokeLater(() -> {
if (dialog != null) {
dialog.close(DialogWrapper.OK_EXIT_CODE);
}
debugProcess.getSession().stepInto(true, null);
});
}
});
}
private static void evaluateAndReturn(final Project project,
final JavaStackFrame stackFrame,
final DebugProcessImpl debugProcess,
XExpression expression,
final DialogWrapper dialog) {
XDebuggerEvaluator evaluator = stackFrame.getEvaluator();
if (evaluator != null) {
evaluator.evaluate(expression,
new XDebuggerEvaluator.XEvaluationCallback() {
@Override
public void evaluated(@NotNull XValue result) {
if (result instanceof JavaValue) {
forceEarlyReturnWithFinally(((JavaValue)result).getDescriptor().getValue(),
stackFrame,
debugProcess,
dialog);
}
}
@Override
public void errorOccurred(@NotNull final String errorMessage) {
showError(project, DebuggerBundle.message("error.unable.to.evaluate.expression") + ": " + errorMessage);
}
}, stackFrame.getSourcePosition());
}
else {
showError(project, XDebuggerBundle.message("xdebugger.evaluate.stack.frame.has.not.evaluator"));
}
}
private static void showError(final Project project, final String message) {
ApplicationManager.getApplication().invokeLater(() -> Messages.showMessageDialog(project,
message,
UIUtil.removeMnemonic(ActionsBundle.actionText("Debugger.ForceEarlyReturn")),
Messages.getErrorIcon()), ModalityState.any());
}
public void update(@NotNull AnActionEvent e) {
boolean enable = false;
JavaStackFrame stackFrame = PopFrameAction.getStackFrame(e);
if (stackFrame != null && stackFrame.getDescriptor().getUiIndex() == 0) {
enable = stackFrame.getStackFrameProxy().getVirtualMachine().canForceEarlyReturn();
}
if (ActionPlaces.isMainMenuOrActionSearch(e.getPlace()) || ActionPlaces.DEBUGGER_TOOLBAR.equals(e.getPlace())) {
e.getPresentation().setEnabled(enable);
}
else {
e.getPresentation().setVisible(enable);
}
}
private static class ReturnExpressionDialog extends DialogWrapper {
private final Project myProject;
private final XDebuggerEditorsProvider myEditorsProvider;
private final DebugProcessImpl myProcess;
private final JavaStackFrame myFrame;
private final XDebuggerExpressionEditor myEditor;
public ReturnExpressionDialog(@NotNull Project project,
XDebuggerEditorsProvider provider,
DebugProcessImpl process,
JavaStackFrame frame) {
super(project);
myProject = project;
myEditorsProvider = provider;
myProcess = process;
myFrame = frame;
myEditor = new XDebuggerExpressionEditor(myProject, myEditorsProvider, "forceReturnValue", myFrame.getSourcePosition(),
XExpressionImpl.EMPTY_EXPRESSION, false, true, false);
setTitle("Return Value");
init();
}
@Nullable
@Override
protected JComponent createCenterPanel() {
return myEditor.getComponent();
}
@Nullable
@Override
public JComponent getPreferredFocusedComponent() {
return myEditor.getPreferredFocusedComponent();
}
@Override
protected void doOKAction() {
evaluateAndReturn(myProject, myFrame, myProcess, myEditor.getExpression(), this);
}
}
}