platform/script-debugger/backend/src/org/jetbrains/debugger/SuspendContext.java

   1 package org.jetbrains.debugger;
   2
   3 import org.jetbrains.annotations.NotNull;
   4 import org.jetbrains.annotations.Nullable;
   5 import org.jetbrains.concurrency.Promise;
   6 import org.jetbrains.debugger.values.ValueManager;
   7
   8 import java.util.List;
   9
  10 /**
  11  * An object that matches the execution state of the VM while suspended
  12  */
  13 public interface SuspendContext {
  14   @NotNull
  15   SuspendState getState();
  16
  17   @Nullable("if no frames (paused by user)")
  18   Script getScript();
  19
  20   /**
  21    * @return the current exception state, or {@code null} if current state is
  22    *         not {@code EXCEPTION}
  23    * @see #getState()
  24    */
  25   @Nullable
  26   ExceptionData getExceptionData();
  27
  28   @Nullable
  29   CallFrame getTopFrame();
  30
  31   /**
  32    * Call frames for the current suspended state (from the innermost (top) frame to the main (bottom) frame)
  33    */
  34   @NotNull
  35   Promise<CallFrame[]> getFrames();
  36
  37   /**
  38    * @return a set of the breakpoints hit on VM suspension with which this
  39    *         context is associated. An empty collection if the suspension was
  40    *         not related to hitting breakpoints (e.g. a step end)
  41    */
  42   @NotNull
  43   List<Breakpoint> getBreakpointsHit();
  44
  45   /**
  46    * @return value mapping that all values have by default; typically unique for a particular {@link SuspendContext}
  47    */
  48   @NotNull
  49   ValueManager getValueManager();
  50
  51   @NotNull
  52   Vm getVm();
  53 }