~ubuntu-branches/ubuntu/karmic/eric/karmic

« back to all changes in this revision

Viewing changes to eric/Documentation/Source/eric4.Debugger.DebuggerInterfacePython.html

  • Committer: Bazaar Package Importer
  • Author(s): Scott Kitterman
  • Date: 2008-01-28 18:02:25 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20080128180225-6nrox6yrworh2c4v
Tags: 4.0.4-1ubuntu1
* Add python-qt3 to build-depends becuase that's where Ubuntu puts 
  pyqtconfig
* Change maintainer to MOTU

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="utf-8"?>
 
2
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
 
3
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
 
4
<html><head>
 
5
<title>eric4.Debugger.DebuggerInterfacePython</title>
 
6
<style>
 
7
body {
 
8
    background:white;
 
9
    margin: 0em 1em 10em 1em;
 
10
    color: black;
 
11
}
 
12
 
 
13
h1 { color: white; background: #4FA4FF; }
 
14
h2 { color: white; background: #4FA4FF; }
 
15
h3 { color: white; background: #00557F; }
 
16
h4 { color: white; background: #00557F; }
 
17
    
 
18
a { color: #AA5500; }
 
19
 
 
20
</style>
 
21
</head>
 
22
<body><a NAME="top" ID="top"></a>
 
23
<h1>eric4.Debugger.DebuggerInterfacePython</h1>
 
24
<p>
 
25
Module implementing the Python debugger interface for the debug server.
 
26
</p>
 
27
<h3>Classes</h3>
 
28
<table>
 
29
<tr>
 
30
<td><a href="#DebuggerInterfacePython">DebuggerInterfacePython</a></td>
 
31
<td>Class implementing the Python debugger interface for the debug server.</td>
 
32
</tr>
 
33
</table>
 
34
<h3>Functions</h3>
 
35
<table>
 
36
<tr>
 
37
<td><a href="#getRegistryData">getRegistryData</a></td>
 
38
<td>Module functionto get characterising data for the debugger interface.</td>
 
39
</tr>
 
40
</table>
 
41
<hr /><hr />
 
42
<a NAME="DebuggerInterfacePython" ID="DebuggerInterfacePython"></a>
 
43
<h2>DebuggerInterfacePython</h2>
 
44
<p>
 
45
    Class implementing the Python debugger interface for the debug server.
 
46
</p>
 
47
<h3>Derived from</h3>
 
48
QObject
 
49
<h3>Methods</h3>
 
50
<table>
 
51
<tr>
 
52
<td><a href="#DebuggerInterfacePython.__init__">DebuggerInterfacePython</a></td>
 
53
<td>Constructor</td>
 
54
</tr><tr>
 
55
<td><a href="#DebuggerInterfacePython.__identityTranslation">__identityTranslation</a></td>
 
56
<td>Private method to perform the identity path translation.</td>
 
57
</tr><tr>
 
58
<td><a href="#DebuggerInterfacePython.__parseClientLine">__parseClientLine</a></td>
 
59
<td>Private method to handle data from the client.</td>
 
60
</tr><tr>
 
61
<td><a href="#DebuggerInterfacePython.__remoteTranslation">__remoteTranslation</a></td>
 
62
<td>Private method to perform the path translation.</td>
 
63
</tr><tr>
 
64
<td><a href="#DebuggerInterfacePython.__sendCommand">__sendCommand</a></td>
 
65
<td>Private method to send a single line command to the client.</td>
 
66
</tr><tr>
 
67
<td><a href="#DebuggerInterfacePython.flush">flush</a></td>
 
68
<td>Public slot to flush the queue.</td>
 
69
</tr><tr>
 
70
<td><a href="#DebuggerInterfacePython.getClientCapabilities">getClientCapabilities</a></td>
 
71
<td>Public method to retrieve the debug clients capabilities.</td>
 
72
</tr><tr>
 
73
<td><a href="#DebuggerInterfacePython.isConnected">isConnected</a></td>
 
74
<td>Public method to test, if a debug client has connected.</td>
 
75
</tr><tr>
 
76
<td><a href="#DebuggerInterfacePython.newConnection">newConnection</a></td>
 
77
<td>Public slot to handle a new connection.</td>
 
78
</tr><tr>
 
79
<td><a href="#DebuggerInterfacePython.remoteBanner">remoteBanner</a></td>
 
80
<td>Public slot to get the banner info of the remote client.</td>
 
81
</tr><tr>
 
82
<td><a href="#DebuggerInterfacePython.remoteBreakpoint">remoteBreakpoint</a></td>
 
83
<td>Public method to set or clear a breakpoint.</td>
 
84
</tr><tr>
 
85
<td><a href="#DebuggerInterfacePython.remoteBreakpointEnable">remoteBreakpointEnable</a></td>
 
86
<td>Public method to enable or disable a breakpoint.</td>
 
87
</tr><tr>
 
88
<td><a href="#DebuggerInterfacePython.remoteBreakpointIgnore">remoteBreakpointIgnore</a></td>
 
89
<td>Public method to ignore a breakpoint the next couple of occurences.</td>
 
90
</tr><tr>
 
91
<td><a href="#DebuggerInterfacePython.remoteCapabilities">remoteCapabilities</a></td>
 
92
<td>Public slot to get the debug clients capabilities.</td>
 
93
</tr><tr>
 
94
<td><a href="#DebuggerInterfacePython.remoteClientSetFilter">remoteClientSetFilter</a></td>
 
95
<td>Public method to set a variables filter list.</td>
 
96
</tr><tr>
 
97
<td><a href="#DebuggerInterfacePython.remoteClientVariable">remoteClientVariable</a></td>
 
98
<td>Public method to request the variables of the debugged program.</td>
 
99
</tr><tr>
 
100
<td><a href="#DebuggerInterfacePython.remoteClientVariables">remoteClientVariables</a></td>
 
101
<td>Public method to request the variables of the debugged program.</td>
 
102
</tr><tr>
 
103
<td><a href="#DebuggerInterfacePython.remoteCompletion">remoteCompletion</a></td>
 
104
<td>Public slot to get the a list of possible commandline completions from the remote client.</td>
 
105
</tr><tr>
 
106
<td><a href="#DebuggerInterfacePython.remoteContinue">remoteContinue</a></td>
 
107
<td>Public method to continue the debugged program.</td>
 
108
</tr><tr>
 
109
<td><a href="#DebuggerInterfacePython.remoteCoverage">remoteCoverage</a></td>
 
110
<td>Public method to load a new program to collect coverage data.</td>
 
111
</tr><tr>
 
112
<td><a href="#DebuggerInterfacePython.remoteCyclops">remoteCyclops</a></td>
 
113
<td>Public method to load a new program to collect profiling data.</td>
 
114
</tr><tr>
 
115
<td><a href="#DebuggerInterfacePython.remoteEnvironment">remoteEnvironment</a></td>
 
116
<td>Public method to set the environment for a program to debug, run, ...</td>
 
117
</tr><tr>
 
118
<td><a href="#DebuggerInterfacePython.remoteEval">remoteEval</a></td>
 
119
<td>Public method to evaluate arg in the current context of the debugged program.</td>
 
120
</tr><tr>
 
121
<td><a href="#DebuggerInterfacePython.remoteExec">remoteExec</a></td>
 
122
<td>Public method to execute stmt in the current context of the debugged program.</td>
 
123
</tr><tr>
 
124
<td><a href="#DebuggerInterfacePython.remoteLoad">remoteLoad</a></td>
 
125
<td>Public method to load a new program to debug.</td>
 
126
</tr><tr>
 
127
<td><a href="#DebuggerInterfacePython.remoteProfile">remoteProfile</a></td>
 
128
<td>Public method to load a new program to collect profiling data.</td>
 
129
</tr><tr>
 
130
<td><a href="#DebuggerInterfacePython.remoteRawInput">remoteRawInput</a></td>
 
131
<td>Public method to send the raw input to the debugged program.</td>
 
132
</tr><tr>
 
133
<td><a href="#DebuggerInterfacePython.remoteRun">remoteRun</a></td>
 
134
<td>Public method to load a new program to run.</td>
 
135
</tr><tr>
 
136
<td><a href="#DebuggerInterfacePython.remoteStatement">remoteStatement</a></td>
 
137
<td>Public method to execute a Python statement.</td>
 
138
</tr><tr>
 
139
<td><a href="#DebuggerInterfacePython.remoteStep">remoteStep</a></td>
 
140
<td>Public method to single step the debugged program.</td>
 
141
</tr><tr>
 
142
<td><a href="#DebuggerInterfacePython.remoteStepOut">remoteStepOut</a></td>
 
143
<td>Public method to step out the debugged program.</td>
 
144
</tr><tr>
 
145
<td><a href="#DebuggerInterfacePython.remoteStepOver">remoteStepOver</a></td>
 
146
<td>Public method to step over the debugged program.</td>
 
147
</tr><tr>
 
148
<td><a href="#DebuggerInterfacePython.remoteStepQuit">remoteStepQuit</a></td>
 
149
<td>Public method to stop the debugged program.</td>
 
150
</tr><tr>
 
151
<td><a href="#DebuggerInterfacePython.remoteUTPrepare">remoteUTPrepare</a></td>
 
152
<td>Public method to prepare a new unittest run.</td>
 
153
</tr><tr>
 
154
<td><a href="#DebuggerInterfacePython.remoteUTRun">remoteUTRun</a></td>
 
155
<td>Public method to start a unittest run.</td>
 
156
</tr><tr>
 
157
<td><a href="#DebuggerInterfacePython.remoteUTStop">remoteUTStop</a></td>
 
158
<td>public method to stop a unittest run.</td>
 
159
</tr><tr>
 
160
<td><a href="#DebuggerInterfacePython.remoteWatchpoint">remoteWatchpoint</a></td>
 
161
<td>Public method to set or clear a watchpoint.</td>
 
162
</tr><tr>
 
163
<td><a href="#DebuggerInterfacePython.remoteWatchpointEnable">remoteWatchpointEnable</a></td>
 
164
<td>Public method to enable or disable a watchpoint.</td>
 
165
</tr><tr>
 
166
<td><a href="#DebuggerInterfacePython.remoteWatchpointIgnore">remoteWatchpointIgnore</a></td>
 
167
<td>Public method to ignore a watchpoint the next couple of occurences.</td>
 
168
</tr><tr>
 
169
<td><a href="#DebuggerInterfacePython.shutdown">shutdown</a></td>
 
170
<td>Public method to cleanly shut down.</td>
 
171
</tr><tr>
 
172
<td><a href="#DebuggerInterfacePython.startRemote">startRemote</a></td>
 
173
<td>Public method to start a remote Python interpreter.</td>
 
174
</tr><tr>
 
175
<td><a href="#DebuggerInterfacePython.startRemoteForProject">startRemoteForProject</a></td>
 
176
<td>Public method to start a remote Python interpreter for a project.</td>
 
177
</tr>
 
178
</table>
 
179
<p><a NAME="DebuggerInterfacePython.__init__" ID="DebuggerInterfacePython.__init__"></a>
 
180
<h4>DebuggerInterfacePython (Constructor)</h4>
 
181
<b>DebuggerInterfacePython</b>(<i>debugServer, passive</i>)
 
182
<p>
 
183
        Constructor
 
184
</p><dl>
 
185
<dt><i>debugServer</i></dt>
 
186
<dd>
 
187
reference to the debug server (DebugServer)
 
188
</dd><dt><i>passive</i></dt>
 
189
<dd>
 
190
flag indicating passive connection mode (boolean)
 
191
</dd>
 
192
</dl><a NAME="DebuggerInterfacePython.__identityTranslation" ID="DebuggerInterfacePython.__identityTranslation"></a>
 
193
<h4>DebuggerInterfacePython.__identityTranslation</h4>
 
194
<b>__identityTranslation</b>(<i>fn, remote2local = True</i>)
 
195
<p>
 
196
        Private method to perform the identity path translation.
 
197
</p><dl>
 
198
<dt><i>fn</i></dt>
 
199
<dd>
 
200
filename to be translated (string or QString)
 
201
</dd><dt><i>remote2local</i></dt>
 
202
<dd>
 
203
flag indicating the direction of translation
 
204
            (False = local to remote, True = remote to local [default])
 
205
</dd>
 
206
</dl><dl>
 
207
<dt>Returns:</dt>
 
208
<dd>
 
209
translated filename (string)
 
210
</dd>
 
211
</dl><a NAME="DebuggerInterfacePython.__parseClientLine" ID="DebuggerInterfacePython.__parseClientLine"></a>
 
212
<h4>DebuggerInterfacePython.__parseClientLine</h4>
 
213
<b>__parseClientLine</b>(<i></i>)
 
214
<p>
 
215
        Private method to handle data from the client.
 
216
</p><a NAME="DebuggerInterfacePython.__remoteTranslation" ID="DebuggerInterfacePython.__remoteTranslation"></a>
 
217
<h4>DebuggerInterfacePython.__remoteTranslation</h4>
 
218
<b>__remoteTranslation</b>(<i>fn, remote2local = True</i>)
 
219
<p>
 
220
        Private method to perform the path translation.
 
221
</p><dl>
 
222
<dt><i>fn</i></dt>
 
223
<dd>
 
224
filename to be translated (string or QString)
 
225
</dd><dt><i>remote2local</i></dt>
 
226
<dd>
 
227
flag indicating the direction of translation
 
228
            (False = local to remote, True = remote to local [default])
 
229
</dd>
 
230
</dl><dl>
 
231
<dt>Returns:</dt>
 
232
<dd>
 
233
translated filename (string)
 
234
</dd>
 
235
</dl><a NAME="DebuggerInterfacePython.__sendCommand" ID="DebuggerInterfacePython.__sendCommand"></a>
 
236
<h4>DebuggerInterfacePython.__sendCommand</h4>
 
237
<b>__sendCommand</b>(<i>cmd</i>)
 
238
<p>
 
239
        Private method to send a single line command to the client.
 
240
</p><dl>
 
241
<dt><i>cmd</i></dt>
 
242
<dd>
 
243
command to send to the debug client (string)
 
244
</dd>
 
245
</dl><a NAME="DebuggerInterfacePython.flush" ID="DebuggerInterfacePython.flush"></a>
 
246
<h4>DebuggerInterfacePython.flush</h4>
 
247
<b>flush</b>(<i></i>)
 
248
<p>
 
249
        Public slot to flush the queue.
 
250
</p><a NAME="DebuggerInterfacePython.getClientCapabilities" ID="DebuggerInterfacePython.getClientCapabilities"></a>
 
251
<h4>DebuggerInterfacePython.getClientCapabilities</h4>
 
252
<b>getClientCapabilities</b>(<i></i>)
 
253
<p>
 
254
        Public method to retrieve the debug clients capabilities.
 
255
</p><dl>
 
256
<dt>Returns:</dt>
 
257
<dd>
 
258
debug client capabilities (integer)
 
259
</dd>
 
260
</dl><a NAME="DebuggerInterfacePython.isConnected" ID="DebuggerInterfacePython.isConnected"></a>
 
261
<h4>DebuggerInterfacePython.isConnected</h4>
 
262
<b>isConnected</b>(<i></i>)
 
263
<p>
 
264
        Public method to test, if a debug client has connected.
 
265
</p><dl>
 
266
<dt>Returns:</dt>
 
267
<dd>
 
268
flag indicating the connection status (boolean)
 
269
</dd>
 
270
</dl><a NAME="DebuggerInterfacePython.newConnection" ID="DebuggerInterfacePython.newConnection"></a>
 
271
<h4>DebuggerInterfacePython.newConnection</h4>
 
272
<b>newConnection</b>(<i>sock</i>)
 
273
<p>
 
274
        Public slot to handle a new connection.
 
275
</p><dl>
 
276
<dt><i>sockreference</i></dt>
 
277
<dd>
 
278
to the socket object (QTcpSocket)
 
279
</dd>
 
280
</dl><dl>
 
281
<dt>Returns:</dt>
 
282
<dd>
 
283
flag indicating success (boolean)
 
284
</dd>
 
285
</dl><a NAME="DebuggerInterfacePython.remoteBanner" ID="DebuggerInterfacePython.remoteBanner"></a>
 
286
<h4>DebuggerInterfacePython.remoteBanner</h4>
 
287
<b>remoteBanner</b>(<i></i>)
 
288
<p>
 
289
        Public slot to get the banner info of the remote client.
 
290
</p><a NAME="DebuggerInterfacePython.remoteBreakpoint" ID="DebuggerInterfacePython.remoteBreakpoint"></a>
 
291
<h4>DebuggerInterfacePython.remoteBreakpoint</h4>
 
292
<b>remoteBreakpoint</b>(<i>fn, line, set, cond = None, temp = False</i>)
 
293
<p>
 
294
        Public method to set or clear a breakpoint.
 
295
</p><dl>
 
296
<dt><i>fn</i></dt>
 
297
<dd>
 
298
filename the breakpoint belongs to (string)
 
299
</dd><dt><i>line</i></dt>
 
300
<dd>
 
301
linenumber of the breakpoint (int)
 
302
</dd><dt><i>set</i></dt>
 
303
<dd>
 
304
flag indicating setting or resetting a breakpoint (boolean)
 
305
</dd><dt><i>cond</i></dt>
 
306
<dd>
 
307
condition of the breakpoint (string)
 
308
</dd><dt><i>temp</i></dt>
 
309
<dd>
 
310
flag indicating a temporary breakpoint (boolean)
 
311
</dd>
 
312
</dl><a NAME="DebuggerInterfacePython.remoteBreakpointEnable" ID="DebuggerInterfacePython.remoteBreakpointEnable"></a>
 
313
<h4>DebuggerInterfacePython.remoteBreakpointEnable</h4>
 
314
<b>remoteBreakpointEnable</b>(<i>fn, line, enable</i>)
 
315
<p>
 
316
        Public method to enable or disable a breakpoint.
 
317
</p><dl>
 
318
<dt><i>fn</i></dt>
 
319
<dd>
 
320
filename the breakpoint belongs to (string)
 
321
</dd><dt><i>line</i></dt>
 
322
<dd>
 
323
linenumber of the breakpoint (int)
 
324
</dd><dt><i>enable</i></dt>
 
325
<dd>
 
326
flag indicating enabling or disabling a breakpoint (boolean)
 
327
</dd>
 
328
</dl><a NAME="DebuggerInterfacePython.remoteBreakpointIgnore" ID="DebuggerInterfacePython.remoteBreakpointIgnore"></a>
 
329
<h4>DebuggerInterfacePython.remoteBreakpointIgnore</h4>
 
330
<b>remoteBreakpointIgnore</b>(<i>fn, line, count</i>)
 
331
<p>
 
332
        Public method to ignore a breakpoint the next couple of occurences.
 
333
</p><dl>
 
334
<dt><i>fn</i></dt>
 
335
<dd>
 
336
filename the breakpoint belongs to (string)
 
337
</dd><dt><i>line</i></dt>
 
338
<dd>
 
339
linenumber of the breakpoint (int)
 
340
</dd><dt><i>count</i></dt>
 
341
<dd>
 
342
number of occurences to ignore (int)
 
343
</dd>
 
344
</dl><a NAME="DebuggerInterfacePython.remoteCapabilities" ID="DebuggerInterfacePython.remoteCapabilities"></a>
 
345
<h4>DebuggerInterfacePython.remoteCapabilities</h4>
 
346
<b>remoteCapabilities</b>(<i></i>)
 
347
<p>
 
348
        Public slot to get the debug clients capabilities.
 
349
</p><a NAME="DebuggerInterfacePython.remoteClientSetFilter" ID="DebuggerInterfacePython.remoteClientSetFilter"></a>
 
350
<h4>DebuggerInterfacePython.remoteClientSetFilter</h4>
 
351
<b>remoteClientSetFilter</b>(<i>scope, filter</i>)
 
352
<p>
 
353
        Public method to set a variables filter list.
 
354
</p><dl>
 
355
<dt><i>scope</i></dt>
 
356
<dd>
 
357
the scope of the variables (0 = local, 1 = global)
 
358
</dd><dt><i>filter</i></dt>
 
359
<dd>
 
360
regexp string for variable names to filter out (string)
 
361
</dd>
 
362
</dl><a NAME="DebuggerInterfacePython.remoteClientVariable" ID="DebuggerInterfacePython.remoteClientVariable"></a>
 
363
<h4>DebuggerInterfacePython.remoteClientVariable</h4>
 
364
<b>remoteClientVariable</b>(<i>scope, filter, var, framenr = 0</i>)
 
365
<p>
 
366
        Public method to request the variables of the debugged program.
 
367
</p><dl>
 
368
<dt><i>scope</i></dt>
 
369
<dd>
 
370
the scope of the variables (0 = local, 1 = global)
 
371
</dd><dt><i>filter</i></dt>
 
372
<dd>
 
373
list of variable types to filter out (list of int)
 
374
</dd><dt><i>var</i></dt>
 
375
<dd>
 
376
list encoded name of variable to retrieve (string)
 
377
</dd><dt><i>framenr</i></dt>
 
378
<dd>
 
379
framenumber of the variables to retrieve (int)
 
380
</dd>
 
381
</dl><a NAME="DebuggerInterfacePython.remoteClientVariables" ID="DebuggerInterfacePython.remoteClientVariables"></a>
 
382
<h4>DebuggerInterfacePython.remoteClientVariables</h4>
 
383
<b>remoteClientVariables</b>(<i>scope, filter, framenr = 0</i>)
 
384
<p>
 
385
        Public method to request the variables of the debugged program.
 
386
</p><dl>
 
387
<dt><i>scope</i></dt>
 
388
<dd>
 
389
the scope of the variables (0 = local, 1 = global)
 
390
</dd><dt><i>filter</i></dt>
 
391
<dd>
 
392
list of variable types to filter out (list of int)
 
393
</dd><dt><i>framenr</i></dt>
 
394
<dd>
 
395
framenumber of the variables to retrieve (int)
 
396
</dd>
 
397
</dl><a NAME="DebuggerInterfacePython.remoteCompletion" ID="DebuggerInterfacePython.remoteCompletion"></a>
 
398
<h4>DebuggerInterfacePython.remoteCompletion</h4>
 
399
<b>remoteCompletion</b>(<i>text</i>)
 
400
<p>
 
401
        Public slot to get the a list of possible commandline completions
 
402
        from the remote client.
 
403
</p><dl>
 
404
<dt><i>text</i></dt>
 
405
<dd>
 
406
the text to be completed (string or QString)
 
407
</dd>
 
408
</dl><a NAME="DebuggerInterfacePython.remoteContinue" ID="DebuggerInterfacePython.remoteContinue"></a>
 
409
<h4>DebuggerInterfacePython.remoteContinue</h4>
 
410
<b>remoteContinue</b>(<i>special = False</i>)
 
411
<p>
 
412
        Public method to continue the debugged program.
 
413
</p><dl>
 
414
<dt><i>special</i></dt>
 
415
<dd>
 
416
flag indicating a special continue operation
 
417
</dd>
 
418
</dl><a NAME="DebuggerInterfacePython.remoteCoverage" ID="DebuggerInterfacePython.remoteCoverage"></a>
 
419
<h4>DebuggerInterfacePython.remoteCoverage</h4>
 
420
<b>remoteCoverage</b>(<i>fn, argv, wd, erase = False, exclude = ""</i>)
 
421
<p>
 
422
        Public method to load a new program to collect coverage data.
 
423
</p><dl>
 
424
<dt><i>fn</i></dt>
 
425
<dd>
 
426
the filename to run (string)
 
427
</dd><dt><i>argv</i></dt>
 
428
<dd>
 
429
the commandline arguments to pass to the program (string or QString)
 
430
</dd><dt><i>wd</i></dt>
 
431
<dd>
 
432
the working directory for the program (string)
 
433
</dd><dt><i>erase=</i></dt>
 
434
<dd>
 
435
flag indicating that coverage info should be
 
436
            cleared first (boolean)
 
437
</dd><dt><i>exclude=</i></dt>
 
438
<dd>
 
439
searchpattern marking line to exclude from coverage
 
440
</dd>
 
441
</dl><a NAME="DebuggerInterfacePython.remoteCyclops" ID="DebuggerInterfacePython.remoteCyclops"></a>
 
442
<h4>DebuggerInterfacePython.remoteCyclops</h4>
 
443
<b>remoteCyclops</b>(<i>fn, argv, wd, modfunc, reports</i>)
 
444
<p>
 
445
        Public method to load a new program to collect profiling data.
 
446
</p><dl>
 
447
<dt><i>fn</i></dt>
 
448
<dd>
 
449
the filename to run (string)
 
450
</dd><dt><i>argv</i></dt>
 
451
<dd>
 
452
the commandline arguments to pass to the program (string or QString)
 
453
</dd><dt><i>wd</i></dt>
 
454
<dd>
 
455
the working directory for the program (string)
 
456
</dd><dt><i>modfunc</i></dt>
 
457
<dd>
 
458
name of a module function which is the main
 
459
            entry point (string)
 
460
</dd><dt><i>reports</i></dt>
 
461
<dd>
 
462
bit mask specifying the reports wanted (integer)
 
463
</dd>
 
464
</dl><a NAME="DebuggerInterfacePython.remoteEnvironment" ID="DebuggerInterfacePython.remoteEnvironment"></a>
 
465
<h4>DebuggerInterfacePython.remoteEnvironment</h4>
 
466
<b>remoteEnvironment</b>(<i>env</i>)
 
467
<p>
 
468
        Public method to set the environment for a program to debug, run, ...
 
469
</p><dl>
 
470
<dt><i>env</i></dt>
 
471
<dd>
 
472
environment settings (dictionary)
 
473
</dd>
 
474
</dl><a NAME="DebuggerInterfacePython.remoteEval" ID="DebuggerInterfacePython.remoteEval"></a>
 
475
<h4>DebuggerInterfacePython.remoteEval</h4>
 
476
<b>remoteEval</b>(<i>arg</i>)
 
477
<p>
 
478
        Public method to evaluate arg in the current context of the debugged program.
 
479
</p><dl>
 
480
<dt><i>arg</i></dt>
 
481
<dd>
 
482
the arguments to evaluate (string)
 
483
</dd>
 
484
</dl><a NAME="DebuggerInterfacePython.remoteExec" ID="DebuggerInterfacePython.remoteExec"></a>
 
485
<h4>DebuggerInterfacePython.remoteExec</h4>
 
486
<b>remoteExec</b>(<i>stmt</i>)
 
487
<p>
 
488
        Public method to execute stmt in the current context of the debugged program.
 
489
</p><dl>
 
490
<dt><i>stmt</i></dt>
 
491
<dd>
 
492
statement to execute (string)
 
493
</dd>
 
494
</dl><a NAME="DebuggerInterfacePython.remoteLoad" ID="DebuggerInterfacePython.remoteLoad"></a>
 
495
<h4>DebuggerInterfacePython.remoteLoad</h4>
 
496
<b>remoteLoad</b>(<i>fn, argv, wd, traceInterpreter = False, autoContinue = True</i>)
 
497
<p>
 
498
        Public method to load a new program to debug.
 
499
</p><dl>
 
500
<dt><i>fn</i></dt>
 
501
<dd>
 
502
the filename to debug (string)
 
503
</dd><dt><i>argv</i></dt>
 
504
<dd>
 
505
the commandline arguments to pass to the program (string or QString)
 
506
</dd><dt><i>wd</i></dt>
 
507
<dd>
 
508
the working directory for the program (string)
 
509
</dd><dt><i>traceInterpreter=</i></dt>
 
510
<dd>
 
511
flag indicating if the interpreter library should be
 
512
            traced as well (boolean)
 
513
</dd><dt><i>autoContinue=</i></dt>
 
514
<dd>
 
515
flag indicating, that the debugger should not stop
 
516
            at the first executable line (boolean)
 
517
</dd>
 
518
</dl><a NAME="DebuggerInterfacePython.remoteProfile" ID="DebuggerInterfacePython.remoteProfile"></a>
 
519
<h4>DebuggerInterfacePython.remoteProfile</h4>
 
520
<b>remoteProfile</b>(<i>fn, argv, wd, erase = False</i>)
 
521
<p>
 
522
        Public method to load a new program to collect profiling data.
 
523
</p><dl>
 
524
<dt><i>fn</i></dt>
 
525
<dd>
 
526
the filename to run (string)
 
527
</dd><dt><i>argv</i></dt>
 
528
<dd>
 
529
the commandline arguments to pass to the program (string or QString)
 
530
</dd><dt><i>wd</i></dt>
 
531
<dd>
 
532
the working directory for the program (string)
 
533
</dd><dt><i>erase=</i></dt>
 
534
<dd>
 
535
flag indicating that timing info should be cleared first (boolean)
 
536
</dd>
 
537
</dl><a NAME="DebuggerInterfacePython.remoteRawInput" ID="DebuggerInterfacePython.remoteRawInput"></a>
 
538
<h4>DebuggerInterfacePython.remoteRawInput</h4>
 
539
<b>remoteRawInput</b>(<i>s</i>)
 
540
<p>
 
541
        Public method to send the raw input to the debugged program.
 
542
</p><dl>
 
543
<dt><i>s</i></dt>
 
544
<dd>
 
545
the raw input (string)
 
546
</dd>
 
547
</dl><a NAME="DebuggerInterfacePython.remoteRun" ID="DebuggerInterfacePython.remoteRun"></a>
 
548
<h4>DebuggerInterfacePython.remoteRun</h4>
 
549
<b>remoteRun</b>(<i>fn, argv, wd</i>)
 
550
<p>
 
551
        Public method to load a new program to run.
 
552
</p><dl>
 
553
<dt><i>fn</i></dt>
 
554
<dd>
 
555
the filename to run (string)
 
556
</dd><dt><i>argv</i></dt>
 
557
<dd>
 
558
the commandline arguments to pass to the program (string or QString)
 
559
</dd><dt><i>wd</i></dt>
 
560
<dd>
 
561
the working directory for the program (string)
 
562
</dd>
 
563
</dl><a NAME="DebuggerInterfacePython.remoteStatement" ID="DebuggerInterfacePython.remoteStatement"></a>
 
564
<h4>DebuggerInterfacePython.remoteStatement</h4>
 
565
<b>remoteStatement</b>(<i>stmt</i>)
 
566
<p>
 
567
        Public method to execute a Python statement.  
 
568
</p><dl>
 
569
<dt><i>stmt</i></dt>
 
570
<dd>
 
571
the Python statement to execute (string). It
 
572
              should not have a trailing newline.
 
573
</dd>
 
574
</dl><a NAME="DebuggerInterfacePython.remoteStep" ID="DebuggerInterfacePython.remoteStep"></a>
 
575
<h4>DebuggerInterfacePython.remoteStep</h4>
 
576
<b>remoteStep</b>(<i></i>)
 
577
<p>
 
578
        Public method to single step the debugged program.
 
579
</p><a NAME="DebuggerInterfacePython.remoteStepOut" ID="DebuggerInterfacePython.remoteStepOut"></a>
 
580
<h4>DebuggerInterfacePython.remoteStepOut</h4>
 
581
<b>remoteStepOut</b>(<i></i>)
 
582
<p>
 
583
        Public method to step out the debugged program.
 
584
</p><a NAME="DebuggerInterfacePython.remoteStepOver" ID="DebuggerInterfacePython.remoteStepOver"></a>
 
585
<h4>DebuggerInterfacePython.remoteStepOver</h4>
 
586
<b>remoteStepOver</b>(<i></i>)
 
587
<p>
 
588
        Public method to step over the debugged program.
 
589
</p><a NAME="DebuggerInterfacePython.remoteStepQuit" ID="DebuggerInterfacePython.remoteStepQuit"></a>
 
590
<h4>DebuggerInterfacePython.remoteStepQuit</h4>
 
591
<b>remoteStepQuit</b>(<i></i>)
 
592
<p>
 
593
        Public method to stop the debugged program.
 
594
</p><a NAME="DebuggerInterfacePython.remoteUTPrepare" ID="DebuggerInterfacePython.remoteUTPrepare"></a>
 
595
<h4>DebuggerInterfacePython.remoteUTPrepare</h4>
 
596
<b>remoteUTPrepare</b>(<i>fn, tn, tfn, cov, covname, coverase</i>)
 
597
<p>
 
598
        Public method to prepare a new unittest run.
 
599
</p><dl>
 
600
<dt><i>fn</i></dt>
 
601
<dd>
 
602
the filename to load (string)
 
603
</dd><dt><i>tn</i></dt>
 
604
<dd>
 
605
the testname to load (string)
 
606
</dd><dt><i>tfn</i></dt>
 
607
<dd>
 
608
the test function name to load tests from (string)
 
609
</dd><dt><i>cov</i></dt>
 
610
<dd>
 
611
flag indicating collection of coverage data is requested
 
612
</dd><dt><i>covname</i></dt>
 
613
<dd>
 
614
filename to be used to assemble the coverage caches
 
615
                filename
 
616
</dd><dt><i>coverase</i></dt>
 
617
<dd>
 
618
flag indicating erasure of coverage data is requested
 
619
</dd>
 
620
</dl><a NAME="DebuggerInterfacePython.remoteUTRun" ID="DebuggerInterfacePython.remoteUTRun"></a>
 
621
<h4>DebuggerInterfacePython.remoteUTRun</h4>
 
622
<b>remoteUTRun</b>(<i></i>)
 
623
<p>
 
624
        Public method to start a unittest run.
 
625
</p><a NAME="DebuggerInterfacePython.remoteUTStop" ID="DebuggerInterfacePython.remoteUTStop"></a>
 
626
<h4>DebuggerInterfacePython.remoteUTStop</h4>
 
627
<b>remoteUTStop</b>(<i></i>)
 
628
<p>
 
629
        public method to stop a unittest run.
 
630
</p><a NAME="DebuggerInterfacePython.remoteWatchpoint" ID="DebuggerInterfacePython.remoteWatchpoint"></a>
 
631
<h4>DebuggerInterfacePython.remoteWatchpoint</h4>
 
632
<b>remoteWatchpoint</b>(<i>cond, set, temp = False</i>)
 
633
<p>
 
634
        Public method to set or clear a watchpoint.
 
635
</p><dl>
 
636
<dt><i>cond</i></dt>
 
637
<dd>
 
638
condition of the watchpoint (string)
 
639
</dd><dt><i>set</i></dt>
 
640
<dd>
 
641
flag indicating setting or resetting a watchpoint (boolean)
 
642
</dd><dt><i>temp</i></dt>
 
643
<dd>
 
644
flag indicating a temporary watchpoint (boolean)
 
645
</dd>
 
646
</dl><a NAME="DebuggerInterfacePython.remoteWatchpointEnable" ID="DebuggerInterfacePython.remoteWatchpointEnable"></a>
 
647
<h4>DebuggerInterfacePython.remoteWatchpointEnable</h4>
 
648
<b>remoteWatchpointEnable</b>(<i>cond, enable</i>)
 
649
<p>
 
650
        Public method to enable or disable a watchpoint.
 
651
</p><dl>
 
652
<dt><i>cond</i></dt>
 
653
<dd>
 
654
condition of the watchpoint (string)
 
655
</dd><dt><i>enable</i></dt>
 
656
<dd>
 
657
flag indicating enabling or disabling a watchpoint (boolean)
 
658
</dd>
 
659
</dl><a NAME="DebuggerInterfacePython.remoteWatchpointIgnore" ID="DebuggerInterfacePython.remoteWatchpointIgnore"></a>
 
660
<h4>DebuggerInterfacePython.remoteWatchpointIgnore</h4>
 
661
<b>remoteWatchpointIgnore</b>(<i>cond, count</i>)
 
662
<p>
 
663
        Public method to ignore a watchpoint the next couple of occurences.
 
664
</p><dl>
 
665
<dt><i>cond</i></dt>
 
666
<dd>
 
667
condition of the watchpoint (string)
 
668
</dd><dt><i>count</i></dt>
 
669
<dd>
 
670
number of occurences to ignore (int)
 
671
</dd>
 
672
</dl><a NAME="DebuggerInterfacePython.shutdown" ID="DebuggerInterfacePython.shutdown"></a>
 
673
<h4>DebuggerInterfacePython.shutdown</h4>
 
674
<b>shutdown</b>(<i></i>)
 
675
<p>
 
676
        Public method to cleanly shut down.
 
677
</p><p>
 
678
        It closes our socket and shuts down
 
679
        the debug client. (Needed on Win OS)
 
680
</p><a NAME="DebuggerInterfacePython.startRemote" ID="DebuggerInterfacePython.startRemote"></a>
 
681
<h4>DebuggerInterfacePython.startRemote</h4>
 
682
<b>startRemote</b>(<i>port</i>)
 
683
<p>
 
684
        Public method to start a remote Python interpreter.
 
685
</p><dl>
 
686
<dt><i>port</i></dt>
 
687
<dd>
 
688
portnumber the debug server is listening on (integer)
 
689
</dd>
 
690
</dl><dl>
 
691
<dt>Returns:</dt>
 
692
<dd>
 
693
pid of the client process (integer) and a flag to indicate
 
694
            a network connection (boolean)
 
695
</dd>
 
696
</dl><a NAME="DebuggerInterfacePython.startRemoteForProject" ID="DebuggerInterfacePython.startRemoteForProject"></a>
 
697
<h4>DebuggerInterfacePython.startRemoteForProject</h4>
 
698
<b>startRemoteForProject</b>(<i>port</i>)
 
699
<p>
 
700
        Public method to start a remote Python interpreter for a project.
 
701
</p><dl>
 
702
<dt><i>port</i></dt>
 
703
<dd>
 
704
portnumber the debug server is listening on (integer)
 
705
</dd>
 
706
</dl><dl>
 
707
<dt>Returns:</dt>
 
708
<dd>
 
709
pid of the client process (integer) and a flag to indicate
 
710
            a network connection (boolean)
 
711
</dd>
 
712
</dl></p>
 
713
<div align="right"><a href="#top">Up</a></div>
 
714
<hr /><hr />
 
715
<a NAME="getRegistryData" ID="getRegistryData"></a>
 
716
<h2>getRegistryData</h2>
 
717
<b>getRegistryData</b>(<i></i>)
 
718
<p>
 
719
    Module functionto get characterising data for the debugger interface.
 
720
</p><dl>
 
721
<dt>Returns:</dt>
 
722
<dd>
 
723
list of the followinf data. Client type (string), client
 
724
        capabilities (integer), client type association (list of strings)
 
725
</dd>
 
726
</dl>
 
727
<div align="right"><a href="#top">Up</a></div>
 
728
<hr />
 
729
</body></html>
 
 
b'\\ No newline at end of file'