Debugger wire protocol: setting breakpoints

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 "vm/object.h"
 
 namespace dart {
 
 class SourceBreakpoint;
 class CodeBreakpoint;
 class Isolate;
 class ObjectPointerVisitor;
 class ActiveVariables;
 
 
 // SourceBreakpoint represents a user-specified breakpoint location in
 // Dart source. There may be more than one CodeBreakpoint object per
 // SourceBreakpoint.
 class SourceBreakpoint {
  public:
-  SourceBreakpoint(const Function& func, intptr_t token_index);
+  SourceBreakpoint(intptr_t id, const Function& func, intptr_t token_index);
 
   RawFunction* function() const { return function_; }
   intptr_t token_index() const { return token_index_; }
+  intptr_t id() const { return id_; }
 
   RawScript* SourceCode();
   RawString* SourceUrl();
   intptr_t LineNumber();

[srdjan, 2012/05/14 20:48:16]

Can the three functions above be const?

[hausner, 2012/05/14 21:07:27]

No, because they evaluate the result lazily. For example, getting the line
number of a breakpoint causes the script to be re-tokenized. I don't want to do
that eagerly.

 
   void Enable();
   void Disable();
   bool IsEnabled() const { return is_enabled_; }
 
  private:
   void VisitObjectPointers(ObjectPointerVisitor* visitor);
 
   void set_function(const Function& func);
   void set_next(SourceBreakpoint* value) { next_ = value; }
   SourceBreakpoint* next() const { return this->next_; }
 
+  intptr_t id_;

[srdjan, 2012/05/14 20:48:16]

Can it be const? Same for token_index, line_number?

[hausner, 2012/05/14 21:07:27]

id_ and token_index_ can be const, line_number_ can't, for the reason mentioned
above.

Done.

   RawFunction* function_;
   intptr_t token_index_;
   intptr_t line_number_;
   bool is_enabled_;
 
   SourceBreakpoint* next_;
 
   friend class Debugger;
   DISALLOW_COPY_AND_ASSIGN(SourceBreakpoint);
 };
@@ skipping 123 matching lines @@
 
   friend class Debugger;
   DISALLOW_COPY_AND_ASSIGN(DebuggerStackTrace);
 };
 
 
 typedef void BreakpointHandler(SourceBreakpoint* bpt,
                                DebuggerStackTrace* stack);
 
 
+
 class Debugger {
  public:
+  enum EventType {
+    kPaused = 1,
+    kBreakpointResolved = 2,
+  };
+  struct DebuggerEvent {
+    EventType type;
+    union {
+      DebuggerStackTrace* stack_trace;
+      SourceBreakpoint* breakpoint;
+    };
+  };
+  typedef void EventHandler(DebuggerEvent *event);
+
   Debugger();
   ~Debugger();
 
   void Initialize(Isolate* isolate);
   void Shutdown();
   bool IsActive();
 
   void NotifyCompilation(const Function& func);
 
+  void SetEventHandler(EventHandler* handler);
   void SetBreakpointHandler(BreakpointHandler* handler);
 
   RawFunction* ResolveFunction(const Library& library,
                                const String& class_name,
                                const String& function_name);
 
   // Set breakpoint at closest location to function entry.
   SourceBreakpoint* SetBreakpointAtEntry(const Function& target_function);
   SourceBreakpoint* SetBreakpointAtLine(const String& script_url,
                                         intptr_t line_number);
 
-  void RemoveBreakpoint(SourceBreakpoint* bpt);
+  void RemoveBreakpoint(intptr_t bp_id);
+  SourceBreakpoint* GetBreakpointById(intptr_t id);
 
   void SetStepOver() { resume_action_ = kStepOver; }
   void SetStepInto() { resume_action_ = kStepInto; }
   void SetStepOut() { resume_action_ = kStepOut; }
 
   void VisitObjectPointers(ObjectPointerVisitor* visitor);
 
   // Called from Runtime when a breakpoint in Dart code is reached.
   void BreakpointCallback();
 
+  DebuggerStackTrace* StackTrace() const { return stack_trace_; }
+
   RawArray* GetInstanceFields(const Instance& obj);
   RawArray* GetStaticFields(const Class& cls);
 
   // Utility functions.
   static const char* QualifiedFunctionName(const Function& func);
 
   RawObject* GetInstanceField(const Class& cls,
                               const String& field_name,
                               const Instance& object);
   RawObject* GetStaticField(const Class& cls,
@@ skipping 18 matching lines @@
   SourceBreakpoint* GetSourceBreakpoint(const Function& func,
                                         intptr_t token_index);
   CodeBreakpoint* MakeCodeBreakpoint(const Function& func,
                                      intptr_t token_index);
 
   // Returns NULL if no breakpoint exists for the given address.
   CodeBreakpoint* GetCodeBreakpoint(uword breakpoint_address);
 
   void SyncBreakpoint(SourceBreakpoint* bpt);
 
+  void SignalBpResolved(SourceBreakpoint *bpt);
+
+  intptr_t nextId() { return next_id_++; }
+
   Isolate* isolate_;
   bool initialized_;
   BreakpointHandler* bp_handler_;
+  EventHandler* event_handler_;
+
+  // ID number generator.
+  intptr_t next_id_;
+
+  // Current stack trace. Valid while executing breakpoint callback code.
+  DebuggerStackTrace* stack_trace_;
+
   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_;
 
   friend class SourceBreakpoint;
   DISALLOW_COPY_AND_ASSIGN(Debugger);
 };
 
 
 }  // namespace dart
 
 #endif  // VM_DEBUGGER_H_