--- a/src/eric7/Documentation/Source/eric7.Debugger.DebugServer.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Debugger.DebugServer.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,37 +7,37 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Debugger.DebugServer</h1>
-
<p>
Module implementing the debug server.
</p>
+
<h3>Global Attributes</h3>
-
<table>
-<tr><td>DebuggerInterfaces</td></tr><tr><td>NetworkInterfaceMapping</td></tr>
+<tr><td>DebuggerInterfaces</td></tr>
+<tr><td>NetworkInterfaceMapping</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#DebugServer">DebugServer</a></td>
<td>Class implementing the debug server embedded within the IDE.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="DebugServer" ID="DebugServer"></a>
<h2>DebugServer</h2>
-
<p>
Class implementing the debug server embedded within the IDE.
</p>
+
<h3>Signals</h3>
<dl>
@@ -212,19 +212,17 @@
<h3>Derived from</h3>
QTcpServer
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#DebugServer.__init__">DebugServer</a></td>
<td>Constructor</td>
@@ -642,19 +640,20 @@
<td>Public method to unregister a debugger interface.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="DebugServer.__init__" ID="DebugServer.__init__"></a>
<h4>DebugServer (Constructor)</h4>
<b>DebugServer</b>(<i>originalPathString, preventPassiveDebugging=False, project=None, parent=None, </i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>originalPathString</i> (str)</dt>
@@ -678,10 +677,10 @@
<a NAME="DebugServer.__addBreakPoints" ID="DebugServer.__addBreakPoints"></a>
<h4>DebugServer.__addBreakPoints</h4>
<b>__addBreakPoints</b>(<i>parentIndex, start, end, debuggerId=""</i>)
-
<p>
Private slot to add breakpoints.
</p>
+
<dl>
<dt><i>parentIndex</i> (QModelIndex)</dt>
@@ -705,10 +704,10 @@
<a NAME="DebugServer.__addWatchPoints" ID="DebugServer.__addWatchPoints"></a>
<h4>DebugServer.__addWatchPoints</h4>
<b>__addWatchPoints</b>(<i>parentIndex, start, end, debuggerId=""</i>)
-
<p>
Private slot to set a watch expression.
</p>
+
<dl>
<dt><i>parentIndex</i> (QModelIndex)</dt>
@@ -732,11 +731,11 @@
<a NAME="DebugServer.__breakPointDataAboutToBeChanged" ID="DebugServer.__breakPointDataAboutToBeChanged"></a>
<h4>DebugServer.__breakPointDataAboutToBeChanged</h4>
<b>__breakPointDataAboutToBeChanged</b>(<i>startIndex, endIndex</i>)
-
<p>
Private slot to handle the dataAboutToBeChanged signal of the
breakpoint model.
</p>
+
<dl>
<dt><i>startIndex</i> (QModelIndex)</dt>
@@ -751,10 +750,10 @@
<a NAME="DebugServer.__changeBreakPoints" ID="DebugServer.__changeBreakPoints"></a>
<h4>DebugServer.__changeBreakPoints</h4>
<b>__changeBreakPoints</b>(<i>startIndex, endIndex</i>)
-
<p>
Private slot to set changed breakpoints.
</p>
+
<dl>
<dt><i>startIndex</i> (QModelIndex)</dt>
@@ -769,10 +768,10 @@
<a NAME="DebugServer.__changeWatchPoints" ID="DebugServer.__changeWatchPoints"></a>
<h4>DebugServer.__changeWatchPoints</h4>
<b>__changeWatchPoints</b>(<i>startIndex, endIndex</i>)
-
<p>
Private slot to set changed watch expressions.
</p>
+
<dl>
<dt><i>startIndex</i> (QModelIndex)</dt>
@@ -787,10 +786,10 @@
<a NAME="DebugServer.__clientClearBreakPoint" ID="DebugServer.__clientClearBreakPoint"></a>
<h4>DebugServer.__clientClearBreakPoint</h4>
<b>__clientClearBreakPoint</b>(<i>fn, lineno</i>)
-
<p>
Private slot to handle the clientClearBreak signal.
</p>
+
<dl>
<dt><i>fn</i> (str)</dt>
@@ -805,10 +804,10 @@
<a NAME="DebugServer.__clientClearWatchPoint" ID="DebugServer.__clientClearWatchPoint"></a>
<h4>DebugServer.__clientClearWatchPoint</h4>
<b>__clientClearWatchPoint</b>(<i>condition</i>)
-
<p>
Private slot to handle the clientClearWatch signal.
</p>
+
<dl>
<dt><i>condition</i> (str)</dt>
@@ -819,24 +818,24 @@
<a NAME="DebugServer.__clientProcessError" ID="DebugServer.__clientProcessError"></a>
<h4>DebugServer.__clientProcessError</h4>
<b>__clientProcessError</b>(<i></i>)
-
<p>
Private slot to process client output received via stderr.
</p>
+
<a NAME="DebugServer.__clientProcessOutput" ID="DebugServer.__clientProcessOutput"></a>
<h4>DebugServer.__clientProcessOutput</h4>
<b>__clientProcessOutput</b>(<i></i>)
-
<p>
Private slot to process client output received via stdout.
</p>
+
<a NAME="DebugServer.__createDebuggerInterface" ID="DebugServer.__createDebuggerInterface"></a>
<h4>DebugServer.__createDebuggerInterface</h4>
<b>__createDebuggerInterface</b>(<i>clientType=None</i>)
-
<p>
Private slot to create the debugger interface object.
</p>
+
<dl>
<dt><i>clientType</i> (str)</dt>
@@ -847,10 +846,10 @@
<a NAME="DebugServer.__deleteBreakPoints" ID="DebugServer.__deleteBreakPoints"></a>
<h4>DebugServer.__deleteBreakPoints</h4>
<b>__deleteBreakPoints</b>(<i>parentIndex, start, end</i>)
-
<p>
Private slot to delete breakpoints.
</p>
+
<dl>
<dt><i>parentIndex</i> (QModelIndex)</dt>
@@ -869,10 +868,10 @@
<a NAME="DebugServer.__deleteWatchPoints" ID="DebugServer.__deleteWatchPoints"></a>
<h4>DebugServer.__deleteWatchPoints</h4>
<b>__deleteWatchPoints</b>(<i>parentIndex, start, end</i>)
-
<p>
Private slot to delete watch expressions.
</p>
+
<dl>
<dt><i>parentIndex</i> (QModelIndex)</dt>
@@ -891,10 +890,10 @@
<a NAME="DebugServer.__findLanguageForExtension" ID="DebugServer.__findLanguageForExtension"></a>
<h4>DebugServer.__findLanguageForExtension</h4>
<b>__findLanguageForExtension</b>(<i>ext</i>)
-
<p>
Private method to get the language associated with a file extension.
</p>
+
<dl>
<dt><i>ext</i> (str)</dt>
@@ -917,11 +916,11 @@
<a NAME="DebugServer.__getNetworkInterfaceAndIndex" ID="DebugServer.__getNetworkInterfaceAndIndex"></a>
<h4>DebugServer.__getNetworkInterfaceAndIndex</h4>
<b>__getNetworkInterfaceAndIndex</b>(<i>address</i>)
-
<p>
Private method to determine the network interface and the interface
index.
</p>
+
<dl>
<dt><i>address</i> (str)</dt>
@@ -944,10 +943,10 @@
<a NAME="DebugServer.__makeWatchCondition" ID="DebugServer.__makeWatchCondition"></a>
<h4>DebugServer.__makeWatchCondition</h4>
<b>__makeWatchCondition</b>(<i>cond, special</i>)
-
<p>
Private method to construct the condition string.
</p>
+
<dl>
<dt><i>cond</i> (str)</dt>
@@ -974,31 +973,31 @@
<a NAME="DebugServer.__newConnection" ID="DebugServer.__newConnection"></a>
<h4>DebugServer.__newConnection</h4>
<b>__newConnection</b>(<i></i>)
-
<p>
Private slot to handle a new connection.
</p>
+
<a NAME="DebugServer.__passiveShutDown" ID="DebugServer.__passiveShutDown"></a>
<h4>DebugServer.__passiveShutDown</h4>
<b>__passiveShutDown</b>(<i></i>)
-
<p>
Private method to shut down a passive debug connection.
</p>
+
<a NAME="DebugServer.__registerDebuggerInterfaces" ID="DebugServer.__registerDebuggerInterfaces"></a>
<h4>DebugServer.__registerDebuggerInterfaces</h4>
<b>__registerDebuggerInterfaces</b>(<i></i>)
-
<p>
Private method to register the available internal debugger interfaces.
</p>
+
<a NAME="DebugServer.__remoteBreakpointEnable" ID="DebugServer.__remoteBreakpointEnable"></a>
<h4>DebugServer.__remoteBreakpointEnable</h4>
<b>__remoteBreakpointEnable</b>(<i>debuggerId, fn, line, enable</i>)
-
<p>
Private method to enable or disable a breakpoint.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -1021,10 +1020,10 @@
<a NAME="DebugServer.__remoteBreakpointIgnore" ID="DebugServer.__remoteBreakpointIgnore"></a>
<h4>DebugServer.__remoteBreakpointIgnore</h4>
<b>__remoteBreakpointIgnore</b>(<i>debuggerId, fn, line, count</i>)
-
<p>
Private method to ignore a breakpoint the next couple of occurrences.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -1047,10 +1046,10 @@
<a NAME="DebugServer.__remoteWatchpoint" ID="DebugServer.__remoteWatchpoint"></a>
<h4>DebugServer.__remoteWatchpoint</h4>
<b>__remoteWatchpoint</b>(<i>debuggerId, cond, setWatch, temp=False</i>)
-
<p>
Private method to set or clear a watch expression.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -1073,10 +1072,10 @@
<a NAME="DebugServer.__remoteWatchpointEnable" ID="DebugServer.__remoteWatchpointEnable"></a>
<h4>DebugServer.__remoteWatchpointEnable</h4>
<b>__remoteWatchpointEnable</b>(<i>debuggerId, cond, enable</i>)
-
<p>
Private method to enable or disable a watch expression.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -1095,11 +1094,11 @@
<a NAME="DebugServer.__remoteWatchpointIgnore" ID="DebugServer.__remoteWatchpointIgnore"></a>
<h4>DebugServer.__remoteWatchpointIgnore</h4>
<b>__remoteWatchpointIgnore</b>(<i>debuggerId, cond, count</i>)
-
<p>
Private method to ignore a watch expression the next couple of
occurrences.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -1118,10 +1117,10 @@
<a NAME="DebugServer.__restoreBreakpoints" ID="DebugServer.__restoreBreakpoints"></a>
<h4>DebugServer.__restoreBreakpoints</h4>
<b>__restoreBreakpoints</b>(<i>debuggerId=""</i>)
-
<p>
Private method to restore the breakpoints after a restart.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -1133,11 +1132,11 @@
<a NAME="DebugServer.__restoreNoDebugList" ID="DebugServer.__restoreNoDebugList"></a>
<h4>DebugServer.__restoreNoDebugList</h4>
<b>__restoreNoDebugList</b>(<i>debuggerId=""</i>)
-
<p>
Private method to restore the list of scripts not to be debugged after
a restart.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -1149,10 +1148,10 @@
<a NAME="DebugServer.__restoreWatchpoints" ID="DebugServer.__restoreWatchpoints"></a>
<h4>DebugServer.__restoreWatchpoints</h4>
<b>__restoreWatchpoints</b>(<i>debuggerId=""</i>)
-
<p>
Private method to restore the watch expressions after a restart.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -1164,10 +1163,10 @@
<a NAME="DebugServer.__setClientType" ID="DebugServer.__setClientType"></a>
<h4>DebugServer.__setClientType</h4>
<b>__setClientType</b>(<i>clType</i>)
-
<p>
Private method to set the client type.
</p>
+
<dl>
<dt><i>clType</i> (str)</dt>
@@ -1178,10 +1177,10 @@
<a NAME="DebugServer.__splitWatchCondition" ID="DebugServer.__splitWatchCondition"></a>
<h4>DebugServer.__splitWatchCondition</h4>
<b>__splitWatchCondition</b>(<i>cond</i>)
-
<p>
Private method to split a remote watch expression.
</p>
+
<dl>
<dt><i>cond</i> (str)</dt>
@@ -1204,11 +1203,11 @@
<a NAME="DebugServer.__watchPointDataAboutToBeChanged" ID="DebugServer.__watchPointDataAboutToBeChanged"></a>
<h4>DebugServer.__watchPointDataAboutToBeChanged</h4>
<b>__watchPointDataAboutToBeChanged</b>(<i>startIndex, endIndex</i>)
-
<p>
Private slot to handle the dataAboutToBeChanged signal of the
watch expression model.
</p>
+
<dl>
<dt><i>startIndex</i> (QModelIndex)</dt>
@@ -1223,10 +1222,10 @@
<a NAME="DebugServer.getBreakPointModel" ID="DebugServer.getBreakPointModel"></a>
<h4>DebugServer.getBreakPointModel</h4>
<b>getBreakPointModel</b>(<i></i>)
-
<p>
Public slot to get a reference to the breakpoint model object.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1242,10 +1241,10 @@
<a NAME="DebugServer.getClientCapabilities" ID="DebugServer.getClientCapabilities"></a>
<h4>DebugServer.getClientCapabilities</h4>
<b>getClientCapabilities</b>(<i>clientType</i>)
-
<p>
Public method to retrieve the debug clients capabilities.
</p>
+
<dl>
<dt><i>clientType</i> (str)</dt>
@@ -1268,10 +1267,10 @@
<a NAME="DebugServer.getClientInterpreter" ID="DebugServer.getClientInterpreter"></a>
<h4>DebugServer.getClientInterpreter</h4>
<b>getClientInterpreter</b>(<i></i>)
-
<p>
Public method to get the interpreter of the debug client.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1287,10 +1286,10 @@
<a NAME="DebugServer.getClientType" ID="DebugServer.getClientType"></a>
<h4>DebugServer.getClientType</h4>
<b>getClientType</b>(<i></i>)
-
<p>
Public method to get the currently running debug client type.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1306,10 +1305,10 @@
<a NAME="DebugServer.getDebuggerIds" ID="DebugServer.getDebuggerIds"></a>
<h4>DebugServer.getDebuggerIds</h4>
<b>getDebuggerIds</b>(<i></i>)
-
<p>
Public method to return the IDs of the connected debugger backends.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1325,10 +1324,10 @@
<a NAME="DebugServer.getExtensions" ID="DebugServer.getExtensions"></a>
<h4>DebugServer.getExtensions</h4>
<b>getExtensions</b>(<i>language</i>)
-
<p>
Public slot to get the extensions associated with the given language.
</p>
+
<dl>
<dt><i>language</i> (str)</dt>
@@ -1351,11 +1350,11 @@
<a NAME="DebugServer.getHostAddress" ID="DebugServer.getHostAddress"></a>
<h4>DebugServer.getHostAddress</h4>
<b>getHostAddress</b>(<i>localhost</i>)
-
<p>
Public method to get the IP address or hostname the debug server is
listening.
</p>
+
<dl>
<dt><i>localhost</i> (bool)</dt>
@@ -1378,10 +1377,10 @@
<a NAME="DebugServer.getProjectEnvironmentString" ID="DebugServer.getProjectEnvironmentString"></a>
<h4>DebugServer.getProjectEnvironmentString</h4>
<b>getProjectEnvironmentString</b>(<i></i>)
-
<p>
Public method to get the string for the project environment.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1397,10 +1396,10 @@
<a NAME="DebugServer.getSupportedLanguages" ID="DebugServer.getSupportedLanguages"></a>
<h4>DebugServer.getSupportedLanguages</h4>
<b>getSupportedLanguages</b>(<i>shellOnly=False</i>)
-
<p>
Public slot to return the supported programming languages.
</p>
+
<dl>
<dt><i>shellOnly</i> (bool)</dt>
@@ -1424,10 +1423,10 @@
<a NAME="DebugServer.getWatchPointModel" ID="DebugServer.getWatchPointModel"></a>
<h4>DebugServer.getWatchPointModel</h4>
<b>getWatchPointModel</b>(<i></i>)
-
<p>
Public slot to get a reference to the watch expression model object.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1443,10 +1442,10 @@
<a NAME="DebugServer.initializeClient" ID="DebugServer.initializeClient"></a>
<h4>DebugServer.initializeClient</h4>
<b>initializeClient</b>(<i>debuggerId</i>)
-
<p>
Public method to initialize a freshly connected debug client.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -1457,10 +1456,10 @@
<a NAME="DebugServer.isClientProcessUp" ID="DebugServer.isClientProcessUp"></a>
<h4>DebugServer.isClientProcessUp</h4>
<b>isClientProcessUp</b>(<i></i>)
-
<p>
Public method to check, if the debug client process is up.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1476,10 +1475,10 @@
<a NAME="DebugServer.isConnected" ID="DebugServer.isConnected"></a>
<h4>DebugServer.isConnected</h4>
<b>isConnected</b>(<i></i>)
-
<p>
Public method to test, if the debug server is connected to a backend.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1495,10 +1494,10 @@
<a NAME="DebugServer.isDebugging" ID="DebugServer.isDebugging"></a>
<h4>DebugServer.isDebugging</h4>
<b>isDebugging</b>(<i></i>)
-
<p>
Public method to test, if the debug server is debugging.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1514,18 +1513,18 @@
<a NAME="DebugServer.mainClientConnected" ID="DebugServer.mainClientConnected"></a>
<h4>DebugServer.mainClientConnected</h4>
<b>mainClientConnected</b>(<i></i>)
-
<p>
Public method to perform actions after the main client has finally
established the connection.
</p>
+
<a NAME="DebugServer.passiveStartUp" ID="DebugServer.passiveStartUp"></a>
<h4>DebugServer.passiveStartUp</h4>
<b>passiveStartUp</b>(<i>fn, reportAllExceptions, debuggerId</i>)
-
<p>
Public method to handle a passive debug connection.
</p>
+
<dl>
<dt><i>fn</i> (str)</dt>
@@ -1544,17 +1543,17 @@
<a NAME="DebugServer.preferencesChanged" ID="DebugServer.preferencesChanged"></a>
<h4>DebugServer.preferencesChanged</h4>
<b>preferencesChanged</b>(<i></i>)
-
<p>
Public slot to handle the preferencesChanged signal.
</p>
+
<a NAME="DebugServer.registerDebuggerInterface" ID="DebugServer.registerDebuggerInterface"></a>
<h4>DebugServer.registerDebuggerInterface</h4>
<b>registerDebuggerInterface</b>(<i>interfaceName, getRegistryData, reregister=False</i>)
-
<p>
Public method to register a debugger interface.
</p>
+
<dl>
<dt><i>interfaceName</i> (str)</dt>
@@ -1577,17 +1576,17 @@
<a NAME="DebugServer.remoteBanner" ID="DebugServer.remoteBanner"></a>
<h4>DebugServer.remoteBanner</h4>
<b>remoteBanner</b>(<i></i>)
-
<p>
Public slot to get the banner info of the remote client.
</p>
+
<a NAME="DebugServer.remoteBreakpoint" ID="DebugServer.remoteBreakpoint"></a>
<h4>DebugServer.remoteBreakpoint</h4>
<b>remoteBreakpoint</b>(<i>debuggerId, fn, line, setBreakpoint, cond=None, temp=False</i>)
-
<p>
Public method to set or clear a breakpoint.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -1618,17 +1617,17 @@
<a NAME="DebugServer.remoteCapabilities" ID="DebugServer.remoteCapabilities"></a>
<h4>DebugServer.remoteCapabilities</h4>
<b>remoteCapabilities</b>(<i></i>)
-
<p>
Public slot to get the debug clients capabilities.
</p>
+
<a NAME="DebugServer.remoteClientDisassembly" ID="DebugServer.remoteClientDisassembly"></a>
<h4>DebugServer.remoteClientDisassembly</h4>
<b>remoteClientDisassembly</b>(<i>debuggerId</i>)
-
<p>
Public method to ask the client for the latest traceback disassembly.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -1639,10 +1638,10 @@
<a NAME="DebugServer.remoteClientSetFilter" ID="DebugServer.remoteClientSetFilter"></a>
<h4>DebugServer.remoteClientSetFilter</h4>
<b>remoteClientSetFilter</b>(<i>debuggerId, scope, filterStr</i>)
-
<p>
Public method to set a variables filter list.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -1661,10 +1660,10 @@
<a NAME="DebugServer.remoteClientStack" ID="DebugServer.remoteClientStack"></a>
<h4>DebugServer.remoteClientStack</h4>
<b>remoteClientStack</b>(<i>debuggerId</i>)
-
<p>
Public method to request the stack of the main thread.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -1675,10 +1674,10 @@
<a NAME="DebugServer.remoteClientVariable" ID="DebugServer.remoteClientVariable"></a>
<h4>DebugServer.remoteClientVariable</h4>
<b>remoteClientVariable</b>(<i>debuggerId, scope, filterList, var, framenr=0, maxSize=0</i>)
-
<p>
Public method to request the variables of the debugged program.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -1711,10 +1710,10 @@
<a NAME="DebugServer.remoteClientVariables" ID="DebugServer.remoteClientVariables"></a>
<h4>DebugServer.remoteClientVariables</h4>
<b>remoteClientVariables</b>(<i>debuggerId, scope, filterList, framenr=0</i>)
-
<p>
Public method to request the variables of the debugged program.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -1737,11 +1736,11 @@
<a NAME="DebugServer.remoteCompletion" ID="DebugServer.remoteCompletion"></a>
<h4>DebugServer.remoteCompletion</h4>
<b>remoteCompletion</b>(<i>debuggerId, text</i>)
-
<p>
Public slot to get the a list of possible commandline completions
from the remote client.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -1756,10 +1755,10 @@
<a NAME="DebugServer.remoteContinue" ID="DebugServer.remoteContinue"></a>
<h4>DebugServer.remoteContinue</h4>
<b>remoteContinue</b>(<i>debuggerId, special=False</i>)
-
<p>
Public method to continue the debugged program.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -1774,11 +1773,11 @@
<a NAME="DebugServer.remoteContinueUntil" ID="DebugServer.remoteContinueUntil"></a>
<h4>DebugServer.remoteContinueUntil</h4>
<b>remoteContinueUntil</b>(<i>debuggerId, line</i>)
-
<p>
Public method to continue the debugged program to the given line
or until returning from the current frame.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -1793,10 +1792,10 @@
<a NAME="DebugServer.remoteCoverage" ID="DebugServer.remoteCoverage"></a>
<h4>DebugServer.remoteCoverage</h4>
<b>remoteCoverage</b>(<i>venvName, fn, argv, wd, env, autoClearShell=True, erase=False, forProject=False, runInConsole=False, clientType="", configOverride=None, </i>)
-
<p>
Public method to load a new program to collect coverage data.
</p>
+
<dl>
<dt><i>venvName</i> (str)</dt>
@@ -1851,10 +1850,10 @@
<a NAME="DebugServer.remoteEnvironment" ID="DebugServer.remoteEnvironment"></a>
<h4>DebugServer.remoteEnvironment</h4>
<b>remoteEnvironment</b>(<i>env</i>)
-
<p>
Public method to set the environment for a program to debug, run, ...
</p>
+
<dl>
<dt><i>env</i> (str or dict)</dt>
@@ -1872,10 +1871,10 @@
<a NAME="DebugServer.remoteLoad" ID="DebugServer.remoteLoad"></a>
<h4>DebugServer.remoteLoad</h4>
<b>remoteLoad</b>(<i>venvName, fn, argv, wd, env, autoClearShell=True, tracePython=False, autoContinue=True, forProject=False, runInConsole=False, clientType="", enableCallTrace=False, enableMultiprocess=False, multiprocessNoDebug="", configOverride=None, reportAllExceptions=False, </i>)
-
<p>
Public method to load a new program to debug.
</p>
+
<dl>
<dt><i>venvName</i> (str)</dt>
@@ -1955,10 +1954,10 @@
<a NAME="DebugServer.remoteMoveIP" ID="DebugServer.remoteMoveIP"></a>
<h4>DebugServer.remoteMoveIP</h4>
<b>remoteMoveIP</b>(<i>debuggerId, line</i>)
-
<p>
Public method to move the instruction pointer to a different line.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -1973,10 +1972,10 @@
<a NAME="DebugServer.remoteProfile" ID="DebugServer.remoteProfile"></a>
<h4>DebugServer.remoteProfile</h4>
<b>remoteProfile</b>(<i>venvName, fn, argv, wd, env, autoClearShell=True, erase=False, forProject=False, runInConsole=False, clientType="", configOverride=None, </i>)
-
<p>
Public method to load a new program to collect profiling data.
</p>
+
<dl>
<dt><i>venvName</i> (str)</dt>
@@ -2031,10 +2030,10 @@
<a NAME="DebugServer.remoteRawInput" ID="DebugServer.remoteRawInput"></a>
<h4>DebugServer.remoteRawInput</h4>
<b>remoteRawInput</b>(<i>debuggerId, inputString</i>)
-
<p>
Public method to send the raw input to the debugged program.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -2049,10 +2048,10 @@
<a NAME="DebugServer.remoteRun" ID="DebugServer.remoteRun"></a>
<h4>DebugServer.remoteRun</h4>
<b>remoteRun</b>(<i>venvName, fn, argv, wd, env, autoClearShell=True, forProject=False, runInConsole=False, clientType="", configOverride=None, </i>)
-
<p>
Public method to load a new program to run.
</p>
+
<dl>
<dt><i>venvName</i> (str)</dt>
@@ -2102,10 +2101,10 @@
<a NAME="DebugServer.remoteSetThread" ID="DebugServer.remoteSetThread"></a>
<h4>DebugServer.remoteSetThread</h4>
<b>remoteSetThread</b>(<i>debuggerId, tid</i>)
-
<p>
Public method to request to set the given thread as current thread.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -2120,10 +2119,10 @@
<a NAME="DebugServer.remoteStatement" ID="DebugServer.remoteStatement"></a>
<h4>DebugServer.remoteStatement</h4>
<b>remoteStatement</b>(<i>debuggerId, stmt</i>)
-
<p>
Public method to execute a Python statement.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -2138,10 +2137,10 @@
<a NAME="DebugServer.remoteStep" ID="DebugServer.remoteStep"></a>
<h4>DebugServer.remoteStep</h4>
<b>remoteStep</b>(<i>debuggerId</i>)
-
<p>
Public method to single step the debugged program.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -2152,10 +2151,10 @@
<a NAME="DebugServer.remoteStepOut" ID="DebugServer.remoteStepOut"></a>
<h4>DebugServer.remoteStepOut</h4>
<b>remoteStepOut</b>(<i>debuggerId</i>)
-
<p>
Public method to step out the debugged program.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -2166,10 +2165,10 @@
<a NAME="DebugServer.remoteStepOver" ID="DebugServer.remoteStepOver"></a>
<h4>DebugServer.remoteStepOver</h4>
<b>remoteStepOver</b>(<i>debuggerId</i>)
-
<p>
Public method to step over the debugged program.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -2180,10 +2179,10 @@
<a NAME="DebugServer.remoteStepQuit" ID="DebugServer.remoteStepQuit"></a>
<h4>DebugServer.remoteStepQuit</h4>
<b>remoteStepQuit</b>(<i>debuggerId</i>)
-
<p>
Public method to stop the debugged program.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -2194,10 +2193,10 @@
<a NAME="DebugServer.remoteThreadList" ID="DebugServer.remoteThreadList"></a>
<h4>DebugServer.remoteThreadList</h4>
<b>remoteThreadList</b>(<i>debuggerId</i>)
-
<p>
Public method to request the list of threads from the client.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -2208,10 +2207,10 @@
<a NAME="DebugServer.setCallTraceEnabled" ID="DebugServer.setCallTraceEnabled"></a>
<h4>DebugServer.setCallTraceEnabled</h4>
<b>setCallTraceEnabled</b>(<i>debuggerId, on</i>)
-
<p>
Public method to set the call trace state.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -2226,10 +2225,10 @@
<a NAME="DebugServer.setDebugging" ID="DebugServer.setDebugging"></a>
<h4>DebugServer.setDebugging</h4>
<b>setDebugging</b>(<i>on</i>)
-
<p>
Public method to set the debugging state.
</p>
+
<dl>
<dt><i>on</i> (bool)</dt>
@@ -2240,7 +2239,6 @@
<a NAME="DebugServer.shutdownServer" ID="DebugServer.shutdownServer"></a>
<h4>DebugServer.shutdownServer</h4>
<b>shutdownServer</b>(<i></i>)
-
<p>
Public method to cleanly shut down.
</p>
@@ -2248,13 +2246,14 @@
It closes our socket and shuts down
the debug client. (Needed on Win OS)
</p>
+
<a NAME="DebugServer.signalClientBanner" ID="DebugServer.signalClientBanner"></a>
<h4>DebugServer.signalClientBanner</h4>
<b>signalClientBanner</b>(<i>version, platform, venvName</i>)
-
<p>
Public method to process the client banner info.
</p>
+
<dl>
<dt><i>version</i> (str)</dt>
@@ -2273,10 +2272,10 @@
<a NAME="DebugServer.signalClientBreakConditionError" ID="DebugServer.signalClientBreakConditionError"></a>
<h4>DebugServer.signalClientBreakConditionError</h4>
<b>signalClientBreakConditionError</b>(<i>filename, lineno, debuggerId</i>)
-
<p>
Public method to process the client breakpoint condition error info.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -2295,10 +2294,10 @@
<a NAME="DebugServer.signalClientCallTrace" ID="DebugServer.signalClientCallTrace"></a>
<h4>DebugServer.signalClientCallTrace</h4>
<b>signalClientCallTrace</b>(<i>isCall, fromFile, fromLine, fromFunction, toFile, toLine, toFunction, debuggerId, </i>)
-
<p>
Public method to process the client call trace data.
</p>
+
<dl>
<dt><i>isCall</i> (bool)</dt>
@@ -2337,10 +2336,10 @@
<a NAME="DebugServer.signalClientCapabilities" ID="DebugServer.signalClientCapabilities"></a>
<h4>DebugServer.signalClientCapabilities</h4>
<b>signalClientCapabilities</b>(<i>capabilities, clientType, venvName</i>)
-
<p>
Public method to process the client capabilities info.
</p>
+
<dl>
<dt><i>capabilities</i> (int)</dt>
@@ -2359,10 +2358,10 @@
<a NAME="DebugServer.signalClientClearBreak" ID="DebugServer.signalClientClearBreak"></a>
<h4>DebugServer.signalClientClearBreak</h4>
<b>signalClientClearBreak</b>(<i>filename, lineno, debuggerId</i>)
-
<p>
Public method to process the client clear breakpoint command.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -2381,10 +2380,10 @@
<a NAME="DebugServer.signalClientClearWatch" ID="DebugServer.signalClientClearWatch"></a>
<h4>DebugServer.signalClientClearWatch</h4>
<b>signalClientClearWatch</b>(<i>condition, debuggerId</i>)
-
<p>
Public slot to handle the clientClearWatch signal.
</p>
+
<dl>
<dt><i>condition</i> (str)</dt>
@@ -2399,10 +2398,10 @@
<a NAME="DebugServer.signalClientCompletionList" ID="DebugServer.signalClientCompletionList"></a>
<h4>DebugServer.signalClientCompletionList</h4>
<b>signalClientCompletionList</b>(<i>completionList, text, debuggerId</i>)
-
<p>
Public method to process the client auto completion info.
</p>
+
<dl>
<dt><i>completionList</i> (list of str)</dt>
@@ -2421,13 +2420,13 @@
<a NAME="DebugServer.signalClientDebuggerId" ID="DebugServer.signalClientDebuggerId"></a>
<h4>DebugServer.signalClientDebuggerId</h4>
<b>signalClientDebuggerId</b>(<i>debuggerId</i>)
-
<p>
Public method to signal the receipt of a new debugger ID.
</p>
<p>
This signal indicates, that a new debugger backend has connected.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -2438,10 +2437,10 @@
<a NAME="DebugServer.signalClientDisassembly" ID="DebugServer.signalClientDisassembly"></a>
<h4>DebugServer.signalClientDisassembly</h4>
<b>signalClientDisassembly</b>(<i>disassembly, debuggerId</i>)
-
<p>
Public method to process the disassembly info from the client.
</p>
+
<dl>
<dt><i>disassembly</i> (dict)</dt>
@@ -2456,11 +2455,11 @@
<a NAME="DebugServer.signalClientDisconnected" ID="DebugServer.signalClientDisconnected"></a>
<h4>DebugServer.signalClientDisconnected</h4>
<b>signalClientDisconnected</b>(<i>debuggerId</i>)
-
<p>
Public method to send a signal when a debug client has closed its
connection.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -2471,10 +2470,10 @@
<a NAME="DebugServer.signalClientException" ID="DebugServer.signalClientException"></a>
<h4>DebugServer.signalClientException</h4>
<b>signalClientException</b>(<i>exceptionType, exceptionMessage, stackTrace, debuggerId, threadName=""</i>)
-
<p>
Public method to process the exception info from the client.
</p>
+
<dl>
<dt><i>exceptionType</i> (str)</dt>
@@ -2503,10 +2502,10 @@
<a NAME="DebugServer.signalClientExit" ID="DebugServer.signalClientExit"></a>
<h4>DebugServer.signalClientExit</h4>
<b>signalClientExit</b>(<i>program, status, message, debuggerId</i>)
-
<p>
Public method to process the client exit status.
</p>
+
<dl>
<dt><i>program</i> (str)</dt>
@@ -2529,10 +2528,10 @@
<a NAME="DebugServer.signalClientLine" ID="DebugServer.signalClientLine"></a>
<h4>DebugServer.signalClientLine</h4>
<b>signalClientLine</b>(<i>filename, lineno, debuggerId, forStack=False, threadName=""</i>)
-
<p>
Public method to process client position feedback.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -2559,10 +2558,10 @@
<a NAME="DebugServer.signalClientOutput" ID="DebugServer.signalClientOutput"></a>
<h4>DebugServer.signalClientOutput</h4>
<b>signalClientOutput</b>(<i>line, debuggerId</i>)
-
<p>
Public method to process a line of client output.
</p>
+
<dl>
<dt><i>line</i> (str)</dt>
@@ -2577,10 +2576,10 @@
<a NAME="DebugServer.signalClientRawInput" ID="DebugServer.signalClientRawInput"></a>
<h4>DebugServer.signalClientRawInput</h4>
<b>signalClientRawInput</b>(<i>prompt, echo, debuggerId</i>)
-
<p>
Public method to process the client raw input command.
</p>
+
<dl>
<dt><i>prompt</i> (str)</dt>
@@ -2599,10 +2598,10 @@
<a NAME="DebugServer.signalClientSignal" ID="DebugServer.signalClientSignal"></a>
<h4>DebugServer.signalClientSignal</h4>
<b>signalClientSignal</b>(<i>message, filename, lineNo, funcName, funcArgs, debuggerId</i>)
-
<p>
Public method to process a signal generated on the client side.
</p>
+
<dl>
<dt><i>message</i> (str)</dt>
@@ -2633,10 +2632,10 @@
<a NAME="DebugServer.signalClientStack" ID="DebugServer.signalClientStack"></a>
<h4>DebugServer.signalClientStack</h4>
<b>signalClientStack</b>(<i>stack, debuggerId, threadName=""</i>)
-
<p>
Public method to process a client's stack information.
</p>
+
<dl>
<dt><i>stack</i> (list of lists of (string, integer, string))</dt>
@@ -2656,10 +2655,10 @@
<a NAME="DebugServer.signalClientStatement" ID="DebugServer.signalClientStatement"></a>
<h4>DebugServer.signalClientStatement</h4>
<b>signalClientStatement</b>(<i>more, debuggerId</i>)
-
<p>
Public method to process the input response from the client.
</p>
+
<dl>
<dt><i>more</i> (bool)</dt>
@@ -2674,10 +2673,10 @@
<a NAME="DebugServer.signalClientSyntaxError" ID="DebugServer.signalClientSyntaxError"></a>
<h4>DebugServer.signalClientSyntaxError</h4>
<b>signalClientSyntaxError</b>(<i>message, filename, lineNo, characterNo, debuggerId, threadName=""</i>)
-
<p>
Public method to process a syntax error info from the client.
</p>
+
<dl>
<dt><i>message</i> (str)</dt>
@@ -2708,10 +2707,10 @@
<a NAME="DebugServer.signalClientThreadList" ID="DebugServer.signalClientThreadList"></a>
<h4>DebugServer.signalClientThreadList</h4>
<b>signalClientThreadList</b>(<i>currentId, threadList, debuggerId</i>)
-
<p>
Public method to process the client thread list info.
</p>
+
<dl>
<dt><i>currentId</i> (int)</dt>
@@ -2730,10 +2729,10 @@
<a NAME="DebugServer.signalClientThreadSet" ID="DebugServer.signalClientThreadSet"></a>
<h4>DebugServer.signalClientThreadSet</h4>
<b>signalClientThreadSet</b>(<i>debuggerId</i>)
-
<p>
Public method to handle the change of the client thread.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -2744,10 +2743,10 @@
<a NAME="DebugServer.signalClientVariable" ID="DebugServer.signalClientVariable"></a>
<h4>DebugServer.signalClientVariable</h4>
<b>signalClientVariable</b>(<i>scope, variables, debuggerId</i>)
-
<p>
Public method to process the client variable info.
</p>
+
<dl>
<dt><i>scope</i> (int)</dt>
@@ -2767,10 +2766,10 @@
<a NAME="DebugServer.signalClientVariables" ID="DebugServer.signalClientVariables"></a>
<h4>DebugServer.signalClientVariables</h4>
<b>signalClientVariables</b>(<i>scope, variables, debuggerId</i>)
-
<p>
Public method to process the client variables info.
</p>
+
<dl>
<dt><i>scope</i> (int)</dt>
@@ -2790,10 +2789,10 @@
<a NAME="DebugServer.signalClientWatchConditionError" ID="DebugServer.signalClientWatchConditionError"></a>
<h4>DebugServer.signalClientWatchConditionError</h4>
<b>signalClientWatchConditionError</b>(<i>condition, debuggerId</i>)
-
<p>
Public method to process the client watch expression error info.
</p>
+
<dl>
<dt><i>condition</i> (str)</dt>
@@ -2808,24 +2807,24 @@
<a NAME="DebugServer.signalLastClientExited" ID="DebugServer.signalLastClientExited"></a>
<h4>DebugServer.signalLastClientExited</h4>
<b>signalLastClientExited</b>(<i></i>)
-
<p>
Public method to process the last client exit event.
</p>
+
<a NAME="DebugServer.signalMainClientExit" ID="DebugServer.signalMainClientExit"></a>
<h4>DebugServer.signalMainClientExit</h4>
<b>signalMainClientExit</b>(<i></i>)
-
<p>
Public method to process the main client exiting.
</p>
+
<a NAME="DebugServer.startClient" ID="DebugServer.startClient"></a>
<h4>DebugServer.startClient</h4>
<b>startClient</b>(<i>unplanned=True, clType=None, forProject=False, runInConsole=False, venvName="", workingDir=None, configOverride=None, </i>)
-
<p>
Public method to start a debug client.
</p>
+
<dl>
<dt><i>unplanned</i> (bool)</dt>
@@ -2862,10 +2861,10 @@
<a NAME="DebugServer.unregisterDebuggerInterface" ID="DebugServer.unregisterDebuggerInterface"></a>
<h4>DebugServer.unregisterDebuggerInterface</h4>
<b>unregisterDebuggerInterface</b>(<i>interfaceName</i>)
-
<p>
Public method to unregister a debugger interface.
</p>
+
<dl>
<dt><i>interfaceName</i> (str)</dt>
@@ -2875,4 +2874,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
