Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Debugger.DebuggerInterfacePython.html

eric6/Documentation/Source/eric6.Debugger.DebuggerInterfacePython.html

branch
maintenance
changeset 8043
0acf98cd089a
parent 7989
a21d673a8f99
child 8163
29fb6d420a25
equal deleted inserted replaced
7991:866adc8c315b 8043:0acf98cd089a
80 <tr> 80 <tr>
81 <td><a href="#DebuggerInterfacePython.__init__">DebuggerInterfacePython</a></td> 81 <td><a href="#DebuggerInterfacePython.__init__">DebuggerInterfacePython</a></td>
82 <td>Constructor</td> 82 <td>Constructor</td>
83 </tr> 83 </tr>
84 <tr> 84 <tr>
85 <td><a href="#DebuggerInterfacePython.__askForkTo">__askForkTo</a></td> 85 <td><a href="#DebuggerInterfacePython.__assignDebuggerId">__assignDebuggerId</a></td>
86 <td>Private method to ask the user which branch of a fork to follow.</td> 86 <td>Private method to set the debugger id for a recent debugger connection attempt.</td>
87 </tr>
88 <tr>
89 <td><a href="#DebuggerInterfacePython.__flush">__flush</a></td>
90 <td>Private slot to flush the queue.</td>
87 </tr> 91 </tr>
88 <tr> 92 <tr>
89 <td><a href="#DebuggerInterfacePython.__handleJsonCommand">__handleJsonCommand</a></td> 93 <td><a href="#DebuggerInterfacePython.__handleJsonCommand">__handleJsonCommand</a></td>
90 <td>Private method to handle a command or response serialized as a JSON string.</td> 94 <td>Private method to handle a command or response serialized as a JSON string.</td>
91 </tr> 95 </tr>
104 <tr> 108 <tr>
105 <td><a href="#DebuggerInterfacePython.__sendJsonCommand">__sendJsonCommand</a></td> 109 <td><a href="#DebuggerInterfacePython.__sendJsonCommand">__sendJsonCommand</a></td>
106 <td>Private method to send a single command to the client.</td> 110 <td>Private method to send a single command to the client.</td>
107 </tr> 111 </tr>
108 <tr> 112 <tr>
113 <td><a href="#DebuggerInterfacePython.__shutdownSocket">__shutdownSocket</a></td>
114 <td>Private slot to shut down a socket.</td>
115 </tr>
116 <tr>
117 <td><a href="#DebuggerInterfacePython.__socketDisconnected">__socketDisconnected</a></td>
118 <td>Private slot handling a socket disconnecting.</td>
119 </tr>
120 <tr>
109 <td><a href="#DebuggerInterfacePython.__startProcess">__startProcess</a></td> 121 <td><a href="#DebuggerInterfacePython.__startProcess">__startProcess</a></td>
110 <td>Private method to start the debugger client process.</td> 122 <td>Private method to start the debugger client process.</td>
111 </tr> 123 </tr>
112 <tr> 124 <tr>
113 <td><a href="#DebuggerInterfacePython.__writeJsonCommandToSocket">__writeJsonCommandToSocket</a></td> 125 <td><a href="#DebuggerInterfacePython.__writeJsonCommandToSocket">__writeJsonCommandToSocket</a></td>
114 <td>Private method to write a JSON command to the socket.</td> 126 <td>Private method to write a JSON command to the socket.</td>
115 </tr> 127 </tr>
116 <tr> 128 <tr>
117 <td><a href="#DebuggerInterfacePython.flush">flush</a></td>
118 <td>Public slot to flush the queue.</td>
119 </tr>
120 <tr>
121 <td><a href="#DebuggerInterfacePython.getClientCapabilities">getClientCapabilities</a></td> 129 <td><a href="#DebuggerInterfacePython.getClientCapabilities">getClientCapabilities</a></td>
122 <td>Public method to retrieve the debug clients capabilities.</td> 130 <td>Public method to retrieve the debug clients capabilities.</td>
123 </tr> 131 </tr>
124 <tr> 132 <tr>
133 <td><a href="#DebuggerInterfacePython.getDebuggerIds">getDebuggerIds</a></td>
134 <td>Public method to return the IDs of the connected debugger backends.</td>
135 </tr>
136 <tr>
125 <td><a href="#DebuggerInterfacePython.isConnected">isConnected</a></td> 137 <td><a href="#DebuggerInterfacePython.isConnected">isConnected</a></td>
126 <td>Public method to test, if a debug client has connected.</td> 138 <td>Public method to test, if a debug client has connected.</td>
127 </tr> 139 </tr>
128 <tr> 140 <tr>
129 <td><a href="#DebuggerInterfacePython.newConnection">newConnection</a></td> 141 <td><a href="#DebuggerInterfacePython.newConnection">newConnection</a></td>
156 <tr> 168 <tr>
157 <td><a href="#DebuggerInterfacePython.remoteClientSetFilter">remoteClientSetFilter</a></td> 169 <td><a href="#DebuggerInterfacePython.remoteClientSetFilter">remoteClientSetFilter</a></td>
158 <td>Public method to set a variables filter list.</td> 170 <td>Public method to set a variables filter list.</td>
159 </tr> 171 </tr>
160 <tr> 172 <tr>
173 <td><a href="#DebuggerInterfacePython.remoteClientStack">remoteClientStack</a></td>
174 <td>Public method to request the stack of the main thread.</td>
175 </tr>
176 <tr>
161 <td><a href="#DebuggerInterfacePython.remoteClientVariable">remoteClientVariable</a></td> 177 <td><a href="#DebuggerInterfacePython.remoteClientVariable">remoteClientVariable</a></td>
162 <td>Public method to request the variables of the debugged program.</td> 178 <td>Public method to request the variables of the debugged program.</td>
163 </tr> 179 </tr>
164 <tr> 180 <tr>
165 <td><a href="#DebuggerInterfacePython.remoteClientVariables">remoteClientVariables</a></td> 181 <td><a href="#DebuggerInterfacePython.remoteClientVariables">remoteClientVariables</a></td>
172 <tr> 188 <tr>
173 <td><a href="#DebuggerInterfacePython.remoteContinue">remoteContinue</a></td> 189 <td><a href="#DebuggerInterfacePython.remoteContinue">remoteContinue</a></td>
174 <td>Public method to continue the debugged program.</td> 190 <td>Public method to continue the debugged program.</td>
175 </tr> 191 </tr>
176 <tr> 192 <tr>
193 <td><a href="#DebuggerInterfacePython.remoteContinueUntil">remoteContinueUntil</a></td>
194 <td>Public method to continue the debugged program to the given line or until returning from the current frame.</td>
195 </tr>
196 <tr>
177 <td><a href="#DebuggerInterfacePython.remoteCoverage">remoteCoverage</a></td> 197 <td><a href="#DebuggerInterfacePython.remoteCoverage">remoteCoverage</a></td>
178 <td>Public method to load a new program to collect coverage data.</td> 198 <td>Public method to load a new program to collect coverage data.</td>
179 </tr> 199 </tr>
180 <tr> 200 <tr>
181 <td><a href="#DebuggerInterfacePython.remoteEnvironment">remoteEnvironment</a></td> 201 <td><a href="#DebuggerInterfacePython.remoteEnvironment">remoteEnvironment</a></td>
186 <td>Public method to load a new program to debug.</td> 206 <td>Public method to load a new program to debug.</td>
187 </tr> 207 </tr>
188 <tr> 208 <tr>
189 <td><a href="#DebuggerInterfacePython.remoteMoveIP">remoteMoveIP</a></td> 209 <td><a href="#DebuggerInterfacePython.remoteMoveIP">remoteMoveIP</a></td>
190 <td>Public method to move the instruction pointer to a different line.</td> 210 <td>Public method to move the instruction pointer to a different line.</td>
211 </tr>
212 <tr>
213 <td><a href="#DebuggerInterfacePython.remoteNoDebugList">remoteNoDebugList</a></td>
214 <td>Public method to set a list of programs not to be debugged.</td>
191 </tr> 215 </tr>
192 <tr> 216 <tr>
193 <td><a href="#DebuggerInterfacePython.remoteProfile">remoteProfile</a></td> 217 <td><a href="#DebuggerInterfacePython.remoteProfile">remoteProfile</a></td>
194 <td>Public method to load a new program to collect profiling data.</td> 218 <td>Public method to load a new program to collect profiling data.</td>
195 </tr> 219 </tr>
296 <dt><i>passive</i> (bool)</dt> 320 <dt><i>passive</i> (bool)</dt>
297 <dd> 321 <dd>
298 flag indicating passive connection mode 322 flag indicating passive connection mode
299 </dd> 323 </dd>
300 </dl> 324 </dl>
301 <a NAME="DebuggerInterfacePython.__askForkTo" ID="DebuggerInterfacePython.__askForkTo"></a> 325 <a NAME="DebuggerInterfacePython.__assignDebuggerId" ID="DebuggerInterfacePython.__assignDebuggerId"></a>
302 <h4>DebuggerInterfacePython.__askForkTo</h4> 326 <h4>DebuggerInterfacePython.__assignDebuggerId</h4>
303 <b>__askForkTo</b>(<i></i>) 327 <b>__assignDebuggerId</b>(<i>sock, debuggerId</i>)
304 328
305 <p> 329 <p>
306 Private method to ask the user which branch of a fork to follow. 330 Private method to set the debugger id for a recent debugger connection
331 attempt.
332 </p>
333 <dl>
334
335 <dt><i>sock</i> (QTcpSocket)</dt>
336 <dd>
337 reference to the socket object
338 </dd>
339 <dt><i>debuggerId</i> (str)</dt>
340 <dd>
341 id of the connected debug client
342 </dd>
343 </dl>
344 <a NAME="DebuggerInterfacePython.__flush" ID="DebuggerInterfacePython.__flush"></a>
345 <h4>DebuggerInterfacePython.__flush</h4>
346 <b>__flush</b>(<i></i>)
347
348 <p>
349 Private slot to flush the queue.
307 </p> 350 </p>
308 <a NAME="DebuggerInterfacePython.__handleJsonCommand" ID="DebuggerInterfacePython.__handleJsonCommand"></a> 351 <a NAME="DebuggerInterfacePython.__handleJsonCommand" ID="DebuggerInterfacePython.__handleJsonCommand"></a>
309 <h4>DebuggerInterfacePython.__handleJsonCommand</h4> 352 <h4>DebuggerInterfacePython.__handleJsonCommand</h4>
310 <b>__handleJsonCommand</b>(<i>jsonStr</i>) 353 <b>__handleJsonCommand</b>(<i>jsonStr, sock</i>)
311 354
312 <p> 355 <p>
313 Private method to handle a command or response serialized as a 356 Private method to handle a command or response serialized as a
314 JSON string. 357 JSON string.
315 </p> 358 </p>
317 360
318 <dt><i>jsonStr</i> (str)</dt> 361 <dt><i>jsonStr</i> (str)</dt>
319 <dd> 362 <dd>
320 string containing the command or response received 363 string containing the command or response received
321 from the debug backend 364 from the debug backend
365 </dd>
366 <dt><i>sock</i> (QTcpSocket)</dt>
367 <dd>
368 reference to the socket the data was received from
322 </dd> 369 </dd>
323 </dl> 370 </dl>
324 <a NAME="DebuggerInterfacePython.__identityTranslation" ID="DebuggerInterfacePython.__identityTranslation"></a> 371 <a NAME="DebuggerInterfacePython.__identityTranslation" ID="DebuggerInterfacePython.__identityTranslation"></a>
325 <h4>DebuggerInterfacePython.__identityTranslation</h4> 372 <h4>DebuggerInterfacePython.__identityTranslation</h4>
326 <b>__identityTranslation</b>(<i>fn, remote2local=True</i>) 373 <b>__identityTranslation</b>(<i>fn, remote2local=True</i>)
328 <p> 375 <p>
329 Private method to perform the identity path translation. 376 Private method to perform the identity path translation.
330 </p> 377 </p>
331 <dl> 378 <dl>
332 379
333 <dt><i>fn</i></dt> 380 <dt><i>fn</i> (str)</dt>
334 <dd> 381 <dd>
335 filename to be translated (string) 382 filename to be translated
336 </dd> 383 </dd>
337 <dt><i>remote2local</i></dt> 384 <dt><i>remote2local</i> (bool)</dt>
338 <dd> 385 <dd>
339 flag indicating the direction of translation 386 flag indicating the direction of translation
340 (False = local to remote, True = remote to local [default]) 387 (False = local to remote, True = remote to local [default])
341 </dd> 388 </dd>
342 </dl> 389 </dl>
343 <dl> 390 <dl>
344 <dt>Returns:</dt> 391 <dt>Return:</dt>
345 <dd> 392 <dd>
346 translated filename (string) 393 translated filename
394 </dd>
395 </dl>
396 <dl>
397 <dt>Return Type:</dt>
398 <dd>
399 str
347 </dd> 400 </dd>
348 </dl> 401 </dl>
349 <a NAME="DebuggerInterfacePython.__parseClientLine" ID="DebuggerInterfacePython.__parseClientLine"></a> 402 <a NAME="DebuggerInterfacePython.__parseClientLine" ID="DebuggerInterfacePython.__parseClientLine"></a>
350 <h4>DebuggerInterfacePython.__parseClientLine</h4> 403 <h4>DebuggerInterfacePython.__parseClientLine</h4>
351 <b>__parseClientLine</b>(<i></i>) 404 <b>__parseClientLine</b>(<i>sock</i>)
352 405
353 <p> 406 <p>
354 Private method to handle data from the client. 407 Private method to handle data from the client.
355 </p> 408 </p>
409 <dl>
410
411 <dt><i>sock</i> (QTcpSocket)</dt>
412 <dd>
413 reference to the socket to read data from
414 </dd>
415 </dl>
356 <a NAME="DebuggerInterfacePython.__remoteTranslation" ID="DebuggerInterfacePython.__remoteTranslation"></a> 416 <a NAME="DebuggerInterfacePython.__remoteTranslation" ID="DebuggerInterfacePython.__remoteTranslation"></a>
357 <h4>DebuggerInterfacePython.__remoteTranslation</h4> 417 <h4>DebuggerInterfacePython.__remoteTranslation</h4>
358 <b>__remoteTranslation</b>(<i>fn, remote2local=True</i>) 418 <b>__remoteTranslation</b>(<i>fn, remote2local=True</i>)
359 419
360 <p> 420 <p>
361 Private method to perform the path translation. 421 Private method to perform the path translation.
362 </p> 422 </p>
363 <dl> 423 <dl>
364 424
365 <dt><i>fn</i></dt> 425 <dt><i>fn</i> (str)</dt>
366 <dd> 426 <dd>
367 filename to be translated (string) 427 filename to be translated
368 </dd> 428 </dd>
369 <dt><i>remote2local</i></dt> 429 <dt><i>remote2local</i> (bool)</dt>
370 <dd> 430 <dd>
371 flag indicating the direction of translation 431 flag indicating the direction of translation
372 (False = local to remote, True = remote to local [default]) 432 (False = local to remote, True = remote to local [default])
373 </dd> 433 </dd>
374 </dl> 434 </dl>
375 <dl> 435 <dl>
376 <dt>Returns:</dt> 436 <dt>Return:</dt>
377 <dd> 437 <dd>
378 translated filename (string) 438 translated filename
439 </dd>
440 </dl>
441 <dl>
442 <dt>Return Type:</dt>
443 <dd>
444 str
379 </dd> 445 </dd>
380 </dl> 446 </dl>
381 <a NAME="DebuggerInterfacePython.__sendJsonCommand" ID="DebuggerInterfacePython.__sendJsonCommand"></a> 447 <a NAME="DebuggerInterfacePython.__sendJsonCommand" ID="DebuggerInterfacePython.__sendJsonCommand"></a>
382 <h4>DebuggerInterfacePython.__sendJsonCommand</h4> 448 <h4>DebuggerInterfacePython.__sendJsonCommand</h4>
383 <b>__sendJsonCommand</b>(<i>command, params</i>) 449 <b>__sendJsonCommand</b>(<i>command, params, debuggerId="", sock=None</i>)
384 450
385 <p> 451 <p>
386 Private method to send a single command to the client. 452 Private method to send a single command to the client.
387 </p> 453 </p>
388 <dl> 454 <dl>
392 command name to be sent 458 command name to be sent
393 </dd> 459 </dd>
394 <dt><i>params</i> (dict)</dt> 460 <dt><i>params</i> (dict)</dt>
395 <dd> 461 <dd>
396 dictionary of named parameters for the command 462 dictionary of named parameters for the command
463 </dd>
464 <dt><i>debuggerId</i> (str)</dt>
465 <dd>
466 id of the debug client to send the command to
467 </dd>
468 <dt><i>sock</i> (QTcpSocket)</dt>
469 <dd>
470 reference to the socket object to be used (only used if
471 debuggerId is not given)
472 </dd>
473 </dl>
474 <a NAME="DebuggerInterfacePython.__shutdownSocket" ID="DebuggerInterfacePython.__shutdownSocket"></a>
475 <h4>DebuggerInterfacePython.__shutdownSocket</h4>
476 <b>__shutdownSocket</b>(<i>sock</i>)
477
478 <p>
479 Private slot to shut down a socket.
480 </p>
481 <dl>
482
483 <dt><i>sock</i> (QTcpSocket)</dt>
484 <dd>
485 reference to the socket
486 </dd>
487 </dl>
488 <a NAME="DebuggerInterfacePython.__socketDisconnected" ID="DebuggerInterfacePython.__socketDisconnected"></a>
489 <h4>DebuggerInterfacePython.__socketDisconnected</h4>
490 <b>__socketDisconnected</b>(<i>sock</i>)
491
492 <p>
493 Private slot handling a socket disconnecting.
494 </p>
495 <dl>
496
497 <dt><i>sock</i> (QTcpSocket)</dt>
498 <dd>
499 reference to the disconnected socket
397 </dd> 500 </dd>
398 </dl> 501 </dl>
399 <a NAME="DebuggerInterfacePython.__startProcess" ID="DebuggerInterfacePython.__startProcess"></a> 502 <a NAME="DebuggerInterfacePython.__startProcess" ID="DebuggerInterfacePython.__startProcess"></a>
400 <h4>DebuggerInterfacePython.__startProcess</h4> 503 <h4>DebuggerInterfacePython.__startProcess</h4>
401 <b>__startProcess</b>(<i>program, arguments, environment=None, workingDir=None</i>) 504 <b>__startProcess</b>(<i>program, arguments, environment=None, workingDir=None</i>)
421 <dd> 524 <dd>
422 directory to start the debugger client in 525 directory to start the debugger client in
423 </dd> 526 </dd>
424 </dl> 527 </dl>
425 <dl> 528 <dl>
426 <dt>Returns:</dt> 529 <dt>Return:</dt>
427 <dd> 530 <dd>
428 the process object 531 the process object
429 </dd> 532 </dd>
430 </dl> 533 </dl>
431 <dl> 534 <dl>
434 QProcess or None 537 QProcess or None
435 </dd> 538 </dd>
436 </dl> 539 </dl>
437 <a NAME="DebuggerInterfacePython.__writeJsonCommandToSocket" ID="DebuggerInterfacePython.__writeJsonCommandToSocket"></a> 540 <a NAME="DebuggerInterfacePython.__writeJsonCommandToSocket" ID="DebuggerInterfacePython.__writeJsonCommandToSocket"></a>
438 <h4>DebuggerInterfacePython.__writeJsonCommandToSocket</h4> 541 <h4>DebuggerInterfacePython.__writeJsonCommandToSocket</h4>
439 <b>__writeJsonCommandToSocket</b>(<i>cmd</i>) 542 <b>__writeJsonCommandToSocket</b>(<i>cmd, sock</i>)
440 543
441 <p> 544 <p>
442 Private method to write a JSON command to the socket. 545 Private method to write a JSON command to the socket.
443 </p> 546 </p>
444 <dl> 547 <dl>
445 548
446 <dt><i>cmd</i> (str)</dt> 549 <dt><i>cmd</i> (str)</dt>
447 <dd> 550 <dd>
448 JSON command to be sent 551 JSON command to be sent
449 </dd> 552 </dd>
450 </dl> 553 <dt><i>sock</i> (QTcpSocket)</dt>
451 <a NAME="DebuggerInterfacePython.flush" ID="DebuggerInterfacePython.flush"></a> 554 <dd>
452 <h4>DebuggerInterfacePython.flush</h4> 555 reference to the socket to write to
453 <b>flush</b>(<i></i>) 556 </dd>
454 557 </dl>
455 <p>
456 Public slot to flush the queue.
457 </p>
458 <a NAME="DebuggerInterfacePython.getClientCapabilities" ID="DebuggerInterfacePython.getClientCapabilities"></a> 558 <a NAME="DebuggerInterfacePython.getClientCapabilities" ID="DebuggerInterfacePython.getClientCapabilities"></a>
459 <h4>DebuggerInterfacePython.getClientCapabilities</h4> 559 <h4>DebuggerInterfacePython.getClientCapabilities</h4>
460 <b>getClientCapabilities</b>(<i></i>) 560 <b>getClientCapabilities</b>(<i></i>)
461 561
462 <p> 562 <p>
463 Public method to retrieve the debug clients capabilities. 563 Public method to retrieve the debug clients capabilities.
464 </p> 564 </p>
465 <dl> 565 <dl>
466 <dt>Returns:</dt> 566 <dt>Return:</dt>
467 <dd> 567 <dd>
468 debug client capabilities (integer) 568 debug client capabilities
569 </dd>
570 </dl>
571 <dl>
572 <dt>Return Type:</dt>
573 <dd>
574 int
575 </dd>
576 </dl>
577 <a NAME="DebuggerInterfacePython.getDebuggerIds" ID="DebuggerInterfacePython.getDebuggerIds"></a>
578 <h4>DebuggerInterfacePython.getDebuggerIds</h4>
579 <b>getDebuggerIds</b>(<i></i>)
580
581 <p>
582 Public method to return the IDs of the connected debugger backends.
583 </p>
584 <dl>
585 <dt>Return:</dt>
586 <dd>
587 list of connected debugger backend IDs
588 </dd>
589 </dl>
590 <dl>
591 <dt>Return Type:</dt>
592 <dd>
593 list of str
469 </dd> 594 </dd>
470 </dl> 595 </dl>
471 <a NAME="DebuggerInterfacePython.isConnected" ID="DebuggerInterfacePython.isConnected"></a> 596 <a NAME="DebuggerInterfacePython.isConnected" ID="DebuggerInterfacePython.isConnected"></a>
472 <h4>DebuggerInterfacePython.isConnected</h4> 597 <h4>DebuggerInterfacePython.isConnected</h4>
473 <b>isConnected</b>(<i></i>) 598 <b>isConnected</b>(<i></i>)
474 599
475 <p> 600 <p>
476 Public method to test, if a debug client has connected. 601 Public method to test, if a debug client has connected.
477 </p> 602 </p>
478 <dl> 603 <dl>
479 <dt>Returns:</dt> 604 <dt>Return:</dt>
480 <dd> 605 <dd>
481 flag indicating the connection status (boolean) 606 flag indicating the connection status
607 </dd>
608 </dl>
609 <dl>
610 <dt>Return Type:</dt>
611 <dd>
612 bool
482 </dd> 613 </dd>
483 </dl> 614 </dl>
484 <a NAME="DebuggerInterfacePython.newConnection" ID="DebuggerInterfacePython.newConnection"></a> 615 <a NAME="DebuggerInterfacePython.newConnection" ID="DebuggerInterfacePython.newConnection"></a>
485 <h4>DebuggerInterfacePython.newConnection</h4> 616 <h4>DebuggerInterfacePython.newConnection</h4>
486 <b>newConnection</b>(<i>sock</i>) 617 <b>newConnection</b>(<i>sock</i>)
488 <p> 619 <p>
489 Public slot to handle a new connection. 620 Public slot to handle a new connection.
490 </p> 621 </p>
491 <dl> 622 <dl>
492 623
493 <dt><i>sock</i></dt> 624 <dt><i>sock</i> (QTcpSocket)</dt>
494 <dd> 625 <dd>
495 reference to the socket object (QTcpSocket) 626 reference to the socket object
496 </dd> 627 </dd>
497 </dl> 628 </dl>
498 <dl> 629 <dl>
499 <dt>Returns:</dt> 630 <dt>Return:</dt>
500 <dd> 631 <dd>
501 flag indicating success (boolean) 632 flag indicating success
633 </dd>
634 </dl>
635 <dl>
636 <dt>Return Type:</dt>
637 <dd>
638 bool
502 </dd> 639 </dd>
503 </dl> 640 </dl>
504 <a NAME="DebuggerInterfacePython.remoteBanner" ID="DebuggerInterfacePython.remoteBanner"></a> 641 <a NAME="DebuggerInterfacePython.remoteBanner" ID="DebuggerInterfacePython.remoteBanner"></a>
505 <h4>DebuggerInterfacePython.remoteBanner</h4> 642 <h4>DebuggerInterfacePython.remoteBanner</h4>
506 <b>remoteBanner</b>(<i></i>) 643 <b>remoteBanner</b>(<i></i>)
508 <p> 645 <p>
509 Public slot to get the banner info of the remote client. 646 Public slot to get the banner info of the remote client.
510 </p> 647 </p>
511 <a NAME="DebuggerInterfacePython.remoteBreakpoint" ID="DebuggerInterfacePython.remoteBreakpoint"></a> 648 <a NAME="DebuggerInterfacePython.remoteBreakpoint" ID="DebuggerInterfacePython.remoteBreakpoint"></a>
512 <h4>DebuggerInterfacePython.remoteBreakpoint</h4> 649 <h4>DebuggerInterfacePython.remoteBreakpoint</h4>
513 <b>remoteBreakpoint</b>(<i>fn, line, setBreakpoint, cond=None, temp=False</i>) 650 <b>remoteBreakpoint</b>(<i>debuggerId, fn, line, setBreakpoint, cond=None, temp=False</i>)
514 651
515 <p> 652 <p>
516 Public method to set or clear a breakpoint. 653 Public method to set or clear a breakpoint.
517 </p> 654 </p>
518 <dl> 655 <dl>
519 656
520 <dt><i>fn</i></dt> 657 <dt><i>debuggerId</i> (str)</dt>
521 <dd> 658 <dd>
522 filename the breakpoint belongs to (string) 659 ID of the debugger backend
523 </dd> 660 </dd>
524 <dt><i>line</i></dt> 661 <dt><i>fn</i> (str)</dt>
525 <dd> 662 <dd>
526 linenumber of the breakpoint (int) 663 filename the breakpoint belongs to
527 </dd> 664 </dd>
528 <dt><i>setBreakpoint</i></dt> 665 <dt><i>line</i> (int)</dt>
529 <dd> 666 <dd>
530 flag indicating setting or resetting a 667 linenumber of the breakpoint
531 breakpoint (boolean) 668 </dd>
532 </dd> 669 <dt><i>setBreakpoint</i> (bool)</dt>
533 <dt><i>cond</i></dt> 670 <dd>
534 <dd> 671 flag indicating setting or resetting a breakpoint
535 condition of the breakpoint (string) 672 </dd>
536 </dd> 673 <dt><i>cond</i> (str)</dt>
537 <dt><i>temp</i></dt> 674 <dd>
538 <dd> 675 condition of the breakpoint
539 flag indicating a temporary breakpoint (boolean) 676 </dd>
677 <dt><i>temp</i> (bool)</dt>
678 <dd>
679 flag indicating a temporary breakpoint
540 </dd> 680 </dd>
541 </dl> 681 </dl>
542 <a NAME="DebuggerInterfacePython.remoteBreakpointEnable" ID="DebuggerInterfacePython.remoteBreakpointEnable"></a> 682 <a NAME="DebuggerInterfacePython.remoteBreakpointEnable" ID="DebuggerInterfacePython.remoteBreakpointEnable"></a>
543 <h4>DebuggerInterfacePython.remoteBreakpointEnable</h4> 683 <h4>DebuggerInterfacePython.remoteBreakpointEnable</h4>
544 <b>remoteBreakpointEnable</b>(<i>fn, line, enable</i>) 684 <b>remoteBreakpointEnable</b>(<i>debuggerId, fn, line, enable</i>)
545 685
546 <p> 686 <p>
547 Public method to enable or disable a breakpoint. 687 Public method to enable or disable a breakpoint.
548 </p> 688 </p>
549 <dl> 689 <dl>
550 690
551 <dt><i>fn</i></dt> 691 <dt><i>debuggerId</i> (str)</dt>
552 <dd> 692 <dd>
553 filename the breakpoint belongs to (string) 693 ID of the debugger backend
554 </dd> 694 </dd>
555 <dt><i>line</i></dt> 695 <dt><i>fn</i> (str)</dt>
556 <dd> 696 <dd>
557 linenumber of the breakpoint (int) 697 filename the breakpoint belongs to
558 </dd> 698 </dd>
559 <dt><i>enable</i></dt> 699 <dt><i>line</i> (int)</dt>
700 <dd>
701 linenumber of the breakpoint
702 </dd>
703 <dt><i>enable</i> (bool)</dt>
560 <dd> 704 <dd>
561 flag indicating enabling or disabling a breakpoint 705 flag indicating enabling or disabling a breakpoint
562 (boolean)
563 </dd> 706 </dd>
564 </dl> 707 </dl>
565 <a NAME="DebuggerInterfacePython.remoteBreakpointIgnore" ID="DebuggerInterfacePython.remoteBreakpointIgnore"></a> 708 <a NAME="DebuggerInterfacePython.remoteBreakpointIgnore" ID="DebuggerInterfacePython.remoteBreakpointIgnore"></a>
566 <h4>DebuggerInterfacePython.remoteBreakpointIgnore</h4> 709 <h4>DebuggerInterfacePython.remoteBreakpointIgnore</h4>
567 <b>remoteBreakpointIgnore</b>(<i>fn, line, count</i>) 710 <b>remoteBreakpointIgnore</b>(<i>debuggerId, fn, line, count</i>)
568 711
569 <p> 712 <p>
570 Public method to ignore a breakpoint the next couple of occurrences. 713 Public method to ignore a breakpoint the next couple of occurrences.
571 </p> 714 </p>
572 <dl> 715 <dl>
573 716
574 <dt><i>fn</i></dt> 717 <dt><i>debuggerId</i> (str)</dt>
575 <dd> 718 <dd>
576 filename the breakpoint belongs to (string) 719 ID of the debugger backend
577 </dd> 720 </dd>
578 <dt><i>line</i></dt> 721 <dt><i>fn</i> (str)</dt>
579 <dd> 722 <dd>
580 linenumber of the breakpoint (int) 723 filename the breakpoint belongs to
581 </dd> 724 </dd>
582 <dt><i>count</i></dt> 725 <dt><i>line</i> (int)</dt>
583 <dd> 726 <dd>
584 number of occurrences to ignore (int) 727 linenumber of the breakpoint
728 </dd>
729 <dt><i>count</i> (int)</dt>
730 <dd>
731 number of occurrences to ignore
585 </dd> 732 </dd>
586 </dl> 733 </dl>
587 <a NAME="DebuggerInterfacePython.remoteCapabilities" ID="DebuggerInterfacePython.remoteCapabilities"></a> 734 <a NAME="DebuggerInterfacePython.remoteCapabilities" ID="DebuggerInterfacePython.remoteCapabilities"></a>
588 <h4>DebuggerInterfacePython.remoteCapabilities</h4> 735 <h4>DebuggerInterfacePython.remoteCapabilities</h4>
589 <b>remoteCapabilities</b>(<i></i>) 736 <b>remoteCapabilities</b>(<i>debuggerId</i>)
590 737
591 <p> 738 <p>
592 Public slot to get the debug clients capabilities. 739 Public slot to get the debug clients capabilities.
593 </p> 740 </p>
741 <dl>
742
743 <dt><i>debuggerId</i> (str)</dt>
744 <dd>
745 ID of the debugger backend
746 </dd>
747 </dl>
594 <a NAME="DebuggerInterfacePython.remoteClientDisassembly" ID="DebuggerInterfacePython.remoteClientDisassembly"></a> 748 <a NAME="DebuggerInterfacePython.remoteClientDisassembly" ID="DebuggerInterfacePython.remoteClientDisassembly"></a>
595 <h4>DebuggerInterfacePython.remoteClientDisassembly</h4> 749 <h4>DebuggerInterfacePython.remoteClientDisassembly</h4>
596 <b>remoteClientDisassembly</b>(<i></i>) 750 <b>remoteClientDisassembly</b>(<i>debuggerId</i>)
597 751
598 <p> 752 <p>
599 Public method to ask the client for the latest traceback disassembly. 753 Public method to ask the client for the latest traceback disassembly.
600 </p> 754 </p>
755 <dl>
756
757 <dt><i>debuggerId</i> (str)</dt>
758 <dd>
759 ID of the debugger backend
760 </dd>
761 </dl>
601 <a NAME="DebuggerInterfacePython.remoteClientSetFilter" ID="DebuggerInterfacePython.remoteClientSetFilter"></a> 762 <a NAME="DebuggerInterfacePython.remoteClientSetFilter" ID="DebuggerInterfacePython.remoteClientSetFilter"></a>
602 <h4>DebuggerInterfacePython.remoteClientSetFilter</h4> 763 <h4>DebuggerInterfacePython.remoteClientSetFilter</h4>
603 <b>remoteClientSetFilter</b>(<i>scope, filterStr</i>) 764 <b>remoteClientSetFilter</b>(<i>debuggerId, scope, filterStr</i>)
604 765
605 <p> 766 <p>
606 Public method to set a variables filter list. 767 Public method to set a variables filter list.
607 </p> 768 </p>
608 <dl> 769 <dl>
609 770
610 <dt><i>scope</i></dt> 771 <dt><i>debuggerId</i> (str)</dt>
772 <dd>
773 ID of the debugger backend
774 </dd>
775 <dt><i>scope</i> (int)</dt>
611 <dd> 776 <dd>
612 the scope of the variables (0 = local, 1 = global) 777 the scope of the variables (0 = local, 1 = global)
613 </dd> 778 </dd>
614 <dt><i>filterStr</i></dt> 779 <dt><i>filterStr</i> (str)</dt>
615 <dd> 780 <dd>
616 regexp string for variable names to filter out 781 regexp string for variable names to filter out
617 (string) 782 </dd>
783 </dl>
784 <a NAME="DebuggerInterfacePython.remoteClientStack" ID="DebuggerInterfacePython.remoteClientStack"></a>
785 <h4>DebuggerInterfacePython.remoteClientStack</h4>
786 <b>remoteClientStack</b>(<i>debuggerId</i>)
787
788 <p>
789 Public method to request the stack of the main thread.
790 </p>
791 <dl>
792
793 <dt><i>debuggerId</i> (str)</dt>
794 <dd>
795 ID of the debugger backend
618 </dd> 796 </dd>
619 </dl> 797 </dl>
620 <a NAME="DebuggerInterfacePython.remoteClientVariable" ID="DebuggerInterfacePython.remoteClientVariable"></a> 798 <a NAME="DebuggerInterfacePython.remoteClientVariable" ID="DebuggerInterfacePython.remoteClientVariable"></a>
621 <h4>DebuggerInterfacePython.remoteClientVariable</h4> 799 <h4>DebuggerInterfacePython.remoteClientVariable</h4>
622 <b>remoteClientVariable</b>(<i>scope, filterList, var, framenr=0, maxSize=0</i>) 800 <b>remoteClientVariable</b>(<i>debuggerId, scope, filterList, var, framenr=0, maxSize=0</i>)
623 801
624 <p> 802 <p>
625 Public method to request the variables of the debugged program. 803 Public method to request the variables of the debugged program.
626 </p> 804 </p>
627 <dl> 805 <dl>
628 806
807 <dt><i>debuggerId</i> (str)</dt>
808 <dd>
809 ID of the debugger backend
810 </dd>
629 <dt><i>scope</i> (int)</dt> 811 <dt><i>scope</i> (int)</dt>
630 <dd> 812 <dd>
631 the scope of the variables (0 = local, 1 = global) 813 the scope of the variables (0 = local, 1 = global)
632 </dd> 814 </dd>
633 <dt><i>filterList</i> (list of int)</dt> 815 <dt><i>filterList</i> (list of str)</dt>
634 <dd> 816 <dd>
635 list of variable types to filter out 817 list of variable types to filter out
636 </dd> 818 </dd>
637 <dt><i>var</i> (list of str)</dt> 819 <dt><i>var</i> (list of str)</dt>
638 <dd> 820 <dd>
649 be given (@@TOO_BIG_TO_SHOW@@). 831 be given (@@TOO_BIG_TO_SHOW@@).
650 </dd> 832 </dd>
651 </dl> 833 </dl>
652 <a NAME="DebuggerInterfacePython.remoteClientVariables" ID="DebuggerInterfacePython.remoteClientVariables"></a> 834 <a NAME="DebuggerInterfacePython.remoteClientVariables" ID="DebuggerInterfacePython.remoteClientVariables"></a>
653 <h4>DebuggerInterfacePython.remoteClientVariables</h4> 835 <h4>DebuggerInterfacePython.remoteClientVariables</h4>
654 <b>remoteClientVariables</b>(<i>scope, filterList, framenr=0, maxSize=0</i>) 836 <b>remoteClientVariables</b>(<i>debuggerId, scope, filterList, framenr=0, maxSize=0</i>)
655 837
656 <p> 838 <p>
657 Public method to request the variables of the debugged program. 839 Public method to request the variables of the debugged program.
658 </p> 840 </p>
659 <dl> 841 <dl>
660 842
843 <dt><i>debuggerId</i> (str)</dt>
844 <dd>
845 ID of the debugger backend
846 </dd>
661 <dt><i>scope</i> (int)</dt> 847 <dt><i>scope</i> (int)</dt>
662 <dd> 848 <dd>
663 the scope of the variables (0 = local, 1 = global) 849 the scope of the variables (0 = local, 1 = global)
664 </dd> 850 </dd>
665 <dt><i>filterList</i> (list of int)</dt> 851 <dt><i>filterList</i> (list of str)</dt>
666 <dd> 852 <dd>
667 list of variable types to filter out 853 list of variable types to filter out
668 </dd> 854 </dd>
669 <dt><i>framenr</i> (int)</dt> 855 <dt><i>framenr</i> (int)</dt>
670 <dd> 856 <dd>
677 be given (@@TOO_BIG_TO_SHOW@@). 863 be given (@@TOO_BIG_TO_SHOW@@).
678 </dd> 864 </dd>
679 </dl> 865 </dl>
680 <a NAME="DebuggerInterfacePython.remoteCompletion" ID="DebuggerInterfacePython.remoteCompletion"></a> 866 <a NAME="DebuggerInterfacePython.remoteCompletion" ID="DebuggerInterfacePython.remoteCompletion"></a>
681 <h4>DebuggerInterfacePython.remoteCompletion</h4> 867 <h4>DebuggerInterfacePython.remoteCompletion</h4>
682 <b>remoteCompletion</b>(<i>text</i>) 868 <b>remoteCompletion</b>(<i>debuggerId, text</i>)
683 869
684 <p> 870 <p>
685 Public slot to get the a list of possible commandline completions 871 Public slot to get the a list of possible commandline completions
686 from the remote client. 872 from the remote client.
687 </p> 873 </p>
688 <dl> 874 <dl>
689 875
690 <dt><i>text</i></dt> 876 <dt><i>debuggerId</i> (str)</dt>
691 <dd> 877 <dd>
692 the text to be completed (string) 878 ID of the debugger backend
879 </dd>
880 <dt><i>text</i> (str)</dt>
881 <dd>
882 the text to be completed
693 </dd> 883 </dd>
694 </dl> 884 </dl>
695 <a NAME="DebuggerInterfacePython.remoteContinue" ID="DebuggerInterfacePython.remoteContinue"></a> 885 <a NAME="DebuggerInterfacePython.remoteContinue" ID="DebuggerInterfacePython.remoteContinue"></a>
696 <h4>DebuggerInterfacePython.remoteContinue</h4> 886 <h4>DebuggerInterfacePython.remoteContinue</h4>
697 <b>remoteContinue</b>(<i>special=False</i>) 887 <b>remoteContinue</b>(<i>debuggerId, special=False</i>)
698 888
699 <p> 889 <p>
700 Public method to continue the debugged program. 890 Public method to continue the debugged program.
701 </p> 891 </p>
702 <dl> 892 <dl>
703 893
704 <dt><i>special</i></dt> 894 <dt><i>debuggerId</i> (str)</dt>
895 <dd>
896 ID of the debugger backend
897 </dd>
898 <dt><i>special</i> (bool)</dt>
705 <dd> 899 <dd>
706 flag indicating a special continue operation 900 flag indicating a special continue operation
901 </dd>
902 </dl>
903 <a NAME="DebuggerInterfacePython.remoteContinueUntil" ID="DebuggerInterfacePython.remoteContinueUntil"></a>
904 <h4>DebuggerInterfacePython.remoteContinueUntil</h4>
905 <b>remoteContinueUntil</b>(<i>debuggerId, line</i>)
906
907 <p>
908 Public method to continue the debugged program to the given line
909 or until returning from the current frame.
910 </p>
911 <dl>
912
913 <dt><i>debuggerId</i> (str)</dt>
914 <dd>
915 ID of the debugger backend
916 </dd>
917 <dt><i>line</i> (int)</dt>
918 <dd>
919 the new line, where execution should be continued to
707 </dd> 920 </dd>
708 </dl> 921 </dl>
709 <a NAME="DebuggerInterfacePython.remoteCoverage" ID="DebuggerInterfacePython.remoteCoverage"></a> 922 <a NAME="DebuggerInterfacePython.remoteCoverage" ID="DebuggerInterfacePython.remoteCoverage"></a>
710 <h4>DebuggerInterfacePython.remoteCoverage</h4> 923 <h4>DebuggerInterfacePython.remoteCoverage</h4>
711 <b>remoteCoverage</b>(<i>fn, argv, wd, erase=False</i>) 924 <b>remoteCoverage</b>(<i>fn, argv, wd, erase=False</i>)
713 <p> 926 <p>
714 Public method to load a new program to collect coverage data. 927 Public method to load a new program to collect coverage data.
715 </p> 928 </p>
716 <dl> 929 <dl>
717 930
718 <dt><i>fn</i></dt> 931 <dt><i>fn</i> (str)</dt>
719 <dd> 932 <dd>
720 the filename to run (string) 933 the filename to run
721 </dd> 934 </dd>
722 <dt><i>argv</i></dt> 935 <dt><i>argv</i> (str)</dt>
723 <dd> 936 <dd>
724 the commandline arguments to pass to the program (string) 937 the commandline arguments to pass to the program
725 </dd> 938 </dd>
726 <dt><i>wd</i></dt> 939 <dt><i>wd</i> (str)</dt>
727 <dd> 940 <dd>
728 the working directory for the program (string) 941 the working directory for the program
729 </dd> 942 </dd>
730 <dt><i>erase=</i></dt> 943 <dt><i>erase</i> (bool)</dt>
731 <dd> 944 <dd>
732 flag indicating that coverage info should be 945 flag indicating that coverage info should be
733 cleared first (boolean) 946 cleared first
734 </dd> 947 </dd>
735 </dl> 948 </dl>
736 <a NAME="DebuggerInterfacePython.remoteEnvironment" ID="DebuggerInterfacePython.remoteEnvironment"></a> 949 <a NAME="DebuggerInterfacePython.remoteEnvironment" ID="DebuggerInterfacePython.remoteEnvironment"></a>
737 <h4>DebuggerInterfacePython.remoteEnvironment</h4> 950 <h4>DebuggerInterfacePython.remoteEnvironment</h4>
738 <b>remoteEnvironment</b>(<i>env</i>) 951 <b>remoteEnvironment</b>(<i>env</i>)
740 <p> 953 <p>
741 Public method to set the environment for a program to debug, run, ... 954 Public method to set the environment for a program to debug, run, ...
742 </p> 955 </p>
743 <dl> 956 <dl>
744 957
745 <dt><i>env</i></dt> 958 <dt><i>env</i> (dict)</dt>
746 <dd> 959 <dd>
747 environment settings (dictionary) 960 environment settings
748 </dd> 961 </dd>
749 </dl> 962 </dl>
750 <a NAME="DebuggerInterfacePython.remoteLoad" ID="DebuggerInterfacePython.remoteLoad"></a> 963 <a NAME="DebuggerInterfacePython.remoteLoad" ID="DebuggerInterfacePython.remoteLoad"></a>
751 <h4>DebuggerInterfacePython.remoteLoad</h4> 964 <h4>DebuggerInterfacePython.remoteLoad</h4>
752 <b>remoteLoad</b>(<i>fn, argv, wd, traceInterpreter=False, autoContinue=True, autoFork=False, forkChild=False</i>) 965 <b>remoteLoad</b>(<i>fn, argv, wd, traceInterpreter=False, autoContinue=True, enableMultiprocess=False</i>)
753 966
754 <p> 967 <p>
755 Public method to load a new program to debug. 968 Public method to load a new program to debug.
756 </p> 969 </p>
757 <dl> 970 <dl>
758 971
759 <dt><i>fn</i></dt> 972 <dt><i>fn</i> (str)</dt>
760 <dd> 973 <dd>
761 the filename to debug (string) 974 the filename to debug
762 </dd> 975 </dd>
763 <dt><i>argv</i></dt> 976 <dt><i>argv</i> (str)</dt>
764 <dd> 977 <dd>
765 the commandline arguments to pass to the program (string) 978 the commandline arguments to pass to the program
766 </dd> 979 </dd>
767 <dt><i>wd</i></dt> 980 <dt><i>wd</i> (str)</dt>
768 <dd> 981 <dd>
769 the working directory for the program (string) 982 the working directory for the program
770 </dd> 983 </dd>
771 <dt><i>traceInterpreter=</i></dt> 984 <dt><i>traceInterpreter</i> (bool)</dt>
772 <dd> 985 <dd>
773 flag indicating if the interpreter library 986 flag indicating if the interpreter library
774 should be traced as well (boolean) 987 should be traced as well
775 </dd> 988 </dd>
776 <dt><i>autoContinue=</i></dt> 989 <dt><i>autoContinue</i> (bool)</dt>
777 <dd> 990 <dd>
778 flag indicating, that the debugger should not 991 flag indicating, that the debugger should not
779 stop at the first executable line (boolean) 992 stop at the first executable line
780 </dd> 993 </dd>
781 <dt><i>autoFork=</i></dt> 994 <dt><i>enableMultiprocess</i> (bool)</dt>
782 <dd> 995 <dd>
783 flag indicating the automatic fork mode (boolean) 996 flag indicating to perform multiprocess
784 </dd> 997 debugging
785 <dt><i>forkChild=</i></dt>
786 <dd>
787 flag indicating to debug the child after forking
788 (boolean)
789 </dd> 998 </dd>
790 </dl> 999 </dl>
791 <a NAME="DebuggerInterfacePython.remoteMoveIP" ID="DebuggerInterfacePython.remoteMoveIP"></a> 1000 <a NAME="DebuggerInterfacePython.remoteMoveIP" ID="DebuggerInterfacePython.remoteMoveIP"></a>
792 <h4>DebuggerInterfacePython.remoteMoveIP</h4> 1001 <h4>DebuggerInterfacePython.remoteMoveIP</h4>
793 <b>remoteMoveIP</b>(<i>line</i>) 1002 <b>remoteMoveIP</b>(<i>debuggerId, line</i>)
794 1003
795 <p> 1004 <p>
796 Public method to move the instruction pointer to a different line. 1005 Public method to move the instruction pointer to a different line.
797 </p> 1006 </p>
798 <dl> 1007 <dl>
799 1008
800 <dt><i>line</i></dt> 1009 <dt><i>debuggerId</i> (str)</dt>
1010 <dd>
1011 ID of the debugger backend
1012 </dd>
1013 <dt><i>line</i> (int)</dt>
801 <dd> 1014 <dd>
802 the new line, where execution should be continued 1015 the new line, where execution should be continued
1016 </dd>
1017 </dl>
1018 <a NAME="DebuggerInterfacePython.remoteNoDebugList" ID="DebuggerInterfacePython.remoteNoDebugList"></a>
1019 <h4>DebuggerInterfacePython.remoteNoDebugList</h4>
1020 <b>remoteNoDebugList</b>(<i>debuggerId, noDebugList</i>)
1021
1022 <p>
1023 Public method to set a list of programs not to be debugged.
1024 </p>
1025 <p>
1026 The programs given in the list will not be run under the control
1027 of the multi process debugger.
1028 </p>
1029 <dl>
1030
1031 <dt><i>debuggerId</i> (str)</dt>
1032 <dd>
1033 ID of the debugger backend
1034 </dd>
1035 <dt><i>noDebugList</i> (list of str)</dt>
1036 <dd>
1037 list of Python programs not to be debugged
803 </dd> 1038 </dd>
804 </dl> 1039 </dl>
805 <a NAME="DebuggerInterfacePython.remoteProfile" ID="DebuggerInterfacePython.remoteProfile"></a> 1040 <a NAME="DebuggerInterfacePython.remoteProfile" ID="DebuggerInterfacePython.remoteProfile"></a>
806 <h4>DebuggerInterfacePython.remoteProfile</h4> 1041 <h4>DebuggerInterfacePython.remoteProfile</h4>
807 <b>remoteProfile</b>(<i>fn, argv, wd, erase=False</i>) 1042 <b>remoteProfile</b>(<i>fn, argv, wd, erase=False</i>)
809 <p> 1044 <p>
810 Public method to load a new program to collect profiling data. 1045 Public method to load a new program to collect profiling data.
811 </p> 1046 </p>
812 <dl> 1047 <dl>
813 1048
814 <dt><i>fn</i></dt> 1049 <dt><i>fn</i> (str)</dt>
815 <dd> 1050 <dd>
816 the filename to run (string) 1051 the filename to run
817 </dd> 1052 </dd>
818 <dt><i>argv</i></dt> 1053 <dt><i>argv</i> (str)</dt>
819 <dd> 1054 <dd>
820 the commandline arguments to pass to the program (string) 1055 the commandline arguments to pass to the program
821 </dd> 1056 </dd>
822 <dt><i>wd</i></dt> 1057 <dt><i>wd</i> (str)</dt>
823 <dd> 1058 <dd>
824 the working directory for the program (string) 1059 the working directory for the program
825 </dd> 1060 </dd>
826 <dt><i>erase=</i></dt> 1061 <dt><i>erase</i> (bool)</dt>
827 <dd> 1062 <dd>
828 flag indicating that timing info should be cleared 1063 flag indicating that timing info should be cleared
829 first (boolean) 1064 first
830 </dd> 1065 </dd>
831 </dl> 1066 </dl>
832 <a NAME="DebuggerInterfacePython.remoteRawInput" ID="DebuggerInterfacePython.remoteRawInput"></a> 1067 <a NAME="DebuggerInterfacePython.remoteRawInput" ID="DebuggerInterfacePython.remoteRawInput"></a>
833 <h4>DebuggerInterfacePython.remoteRawInput</h4> 1068 <h4>DebuggerInterfacePython.remoteRawInput</h4>
834 <b>remoteRawInput</b>(<i>s</i>) 1069 <b>remoteRawInput</b>(<i>debuggerId, inputString</i>)
835 1070
836 <p> 1071 <p>
837 Public method to send the raw input to the debugged program. 1072 Public method to send the raw input to the debugged program.
838 </p> 1073 </p>
839 <dl> 1074 <dl>
840 1075
841 <dt><i>s</i></dt> 1076 <dt><i>debuggerId</i> (str)</dt>
842 <dd> 1077 <dd>
843 the raw input (string) 1078 ID of the debugger backend
1079 </dd>
1080 <dt><i>inputString</i> (str)</dt>
1081 <dd>
1082 the raw input
844 </dd> 1083 </dd>
845 </dl> 1084 </dl>
846 <a NAME="DebuggerInterfacePython.remoteRun" ID="DebuggerInterfacePython.remoteRun"></a> 1085 <a NAME="DebuggerInterfacePython.remoteRun" ID="DebuggerInterfacePython.remoteRun"></a>
847 <h4>DebuggerInterfacePython.remoteRun</h4> 1086 <h4>DebuggerInterfacePython.remoteRun</h4>
848 <b>remoteRun</b>(<i>fn, argv, wd, autoFork=False, forkChild=False</i>) 1087 <b>remoteRun</b>(<i>fn, argv, wd</i>)
849 1088
850 <p> 1089 <p>
851 Public method to load a new program to run. 1090 Public method to load a new program to run.
852 </p> 1091 </p>
853 <dl> 1092 <dl>
854 1093
855 <dt><i>fn</i></dt> 1094 <dt><i>fn</i> (str)</dt>
856 <dd> 1095 <dd>
857 the filename to run (string) 1096 the filename to run
858 </dd> 1097 </dd>
859 <dt><i>argv</i></dt> 1098 <dt><i>argv</i> (str)</dt>
860 <dd> 1099 <dd>
861 the commandline arguments to pass to the program (string) 1100 the commandline arguments to pass to the program
862 </dd> 1101 </dd>
863 <dt><i>wd</i></dt> 1102 <dt><i>wd</i> (str)</dt>
864 <dd> 1103 <dd>
865 the working directory for the program (string) 1104 the working directory for the program
866 </dd>
867 <dt><i>autoFork=</i></dt>
868 <dd>
869 flag indicating the automatic fork mode (boolean)
870 </dd>
871 <dt><i>forkChild=</i></dt>
872 <dd>
873 flag indicating to debug the child after forking
874 (boolean)
875 </dd> 1105 </dd>
876 </dl> 1106 </dl>
877 <a NAME="DebuggerInterfacePython.remoteSetThread" ID="DebuggerInterfacePython.remoteSetThread"></a> 1107 <a NAME="DebuggerInterfacePython.remoteSetThread" ID="DebuggerInterfacePython.remoteSetThread"></a>
878 <h4>DebuggerInterfacePython.remoteSetThread</h4> 1108 <h4>DebuggerInterfacePython.remoteSetThread</h4>
879 <b>remoteSetThread</b>(<i>tid</i>) 1109 <b>remoteSetThread</b>(<i>debuggerId, tid</i>)
880 1110
881 <p> 1111 <p>
882 Public method to request to set the given thread as current thread. 1112 Public method to request to set the given thread as current thread.
883 </p> 1113 </p>
884 <dl> 1114 <dl>
885 1115
886 <dt><i>tid</i></dt> 1116 <dt><i>debuggerId</i> (str)</dt>
887 <dd> 1117 <dd>
888 id of the thread (integer) 1118 ID of the debugger backend
1119 </dd>
1120 <dt><i>tid</i> (int)</dt>
1121 <dd>
1122 id of the thread
889 </dd> 1123 </dd>
890 </dl> 1124 </dl>
891 <a NAME="DebuggerInterfacePython.remoteStatement" ID="DebuggerInterfacePython.remoteStatement"></a> 1125 <a NAME="DebuggerInterfacePython.remoteStatement" ID="DebuggerInterfacePython.remoteStatement"></a>
892 <h4>DebuggerInterfacePython.remoteStatement</h4> 1126 <h4>DebuggerInterfacePython.remoteStatement</h4>
893 <b>remoteStatement</b>(<i>stmt</i>) 1127 <b>remoteStatement</b>(<i>debuggerId, stmt</i>)
894 1128
895 <p> 1129 <p>
896 Public method to execute a Python statement. 1130 Public method to execute a Python statement.
897 </p> 1131 </p>
898 <dl> 1132 <dl>
899 1133
900 <dt><i>stmt</i></dt> 1134 <dt><i>debuggerId</i> (str)</dt>
901 <dd> 1135 <dd>
902 the Python statement to execute (string). It 1136 ID of the debugger backend
903 should not have a trailing newline. 1137 </dd>
1138 <dt><i>stmt</i> (str)</dt>
1139 <dd>
1140 the Python statement to execute.
904 </dd> 1141 </dd>
905 </dl> 1142 </dl>
906 <a NAME="DebuggerInterfacePython.remoteStep" ID="DebuggerInterfacePython.remoteStep"></a> 1143 <a NAME="DebuggerInterfacePython.remoteStep" ID="DebuggerInterfacePython.remoteStep"></a>
907 <h4>DebuggerInterfacePython.remoteStep</h4> 1144 <h4>DebuggerInterfacePython.remoteStep</h4>
908 <b>remoteStep</b>(<i></i>) 1145 <b>remoteStep</b>(<i>debuggerId</i>)
909 1146
910 <p> 1147 <p>
911 Public method to single step the debugged program. 1148 Public method to single step the debugged program.
912 </p> 1149 </p>
1150 <dl>
1151
1152 <dt><i>debuggerId</i> (str)</dt>
1153 <dd>
1154 ID of the debugger backend
1155 </dd>
1156 </dl>
913 <a NAME="DebuggerInterfacePython.remoteStepOut" ID="DebuggerInterfacePython.remoteStepOut"></a> 1157 <a NAME="DebuggerInterfacePython.remoteStepOut" ID="DebuggerInterfacePython.remoteStepOut"></a>
914 <h4>DebuggerInterfacePython.remoteStepOut</h4> 1158 <h4>DebuggerInterfacePython.remoteStepOut</h4>
915 <b>remoteStepOut</b>(<i></i>) 1159 <b>remoteStepOut</b>(<i>debuggerId</i>)
916 1160
917 <p> 1161 <p>
918 Public method to step out the debugged program. 1162 Public method to step out the debugged program.
919 </p> 1163 </p>
1164 <dl>
1165
1166 <dt><i>debuggerId</i> (str)</dt>
1167 <dd>
1168 ID of the debugger backend
1169 </dd>
1170 </dl>
920 <a NAME="DebuggerInterfacePython.remoteStepOver" ID="DebuggerInterfacePython.remoteStepOver"></a> 1171 <a NAME="DebuggerInterfacePython.remoteStepOver" ID="DebuggerInterfacePython.remoteStepOver"></a>
921 <h4>DebuggerInterfacePython.remoteStepOver</h4> 1172 <h4>DebuggerInterfacePython.remoteStepOver</h4>
922 <b>remoteStepOver</b>(<i></i>) 1173 <b>remoteStepOver</b>(<i>debuggerId</i>)
923 1174
924 <p> 1175 <p>
925 Public method to step over the debugged program. 1176 Public method to step over the debugged program.
926 </p> 1177 </p>
1178 <dl>
1179
1180 <dt><i>debuggerId</i> (str)</dt>
1181 <dd>
1182 ID of the debugger backend
1183 </dd>
1184 </dl>
927 <a NAME="DebuggerInterfacePython.remoteStepQuit" ID="DebuggerInterfacePython.remoteStepQuit"></a> 1185 <a NAME="DebuggerInterfacePython.remoteStepQuit" ID="DebuggerInterfacePython.remoteStepQuit"></a>
928 <h4>DebuggerInterfacePython.remoteStepQuit</h4> 1186 <h4>DebuggerInterfacePython.remoteStepQuit</h4>
929 <b>remoteStepQuit</b>(<i></i>) 1187 <b>remoteStepQuit</b>(<i>debuggerId</i>)
930 1188
931 <p> 1189 <p>
932 Public method to stop the debugged program. 1190 Public method to stop the debugged program.
933 </p> 1191 </p>
1192 <dl>
1193
1194 <dt><i>debuggerId</i> (str)</dt>
1195 <dd>
1196 ID of the debugger backend
1197 </dd>
1198 </dl>
934 <a NAME="DebuggerInterfacePython.remoteThreadList" ID="DebuggerInterfacePython.remoteThreadList"></a> 1199 <a NAME="DebuggerInterfacePython.remoteThreadList" ID="DebuggerInterfacePython.remoteThreadList"></a>
935 <h4>DebuggerInterfacePython.remoteThreadList</h4> 1200 <h4>DebuggerInterfacePython.remoteThreadList</h4>
936 <b>remoteThreadList</b>(<i></i>) 1201 <b>remoteThreadList</b>(<i>debuggerId</i>)
937 1202
938 <p> 1203 <p>
939 Public method to request the list of threads from the client. 1204 Public method to request the list of threads from the client.
940 </p> 1205 </p>
1206 <dl>
1207
1208 <dt><i>debuggerId</i> (str)</dt>
1209 <dd>
1210 ID of the debugger backend
1211 </dd>
1212 </dl>
941 <a NAME="DebuggerInterfacePython.remoteUTDiscover" ID="DebuggerInterfacePython.remoteUTDiscover"></a> 1213 <a NAME="DebuggerInterfacePython.remoteUTDiscover" ID="DebuggerInterfacePython.remoteUTDiscover"></a>
942 <h4>DebuggerInterfacePython.remoteUTDiscover</h4> 1214 <h4>DebuggerInterfacePython.remoteUTDiscover</h4>
943 <b>remoteUTDiscover</b>(<i>syspath, workdir, discoveryStart</i>) 1215 <b>remoteUTDiscover</b>(<i>syspath, workdir, discoveryStart</i>)
944 1216
945 <p> 1217 <p>
1050 <p> 1322 <p>
1051 Public method to stop a unittest run. 1323 Public method to stop a unittest run.
1052 </p> 1324 </p>
1053 <a NAME="DebuggerInterfacePython.remoteWatchpoint" ID="DebuggerInterfacePython.remoteWatchpoint"></a> 1325 <a NAME="DebuggerInterfacePython.remoteWatchpoint" ID="DebuggerInterfacePython.remoteWatchpoint"></a>
1054 <h4>DebuggerInterfacePython.remoteWatchpoint</h4> 1326 <h4>DebuggerInterfacePython.remoteWatchpoint</h4>
1055 <b>remoteWatchpoint</b>(<i>cond, setWatch, temp=False</i>) 1327 <b>remoteWatchpoint</b>(<i>debuggerId, cond, setWatch, temp=False</i>)
1056 1328
1057 <p> 1329 <p>
1058 Public method to set or clear a watch expression. 1330 Public method to set or clear a watch expression.
1059 </p> 1331 </p>
1060 <dl> 1332 <dl>
1061 1333
1062 <dt><i>cond</i></dt> 1334 <dt><i>debuggerId</i> (str)</dt>
1063 <dd> 1335 <dd>
1064 expression of the watch expression (string) 1336 ID of the debugger backend
1065 </dd> 1337 </dd>
1066 <dt><i>setWatch</i></dt> 1338 <dt><i>cond</i> (str)</dt>
1339 <dd>
1340 expression of the watch expression
1341 </dd>
1342 <dt><i>setWatch</i> (bool)</dt>
1067 <dd> 1343 <dd>
1068 flag indicating setting or resetting a watch expression 1344 flag indicating setting or resetting a watch expression
1069 (boolean) 1345 </dd>
1070 </dd> 1346 <dt><i>temp</i> (bool)</dt>
1071 <dt><i>temp</i></dt> 1347 <dd>
1072 <dd> 1348 flag indicating a temporary watch expression
1073 flag indicating a temporary watch expression (boolean)
1074 </dd> 1349 </dd>
1075 </dl> 1350 </dl>
1076 <a NAME="DebuggerInterfacePython.remoteWatchpointEnable" ID="DebuggerInterfacePython.remoteWatchpointEnable"></a> 1351 <a NAME="DebuggerInterfacePython.remoteWatchpointEnable" ID="DebuggerInterfacePython.remoteWatchpointEnable"></a>
1077 <h4>DebuggerInterfacePython.remoteWatchpointEnable</h4> 1352 <h4>DebuggerInterfacePython.remoteWatchpointEnable</h4>
1078 <b>remoteWatchpointEnable</b>(<i>cond, enable</i>) 1353 <b>remoteWatchpointEnable</b>(<i>debuggerId, cond, enable</i>)
1079 1354
1080 <p> 1355 <p>
1081 Public method to enable or disable a watch expression. 1356 Public method to enable or disable a watch expression.
1082 </p> 1357 </p>
1083 <dl> 1358 <dl>
1084 1359
1085 <dt><i>cond</i></dt> 1360 <dt><i>debuggerId</i> (str)</dt>
1086 <dd> 1361 <dd>
1087 expression of the watch expression (string) 1362 ID of the debugger backend
1088 </dd> 1363 </dd>
1089 <dt><i>enable</i></dt> 1364 <dt><i>cond</i> (str)</dt>
1365 <dd>
1366 expression of the watch expression
1367 </dd>
1368 <dt><i>enable</i> (bool)</dt>
1090 <dd> 1369 <dd>
1091 flag indicating enabling or disabling a watch expression 1370 flag indicating enabling or disabling a watch expression
1092 (boolean)
1093 </dd> 1371 </dd>
1094 </dl> 1372 </dl>
1095 <a NAME="DebuggerInterfacePython.remoteWatchpointIgnore" ID="DebuggerInterfacePython.remoteWatchpointIgnore"></a> 1373 <a NAME="DebuggerInterfacePython.remoteWatchpointIgnore" ID="DebuggerInterfacePython.remoteWatchpointIgnore"></a>
1096 <h4>DebuggerInterfacePython.remoteWatchpointIgnore</h4> 1374 <h4>DebuggerInterfacePython.remoteWatchpointIgnore</h4>
1097 <b>remoteWatchpointIgnore</b>(<i>cond, count</i>) 1375 <b>remoteWatchpointIgnore</b>(<i>debuggerId, cond, count</i>)
1098 1376
1099 <p> 1377 <p>
1100 Public method to ignore a watch expression the next couple of 1378 Public method to ignore a watch expression the next couple of
1101 occurrences. 1379 occurrences.
1102 </p> 1380 </p>
1103 <dl> 1381 <dl>
1104 1382
1105 <dt><i>cond</i></dt> 1383 <dt><i>debuggerId</i> (str)</dt>
1106 <dd> 1384 <dd>
1107 expression of the watch expression (string) 1385 ID of the debugger backend
1108 </dd> 1386 </dd>
1109 <dt><i>count</i></dt> 1387 <dt><i>cond</i> (str)</dt>
1110 <dd> 1388 <dd>
1111 number of occurrences to ignore (int) 1389 expression of the watch expression
1390 </dd>
1391 <dt><i>count</i> (int)</dt>
1392 <dd>
1393 number of occurrences to ignore
1112 </dd> 1394 </dd>
1113 </dl> 1395 </dl>
1114 <a NAME="DebuggerInterfacePython.setCallTraceEnabled" ID="DebuggerInterfacePython.setCallTraceEnabled"></a> 1396 <a NAME="DebuggerInterfacePython.setCallTraceEnabled" ID="DebuggerInterfacePython.setCallTraceEnabled"></a>
1115 <h4>DebuggerInterfacePython.setCallTraceEnabled</h4> 1397 <h4>DebuggerInterfacePython.setCallTraceEnabled</h4>
1116 <b>setCallTraceEnabled</b>(<i>on</i>) 1398 <b>setCallTraceEnabled</b>(<i>debuggerId, on</i>)
1117 1399
1118 <p> 1400 <p>
1119 Public method to set the call trace state. 1401 Public method to set the call trace state.
1120 </p> 1402 </p>
1121 <dl> 1403 <dl>
1122 1404
1123 <dt><i>on</i></dt> 1405 <dt><i>debuggerId</i> (str)</dt>
1124 <dd> 1406 <dd>
1125 flag indicating to enable the call trace function (boolean) 1407 ID of the debugger backend
1408 </dd>
1409 <dt><i>on</i> (bool)</dt>
1410 <dd>
1411 flag indicating to enable the call trace function
1126 </dd> 1412 </dd>
1127 </dl> 1413 </dl>
1128 <a NAME="DebuggerInterfacePython.shutdown" ID="DebuggerInterfacePython.shutdown"></a> 1414 <a NAME="DebuggerInterfacePython.shutdown" ID="DebuggerInterfacePython.shutdown"></a>
1129 <h4>DebuggerInterfacePython.shutdown</h4> 1415 <h4>DebuggerInterfacePython.shutdown</h4>
1130 <b>shutdown</b>(<i></i>) 1416 <b>shutdown</b>(<i></i>)
1131 1417
1132 <p> 1418 <p>
1133 Public method to cleanly shut down. 1419 Public method to cleanly shut down.
1134 </p> 1420 </p>
1135 <p> 1421 <p>
1136 It closes our socket and shuts down 1422 It closes our sockets and shuts down the debug clients.
1137 the debug client. (Needed on Win OS) 1423 (Needed on Win OS)
1138 </p> 1424 </p>
1139 <a NAME="DebuggerInterfacePython.startRemote" ID="DebuggerInterfacePython.startRemote"></a> 1425 <a NAME="DebuggerInterfacePython.startRemote" ID="DebuggerInterfacePython.startRemote"></a>
1140 <h4>DebuggerInterfacePython.startRemote</h4> 1426 <h4>DebuggerInterfacePython.startRemote</h4>
1141 <b>startRemote</b>(<i>port, runInConsole, venvName, originalPathString, workingDir=None</i>) 1427 <b>startRemote</b>(<i>port, runInConsole, venvName, originalPathString, workingDir=None</i>)
1142 1428
1166 <dd> 1452 <dd>
1167 directory to start the debugger client in 1453 directory to start the debugger client in
1168 </dd> 1454 </dd>
1169 </dl> 1455 </dl>
1170 <dl> 1456 <dl>
1171 <dt>Returns:</dt> 1457 <dt>Return:</dt>
1172 <dd> 1458 <dd>
1173 client process object, a flag to indicate a network connection 1459 client process object, a flag to indicate a network connection
1174 and the name of the interpreter in case of a local execution 1460 and the name of the interpreter in case of a local execution
1175 </dd> 1461 </dd>
1176 </dl> 1462 </dl>
1210 <dd> 1496 <dd>
1211 directory to start the debugger client in 1497 directory to start the debugger client in
1212 </dd> 1498 </dd>
1213 </dl> 1499 </dl>
1214 <dl> 1500 <dl>
1215 <dt>Returns:</dt> 1501 <dt>Return:</dt>
1216 <dd> 1502 <dd>
1217 client process object, a flag to indicate a network connection 1503 client process object, a flag to indicate a network connection
1218 and the name of the interpreter in case of a local execution 1504 and the name of the interpreter in case of a local execution
1219 </dd> 1505 </dd>
1220 </dl> 1506 </dl>
1247 <dd> 1533 <dd>
1248 flag indicating passive connection mode 1534 flag indicating passive connection mode
1249 </dd> 1535 </dd>
1250 </dl> 1536 </dl>
1251 <dl> 1537 <dl>
1252 <dt>Returns:</dt> 1538 <dt>Return:</dt>
1253 <dd> 1539 <dd>
1254 instantiated debugger interface 1540 instantiated debugger interface
1255 </dd> 1541 </dd>
1256 </dl> 1542 </dl>
1257 <dl> 1543 <dl>
1270 <p> 1556 <p>
1271 Module function to get characterizing data for the supported debugger 1557 Module function to get characterizing data for the supported debugger
1272 interfaces. 1558 interfaces.
1273 </p> 1559 </p>
1274 <dl> 1560 <dl>
1275 <dt>Returns:</dt> 1561 <dt>Return:</dt>
1276 <dd> 1562 <dd>
1277 list of tuples containing the client type, the client capabilities, 1563 list of tuples containing the client type, the client capabilities,
1278 the client file type associations and a reference to the creation 1564 the client file type associations and a reference to the creation
1279 function 1565 function
1280 </dd> 1566 </dd>

Mercurial Repository: eric

eric ide

mercurial