Mono.Debugging Reports a debugger event Raised when the debugger resumes execution after being stopped Raised when the underlying debugging engine has been initialized and it is ready to start execution. Raised when the debugging session is paused Raised when the execution is interrupted by an external event Raised when a breakpoint is hit Raised when the execution is interrupted due to receiving a signal Raised when the debugged process exits Raised when an exception for which there is a catchpoint is thrown Raised when an exception is unhandled Raised when a thread is started in the debugged process Raised when a thread is stopped in the debugged process Raised when the 'busy state' of the debugger changes. The debugger may switch to busy state if it is in the middle of an expression evaluation which can't be aborted. Releases all resource used by the object. Call when you are finished using the . The method leaves the in an unusable state. After calling , you must release all references to the so the garbage collector can reclaim the memory that the was occupying. Gets or sets an exception handler to be invoked when an exception is raised by the debugger engine. Notice that this handler will be used to report exceptions in the debugger, not exceptions raised in the debugged process. Gets or sets the connection dialog creator callback. Gets or sets the connection dialog creator callback. Gets or sets the breakpoint trace handler. This handler is invoked when the value of a tracepoint has to be printed Gets or sets the type resolver handler. This handler is invoked when the expression evaluator needs to resolve a type name. Gets or sets the an expression evaluator provider This handler is invoked when the debugger needs to get an evaluator for a specific type of file Gets or sets the custom break event hit handler. This handler is invoked when a custom breakpoint is hit to determine if the debug session should continue or stop. Gets or sets the breakpoint store for the debugger session. Starts a debugging session Startup information Session options Is thrown when an argument passed to a method is invalid because it is . Starts a debugging session by attaching the debugger to a running process Process information Debugging options Is thrown when an argument passed to a method is invalid because it is . Detaches this debugging session from the debugged process Gets a value indicating whether this has been attached to a process using the Attach method. true if attached to process; otherwise, false. Gets or sets the active thread. This property can only be used when the debugger is paused Executes one line of code Executes one line of code, stepping into method invocations Executes one low level instruction Executes one low level instruction, stepping into method invocations Resumes the execution of the debugger and stops when the current method is exited Sets the next statement on the active thread. File name. Line. Column. Sets the next statement on the active thread. The IL offset. Returns the status of a breakpoint for this debugger session. Returns a status message of a breakpoint for this debugger session. Gets the debugger options object Gets or sets the evaluation options. Resumes the execution of the debugger Pauses the execution of the debugger Stops the execution of the debugger by killing the debugged process Gets a value indicating whether the debuggee is currently connected Gets a value indicating whether the debuggee is currently running (not paused by the debugger) Gets a value indicating whether the debuggee has exited. Gets a list of all processes This method can only be used when the debuggee is stopped by the debugger Gets or sets the output writer callback. This callback is invoked to print debuggee output Gets or sets the log writer. This callback is invoked to print debugger log messages Gets or sets the debug writer. This callback is invoked to print debugge messages called via System.Diagnostics.Debugger.Log Gets the disassembly of a source code file An array of AssemblyLine, with one element for each source code line that could be disassembled The file. This method can only be used when the debuggee is stopped by the debugger Stops the execution of background evaluations being done by the debugger This method can only be used when the debuggee is stopped by the debugger Gets a value indicating whether there are background evaluations being done by the debugger which can be cancelled. This method can only be used when the debuggee is stopped by the debugger Override to stop the execution of background evaluations being done by the debugger Called when an expression needs to be resolved The expression The source code location The resolved expression Tries to bind all unbound breakpoints of a source file Source file path This method can be called by a subclass to ask the debugger session to attempt to bind all unbound breakpoints defined on the given file. This method could be called, for example, when a new assembly that contains this file is loaded into memory. It is not necessary to use this method if the subclass keeps track of unbound breakpoints by itself. Unbinds all bound breakpoints of a source file The source file path This method can be called by a subclass to ask the debugger session to unbind all bound breakpoints defined on the given file. This method could be called, for example, when an assembly that contains this file is unloaded from memory. It is not necessary to use this method if the subclass keeps track of unbound breakpoints by itself. Called to attach the debugger to a running process Process identifier. Reports an unhandled exception in the debugger True if the debugger engine handles the exception. False otherwise. The exception This method can be used by subclasses to report errors in the debugger that must be reported to the user. When set, operations such as OnRun, OnAttachToProcess, OnStepLine, etc, are run in a background thread, so it will not block the caller of the corresponding public methods. Called to start the execution of the debugger Startup information Called to attach the debugger to a running process Process identifier. Called to detach the debugging session from the running process Called when the active thread has to be changed Process identifier. Thread identifier. This method can only be called when the debuggee is stopped by the debugger Called when the debug session has to be paused Called when the target process has to be exited Called to step one source code line This method can only be called when the debuggee is stopped by the debugger Called to step one source line, but step over method calls This method can only be called when the debuggee is stopped by the debugger Called to step one instruction This method can only be called when the debuggee is stopped by the debugger Called to step one instruction, but step over method calls This method can only be called when the debuggee is stopped by the debugger Called to continue execution until leaving the current method This method can only be called when the debuggee is stopped by the debugger Called to resume execution This method can only be called when the debuggee is stopped by the debugger Checks whether or not the debugger supports setting the next statement to use when the debugger is resumed. This method is generally used to determine whether or not UI menu items should be shown. true if the debugger supports setting the next statement to use when the debugger is resumed; otherwise, false. Sets the next statement to be executed when the debugger is resumed. This method can only be called when the debuggee is stopped by the debugger. Sets the next statement to be executed when the debugger is resumed. This method can only be called when the debuggee is stopped by the debugger. Called to insert a new breakpoint or catchpoint The break event. Implementations of this method must: (1) create (and return) an instance of BreakEventInfo (or a subclass of it). (2) Attempt to activate a breakpoint at the location specified in breakEvent. If the breakpoint cannot be activated at the time this method is called, it is the responsibility of the DebuggerSession subclass to attempt it later on. The BreakEventInfo object can be used to change the status of the breakpoint, update the hit point, etc. Called when a breakpoint has been removed. The breakpoint Implementations of this method should remove or disable the breakpoint in the debugging engine. Called when information about a breakpoint has changed The break event This method is called when some information about the breakpoint changes. Notice that the file and line of a breakpoint or the exception name of a catchpoint can't be modified. Changes of the Enabled property are notified by calling OnEnableBreakEvent. Called when a break event is enabled or disabled The break event The new status Queried when the debugger session has to check if changes in breakpoints are allowed or not true if break event changes are allowed; otherwise, false. This property should return false if at the time it is invoked the debugger engine doesn't support adding, removing or doing changes in breakpoints. Called to get a list of the threads of a process Process identifier. This method can only be called when the debuggee is stopped by the debugger Called to get a list of all debugee processes This method can only be called when the debuggee is stopped by the debugger Called to get the backtrace of a thread Process identifier. Thread identifier. This method can only be called when the debuggee is stopped by the debugger Called to gets the disassembly of a source code file An array of AssemblyLine, with one element for each source code line that could be disassembled The file. This method can only be used when the debuggee is stopped by the debugger Called for every object that is obtained from the debugger engine. Subclasses may want to create wrappers for some of those objects Calling this method is optional. It's usefull to call this method so underlying debugger can optimize speed of fetching multiple frames on . Array of threads to fetch frames. Gets the full name of the stackframe. Which respects Session.EvaluationOptions.StackFrameFormat Returns True if the expression is valid and can be evaluated for this frame. Returns True if the expression is valid and can be evaluated for this frame. Gets the flags of the value Name of the value (for example, the property name) Gets or sets the value of the object The value. Is thrown when trying to set a value on a read-only ObjectValue When value settings was failed. This exception should be shown to user. This value is a string representation of the ObjectValue. The content depends on several evaluation options. For example, if ToString calls are enabled, this value will be the result of calling ToString. If the object is a primitive type, in general the Value will be an expression that represents the value in the target language. For example, when debugging C#, if the property is an string, the value will include the quotation marks and chars like '\' will be properly escaped. If you need to get the real CLR value of the object, use GetRawValue. Gets or sets the display value of this object This method returns a string to be used when showing the value of this object. In most cases, the Value and DisplayValue properties return the same text, but there are some cases in which DisplayValue may return a more convenient textual representation of the value, which may not be a valid target language expression. For example in C#, an enum Value includes the full enum type name (e.g. "Gtk.ResponseType.OK"), while DisplayValue only has the enum value name ("OK"). Sets the value of this object, using the default evaluation options Sets the value of this object, using the specified evaluation options The value The options Is thrown if the value is read-only When value settings was failed. This exception should be shown to user. Gets the raw value of this object The raw value. This method can be used to get the CLR value of the object. For example, if this ObjectValue is a property of type String, this method will return the System.String value of the property. If this ObjectValue refers to an object instead of a primitive value, then a RawValue object will be returned. RawValue can be used to get and set members of an object, and to call methods. If this ObjectValue refers to an array, then a RawValueArray object will be returned. Gets the raw value of this object The evaluation options The raw value. This method can be used to get the CLR value of the object. For example, if this ObjectValue is a property of type String, this method will return the System.String value of the property. If this ObjectValue refers to an object instead of a primitive value, then a RawValue object will be returned. RawValue can be used to get and set members of an object, and to call methods. If this ObjectValue refers to an array, then a RawValueArray object will be returned. Sets the raw value of this object The value The provided value can be a primitive type, a RawValue object or a RawValueArray object. Sets the raw value of this object The value The evaluation options The provided value can be a primitive type, a RawValue object or a RawValueArray object. Full name of the type of the object Gets or sets the child selector. The child selector is an expression which can be concatenated to a parent expression to get this child. For example, if this object is a reference to a field named 'foo' of an object, the child selector is '.foo'. Gets a value indicating whether this object has children. true if this instance has children; otherwise, false. Gets a child value The child. Name of the member This method can be used to get a member of an object (such as a field or property) Gets a child value The child. Name of the member Options to be used to evaluate the child This method can be used to get a member of an object (such as a field or property) Gets all children of the object An array of all child values Gets all children of the object An array of all child values Options to be used to evaluate the children Gets an item of an array The array item. Item index Is thrown if this object is not an array (IsArray returns false) Gets an item of an array The array item. Item index Options to be used to evaluate the item Is thrown if this object is not an array (IsArray returns false) Gets the number of items of an array Is thrown if this object is not an array (IsArray returns false) Refreshes the value of this object This method can be called to get a more up-to-date value for this object. Refreshes the value of this object This method can be called to get a more up-to-date value for this object. Gets a wait handle which can be used to wait for the evaluation of this object to end The wait handle. Gets or sets a value indicating whether this is enabled. true if enabled; otherwise, false. Changes in this property are automatically applied. There is no need to call CommitChanges(). Gets the status of the break event The status of the break event for the given debug session Session for which to get the status of the break event Gets a message describing the status of the break event The status message of the break event for the given debug session Session for which to get the status message of the break event Gets or sets the expression to be traced when the breakpoint is hit If this break event is hit and the HitAction is TraceExpression, the debugger will evaluate and print the value of this property. The CommitChanges() method has to be called for changes in this property to take effect. Gets the last value traced. This property returns the last evaluation of TraceExpression. Gets or sets the action to be performed when the breakpoint is hit If the value is Break, the debugger will pause the execution. If the value is PrintExpression, the debugger will evaluate and print the value of the TraceExpression property. If the value is CustomAction, the debugger will execute the CustomBreakEventHitHandler callback specified in DebuggerSession, and will provide the value of CustomActionId as argument. The CommitChanges() method has to be called for changes in this property to take effect. Gets or sets the hit count mode. When the break event is hit, the HitCountMode is used to compare the CurrentHitCount with the TargetHitCount to determine if the break event should trigger. Gets or sets the target hit count. When the break event is hit, if the value of HitCountMode is not None, then the value of CurrentHitCount will be incremented. Execution will immediately resume if it is determined that the CurrentHitCount vs TargetHitCount comparison does not meet the requirements of HitCountMode. The CommitChanges() method has to be called for changes in this property to take effect. FIXME: rename this to TargetHitCount Gets or sets the current hit count. When the break event is hit, the HitCountMode is used to compare the CurrentHitCount with the TargetHitCount to determine if the break event should trigger. Gets or sets the custom action identifier. If this break event is hit and the value of HitAction is CustomAction, the debugger will execute the CustomBreakEventHitHandler callback specified in DebuggerSession, and will provide the value of this property as argument. The CommitChanges() method has to be called for changes in this property to take effect. NonUserBreakpoint is special kind of breakpoint that is not placed by user but by IDE/Add-In. This breakpoint is usually used by AddIn to execute code on debugee at certain point in application execution. IDE must hide this breakpoint from user. In breakpoints list and it must not stop execution(show breakpoint hit location). WARNING: Code that adds this breakpoint must also make sure to call session.Continue(); when breakpoint is hit. Commits changes done in the break event properties This method must be called after doing changes in the break event properties. Clone this instance. Makes a copy of this instance A break event from which to copy the data. Default is null. Which means do same as "ProjectAssembliesOnly" setting. Represents an object in the process being debugged Initializes a new instance of the class. Value source Full name of the type of the object Invokes a method on the object The result of the invocation The name of the method The parameters (primitive type values, RawValue instances or RawValueArray instances) Gets the value of a field or property The value (a primitive type value, a RawValue instance or a RawValueArray instance) Name of the field or property Sets the value of a field or property Name of the field or property The value (a primitive type value, a RawValue instance or a RawValueArray instance) Represents an array of objects in the process being debugged Initializes a new instance of the class. Value source. Full type name of the array items Gets or sets the item at the specified index. The index The item value can be a primitive type value, a RawValue instance or a RawValueArray instance. Gets the values. The items. The index. The number of items to get. This method is useful for incrementally fetching an array in order to avoid long waiting periods when the array is too large for ToArray(). Returns an array with all items of the RawValueArray This method is useful to avoid unnecessary debugger-debuggee roundtrips when processing all items of an array. For example, if a RawValueArray represents an image encoded in a byte[], getting the values one by one using the indexer is very slow. The ToArray() will return the whole byte[] in a single call. Gets the length of the array Represents a string object in the process being debugged Initializes a new instance of the class. Value source. Gets the length of the string Gets a substring of the string The starting index of the requested substring. The length of the requested substring. Gets the value. The value. The provided value can have the following members: Type of the object: type of the exception Message: Message of the exception Instance: Raw instance of the exception StackTrace: an array of frames. Each frame must have: Value of the object: display text of the frame File: name of the file Line: line Column: column InnerException: inner exception, following the same format described above. The provided value must have a specific structure. The Value property is the display text. A child "File" member must be the name of the file. A child "Line" member must be the line. A child "Column" member must be the column. The breakpoint is not connected to any debug session The breakpoint is not yet bound to a valid location The breakpoint is bound The breakpoint could not be bound because the breakpoint location is invalid There was a debugger error while binding the breakpoint This class can be used to manage and get information about a breakpoint at debug-time. It is intended to be used by DebuggerSession subclasses. Gets or sets the implementation specific handle of the breakpoint Break event that this instance represents Gets the status of the break event Gets a description of the status Adjusts the location of a breakpoint New line. This method can be used to temporarily change source code line of the breakpoint. This is useful, for example, when two adjacent lines are mapped to a single native offset. If the breakpoint is set to the first of those lines, the debugger might end stopping in the second line, because it has the same native offset. To avoid this confusion situation, the debugger implementation may decide to adjust the position of the breakpoint, and move it to the second line. This line adjustment has effect only during the debug session, and is automatically reset when it terminates. Increments the hit count. true if the break event should trigger, or false otherwise. This is a simple abstraction so that MD can plug in its own logging service to handle the Mono.Debugging.Soft error logging, without Mono.Debugging.Soft depending on MonoDevelop.Core. In the absence of a custom logger, it writes to Console. Gets the new debugger log filename. It may return null which means disable logging. The new debugger log filename or null. Updates the value with the result of evaluation of expression call site should catch this exception and show it to user in pretty way (e.g. in message box) All other exceptions indicate error and should be logged This class can be used to generate an ObjectValue using a provided evaluation delegate. The value is initialy evaluated synchronously (blocking the caller). If no result is obtained after a short period (provided in the WaitTime property), evaluation will then be made asynchronous and the Run method will immediately return an ObjectValue with the Evaluating state. When evaluation is aborted and debugger callback is invoked the implementation has to check for Token.IsCancellationRequested and call Task.SetCancelled() instead of setting the result The implementation has to tell the debugger to abort the evaluation. This method must bot block. indicates how many times this method has been already called for this evaluation. E.g. the implementation can perform some 'rude abort' after several previous ordinary 'aborts' were failed. For the first call this parameter == 0 Called to invoke the operation. The execution must be asynchronous (it must return immediatelly). Called to abort the execution of the operation. It has to throw an exception if the operation can't be aborted. This operation must not block. The engine will wait for the operation to be aborted by calling WaitForCompleted. Waits until the operation has been completed or aborted. Enables or disables async evaluation Returns all members of a type. The following binding flags have to be honored: BindingFlags.Static, BindingFlags.Instance, BindingFlags.Public, BindingFlags.NonPublic, BindingFlags.DeclareOnly Disambiguate the ObjectValue's name (in the case where the property name also exists in a base class). The ValueReference. The ObjectValue. Executes the provided evaluator. If a result is obtained before RunTimeout milliseconds, the method ends returning True. If it does not finish after RunTimeout milliseconds, the method ends retuning False, although the evaluation continues in the background. In that case, when evaluation ends, the provided delayedDoneCallback delegate is called. This method may perform conversion between cast-incompatible types, e.g. converts "123" to 123 Performs strong cast