--- a/src/eric7/Documentation/Source/eric7.Debugger.DebugUI.html Sat Dec 16 15:21:11 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Debugger.DebugUI.html Sat Dec 16 16:30:55 2023 +0100 @@ -51,6 +51,10 @@ emitted at breaking after a reported exception </dd> +<dt>debuggingFinished</dt> +<dd> +emitted to signal the end of a debugging session +</dd> <dt>debuggingStarted(filename)</dt> <dd> emitted when a debugging session was @@ -224,12 +228,12 @@ <td>Private method to get the list of threads from the client.</td> </tr> <tr> -<td><a href="#DebugUI.__lastClientExited">__lastClientExited</a></td> -<td>Private slot handling the exit of the last client.</td> +<td><a href="#DebugUI.__lastEditorClosed">__lastEditorClosed</a></td> +<td>Private slot to handle the closeProgram signal.</td> </tr> <tr> -<td><a href="#DebugUI.__lastEditorClosed">__lastEditorClosed</a></td> -<td>Private slot to handle the closeProgram signal.</td> +<td><a href="#DebugUI.__mainClientExit">__mainClientExit</a></td> +<td>Private slot handling the exit of the last client.</td> </tr> <tr> <td><a href="#DebugUI.__moveInstructionPointer">__moveInstructionPointer</a></td> @@ -324,6 +328,10 @@ <td>Public method to clear the various debug histories.</td> </tr> <tr> +<td><a href="#DebugUI.debugInternalScript">debugInternalScript</a></td> +<td>Public method to run an internal script with debugger support.</td> +</tr> +<tr> <td><a href="#DebugUI.doCoverage">doCoverage</a></td> <td>Public method to handle the coverage actions.</td> </tr> @@ -344,6 +352,10 @@ <td>Public method to get a list of all actions.</td> </tr> <tr> +<td><a href="#DebugUI.getProjectEnvironmentString">getProjectEnvironmentString</a></td> +<td>Public method to get the string for the project environment.</td> +</tr> +<tr> <td><a href="#DebugUI.getSelectedDebuggerId">getSelectedDebuggerId</a></td> <td>Public method to get the currently selected debugger ID.</td> </tr> @@ -980,13 +992,6 @@ ID of the debugger backend </dd> </dl> -<a NAME="DebugUI.__lastClientExited" ID="DebugUI.__lastClientExited"></a> -<h4>DebugUI.__lastClientExited</h4> -<b>__lastClientExited</b>(<i></i>) - -<p> - Private slot handling the exit of the last client. -</p> <a NAME="DebugUI.__lastEditorClosed" ID="DebugUI.__lastEditorClosed"></a> <h4>DebugUI.__lastEditorClosed</h4> <b>__lastEditorClosed</b>(<i></i>) @@ -994,6 +999,13 @@ <p> Private slot to handle the closeProgram signal. </p> +<a NAME="DebugUI.__mainClientExit" ID="DebugUI.__mainClientExit"></a> +<h4>DebugUI.__mainClientExit</h4> +<b>__mainClientExit</b>(<i></i>) + +<p> + Private slot handling the exit of the last client. +</p> <a NAME="DebugUI.__moveInstructionPointer" ID="DebugUI.__moveInstructionPointer"></a> <h4>DebugUI.__moveInstructionPointer</h4> <b>__moveInstructionPointer</b>(<i>debuggerId=""</i>) @@ -1229,6 +1241,45 @@ <p> Public method to clear the various debug histories. </p> +<a NAME="DebugUI.debugInternalScript" ID="DebugUI.debugInternalScript"></a> +<h4>DebugUI.debugInternalScript</h4> +<b>debugInternalScript</b>(<i>venvName, scriptName, argv, workDir, environment, clientType, forProject</i>) + +<p> + Public method to run an internal script with debugger support. +</p> +<dl> + +<dt><i>venvName</i> (str)</dt> +<dd> +name of the environment for the debug tests run +</dd> +<dt><i>scriptName</i> (str)</dt> +<dd> +name of the internal script to be run +</dd> +<dt><i>argv</i> (str or list of str)</dt> +<dd> +string or list containing the parameters for the script +</dd> +<dt><i>workDir</i> (str)</dt> +<dd> +working directory for the script +</dd> +<dt><i>environment</i> (str)</dt> +<dd> +string defining the additional or changed environment + variables +</dd> +<dt><i>clientType</i> (str)</dt> +<dd> +type (language) of the debug client to be used +</dd> +<dt><i>forProject</i> (bool)</dt> +<dd> +flag indicating a project related debug session +</dd> +</dl> <a NAME="DebugUI.doCoverage" ID="DebugUI.doCoverage"></a> <h4>DebugUI.doCoverage</h4> <b>doCoverage</b>(<i>runProject, script=""</i>) @@ -1318,6 +1369,25 @@ list of all actions (list of EricAction) </dd> </dl> +<a NAME="DebugUI.getProjectEnvironmentString" ID="DebugUI.getProjectEnvironmentString"></a> +<h4>DebugUI.getProjectEnvironmentString</h4> +<b>getProjectEnvironmentString</b>(<i></i>) + +<p> + Public method to get the string for the project environment. +</p> +<dl> +<dt>Return:</dt> +<dd> +string for the project environment +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> <a NAME="DebugUI.getSelectedDebuggerId" ID="DebugUI.getSelectedDebuggerId"></a> <h4>DebugUI.getSelectedDebuggerId</h4> <b>getSelectedDebuggerId</b>(<i></i>)