Version 1.1.0-dev.5.2

dart/runtime/vm/debugger.h

 // Copyright (c) 2012, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 #ifndef VM_DEBUGGER_H_
 #define VM_DEBUGGER_H_
 
 #include "include/dart_debugger_api.h"
 
 #include "vm/object.h"
 #include "vm/port.h"
 
 namespace dart {
 
 class ActiveVariables;
 class CodeBreakpoint;
 class Isolate;
 class JSONArray;
 class JSONStream;
 class ObjectPointerVisitor;
 class RemoteObjectCache;
 class SourceBreakpoint;
 class StackFrame;
 
 // SourceBreakpoint represents a user-specified breakpoint location in
 // Dart source. There may be more than one CodeBreakpoint object per
 // SourceBreakpoint.
 class SourceBreakpoint {
  public:
-  SourceBreakpoint(intptr_t id, const Function& func, intptr_t token_pos);
+  SourceBreakpoint(intptr_t id, const Script& script, intptr_t token_pos);
 
   RawFunction* function() const { return function_; }
   intptr_t token_pos() const { return token_pos_; }
-  void set_token_pos(intptr_t value) { token_pos_ = value; }
   intptr_t id() const { return id_; }
 
-  RawScript* SourceCode();
+  RawScript* script() { return script_; }
   RawString* SourceUrl();
   intptr_t LineNumber();
 
-  void GetCodeLocation(Library* lib,
-                       Script* script,
-                       intptr_t* token_pos) const;
+  void GetCodeLocation(Library* lib, Script* script, intptr_t* token_pos);
 
   void Enable();
   void Disable();
   bool IsEnabled() const { return is_enabled_; }
+  bool IsResolved() { return is_resolved_; }
 
-  void PrintToJSONStream(JSONStream* stream) const;
+  void PrintToJSONStream(JSONStream* stream);
 
  private:
   void VisitObjectPointers(ObjectPointerVisitor* visitor);
 
-  void set_function(const Function& func);
+  void SetResolved(const Function& func, intptr_t token_pos);
   void set_next(SourceBreakpoint* value) { next_ = value; }
   SourceBreakpoint* next() const { return this->next_; }
 
   const intptr_t id_;
+  RawScript* script_;
+  intptr_t token_pos_;
+  bool is_resolved_;
+  bool is_enabled_;
+  SourceBreakpoint* next_;
+
+  // Valid for resolved breakpoints:
   RawFunction* function_;
-  intptr_t token_pos_;
   intptr_t line_number_;
-  bool is_enabled_;
-
-  SourceBreakpoint* next_;
 
   friend class Debugger;
   DISALLOW_COPY_AND_ASSIGN(SourceBreakpoint);
 };
 
 
 // CodeBreakpoint represents a location in compiled code. There may be
 // more than one CodeBreakpoint for one SourceBreakpoint, e.g. when a
 // function gets compiled as a regular function and as a closure.
 class CodeBreakpoint {
@@ skipping 19 matching lines @@
 
   SourceBreakpoint* src_bpt() const { return src_bpt_; }
   void set_src_bpt(SourceBreakpoint* value) { src_bpt_ = value; }
 
   void set_next(CodeBreakpoint* value) { next_ = value; }
   CodeBreakpoint* next() const { return this->next_; }
   intptr_t pc_desc_index() const { return pc_desc_index_; }
 
   void PatchCode();
   void RestoreCode();
-  void PatchFunctionReturn();
-  void RestoreFunctionReturn();
 
   RawFunction* function_;
   intptr_t pc_desc_index_;
   intptr_t token_pos_;
   uword pc_;
   intptr_t line_number_;
   bool is_enabled_;
 
   SourceBreakpoint* src_bpt_;
   CodeBreakpoint* next_;
@@ skipping 181 matching lines @@
   void OneTimeBreakAtEntry(const Function& target_function);
 
   void RemoveBreakpoint(intptr_t bp_id);
   SourceBreakpoint* GetBreakpointById(intptr_t id);
 
   void SetStepOver();
   void SetSingleStep();
   void SetStepOut();
   bool IsStepping() const { return resume_action_ != kContinue; }
 
+  bool IsPaused() const { return pause_event_ != NULL; }
+
+  // Indicates why the debugger is currently paused.  If the debugger
+  // is not paused, this returns NULL.  Note that the debugger can be
+  // paused for breakpoints, isolate interruption, and (sometimes)
+  // exceptions.
+  const DebuggerEvent* PauseEvent() const { return pause_event_; }
+
   void SetExceptionPauseInfo(Dart_ExceptionPauseInfo pause_info);
   Dart_ExceptionPauseInfo GetExceptionPauseInfo();
 
   void VisitObjectPointers(ObjectPointerVisitor* visitor);
 
   // Called from Runtime when a breakpoint in Dart code is reached.
   void BreakpointCallback();
 
   // Returns true if there is at least one breakpoint set in func.
   // Checks for both user-defined and internal temporary breakpoints.
@@ skipping 46 matching lines @@
   static bool IsDebuggable(const Function& func);
 
  private:
   enum ResumeAction {
     kContinue,
     kStepOver,
     kStepOut,
     kSingleStep
   };
 
+  void FindEquivalentFunctions(const Script& script,
+                               intptr_t start_pos,
+                               intptr_t end_pos,
+                               GrowableObjectArray* function_list);
+  RawFunction* FindBestFit(const Script& script, intptr_t token_pos);
+  RawFunction* FindInnermostClosure(const Function& function,
+                                    intptr_t token_pos);
   intptr_t ResolveBreakpointPos(const Function& func,
-                                intptr_t first_token_pos,
-                                intptr_t last_token_pos);
+                                intptr_t requested_token_pos);
   void DeoptimizeWorld();
   void InstrumentForStepping(const Function& target_function);
+  SourceBreakpoint* SetBreakpoint(const Script& script, intptr_t token_pos);
   SourceBreakpoint* SetBreakpoint(const Function& target_function,
                                   intptr_t first_token_pos,
                                   intptr_t last_token_pos);
   void RemoveInternalBreakpoints();
   void UnlinkCodeBreakpoints(SourceBreakpoint* src_bpt);
   void RegisterSourceBreakpoint(SourceBreakpoint* bpt);
   void RegisterCodeBreakpoint(CodeBreakpoint* bpt);
-  SourceBreakpoint* GetSourceBreakpoint(const Function& func,
+  SourceBreakpoint* GetSourceBreakpoint(const Script& script,
                                         intptr_t token_pos);
   void MakeCodeBreakpointsAt(const Function& func,
-                             intptr_t token_pos,
                              SourceBreakpoint* bpt);
   // Returns NULL if no breakpoint exists for the given address.
   CodeBreakpoint* GetCodeBreakpoint(uword breakpoint_address);
 
   void SyncBreakpoint(SourceBreakpoint* bpt);
 
   ActivationFrame* TopDartFrame() const;
   static ActivationFrame* CollectDartFrame(Isolate* isolate,
                                            uword pc,
                                            StackFrame* frame,
@@ skipping 13 matching lines @@
   intptr_t nextId() { return next_id_++; }
 
   bool ShouldPauseOnException(DebuggerStackTrace* stack_trace,
                               const Instance& exc);
 
   void CollectLibraryFields(const GrowableObjectArray& field_list,
                             const Library& lib,
                             const String& prefix,
                             bool include_private_fields);
 
+  // Handles any events which pause vm execution.  Breakpoints,
+  // interrupts, etc.
+  void Pause(DebuggerEvent* event);
+
   Isolate* isolate_;
   Dart_Port isolate_id_;  // A unique ID for the isolate in the debugger.
   bool initialized_;
 
   // ID number generator.
   intptr_t next_id_;
 
-  // Current stack trace. Valid while executing breakpoint callback code.
-  DebuggerStackTrace* stack_trace_;
-
-  RemoteObjectCache* obj_cache_;
 
   SourceBreakpoint* src_breakpoints_;
   CodeBreakpoint* code_breakpoints_;
 
   // Tells debugger what to do when resuming execution after a breakpoint.
   ResumeAction resume_action_;
 
   // Do not call back to breakpoint handler if this flag is set.
   // Effectively this means ignoring breakpoints. Set when Dart code may
   // be run as a side effect of getting values of fields.
   bool ignore_breakpoints_;
 
-  // True while debugger calls event_handler_. Used to prevent recursive
-  // debugger events.
-  bool in_event_notification_;
+  // Indicates why the debugger is currently paused.  If the debugger
+  // is not paused, this is NULL.  Note that the debugger can be
+  // paused for breakpoints, isolate interruption, and (sometimes)
+  // exceptions.
+  DebuggerEvent* pause_event_;
+
+  // An id -> object map.  Valid only while IsPaused().
+  RemoteObjectCache* obj_cache_;
+
+  // Current stack trace. Valid only while IsPaused().
+  DebuggerStackTrace* stack_trace_;
 
   Dart_ExceptionPauseInfo exc_pause_info_;
 
   static EventHandler* event_handler_;
 
   friend class Isolate;
   friend class SourceBreakpoint;
   DISALLOW_COPY_AND_ASSIGN(Debugger);
 };
 
 
 }  // namespace dart
 
 #endif  // VM_DEBUGGER_H_