62 </dd> |
62 </dd> |
63 <dt>callTraceInfo</dt> |
63 <dt>callTraceInfo</dt> |
64 <dd> |
64 <dd> |
65 emitted after the client reported the call trace |
65 emitted after the client reported the call trace |
66 data (isCall, fromFile, fromLine, fromFunction, toFile, toLine, |
66 data (isCall, fromFile, fromLine, fromFunction, toFile, toLine, |
67 toFunction) |
67 toFunction, debuggerId) |
68 </dd> |
68 </dd> |
69 <dt>clientBanner(version, platform, dbgclient, venvname)</dt> |
69 <dt>clientBanner(version, platform, venvname)</dt> |
70 <dd> |
70 <dd> |
71 emitted after |
71 emitted after |
72 the client banner data was received |
72 the client banner data was received |
73 </dd> |
73 </dd> |
74 <dt>clientBreakConditionError(fn, lineno)</dt> |
74 <dt>clientBreakConditionError(fn, lineno, debuggerId)</dt> |
75 <dd> |
75 <dd> |
76 emitted after the client has |
76 emitted after the |
77 signaled a syntax error in a breakpoint condition |
77 client has signaled a syntax error in a breakpoint condition |
78 </dd> |
78 </dd> |
79 <dt>clientCapabilities(capabilities, cltype, venvname)</dt> |
79 <dt>clientCapabilities(capabilities, cltype, venvname)</dt> |
80 <dd> |
80 <dd> |
81 emitted after |
81 emitted after |
82 the clients capabilities were received |
82 the clients capabilities were received |
83 </dd> |
83 </dd> |
84 <dt>clientClearBreak(filename, lineno)</dt> |
84 <dt>clientClearBreak(filename, lineno, debuggerId)</dt> |
85 <dd> |
85 <dd> |
86 emitted after the debug client |
86 emitted after the |
87 has decided to clear a temporary breakpoint |
87 debug client has decided to clear a temporary breakpoint |
88 </dd> |
88 </dd> |
89 <dt>clientClearWatch(condition)</dt> |
89 <dt>clientClearWatch(condition, debuggerId)</dt> |
90 <dd> |
90 <dd> |
91 emitted after the debug client |
91 emitted after the debug |
92 has decided to clear a temporary watch expression |
92 client has decided to clear a temporary watch expression |
93 </dd> |
93 </dd> |
94 <dt>clientCompletionList(completionList, text)</dt> |
94 <dt>clientCompletionList(completionList, text, debuggerId)</dt> |
|
95 <dd> |
|
96 emitted |
|
97 after the client the commandline completion list and the reworked |
|
98 search string was received from the client |
|
99 </dd> |
|
100 <dt>clientDebuggerId(debuggerId)</dt> |
|
101 <dd> |
|
102 emitted to indicate a newly connected |
|
103 debugger backend |
|
104 </dd> |
|
105 <dt>clientDisassembly(disassembly, debuggerId)</dt> |
95 <dd> |
106 <dd> |
96 emitted after the client |
107 emitted after the client |
97 the commandline completion list and the reworked searchstring was |
108 has sent a disassembly of the code raising an exception |
98 received from the client |
109 </dd> |
99 </dd> |
110 <dt>clientException(exceptionType, exceptionMessage, stackTrace, debuggerId)</dt> |
100 <dt>clientDisassembly(disassembly)</dt> |
111 <dd> |
101 <dd> |
112 emitted after an exception occured on the client side |
102 emitted after the client has sent |
113 </dd> |
103 a disassembly of the code raising an exception |
114 <dt>clientExit(str, int, str, bool, str)</dt> |
104 </dd> |
115 <dd> |
105 <dt>clientException(exception)</dt> |
116 emitted after the client has |
106 <dd> |
117 exited giving the program name, the exit status, an exit message, an |
107 emitted after an exception occured on |
118 indication to be quiet and the ID of the exited client |
108 the client side |
|
109 </dd> |
|
110 <dt>clientExit(int, str, bool)</dt> |
|
111 <dd> |
|
112 emitted after the client has exited |
|
113 giving the exit status, an exit message and an indication to be quiet |
|
114 </dd> |
119 </dd> |
115 <dt>clientGone(bool)</dt> |
120 <dt>clientGone(bool)</dt> |
116 <dd> |
121 <dd> |
117 emitted if the client went away (planned or |
122 emitted if the client went away (planned or |
118 unplanned) |
123 unplanned) |
139 <dt>clientProcessStdout(str)</dt> |
144 <dt>clientProcessStdout(str)</dt> |
140 <dd> |
145 <dd> |
141 emitted after the client has sent some |
146 emitted after the client has sent some |
142 output via stdout |
147 output via stdout |
143 </dd> |
148 </dd> |
144 <dt>clientRawInput(prompt, echo)</dt> |
149 <dt>clientRawInput(prompt, echo, debuggerId)</dt> |
145 <dd> |
150 <dd> |
146 emitted after a raw input request was |
151 emitted after a raw input |
147 received |
152 request was received |
148 </dd> |
153 </dd> |
149 <dt>clientRawInputSent()</dt> |
154 <dt>clientRawInputSent(debuggerId)</dt> |
150 <dd> |
155 <dd> |
151 emitted after the data was sent to the |
156 emitted after the data was sent |
152 debug client |
157 to the indicated debug client |
153 </dd> |
158 </dd> |
154 <dt>clientSignal(signal)</dt> |
159 <dt>clientSignal(message, filename, linenumber, function name, function arguments, debuggerId)</dt> |
155 <dd> |
160 <dd> |
156 emitted after a signal has been generated on |
161 emitted after a signal has been |
157 the client side |
162 generated on the client side |
158 </dd> |
163 </dd> |
159 <dt>clientStack(stack)</dt> |
164 <dt>clientStack(stack, debuggerId)</dt> |
160 <dd> |
165 <dd> |
161 emitted after the debug client has executed a |
166 emitted after the debug client has |
162 line of code |
167 executed a line of code |
163 </dd> |
168 </dd> |
164 <dt>clientStatement(bool)</dt> |
169 <dt>clientStatement(continue, debuggerId)</dt> |
165 <dd> |
170 <dd> |
166 emitted after an interactive command has |
171 emitted after an interactive |
167 been executed. The parameter is 0 to indicate that the command is |
172 command has been executed. The parameter is False to indicate that the |
168 complete and 1 if it needs more input. |
173 command is complete and True if it needs more input. |
169 </dd> |
174 </dd> |
170 <dt>clientSyntaxError(exception)</dt> |
175 <dt>clientSyntaxError(message, filename, linenumber, characternumber, debuggerId)</dt> |
171 <dd> |
176 <dd> |
172 emitted after a syntax error has been |
177 emitted after a syntax error has been detected on the |
173 detected on the client side |
178 client side |
174 </dd> |
179 </dd> |
175 <dt>clientThreadList(currentId, threadList)</dt> |
180 <dt>clientThreadList(currentId, threadList, debuggerId)</dt> |
176 <dd> |
181 <dd> |
177 emitted after a thread list |
182 emitted after |
178 has been received |
183 a thread list has been received |
179 </dd> |
184 </dd> |
180 <dt>clientThreadSet()</dt> |
185 <dt>clientThreadSet(debuggerId)</dt> |
181 <dd> |
|
182 emitted after the client has acknowledged the |
|
183 change of the current thread |
|
184 </dd> |
|
185 <dt>clientVariable(scope, variables)</dt> |
|
186 <dd> |
|
187 emitted after a dump for one class |
|
188 variable has been received |
|
189 </dd> |
|
190 <dt>clientVariables(scope, variables)</dt> |
|
191 <dd> |
|
192 emitted after a variables dump |
|
193 has been received |
|
194 </dd> |
|
195 <dt>clientWatchConditionError(condition)</dt> |
|
196 <dd> |
186 <dd> |
197 emitted after the client has |
187 emitted after the client has |
198 signaled a syntax error in a watch expression |
188 acknowledged the change of the current thread |
|
189 </dd> |
|
190 <dt>clientVariable(scope, variables, debuggerId)</dt> |
|
191 <dd> |
|
192 emitted after a dump |
|
193 for one class variable has been received |
|
194 </dd> |
|
195 <dt>clientVariables(scope, variables, debuggerId)</dt> |
|
196 <dd> |
|
197 emitted after a |
|
198 variables dump has been received |
|
199 </dd> |
|
200 <dt>clientWatchConditionError(condition, debuggerId)</dt> |
|
201 <dd> |
|
202 emitted after the |
|
203 client has signaled a syntax error in a watch expression |
|
204 </dd> |
|
205 <dt>lastClientExited()</dt> |
|
206 <dd> |
|
207 emitted to indicate that the last connected |
|
208 debug client has terminated |
199 </dd> |
209 </dd> |
200 <dt>passiveDebugStarted(str, bool)</dt> |
210 <dt>passiveDebugStarted(str, bool)</dt> |
201 <dd> |
211 <dd> |
202 emitted after the debug client has |
212 emitted after the debug client has |
203 connected in passive debug mode |
213 connected in passive debug mode |
722 setting |
760 setting |
723 </dd> |
761 </dd> |
724 </dl> |
762 </dl> |
725 <a NAME="DebugServer.__addBreakPoints" ID="DebugServer.__addBreakPoints"></a> |
763 <a NAME="DebugServer.__addBreakPoints" ID="DebugServer.__addBreakPoints"></a> |
726 <h4>DebugServer.__addBreakPoints</h4> |
764 <h4>DebugServer.__addBreakPoints</h4> |
727 <b>__addBreakPoints</b>(<i>parentIndex, start, end</i>) |
765 <b>__addBreakPoints</b>(<i>parentIndex, start, end, debuggerId=""</i>) |
728 |
766 |
729 <p> |
767 <p> |
730 Private slot to add breakpoints. |
768 Private slot to add breakpoints. |
731 </p> |
769 </p> |
732 <dl> |
770 <dl> |
733 |
771 |
734 <dt><i>parentIndex</i></dt> |
772 <dt><i>parentIndex</i> (QModelIndex)</dt> |
735 <dd> |
773 <dd> |
736 index of parent item (QModelIndex) |
774 index of parent item |
737 </dd> |
775 </dd> |
738 <dt><i>start</i></dt> |
776 <dt><i>start</i> (int)</dt> |
739 <dd> |
777 <dd> |
740 start row (integer) |
778 start row |
741 </dd> |
779 </dd> |
742 <dt><i>end</i></dt> |
780 <dt><i>end</i> (int)</dt> |
743 <dd> |
781 <dd> |
744 end row (integer) |
782 end row |
|
783 </dd> |
|
784 <dt><i>debuggerId</i> (str)</dt> |
|
785 <dd> |
|
786 ID of the debugger backend to send to. If this is |
|
787 empty, they will be broadcast to all connected backends. |
745 </dd> |
788 </dd> |
746 </dl> |
789 </dl> |
747 <a NAME="DebugServer.__addWatchPoints" ID="DebugServer.__addWatchPoints"></a> |
790 <a NAME="DebugServer.__addWatchPoints" ID="DebugServer.__addWatchPoints"></a> |
748 <h4>DebugServer.__addWatchPoints</h4> |
791 <h4>DebugServer.__addWatchPoints</h4> |
749 <b>__addWatchPoints</b>(<i>parentIndex, start, end</i>) |
792 <b>__addWatchPoints</b>(<i>parentIndex, start, end, debuggerId=""</i>) |
750 |
793 |
751 <p> |
794 <p> |
752 Private slot to set a watch expression. |
795 Private slot to set a watch expression. |
753 </p> |
796 </p> |
754 <dl> |
797 <dl> |
755 |
798 |
756 <dt><i>parentIndex</i></dt> |
799 <dt><i>parentIndex</i> (QModelIndex)</dt> |
757 <dd> |
800 <dd> |
758 index of parent item (QModelIndex) |
801 index of parent item |
759 </dd> |
802 </dd> |
760 <dt><i>start</i></dt> |
803 <dt><i>start</i> (int)</dt> |
761 <dd> |
804 <dd> |
762 start row (integer) |
805 start row |
763 </dd> |
806 </dd> |
764 <dt><i>end</i></dt> |
807 <dt><i>end</i> (int)</dt> |
765 <dd> |
808 <dd> |
766 end row (integer) |
809 end row |
|
810 </dd> |
|
811 <dt><i>debuggerId</i> (str)</dt> |
|
812 <dd> |
|
813 ID of the debugger backend to send to. If this is |
|
814 empty, they will be broadcast to all connected backends. |
767 </dd> |
815 </dd> |
768 </dl> |
816 </dl> |
769 <a NAME="DebugServer.__breakPointDataAboutToBeChanged" ID="DebugServer.__breakPointDataAboutToBeChanged"></a> |
817 <a NAME="DebugServer.__breakPointDataAboutToBeChanged" ID="DebugServer.__breakPointDataAboutToBeChanged"></a> |
770 <h4>DebugServer.__breakPointDataAboutToBeChanged</h4> |
818 <h4>DebugServer.__breakPointDataAboutToBeChanged</h4> |
771 <b>__breakPointDataAboutToBeChanged</b>(<i>startIndex, endIndex</i>) |
819 <b>__breakPointDataAboutToBeChanged</b>(<i>startIndex, endIndex</i>) |
1017 <p> |
1077 <p> |
1018 Private method to register the available internal debugger interfaces. |
1078 Private method to register the available internal debugger interfaces. |
1019 </p> |
1079 </p> |
1020 <a NAME="DebugServer.__remoteBreakpointEnable" ID="DebugServer.__remoteBreakpointEnable"></a> |
1080 <a NAME="DebugServer.__remoteBreakpointEnable" ID="DebugServer.__remoteBreakpointEnable"></a> |
1021 <h4>DebugServer.__remoteBreakpointEnable</h4> |
1081 <h4>DebugServer.__remoteBreakpointEnable</h4> |
1022 <b>__remoteBreakpointEnable</b>(<i>fn, line, enable</i>) |
1082 <b>__remoteBreakpointEnable</b>(<i>debuggerId, fn, line, enable</i>) |
1023 |
1083 |
1024 <p> |
1084 <p> |
1025 Private method to enable or disable a breakpoint. |
1085 Private method to enable or disable a breakpoint. |
1026 </p> |
1086 </p> |
1027 <dl> |
1087 <dl> |
1028 |
1088 |
1029 <dt><i>fn</i></dt> |
1089 <dt><i>debuggerId</i> (str)</dt> |
1030 <dd> |
1090 <dd> |
1031 filename the breakpoint belongs to (string) |
1091 ID of the debugger backend |
1032 </dd> |
1092 </dd> |
1033 <dt><i>line</i></dt> |
1093 <dt><i>fn</i> (str)</dt> |
1034 <dd> |
1094 <dd> |
1035 linenumber of the breakpoint (int) |
1095 filename the breakpoint belongs to |
1036 </dd> |
1096 </dd> |
1037 <dt><i>enable</i></dt> |
1097 <dt><i>line</i> (int)</dt> |
|
1098 <dd> |
|
1099 linenumber of the breakpoint |
|
1100 </dd> |
|
1101 <dt><i>enable</i> (bool)</dt> |
1038 <dd> |
1102 <dd> |
1039 flag indicating enabling or disabling a breakpoint |
1103 flag indicating enabling or disabling a breakpoint |
1040 (boolean) |
|
1041 </dd> |
1104 </dd> |
1042 </dl> |
1105 </dl> |
1043 <a NAME="DebugServer.__remoteBreakpointIgnore" ID="DebugServer.__remoteBreakpointIgnore"></a> |
1106 <a NAME="DebugServer.__remoteBreakpointIgnore" ID="DebugServer.__remoteBreakpointIgnore"></a> |
1044 <h4>DebugServer.__remoteBreakpointIgnore</h4> |
1107 <h4>DebugServer.__remoteBreakpointIgnore</h4> |
1045 <b>__remoteBreakpointIgnore</b>(<i>fn, line, count</i>) |
1108 <b>__remoteBreakpointIgnore</b>(<i>debuggerId, fn, line, count</i>) |
1046 |
1109 |
1047 <p> |
1110 <p> |
1048 Private method to ignore a breakpoint the next couple of occurrences. |
1111 Private method to ignore a breakpoint the next couple of occurrences. |
1049 </p> |
1112 </p> |
1050 <dl> |
1113 <dl> |
1051 |
1114 |
1052 <dt><i>fn</i></dt> |
1115 <dt><i>debuggerId</i> (str)</dt> |
1053 <dd> |
1116 <dd> |
1054 filename the breakpoint belongs to (string) |
1117 ID of the debugger backend |
1055 </dd> |
1118 </dd> |
1056 <dt><i>line</i></dt> |
1119 <dt><i>fn</i> (str)</dt> |
1057 <dd> |
1120 <dd> |
1058 linenumber of the breakpoint (int) |
1121 filename the breakpoint belongs to |
1059 </dd> |
1122 </dd> |
1060 <dt><i>count</i></dt> |
1123 <dt><i>line</i> (int)</dt> |
1061 <dd> |
1124 <dd> |
1062 number of occurrences to ignore (int) |
1125 linenumber of the breakpoint |
|
1126 </dd> |
|
1127 <dt><i>count</i> (int)</dt> |
|
1128 <dd> |
|
1129 number of occurrences to ignore |
1063 </dd> |
1130 </dd> |
1064 </dl> |
1131 </dl> |
1065 <a NAME="DebugServer.__remoteWatchpoint" ID="DebugServer.__remoteWatchpoint"></a> |
1132 <a NAME="DebugServer.__remoteWatchpoint" ID="DebugServer.__remoteWatchpoint"></a> |
1066 <h4>DebugServer.__remoteWatchpoint</h4> |
1133 <h4>DebugServer.__remoteWatchpoint</h4> |
1067 <b>__remoteWatchpoint</b>(<i>cond, setWatch, temp=False</i>) |
1134 <b>__remoteWatchpoint</b>(<i>debuggerId, cond, setWatch, temp=False</i>) |
1068 |
1135 |
1069 <p> |
1136 <p> |
1070 Private method to set or clear a watch expression. |
1137 Private method to set or clear a watch expression. |
1071 </p> |
1138 </p> |
1072 <dl> |
1139 <dl> |
1073 |
1140 |
1074 <dt><i>cond</i></dt> |
1141 <dt><i>debuggerId</i> (str)</dt> |
1075 <dd> |
1142 <dd> |
1076 expression of the watch expression (string) |
1143 ID of the debugger backend |
1077 </dd> |
1144 </dd> |
1078 <dt><i>setWatch</i></dt> |
1145 <dt><i>cond</i> (str)</dt> |
|
1146 <dd> |
|
1147 expression of the watch expression |
|
1148 </dd> |
|
1149 <dt><i>setWatch</i> (bool)</dt> |
1079 <dd> |
1150 <dd> |
1080 flag indicating setting or resetting a watch expression |
1151 flag indicating setting or resetting a watch expression |
1081 (boolean) |
1152 </dd> |
1082 </dd> |
1153 <dt><i>temp</i> (bool)</dt> |
1083 <dt><i>temp</i></dt> |
1154 <dd> |
1084 <dd> |
1155 flag indicating a temporary watch expression |
1085 flag indicating a temporary watch expression (boolean) |
|
1086 </dd> |
1156 </dd> |
1087 </dl> |
1157 </dl> |
1088 <a NAME="DebugServer.__remoteWatchpointEnable" ID="DebugServer.__remoteWatchpointEnable"></a> |
1158 <a NAME="DebugServer.__remoteWatchpointEnable" ID="DebugServer.__remoteWatchpointEnable"></a> |
1089 <h4>DebugServer.__remoteWatchpointEnable</h4> |
1159 <h4>DebugServer.__remoteWatchpointEnable</h4> |
1090 <b>__remoteWatchpointEnable</b>(<i>cond, enable</i>) |
1160 <b>__remoteWatchpointEnable</b>(<i>debuggerId, cond, enable</i>) |
1091 |
1161 |
1092 <p> |
1162 <p> |
1093 Private method to enable or disable a watch expression. |
1163 Private method to enable or disable a watch expression. |
1094 </p> |
1164 </p> |
1095 <dl> |
1165 <dl> |
1096 |
1166 |
1097 <dt><i>cond</i></dt> |
1167 <dt><i>debuggerId</i> (str)</dt> |
1098 <dd> |
1168 <dd> |
1099 expression of the watch expression (string) |
1169 ID of the debugger backend |
1100 </dd> |
1170 </dd> |
1101 <dt><i>enable</i></dt> |
1171 <dt><i>cond</i> (str)</dt> |
|
1172 <dd> |
|
1173 expression of the watch expression |
|
1174 </dd> |
|
1175 <dt><i>enable</i> (bool)</dt> |
1102 <dd> |
1176 <dd> |
1103 flag indicating enabling or disabling a watch expression |
1177 flag indicating enabling or disabling a watch expression |
1104 (boolean) |
|
1105 </dd> |
1178 </dd> |
1106 </dl> |
1179 </dl> |
1107 <a NAME="DebugServer.__remoteWatchpointIgnore" ID="DebugServer.__remoteWatchpointIgnore"></a> |
1180 <a NAME="DebugServer.__remoteWatchpointIgnore" ID="DebugServer.__remoteWatchpointIgnore"></a> |
1108 <h4>DebugServer.__remoteWatchpointIgnore</h4> |
1181 <h4>DebugServer.__remoteWatchpointIgnore</h4> |
1109 <b>__remoteWatchpointIgnore</b>(<i>cond, count</i>) |
1182 <b>__remoteWatchpointIgnore</b>(<i>debuggerId, cond, count</i>) |
1110 |
1183 |
1111 <p> |
1184 <p> |
1112 Private method to ignore a watch expression the next couple of |
1185 Private method to ignore a watch expression the next couple of |
1113 occurrences. |
1186 occurrences. |
1114 </p> |
1187 </p> |
1115 <dl> |
1188 <dl> |
1116 |
1189 |
1117 <dt><i>cond</i></dt> |
1190 <dt><i>debuggerId</i> (str)</dt> |
1118 <dd> |
1191 <dd> |
1119 expression of the watch expression (string) |
1192 ID of the debugger backend |
1120 </dd> |
1193 </dd> |
1121 <dt><i>count</i></dt> |
1194 <dt><i>cond</i> (str)</dt> |
1122 <dd> |
1195 <dd> |
1123 number of occurrences to ignore (int) |
1196 expression of the watch expression |
|
1197 </dd> |
|
1198 <dt><i>count</i> (int)</dt> |
|
1199 <dd> |
|
1200 number of occurrences to ignore |
1124 </dd> |
1201 </dd> |
1125 </dl> |
1202 </dl> |
1126 <a NAME="DebugServer.__restoreBreakpoints" ID="DebugServer.__restoreBreakpoints"></a> |
1203 <a NAME="DebugServer.__restoreBreakpoints" ID="DebugServer.__restoreBreakpoints"></a> |
1127 <h4>DebugServer.__restoreBreakpoints</h4> |
1204 <h4>DebugServer.__restoreBreakpoints</h4> |
1128 <b>__restoreBreakpoints</b>(<i></i>) |
1205 <b>__restoreBreakpoints</b>(<i>debuggerId=""</i>) |
1129 |
1206 |
1130 <p> |
1207 <p> |
1131 Private method to restore the breakpoints after a restart. |
1208 Private method to restore the breakpoints after a restart. |
1132 </p> |
1209 </p> |
|
1210 <dl> |
|
1211 |
|
1212 <dt><i>debuggerId</i> (str)</dt> |
|
1213 <dd> |
|
1214 ID of the debugger backend to send to. If this is |
|
1215 empty, they will be broadcast to all connected backends. |
|
1216 </dd> |
|
1217 </dl> |
|
1218 <a NAME="DebugServer.__restoreNoDebugList" ID="DebugServer.__restoreNoDebugList"></a> |
|
1219 <h4>DebugServer.__restoreNoDebugList</h4> |
|
1220 <b>__restoreNoDebugList</b>(<i>debuggerId=""</i>) |
|
1221 |
|
1222 <p> |
|
1223 Private method to restore the watch expressions after a restart. |
|
1224 </p> |
|
1225 <dl> |
|
1226 |
|
1227 <dt><i>debuggerId</i> (str)</dt> |
|
1228 <dd> |
|
1229 ID of the debugger backend to send to. If this is |
|
1230 empty, they will be broadcast to all connected backends. |
|
1231 </dd> |
|
1232 </dl> |
1133 <a NAME="DebugServer.__restoreWatchpoints" ID="DebugServer.__restoreWatchpoints"></a> |
1233 <a NAME="DebugServer.__restoreWatchpoints" ID="DebugServer.__restoreWatchpoints"></a> |
1134 <h4>DebugServer.__restoreWatchpoints</h4> |
1234 <h4>DebugServer.__restoreWatchpoints</h4> |
1135 <b>__restoreWatchpoints</b>(<i></i>) |
1235 <b>__restoreWatchpoints</b>(<i>debuggerId=""</i>) |
1136 |
1236 |
1137 <p> |
1237 <p> |
1138 Private method to restore the watch expressions after a restart. |
1238 Private method to restore the watch expressions after a restart. |
1139 </p> |
1239 </p> |
|
1240 <dl> |
|
1241 |
|
1242 <dt><i>debuggerId</i> (str)</dt> |
|
1243 <dd> |
|
1244 ID of the debugger backend to send to. If this is |
|
1245 empty, they will be broadcast to all connected backends. |
|
1246 </dd> |
|
1247 </dl> |
1140 <a NAME="DebugServer.__setClientType" ID="DebugServer.__setClientType"></a> |
1248 <a NAME="DebugServer.__setClientType" ID="DebugServer.__setClientType"></a> |
1141 <h4>DebugServer.__setClientType</h4> |
1249 <h4>DebugServer.__setClientType</h4> |
1142 <b>__setClientType</b>(<i>clType</i>) |
1250 <b>__setClientType</b>(<i>clType</i>) |
1143 |
1251 |
1144 <p> |
1252 <p> |
1145 Private method to set the client type. |
1253 Private method to set the client type. |
1146 </p> |
1254 </p> |
1147 <dl> |
1255 <dl> |
1148 |
1256 |
1149 <dt><i>clType</i></dt> |
1257 <dt><i>clType</i> (str)</dt> |
1150 <dd> |
1258 <dd> |
1151 type of client to be started (string) |
1259 type of client to be started |
1152 </dd> |
1260 </dd> |
1153 </dl> |
1261 </dl> |
1154 <a NAME="DebugServer.__splitWatchCondition" ID="DebugServer.__splitWatchCondition"></a> |
1262 <a NAME="DebugServer.__splitWatchCondition" ID="DebugServer.__splitWatchCondition"></a> |
1155 <h4>DebugServer.__splitWatchCondition</h4> |
1263 <h4>DebugServer.__splitWatchCondition</h4> |
1156 <b>__splitWatchCondition</b>(<i>cond</i>) |
1264 <b>__splitWatchCondition</b>(<i>cond</i>) |
1632 <p> |
1835 <p> |
1633 Public slot to get the banner info of the remote client. |
1836 Public slot to get the banner info of the remote client. |
1634 </p> |
1837 </p> |
1635 <a NAME="DebugServer.remoteBreakpoint" ID="DebugServer.remoteBreakpoint"></a> |
1838 <a NAME="DebugServer.remoteBreakpoint" ID="DebugServer.remoteBreakpoint"></a> |
1636 <h4>DebugServer.remoteBreakpoint</h4> |
1839 <h4>DebugServer.remoteBreakpoint</h4> |
1637 <b>remoteBreakpoint</b>(<i>fn, line, setBreakpoint, cond=None, temp=False</i>) |
1840 <b>remoteBreakpoint</b>(<i>debuggerId, fn, line, setBreakpoint, cond=None, temp=False</i>) |
1638 |
1841 |
1639 <p> |
1842 <p> |
1640 Public method to set or clear a breakpoint. |
1843 Public method to set or clear a breakpoint. |
1641 </p> |
1844 </p> |
1642 <dl> |
1845 <dl> |
1643 |
1846 |
1644 <dt><i>fn</i></dt> |
1847 <dt><i>debuggerId</i> (str)</dt> |
1645 <dd> |
1848 <dd> |
1646 filename the breakpoint belongs to (string) |
1849 ID of the debugger backend |
1647 </dd> |
1850 </dd> |
1648 <dt><i>line</i></dt> |
1851 <dt><i>fn</i> (str)</dt> |
1649 <dd> |
1852 <dd> |
1650 linenumber of the breakpoint (int) |
1853 filename the breakpoint belongs to |
1651 </dd> |
1854 </dd> |
1652 <dt><i>setBreakpoint</i></dt> |
1855 <dt><i>line</i> (int)</dt> |
|
1856 <dd> |
|
1857 linenumber of the breakpoint |
|
1858 </dd> |
|
1859 <dt><i>setBreakpoint</i> (bool)</dt> |
1653 <dd> |
1860 <dd> |
1654 flag indicating setting or resetting a breakpoint |
1861 flag indicating setting or resetting a breakpoint |
1655 (boolean) |
1862 </dd> |
1656 </dd> |
1863 <dt><i>cond</i> (str)</dt> |
1657 <dt><i>cond</i></dt> |
1864 <dd> |
1658 <dd> |
1865 condition of the breakpoint |
1659 condition of the breakpoint (string) |
1866 </dd> |
1660 </dd> |
1867 <dt><i>temp</i> (bool)</dt> |
1661 <dt><i>temp</i></dt> |
1868 <dd> |
1662 <dd> |
1869 flag indicating a temporary breakpoint |
1663 flag indicating a temporary breakpoint (boolean) |
|
1664 </dd> |
1870 </dd> |
1665 </dl> |
1871 </dl> |
1666 <a NAME="DebugServer.remoteCapabilities" ID="DebugServer.remoteCapabilities"></a> |
1872 <a NAME="DebugServer.remoteCapabilities" ID="DebugServer.remoteCapabilities"></a> |
1667 <h4>DebugServer.remoteCapabilities</h4> |
1873 <h4>DebugServer.remoteCapabilities</h4> |
1668 <b>remoteCapabilities</b>(<i></i>) |
1874 <b>remoteCapabilities</b>(<i></i>) |
1670 <p> |
1876 <p> |
1671 Public slot to get the debug clients capabilities. |
1877 Public slot to get the debug clients capabilities. |
1672 </p> |
1878 </p> |
1673 <a NAME="DebugServer.remoteClientDisassembly" ID="DebugServer.remoteClientDisassembly"></a> |
1879 <a NAME="DebugServer.remoteClientDisassembly" ID="DebugServer.remoteClientDisassembly"></a> |
1674 <h4>DebugServer.remoteClientDisassembly</h4> |
1880 <h4>DebugServer.remoteClientDisassembly</h4> |
1675 <b>remoteClientDisassembly</b>(<i></i>) |
1881 <b>remoteClientDisassembly</b>(<i>debuggerId</i>) |
1676 |
1882 |
1677 <p> |
1883 <p> |
1678 Public method to ask the client for the latest traceback disassembly. |
1884 Public method to ask the client for the latest traceback disassembly. |
1679 </p> |
1885 </p> |
|
1886 <dl> |
|
1887 |
|
1888 <dt><i>debuggerId</i> (str)</dt> |
|
1889 <dd> |
|
1890 ID of the debugger backend |
|
1891 </dd> |
|
1892 </dl> |
1680 <a NAME="DebugServer.remoteClientSetFilter" ID="DebugServer.remoteClientSetFilter"></a> |
1893 <a NAME="DebugServer.remoteClientSetFilter" ID="DebugServer.remoteClientSetFilter"></a> |
1681 <h4>DebugServer.remoteClientSetFilter</h4> |
1894 <h4>DebugServer.remoteClientSetFilter</h4> |
1682 <b>remoteClientSetFilter</b>(<i>scope, filterStr</i>) |
1895 <b>remoteClientSetFilter</b>(<i>debuggerId, scope, filterStr</i>) |
1683 |
1896 |
1684 <p> |
1897 <p> |
1685 Public method to set a variables filter list. |
1898 Public method to set a variables filter list. |
1686 </p> |
1899 </p> |
1687 <dl> |
1900 <dl> |
1688 |
1901 |
1689 <dt><i>scope</i></dt> |
1902 <dt><i>debuggerId</i> (str)</dt> |
|
1903 <dd> |
|
1904 ID of the debugger backend |
|
1905 </dd> |
|
1906 <dt><i>scope</i> (int)</dt> |
1690 <dd> |
1907 <dd> |
1691 the scope of the variables (0 = local, 1 = global) |
1908 the scope of the variables (0 = local, 1 = global) |
1692 </dd> |
1909 </dd> |
1693 <dt><i>filterStr</i></dt> |
1910 <dt><i>filterStr</i> (str)</dt> |
1694 <dd> |
1911 <dd> |
1695 regexp string for variable names to filter out |
1912 regexp string for variable names to filter out |
1696 (string) |
1913 </dd> |
|
1914 </dl> |
|
1915 <a NAME="DebugServer.remoteClientStack" ID="DebugServer.remoteClientStack"></a> |
|
1916 <h4>DebugServer.remoteClientStack</h4> |
|
1917 <b>remoteClientStack</b>(<i>debuggerId</i>) |
|
1918 |
|
1919 <p> |
|
1920 Public method to request the stack of the main thread. |
|
1921 </p> |
|
1922 <dl> |
|
1923 |
|
1924 <dt><i>debuggerId</i> (str)</dt> |
|
1925 <dd> |
|
1926 ID of the debugger backend |
1697 </dd> |
1927 </dd> |
1698 </dl> |
1928 </dl> |
1699 <a NAME="DebugServer.remoteClientVariable" ID="DebugServer.remoteClientVariable"></a> |
1929 <a NAME="DebugServer.remoteClientVariable" ID="DebugServer.remoteClientVariable"></a> |
1700 <h4>DebugServer.remoteClientVariable</h4> |
1930 <h4>DebugServer.remoteClientVariable</h4> |
1701 <b>remoteClientVariable</b>(<i>scope, filterList, var, framenr=0</i>) |
1931 <b>remoteClientVariable</b>(<i>debuggerId, scope, filterList, var, framenr=0, maxSize=0</i>) |
1702 |
1932 |
1703 <p> |
1933 <p> |
1704 Public method to request the variables of the debugged program. |
1934 Public method to request the variables of the debugged program. |
1705 </p> |
1935 </p> |
1706 <dl> |
1936 <dl> |
1707 |
1937 |
1708 <dt><i>scope</i></dt> |
1938 <dt><i>debuggerId</i> (str)</dt> |
|
1939 <dd> |
|
1940 ID of the debugger backend |
|
1941 </dd> |
|
1942 <dt><i>scope</i> (int)</dt> |
1709 <dd> |
1943 <dd> |
1710 the scope of the variables (0 = local, 1 = global) |
1944 the scope of the variables (0 = local, 1 = global) |
1711 </dd> |
1945 </dd> |
1712 <dt><i>filterList</i></dt> |
1946 <dt><i>filterList</i> (list of str)</dt> |
1713 <dd> |
1947 <dd> |
1714 list of variable types to filter out (list of int) |
1948 list of variable types to filter out |
1715 </dd> |
1949 </dd> |
1716 <dt><i>var</i></dt> |
1950 <dt><i>var</i> (list of str)</dt> |
1717 <dd> |
1951 <dd> |
1718 list encoded name of variable to retrieve (string) |
1952 list encoded name of variable to retrieve |
1719 </dd> |
1953 </dd> |
1720 <dt><i>framenr</i></dt> |
1954 <dt><i>framenr</i> (int)</dt> |
1721 <dd> |
1955 <dd> |
1722 framenumber of the variables to retrieve (int) |
1956 framenumber of the variables to retrieve |
|
1957 </dd> |
|
1958 <dt><i>maxSize</i> (int)</dt> |
|
1959 <dd> |
|
1960 maximum size the formatted value of a variable will |
|
1961 be shown. If it is bigger than that, a 'too big' indication will |
|
1962 be given (@@TOO_BIG_TO_SHOW@@). |
1723 </dd> |
1963 </dd> |
1724 </dl> |
1964 </dl> |
1725 <a NAME="DebugServer.remoteClientVariables" ID="DebugServer.remoteClientVariables"></a> |
1965 <a NAME="DebugServer.remoteClientVariables" ID="DebugServer.remoteClientVariables"></a> |
1726 <h4>DebugServer.remoteClientVariables</h4> |
1966 <h4>DebugServer.remoteClientVariables</h4> |
1727 <b>remoteClientVariables</b>(<i>scope, filterList, framenr=0</i>) |
1967 <b>remoteClientVariables</b>(<i>debuggerId, scope, filterList, framenr=0</i>) |
1728 |
1968 |
1729 <p> |
1969 <p> |
1730 Public method to request the variables of the debugged program. |
1970 Public method to request the variables of the debugged program. |
1731 </p> |
1971 </p> |
1732 <dl> |
1972 <dl> |
1733 |
1973 |
1734 <dt><i>scope</i></dt> |
1974 <dt><i>debuggerId</i> (str)</dt> |
|
1975 <dd> |
|
1976 ID of the debugger backend |
|
1977 </dd> |
|
1978 <dt><i>scope</i> (int)</dt> |
1735 <dd> |
1979 <dd> |
1736 the scope of the variables (0 = local, 1 = global) |
1980 the scope of the variables (0 = local, 1 = global) |
1737 </dd> |
1981 </dd> |
1738 <dt><i>filterList</i></dt> |
1982 <dt><i>filterList</i> (list of str)</dt> |
1739 <dd> |
1983 <dd> |
1740 list of variable types to filter out (list of int) |
1984 list of variable types to filter out |
1741 </dd> |
1985 </dd> |
1742 <dt><i>framenr</i></dt> |
1986 <dt><i>framenr</i> (int)</dt> |
1743 <dd> |
1987 <dd> |
1744 framenumber of the variables to retrieve (int) |
1988 framenumber of the variables to retrieve |
1745 </dd> |
1989 </dd> |
1746 </dl> |
1990 </dl> |
1747 <a NAME="DebugServer.remoteCompletion" ID="DebugServer.remoteCompletion"></a> |
1991 <a NAME="DebugServer.remoteCompletion" ID="DebugServer.remoteCompletion"></a> |
1748 <h4>DebugServer.remoteCompletion</h4> |
1992 <h4>DebugServer.remoteCompletion</h4> |
1749 <b>remoteCompletion</b>(<i>text</i>) |
1993 <b>remoteCompletion</b>(<i>debuggerId, text</i>) |
1750 |
1994 |
1751 <p> |
1995 <p> |
1752 Public slot to get the a list of possible commandline completions |
1996 Public slot to get the a list of possible commandline completions |
1753 from the remote client. |
1997 from the remote client. |
1754 </p> |
1998 </p> |
1755 <dl> |
1999 <dl> |
1756 |
2000 |
1757 <dt><i>text</i></dt> |
2001 <dt><i>debuggerId</i> (str)</dt> |
1758 <dd> |
2002 <dd> |
1759 the text to be completed (string) |
2003 ID of the debugger backend |
|
2004 </dd> |
|
2005 <dt><i>text</i> (str)</dt> |
|
2006 <dd> |
|
2007 the text to be completed |
1760 </dd> |
2008 </dd> |
1761 </dl> |
2009 </dl> |
1762 <a NAME="DebugServer.remoteContinue" ID="DebugServer.remoteContinue"></a> |
2010 <a NAME="DebugServer.remoteContinue" ID="DebugServer.remoteContinue"></a> |
1763 <h4>DebugServer.remoteContinue</h4> |
2011 <h4>DebugServer.remoteContinue</h4> |
1764 <b>remoteContinue</b>(<i>special=False</i>) |
2012 <b>remoteContinue</b>(<i>debuggerId, special=False</i>) |
1765 |
2013 |
1766 <p> |
2014 <p> |
1767 Public method to continue the debugged program. |
2015 Public method to continue the debugged program. |
1768 </p> |
2016 </p> |
1769 <dl> |
2017 <dl> |
1770 |
2018 |
|
2019 <dt><i>debuggerId</i> (str)</dt> |
|
2020 <dd> |
|
2021 ID of the debugger backend |
|
2022 </dd> |
1771 <dt><i>special</i></dt> |
2023 <dt><i>special</i></dt> |
1772 <dd> |
2024 <dd> |
1773 flag indicating a special continue operation |
2025 flag indicating a special continue operation |
1774 </dd> |
2026 </dd> |
1775 </dl> |
2027 </dl> |
1867 </dd> |
2119 </dd> |
1868 <dt><i>env</i> (str)</dt> |
2120 <dt><i>env</i> (str)</dt> |
1869 <dd> |
2121 <dd> |
1870 environment parameter settings |
2122 environment parameter settings |
1871 </dd> |
2123 </dd> |
1872 <dt><i>autoClearShell=</i> (bool)</dt> |
2124 <dt><i>autoClearShell</i> (bool)</dt> |
1873 <dd> |
2125 <dd> |
1874 flag indicating, that the interpreter window |
2126 flag indicating, that the interpreter window |
1875 should be cleared |
2127 should be cleared |
1876 </dd> |
2128 </dd> |
1877 <dt><i>tracePython=</i> (bool)</dt> |
2129 <dt><i>tracePython</i> (bool)</dt> |
1878 <dd> |
2130 <dd> |
1879 flag indicating if the Python library should be |
2131 flag indicating if the Python library should be |
1880 traced as well |
2132 traced as well |
1881 </dd> |
2133 </dd> |
1882 <dt><i>autoContinue=</i> (bool)</dt> |
2134 <dt><i>autoContinue</i> (bool)</dt> |
1883 <dd> |
2135 <dd> |
1884 flag indicating, that the debugger should not |
2136 flag indicating, that the debugger should not |
1885 stop at the first executable line |
2137 stop at the first executable line |
1886 </dd> |
2138 </dd> |
1887 <dt><i>forProject=</i> (bool)</dt> |
2139 <dt><i>forProject</i> (bool)</dt> |
1888 <dd> |
2140 <dd> |
1889 flag indicating a project related action |
2141 flag indicating a project related action |
1890 </dd> |
2142 </dd> |
1891 <dt><i>runInConsole=</i> (bool)</dt> |
2143 <dt><i>runInConsole</i> (bool)</dt> |
1892 <dd> |
2144 <dd> |
1893 flag indicating to start the debugger in a |
2145 flag indicating to start the debugger in a |
1894 console window |
2146 console window |
1895 </dd> |
2147 </dd> |
1896 <dt><i>autoFork=</i> (bool)</dt> |
2148 <dt><i>clientType</i> (str)</dt> |
1897 <dd> |
|
1898 flag indicating the automatic fork mode |
|
1899 </dd> |
|
1900 <dt><i>forkChild=</i> (bool)</dt> |
|
1901 <dd> |
|
1902 flag indicating to debug the child after forking |
|
1903 </dd> |
|
1904 <dt><i>clientType=</i> (str)</dt> |
|
1905 <dd> |
2149 <dd> |
1906 client type to be used |
2150 client type to be used |
1907 </dd> |
2151 </dd> |
1908 <dt><i>enableCallTrace=</i> (bool)</dt> |
2152 <dt><i>enableCallTrace</i> (bool)</dt> |
1909 <dd> |
2153 <dd> |
1910 flag indicating to enable the call trace |
2154 flag indicating to enable the call trace |
1911 function |
2155 function |
1912 </dd> |
2156 </dd> |
|
2157 <dt><i>enableMultiprocess</i> (bool)</dt> |
|
2158 <dd> |
|
2159 flag indicating to perform multiprocess |
|
2160 debugging |
|
2161 </dd> |
|
2162 <dt><i>multiprocessNoDebug</i> (str)</dt> |
|
2163 <dd> |
|
2164 space separated list of programs not to be |
|
2165 debugged |
|
2166 </dd> |
1913 </dl> |
2167 </dl> |
1914 <a NAME="DebugServer.remoteMoveIP" ID="DebugServer.remoteMoveIP"></a> |
2168 <a NAME="DebugServer.remoteMoveIP" ID="DebugServer.remoteMoveIP"></a> |
1915 <h4>DebugServer.remoteMoveIP</h4> |
2169 <h4>DebugServer.remoteMoveIP</h4> |
1916 <b>remoteMoveIP</b>(<i>line</i>) |
2170 <b>remoteMoveIP</b>(<i>debuggerId, line</i>) |
1917 |
2171 |
1918 <p> |
2172 <p> |
1919 Public method to move the instruction pointer to a different line. |
2173 Public method to move the instruction pointer to a different line. |
1920 </p> |
2174 </p> |
1921 <dl> |
2175 <dl> |
1922 |
2176 |
1923 <dt><i>line</i></dt> |
2177 <dt><i>debuggerId</i> (str)</dt> |
|
2178 <dd> |
|
2179 ID of the debugger backend |
|
2180 </dd> |
|
2181 <dt><i>line</i> (int)</dt> |
1924 <dd> |
2182 <dd> |
1925 the new line, where execution should be continued |
2183 the new line, where execution should be continued |
1926 </dd> |
2184 </dd> |
1927 </dl> |
2185 </dl> |
1928 <a NAME="DebugServer.remoteProfile" ID="DebugServer.remoteProfile"></a> |
2186 <a NAME="DebugServer.remoteProfile" ID="DebugServer.remoteProfile"></a> |
1952 </dd> |
2210 </dd> |
1953 <dt><i>env</i> (str)</dt> |
2211 <dt><i>env</i> (str)</dt> |
1954 <dd> |
2212 <dd> |
1955 environment parameter settings |
2213 environment parameter settings |
1956 </dd> |
2214 </dd> |
1957 <dt><i>autoClearShell=</i> (bool)</dt> |
2215 <dt><i>autoClearShell</i> (bool)</dt> |
1958 <dd> |
2216 <dd> |
1959 flag indicating, that the interpreter window |
2217 flag indicating, that the interpreter window |
1960 should be cleared |
2218 should be cleared |
1961 </dd> |
2219 </dd> |
1962 <dt><i>erase=</i> (bool)</dt> |
2220 <dt><i>erase</i> (bool)</dt> |
1963 <dd> |
2221 <dd> |
1964 flag indicating that coverage info should be |
2222 flag indicating that coverage info should be |
1965 cleared first |
2223 cleared first |
1966 </dd> |
2224 </dd> |
1967 <dt><i>forProject=</i> (bool)</dt> |
2225 <dt><i>forProject</i> (bool)</dt> |
1968 <dd> |
2226 <dd> |
1969 flag indicating a project related action |
2227 flag indicating a project related action |
1970 </dd> |
2228 </dd> |
1971 <dt><i>runInConsole=</i> (bool)</dt> |
2229 <dt><i>runInConsole</i> (bool)</dt> |
1972 <dd> |
2230 <dd> |
1973 flag indicating to start the debugger in a |
2231 flag indicating to start the debugger in a |
1974 console window |
2232 console window |
1975 </dd> |
2233 </dd> |
1976 <dt><i>clientType=</i> (str)</dt> |
2234 <dt><i>clientType</i> (str)</dt> |
1977 <dd> |
2235 <dd> |
1978 client type to be used |
2236 client type to be used |
1979 </dd> |
2237 </dd> |
1980 </dl> |
2238 </dl> |
1981 <a NAME="DebugServer.remoteRawInput" ID="DebugServer.remoteRawInput"></a> |
2239 <a NAME="DebugServer.remoteRawInput" ID="DebugServer.remoteRawInput"></a> |
1982 <h4>DebugServer.remoteRawInput</h4> |
2240 <h4>DebugServer.remoteRawInput</h4> |
1983 <b>remoteRawInput</b>(<i>s</i>) |
2241 <b>remoteRawInput</b>(<i>debuggerId, inputString</i>) |
1984 |
2242 |
1985 <p> |
2243 <p> |
1986 Public method to send the raw input to the debugged program. |
2244 Public method to send the raw input to the debugged program. |
1987 </p> |
2245 </p> |
1988 <dl> |
2246 <dl> |
1989 |
2247 |
1990 <dt><i>s</i></dt> |
2248 <dt><i>debuggerId</i> (str)</dt> |
1991 <dd> |
2249 <dd> |
1992 the raw input (string) |
2250 ID of the debugger backend |
|
2251 </dd> |
|
2252 <dt><i>inputString</i> (str)</dt> |
|
2253 <dd> |
|
2254 the raw input |
1993 </dd> |
2255 </dd> |
1994 </dl> |
2256 </dl> |
1995 <a NAME="DebugServer.remoteRun" ID="DebugServer.remoteRun"></a> |
2257 <a NAME="DebugServer.remoteRun" ID="DebugServer.remoteRun"></a> |
1996 <h4>DebugServer.remoteRun</h4> |
2258 <h4>DebugServer.remoteRun</h4> |
1997 <b>remoteRun</b>(<i>venvName, fn, argv, wd, env, autoClearShell=True, forProject=False, runInConsole=False, autoFork=False, forkChild=False, clientType=""</i>) |
2259 <b>remoteRun</b>(<i>venvName, fn, argv, wd, env, autoClearShell=True, forProject=False, runInConsole=False, clientType=""</i>) |
1998 |
2260 |
1999 <p> |
2261 <p> |
2000 Public method to load a new program to run. |
2262 Public method to load a new program to run. |
2001 </p> |
2263 </p> |
2002 <dl> |
2264 <dl> |
2019 </dd> |
2281 </dd> |
2020 <dt><i>env</i> (str)</dt> |
2282 <dt><i>env</i> (str)</dt> |
2021 <dd> |
2283 <dd> |
2022 environment parameter settings |
2284 environment parameter settings |
2023 </dd> |
2285 </dd> |
2024 <dt><i>autoClearShell=</i> (bool)</dt> |
2286 <dt><i>autoClearShell</i> (bool)</dt> |
2025 <dd> |
2287 <dd> |
2026 flag indicating, that the interpreter window |
2288 flag indicating, that the interpreter window |
2027 should be cleared |
2289 should be cleared |
2028 </dd> |
2290 </dd> |
2029 <dt><i>forProject=</i> (bool)</dt> |
2291 <dt><i>forProject</i> (bool)</dt> |
2030 <dd> |
2292 <dd> |
2031 flag indicating a project related action |
2293 flag indicating a project related action |
2032 </dd> |
2294 </dd> |
2033 <dt><i>runInConsole=</i> (bool)</dt> |
2295 <dt><i>runInConsole</i> (bool)</dt> |
2034 <dd> |
2296 <dd> |
2035 flag indicating to start the debugger in a |
2297 flag indicating to start the debugger in a |
2036 console window |
2298 console window |
2037 </dd> |
2299 </dd> |
2038 <dt><i>autoFork=</i> (bool)</dt> |
2300 <dt><i>clientType</i> (str)</dt> |
2039 <dd> |
|
2040 flag indicating the automatic fork mode |
|
2041 </dd> |
|
2042 <dt><i>forkChild=</i> (bool)</dt> |
|
2043 <dd> |
|
2044 flag indicating to debug the child after forking |
|
2045 </dd> |
|
2046 <dt><i>clientType=</i> (str)</dt> |
|
2047 <dd> |
2301 <dd> |
2048 client type to be used |
2302 client type to be used |
2049 </dd> |
2303 </dd> |
2050 </dl> |
2304 </dl> |
2051 <a NAME="DebugServer.remoteSetThread" ID="DebugServer.remoteSetThread"></a> |
2305 <a NAME="DebugServer.remoteSetThread" ID="DebugServer.remoteSetThread"></a> |
2052 <h4>DebugServer.remoteSetThread</h4> |
2306 <h4>DebugServer.remoteSetThread</h4> |
2053 <b>remoteSetThread</b>(<i>tid</i>) |
2307 <b>remoteSetThread</b>(<i>debuggerId, tid</i>) |
2054 |
2308 |
2055 <p> |
2309 <p> |
2056 Public method to request to set the given thread as current thread. |
2310 Public method to request to set the given thread as current thread. |
2057 </p> |
2311 </p> |
2058 <dl> |
2312 <dl> |
2059 |
2313 |
2060 <dt><i>tid</i></dt> |
2314 <dt><i>debuggerId</i> (str)</dt> |
2061 <dd> |
2315 <dd> |
2062 id of the thread (integer) |
2316 ID of the debugger backend |
|
2317 </dd> |
|
2318 <dt><i>tid</i> (int)</dt> |
|
2319 <dd> |
|
2320 id of the thread |
2063 </dd> |
2321 </dd> |
2064 </dl> |
2322 </dl> |
2065 <a NAME="DebugServer.remoteStatement" ID="DebugServer.remoteStatement"></a> |
2323 <a NAME="DebugServer.remoteStatement" ID="DebugServer.remoteStatement"></a> |
2066 <h4>DebugServer.remoteStatement</h4> |
2324 <h4>DebugServer.remoteStatement</h4> |
2067 <b>remoteStatement</b>(<i>stmt</i>) |
2325 <b>remoteStatement</b>(<i>debuggerId, stmt</i>) |
2068 |
2326 |
2069 <p> |
2327 <p> |
2070 Public method to execute a Python statement. |
2328 Public method to execute a Python statement. |
2071 </p> |
2329 </p> |
2072 <dl> |
2330 <dl> |
2073 |
2331 |
2074 <dt><i>stmt</i></dt> |
2332 <dt><i>debuggerId</i> (str)</dt> |
2075 <dd> |
2333 <dd> |
2076 the Python statement to execute (string). It |
2334 ID of the debugger backend |
2077 should not have a trailing newline. |
2335 </dd> |
|
2336 <dt><i>stmt</i> (str)</dt> |
|
2337 <dd> |
|
2338 the Python statement to execute. |
2078 </dd> |
2339 </dd> |
2079 </dl> |
2340 </dl> |
2080 <a NAME="DebugServer.remoteStep" ID="DebugServer.remoteStep"></a> |
2341 <a NAME="DebugServer.remoteStep" ID="DebugServer.remoteStep"></a> |
2081 <h4>DebugServer.remoteStep</h4> |
2342 <h4>DebugServer.remoteStep</h4> |
2082 <b>remoteStep</b>(<i></i>) |
2343 <b>remoteStep</b>(<i>debuggerId</i>) |
2083 |
2344 |
2084 <p> |
2345 <p> |
2085 Public method to single step the debugged program. |
2346 Public method to single step the debugged program. |
2086 </p> |
2347 </p> |
|
2348 <dl> |
|
2349 |
|
2350 <dt><i>debuggerId</i> (str)</dt> |
|
2351 <dd> |
|
2352 ID of the debugger backend |
|
2353 </dd> |
|
2354 </dl> |
2087 <a NAME="DebugServer.remoteStepOut" ID="DebugServer.remoteStepOut"></a> |
2355 <a NAME="DebugServer.remoteStepOut" ID="DebugServer.remoteStepOut"></a> |
2088 <h4>DebugServer.remoteStepOut</h4> |
2356 <h4>DebugServer.remoteStepOut</h4> |
2089 <b>remoteStepOut</b>(<i></i>) |
2357 <b>remoteStepOut</b>(<i>debuggerId</i>) |
2090 |
2358 |
2091 <p> |
2359 <p> |
2092 Public method to step out the debugged program. |
2360 Public method to step out the debugged program. |
2093 </p> |
2361 </p> |
|
2362 <dl> |
|
2363 |
|
2364 <dt><i>debuggerId</i> (str)</dt> |
|
2365 <dd> |
|
2366 ID of the debugger backend |
|
2367 </dd> |
|
2368 </dl> |
2094 <a NAME="DebugServer.remoteStepOver" ID="DebugServer.remoteStepOver"></a> |
2369 <a NAME="DebugServer.remoteStepOver" ID="DebugServer.remoteStepOver"></a> |
2095 <h4>DebugServer.remoteStepOver</h4> |
2370 <h4>DebugServer.remoteStepOver</h4> |
2096 <b>remoteStepOver</b>(<i></i>) |
2371 <b>remoteStepOver</b>(<i>debuggerId</i>) |
2097 |
2372 |
2098 <p> |
2373 <p> |
2099 Public method to step over the debugged program. |
2374 Public method to step over the debugged program. |
2100 </p> |
2375 </p> |
|
2376 <dl> |
|
2377 |
|
2378 <dt><i>debuggerId</i> (str)</dt> |
|
2379 <dd> |
|
2380 ID of the debugger backend |
|
2381 </dd> |
|
2382 </dl> |
2101 <a NAME="DebugServer.remoteStepQuit" ID="DebugServer.remoteStepQuit"></a> |
2383 <a NAME="DebugServer.remoteStepQuit" ID="DebugServer.remoteStepQuit"></a> |
2102 <h4>DebugServer.remoteStepQuit</h4> |
2384 <h4>DebugServer.remoteStepQuit</h4> |
2103 <b>remoteStepQuit</b>(<i></i>) |
2385 <b>remoteStepQuit</b>(<i>debuggerId</i>) |
2104 |
2386 |
2105 <p> |
2387 <p> |
2106 Public method to stop the debugged program. |
2388 Public method to stop the debugged program. |
2107 </p> |
2389 </p> |
|
2390 <dl> |
|
2391 |
|
2392 <dt><i>debuggerId</i> (str)</dt> |
|
2393 <dd> |
|
2394 ID of the debugger backend |
|
2395 </dd> |
|
2396 </dl> |
2108 <a NAME="DebugServer.remoteThreadList" ID="DebugServer.remoteThreadList"></a> |
2397 <a NAME="DebugServer.remoteThreadList" ID="DebugServer.remoteThreadList"></a> |
2109 <h4>DebugServer.remoteThreadList</h4> |
2398 <h4>DebugServer.remoteThreadList</h4> |
2110 <b>remoteThreadList</b>(<i></i>) |
2399 <b>remoteThreadList</b>(<i>debuggerId</i>) |
2111 |
2400 |
2112 <p> |
2401 <p> |
2113 Public method to request the list of threads from the client. |
2402 Public method to request the list of threads from the client. |
2114 </p> |
2403 </p> |
|
2404 <dl> |
|
2405 |
|
2406 <dt><i>debuggerId</i> (str)</dt> |
|
2407 <dd> |
|
2408 ID of the debugger backend |
|
2409 </dd> |
|
2410 </dl> |
2115 <a NAME="DebugServer.remoteUTDiscover" ID="DebugServer.remoteUTDiscover"></a> |
2411 <a NAME="DebugServer.remoteUTDiscover" ID="DebugServer.remoteUTDiscover"></a> |
2116 <h4>DebugServer.remoteUTDiscover</h4> |
2412 <h4>DebugServer.remoteUTDiscover</h4> |
2117 <b>remoteUTDiscover</b>(<i>clientType, forProject, venvName, syspath, workdir, discoveryStart</i>) |
2413 <b>remoteUTDiscover</b>(<i>clientType, forProject, venvName, syspath, workdir, discoveryStart</i>) |
2118 |
2414 |
2119 <p> |
2415 <p> |
2301 interpreter version info |
2601 interpreter version info |
2302 </dd> |
2602 </dd> |
2303 <dt><i>platform</i> (str)</dt> |
2603 <dt><i>platform</i> (str)</dt> |
2304 <dd> |
2604 <dd> |
2305 hostname of the client |
2605 hostname of the client |
2306 </dd> |
|
2307 <dt><i>debugClient</i> (str)</dt> |
|
2308 <dd> |
|
2309 additional debugger type info |
|
2310 </dd> |
2606 </dd> |
2311 <dt><i>venvName</i> (str)</dt> |
2607 <dt><i>venvName</i> (str)</dt> |
2312 <dd> |
2608 <dd> |
2313 name of the virtual environment |
2609 name of the virtual environment |
2314 </dd> |
2610 </dd> |
2315 </dl> |
2611 </dl> |
2316 <a NAME="DebugServer.signalClientBreakConditionError" ID="DebugServer.signalClientBreakConditionError"></a> |
2612 <a NAME="DebugServer.signalClientBreakConditionError" ID="DebugServer.signalClientBreakConditionError"></a> |
2317 <h4>DebugServer.signalClientBreakConditionError</h4> |
2613 <h4>DebugServer.signalClientBreakConditionError</h4> |
2318 <b>signalClientBreakConditionError</b>(<i>filename, lineno</i>) |
2614 <b>signalClientBreakConditionError</b>(<i>filename, lineno, debuggerId</i>) |
2319 |
2615 |
2320 <p> |
2616 <p> |
2321 Public method to process the client breakpoint condition error info. |
2617 Public method to process the client breakpoint condition error info. |
2322 </p> |
2618 </p> |
2323 <dl> |
2619 <dl> |
2324 |
2620 |
2325 <dt><i>filename</i></dt> |
2621 <dt><i>filename</i> (str)</dt> |
2326 <dd> |
2622 <dd> |
2327 filename of the breakpoint (string) |
2623 filename of the breakpoint |
2328 </dd> |
2624 </dd> |
2329 <dt><i>lineno</i></dt> |
2625 <dt><i>lineno</i> (int)</dt> |
2330 <dd> |
2626 <dd> |
2331 line umber of the breakpoint (integer) |
2627 line umber of the breakpoint |
|
2628 </dd> |
|
2629 <dt><i>debuggerId</i> (str)</dt> |
|
2630 <dd> |
|
2631 ID of the debugger backend |
2332 </dd> |
2632 </dd> |
2333 </dl> |
2633 </dl> |
2334 <a NAME="DebugServer.signalClientCallTrace" ID="DebugServer.signalClientCallTrace"></a> |
2634 <a NAME="DebugServer.signalClientCallTrace" ID="DebugServer.signalClientCallTrace"></a> |
2335 <h4>DebugServer.signalClientCallTrace</h4> |
2635 <h4>DebugServer.signalClientCallTrace</h4> |
2336 <b>signalClientCallTrace</b>(<i>isCall, fromFile, fromLine, fromFunction, toFile, toLine, toFunction</i>) |
2636 <b>signalClientCallTrace</b>(<i>isCall, fromFile, fromLine, fromFunction, toFile, toLine, toFunction, debuggerId</i>) |
2337 |
2637 |
2338 <p> |
2638 <p> |
2339 Public method to process the client call trace data. |
2639 Public method to process the client call trace data. |
2340 </p> |
2640 </p> |
2341 <dl> |
2641 <dl> |
2342 |
2642 |
2343 <dt><i>isCall</i></dt> |
2643 <dt><i>isCall</i> (bool)</dt> |
2344 <dd> |
2644 <dd> |
2345 flag indicating a 'call' (boolean) |
2645 flag indicating a 'call' |
2346 </dd> |
2646 </dd> |
2347 <dt><i>fromFile</i></dt> |
2647 <dt><i>fromFile</i> (str)</dt> |
2348 <dd> |
2648 <dd> |
2349 name of the originating file (string) |
2649 name of the originating file |
2350 </dd> |
2650 </dd> |
2351 <dt><i>fromLine</i></dt> |
2651 <dt><i>fromLine</i> (str)</dt> |
2352 <dd> |
2652 <dd> |
2353 line number in the originating file (string) |
2653 line number in the originating file |
2354 </dd> |
2654 </dd> |
2355 <dt><i>fromFunction</i></dt> |
2655 <dt><i>fromFunction</i> (str)</dt> |
2356 <dd> |
2656 <dd> |
2357 name of the originating function (string) |
2657 name of the originating function |
2358 </dd> |
2658 </dd> |
2359 <dt><i>toFile</i></dt> |
2659 <dt><i>toFile</i> (str)</dt> |
2360 <dd> |
2660 <dd> |
2361 name of the target file (string) |
2661 name of the target file |
2362 </dd> |
2662 </dd> |
2363 <dt><i>toLine</i></dt> |
2663 <dt><i>toLine</i> (str)</dt> |
2364 <dd> |
2664 <dd> |
2365 line number in the target file (string) |
2665 line number in the target file |
2366 </dd> |
2666 </dd> |
2367 <dt><i>toFunction</i></dt> |
2667 <dt><i>toFunction</i> (str)</dt> |
2368 <dd> |
2668 <dd> |
2369 name of the target function (string) |
2669 name of the target function |
|
2670 </dd> |
|
2671 <dt><i>debuggerId</i> (str)</dt> |
|
2672 <dd> |
|
2673 ID of the debugger backend |
2370 </dd> |
2674 </dd> |
2371 </dl> |
2675 </dl> |
2372 <a NAME="DebugServer.signalClientCapabilities" ID="DebugServer.signalClientCapabilities"></a> |
2676 <a NAME="DebugServer.signalClientCapabilities" ID="DebugServer.signalClientCapabilities"></a> |
2373 <h4>DebugServer.signalClientCapabilities</h4> |
2677 <h4>DebugServer.signalClientCapabilities</h4> |
2374 <b>signalClientCapabilities</b>(<i>capabilities, clientType, venvName</i>) |
2678 <b>signalClientCapabilities</b>(<i>capabilities, clientType, venvName</i>) |
2391 name of the virtual environment |
2695 name of the virtual environment |
2392 </dd> |
2696 </dd> |
2393 </dl> |
2697 </dl> |
2394 <a NAME="DebugServer.signalClientClearBreak" ID="DebugServer.signalClientClearBreak"></a> |
2698 <a NAME="DebugServer.signalClientClearBreak" ID="DebugServer.signalClientClearBreak"></a> |
2395 <h4>DebugServer.signalClientClearBreak</h4> |
2699 <h4>DebugServer.signalClientClearBreak</h4> |
2396 <b>signalClientClearBreak</b>(<i>filename, lineno</i>) |
2700 <b>signalClientClearBreak</b>(<i>filename, lineno, debuggerId</i>) |
2397 |
2701 |
2398 <p> |
2702 <p> |
2399 Public method to process the client clear breakpoint command. |
2703 Public method to process the client clear breakpoint command. |
2400 </p> |
2704 </p> |
2401 <dl> |
2705 <dl> |
2402 |
2706 |
2403 <dt><i>filename</i></dt> |
2707 <dt><i>filename</i> (str)</dt> |
2404 <dd> |
2708 <dd> |
2405 filename of the breakpoint (string) |
2709 filename of the breakpoint |
2406 </dd> |
2710 </dd> |
2407 <dt><i>lineno</i></dt> |
2711 <dt><i>lineno</i> (int)</dt> |
2408 <dd> |
2712 <dd> |
2409 line umber of the breakpoint (integer) |
2713 line umber of the breakpoint |
|
2714 </dd> |
|
2715 <dt><i>debuggerId</i> (str)</dt> |
|
2716 <dd> |
|
2717 ID of the debugger backend |
2410 </dd> |
2718 </dd> |
2411 </dl> |
2719 </dl> |
2412 <a NAME="DebugServer.signalClientClearWatch" ID="DebugServer.signalClientClearWatch"></a> |
2720 <a NAME="DebugServer.signalClientClearWatch" ID="DebugServer.signalClientClearWatch"></a> |
2413 <h4>DebugServer.signalClientClearWatch</h4> |
2721 <h4>DebugServer.signalClientClearWatch</h4> |
2414 <b>signalClientClearWatch</b>(<i>condition</i>) |
2722 <b>signalClientClearWatch</b>(<i>condition, debuggerId</i>) |
2415 |
2723 |
2416 <p> |
2724 <p> |
2417 Public slot to handle the clientClearWatch signal. |
2725 Public slot to handle the clientClearWatch signal. |
2418 </p> |
2726 </p> |
2419 <dl> |
2727 <dl> |
2420 |
2728 |
2421 <dt><i>condition</i></dt> |
2729 <dt><i>condition</i> (str)</dt> |
2422 <dd> |
2730 <dd> |
2423 expression of watch expression to clear (string) |
2731 expression of watch expression to clear |
|
2732 </dd> |
|
2733 <dt><i>debuggerId</i> (str)</dt> |
|
2734 <dd> |
|
2735 ID of the debugger backend |
2424 </dd> |
2736 </dd> |
2425 </dl> |
2737 </dl> |
2426 <a NAME="DebugServer.signalClientCompletionList" ID="DebugServer.signalClientCompletionList"></a> |
2738 <a NAME="DebugServer.signalClientCompletionList" ID="DebugServer.signalClientCompletionList"></a> |
2427 <h4>DebugServer.signalClientCompletionList</h4> |
2739 <h4>DebugServer.signalClientCompletionList</h4> |
2428 <b>signalClientCompletionList</b>(<i>completionList, text</i>) |
2740 <b>signalClientCompletionList</b>(<i>completionList, text, debuggerId</i>) |
2429 |
2741 |
2430 <p> |
2742 <p> |
2431 Public method to process the client auto completion info. |
2743 Public method to process the client auto completion info. |
2432 </p> |
2744 </p> |
2433 <dl> |
2745 <dl> |
2434 |
2746 |
2435 <dt><i>completionList</i></dt> |
2747 <dt><i>completionList</i> (list of str)</dt> |
2436 <dd> |
2748 <dd> |
2437 list of possible completions (list of strings) |
2749 list of possible completions |
2438 </dd> |
2750 </dd> |
2439 <dt><i>text</i></dt> |
2751 <dt><i>text</i> (str)</dt> |
2440 <dd> |
2752 <dd> |
2441 the text to be completed (string) |
2753 the text to be completed |
|
2754 </dd> |
|
2755 <dt><i>debuggerId</i> (str)</dt> |
|
2756 <dd> |
|
2757 ID of the debugger backend |
|
2758 </dd> |
|
2759 </dl> |
|
2760 <a NAME="DebugServer.signalClientDebuggerId" ID="DebugServer.signalClientDebuggerId"></a> |
|
2761 <h4>DebugServer.signalClientDebuggerId</h4> |
|
2762 <b>signalClientDebuggerId</b>(<i>debuggerId</i>) |
|
2763 |
|
2764 <p> |
|
2765 Public method to signal the receipt of a new debugger ID. |
|
2766 </p> |
|
2767 <p> |
|
2768 This signal indicates, that a new debugger backend has connected. |
|
2769 </p> |
|
2770 <dl> |
|
2771 |
|
2772 <dt><i>debuggerId</i> (str)</dt> |
|
2773 <dd> |
|
2774 ID of the newly connected debugger backend |
2442 </dd> |
2775 </dd> |
2443 </dl> |
2776 </dl> |
2444 <a NAME="DebugServer.signalClientDisassembly" ID="DebugServer.signalClientDisassembly"></a> |
2777 <a NAME="DebugServer.signalClientDisassembly" ID="DebugServer.signalClientDisassembly"></a> |
2445 <h4>DebugServer.signalClientDisassembly</h4> |
2778 <h4>DebugServer.signalClientDisassembly</h4> |
2446 <b>signalClientDisassembly</b>(<i>disassembly</i>) |
2779 <b>signalClientDisassembly</b>(<i>disassembly, debuggerId</i>) |
2447 |
2780 |
2448 <p> |
2781 <p> |
2449 Public method to process the disassembly info from the client. |
2782 Public method to process the disassembly info from the client. |
2450 </p> |
2783 </p> |
2451 <dl> |
2784 <dl> |
2452 |
2785 |
2453 <dt><i>disassembly</i> (dict)</dt> |
2786 <dt><i>disassembly</i> (dict)</dt> |
2454 <dd> |
2787 <dd> |
2455 dictionary containing the disassembly information |
2788 dictionary containing the disassembly information |
|
2789 </dd> |
|
2790 <dt><i>debuggerId</i> (str)</dt> |
|
2791 <dd> |
|
2792 ID of the debugger backend |
2456 </dd> |
2793 </dd> |
2457 </dl> |
2794 </dl> |
2458 <a NAME="DebugServer.signalClientException" ID="DebugServer.signalClientException"></a> |
2795 <a NAME="DebugServer.signalClientException" ID="DebugServer.signalClientException"></a> |
2459 <h4>DebugServer.signalClientException</h4> |
2796 <h4>DebugServer.signalClientException</h4> |
2460 <b>signalClientException</b>(<i>exceptionType, exceptionMessage, stackTrace</i>) |
2797 <b>signalClientException</b>(<i>exceptionType, exceptionMessage, stackTrace, debuggerId</i>) |
2461 |
2798 |
2462 <p> |
2799 <p> |
2463 Public method to process the exception info from the client. |
2800 Public method to process the exception info from the client. |
2464 </p> |
2801 </p> |
2465 <dl> |
2802 <dl> |
2466 |
2803 |
2467 <dt><i>exceptionType</i></dt> |
2804 <dt><i>exceptionType</i> (str)</dt> |
2468 <dd> |
2805 <dd> |
2469 type of exception raised (string) |
2806 type of exception raised |
2470 </dd> |
2807 </dd> |
2471 <dt><i>exceptionMessage</i></dt> |
2808 <dt><i>exceptionMessage</i> (str)</dt> |
2472 <dd> |
2809 <dd> |
2473 message given by the exception (string) |
2810 message given by the exception |
2474 </dd> |
2811 </dd> |
2475 <dt><i>stackTrace</i></dt> |
2812 <dt><i>stackTrace</i> (list)</dt> |
2476 <dd> |
2813 <dd> |
2477 list of stack entries with the exception position |
2814 list of stack entries with the exception position |
2478 first. Each stack entry is a list giving the filename and the |
2815 first. Each stack entry is a list giving the filename and the |
2479 linenumber. |
2816 linenumber. |
2480 </dd> |
2817 </dd> |
|
2818 <dt><i>debuggerId</i> (str)</dt> |
|
2819 <dd> |
|
2820 ID of the debugger backend |
|
2821 </dd> |
2481 </dl> |
2822 </dl> |
2482 <a NAME="DebugServer.signalClientExit" ID="DebugServer.signalClientExit"></a> |
2823 <a NAME="DebugServer.signalClientExit" ID="DebugServer.signalClientExit"></a> |
2483 <h4>DebugServer.signalClientExit</h4> |
2824 <h4>DebugServer.signalClientExit</h4> |
2484 <b>signalClientExit</b>(<i>status, message=""</i>) |
2825 <b>signalClientExit</b>(<i>program, status, message, debuggerId</i>) |
2485 |
2826 |
2486 <p> |
2827 <p> |
2487 Public method to process the client exit status. |
2828 Public method to process the client exit status. |
2488 </p> |
2829 </p> |
2489 <dl> |
2830 <dl> |
2490 |
2831 |
|
2832 <dt><i>program</i> (str)</dt> |
|
2833 <dd> |
|
2834 name of the exited program |
|
2835 </dd> |
2491 <dt><i>status</i> (int)</dt> |
2836 <dt><i>status</i> (int)</dt> |
2492 <dd> |
2837 <dd> |
2493 exit code |
2838 exit code |
2494 </dd> |
2839 </dd> |
2495 <dt><i>message</i> (str)</dt> |
2840 <dt><i>message</i> (str)</dt> |
2496 <dd> |
2841 <dd> |
2497 message sent with the exit |
2842 message sent with the exit |
|
2843 </dd> |
|
2844 <dt><i>debuggerId</i> (str)</dt> |
|
2845 <dd> |
|
2846 ID of the debugger backend |
2498 </dd> |
2847 </dd> |
2499 </dl> |
2848 </dl> |
2500 <a NAME="DebugServer.signalClientLine" ID="DebugServer.signalClientLine"></a> |
2849 <a NAME="DebugServer.signalClientLine" ID="DebugServer.signalClientLine"></a> |
2501 <h4>DebugServer.signalClientLine</h4> |
2850 <h4>DebugServer.signalClientLine</h4> |
2502 <b>signalClientLine</b>(<i>filename, lineno, forStack=False</i>) |
2851 <b>signalClientLine</b>(<i>filename, lineno, debuggerId, forStack=False</i>) |
2503 |
2852 |
2504 <p> |
2853 <p> |
2505 Public method to process client position feedback. |
2854 Public method to process client position feedback. |
2506 </p> |
2855 </p> |
2507 <dl> |
2856 <dl> |
2508 |
2857 |
2509 <dt><i>filename</i></dt> |
2858 <dt><i>filename</i> (str)</dt> |
2510 <dd> |
2859 <dd> |
2511 name of the file currently being executed (string) |
2860 name of the file currently being executed |
2512 </dd> |
2861 </dd> |
2513 <dt><i>lineno</i></dt> |
2862 <dt><i>lineno</i> (int)</dt> |
2514 <dd> |
2863 <dd> |
2515 line of code currently being executed (integer) |
2864 line of code currently being executed |
2516 </dd> |
2865 </dd> |
2517 <dt><i>forStack</i></dt> |
2866 <dt><i>debuggerId</i> (str)</dt> |
2518 <dd> |
2867 <dd> |
2519 flag indicating this is for a stack dump (boolean) |
2868 ID of the debugger backend |
|
2869 </dd> |
|
2870 <dt><i>forStack</i> (bool)</dt> |
|
2871 <dd> |
|
2872 flag indicating this is for a stack dump |
2520 </dd> |
2873 </dd> |
2521 </dl> |
2874 </dl> |
2522 <a NAME="DebugServer.signalClientOutput" ID="DebugServer.signalClientOutput"></a> |
2875 <a NAME="DebugServer.signalClientOutput" ID="DebugServer.signalClientOutput"></a> |
2523 <h4>DebugServer.signalClientOutput</h4> |
2876 <h4>DebugServer.signalClientOutput</h4> |
2524 <b>signalClientOutput</b>(<i>line</i>) |
2877 <b>signalClientOutput</b>(<i>line, debuggerId</i>) |
2525 |
2878 |
2526 <p> |
2879 <p> |
2527 Public method to process a line of client output. |
2880 Public method to process a line of client output. |
2528 </p> |
2881 </p> |
2529 <dl> |
2882 <dl> |
2530 |
2883 |
2531 <dt><i>line</i></dt> |
2884 <dt><i>line</i> (str)</dt> |
2532 <dd> |
2885 <dd> |
2533 client output (string) |
2886 client output |
|
2887 </dd> |
|
2888 <dt><i>debuggerId</i> (str)</dt> |
|
2889 <dd> |
|
2890 ID of the debugger backend |
2534 </dd> |
2891 </dd> |
2535 </dl> |
2892 </dl> |
2536 <a NAME="DebugServer.signalClientRawInput" ID="DebugServer.signalClientRawInput"></a> |
2893 <a NAME="DebugServer.signalClientRawInput" ID="DebugServer.signalClientRawInput"></a> |
2537 <h4>DebugServer.signalClientRawInput</h4> |
2894 <h4>DebugServer.signalClientRawInput</h4> |
2538 <b>signalClientRawInput</b>(<i>prompt, echo</i>) |
2895 <b>signalClientRawInput</b>(<i>prompt, echo, debuggerId</i>) |
2539 |
2896 |
2540 <p> |
2897 <p> |
2541 Public method to process the client raw input command. |
2898 Public method to process the client raw input command. |
2542 </p> |
2899 </p> |
2543 <dl> |
2900 <dl> |
2544 |
2901 |
2545 <dt><i>prompt</i></dt> |
2902 <dt><i>prompt</i> (str)</dt> |
2546 <dd> |
2903 <dd> |
2547 the input prompt (string) |
2904 the input prompt |
2548 </dd> |
2905 </dd> |
2549 <dt><i>echo</i></dt> |
2906 <dt><i>echo</i> (bool)</dt> |
2550 <dd> |
2907 <dd> |
2551 flag indicating an echoing of the input (boolean) |
2908 flag indicating an echoing of the input |
|
2909 </dd> |
|
2910 <dt><i>debuggerId</i> (str)</dt> |
|
2911 <dd> |
|
2912 ID of the debugger backend |
2552 </dd> |
2913 </dd> |
2553 </dl> |
2914 </dl> |
2554 <a NAME="DebugServer.signalClientSignal" ID="DebugServer.signalClientSignal"></a> |
2915 <a NAME="DebugServer.signalClientSignal" ID="DebugServer.signalClientSignal"></a> |
2555 <h4>DebugServer.signalClientSignal</h4> |
2916 <h4>DebugServer.signalClientSignal</h4> |
2556 <b>signalClientSignal</b>(<i>message, filename, lineNo, funcName, funcArgs</i>) |
2917 <b>signalClientSignal</b>(<i>message, filename, lineNo, funcName, funcArgs, debuggerId</i>) |
2557 |
2918 |
2558 <p> |
2919 <p> |
2559 Public method to process a signal generated on the client side. |
2920 Public method to process a signal generated on the client side. |
2560 </p> |
2921 </p> |
2561 <dl> |
2922 <dl> |
2577 name of the function causing the signal |
2938 name of the function causing the signal |
2578 </dd> |
2939 </dd> |
2579 <dt><i>funcArgs</i> (str)</dt> |
2940 <dt><i>funcArgs</i> (str)</dt> |
2580 <dd> |
2941 <dd> |
2581 function arguments |
2942 function arguments |
|
2943 </dd> |
|
2944 <dt><i>debuggerId</i> (str)</dt> |
|
2945 <dd> |
|
2946 ID of the debugger backend |
2582 </dd> |
2947 </dd> |
2583 </dl> |
2948 </dl> |
2584 <a NAME="DebugServer.signalClientStack" ID="DebugServer.signalClientStack"></a> |
2949 <a NAME="DebugServer.signalClientStack" ID="DebugServer.signalClientStack"></a> |
2585 <h4>DebugServer.signalClientStack</h4> |
2950 <h4>DebugServer.signalClientStack</h4> |
2586 <b>signalClientStack</b>(<i>stack</i>) |
2951 <b>signalClientStack</b>(<i>stack, debuggerId</i>) |
2587 |
2952 |
2588 <p> |
2953 <p> |
2589 Public method to process a client's stack information. |
2954 Public method to process a client's stack information. |
2590 </p> |
2955 </p> |
2591 <dl> |
2956 <dl> |
2592 |
2957 |
2593 <dt><i>stack</i></dt> |
2958 <dt><i>stack</i> (list of lists of (string, integer, string))</dt> |
2594 <dd> |
2959 <dd> |
2595 list of stack entries. Each entry is a tuple of three |
2960 list of stack entries. Each entry is a tuple of three |
2596 values giving the filename, linenumber and method |
2961 values giving the filename, linenumber and method |
2597 (list of lists of (string, integer, string)) |
2962 </dd> |
|
2963 <dt><i>debuggerId</i> (str)</dt> |
|
2964 <dd> |
|
2965 ID of the debugger backend |
2598 </dd> |
2966 </dd> |
2599 </dl> |
2967 </dl> |
2600 <a NAME="DebugServer.signalClientStatement" ID="DebugServer.signalClientStatement"></a> |
2968 <a NAME="DebugServer.signalClientStatement" ID="DebugServer.signalClientStatement"></a> |
2601 <h4>DebugServer.signalClientStatement</h4> |
2969 <h4>DebugServer.signalClientStatement</h4> |
2602 <b>signalClientStatement</b>(<i>more</i>) |
2970 <b>signalClientStatement</b>(<i>more, debuggerId</i>) |
2603 |
2971 |
2604 <p> |
2972 <p> |
2605 Public method to process the input response from the client. |
2973 Public method to process the input response from the client. |
2606 </p> |
2974 </p> |
2607 <dl> |
2975 <dl> |
2608 |
2976 |
2609 <dt><i>more</i></dt> |
2977 <dt><i>more</i> (bool)</dt> |
2610 <dd> |
2978 <dd> |
2611 flag indicating that more user input is required |
2979 flag indicating that more user input is required |
|
2980 </dd> |
|
2981 <dt><i>debuggerId</i> (str)</dt> |
|
2982 <dd> |
|
2983 ID of the debugger backend |
2612 </dd> |
2984 </dd> |
2613 </dl> |
2985 </dl> |
2614 <a NAME="DebugServer.signalClientSyntaxError" ID="DebugServer.signalClientSyntaxError"></a> |
2986 <a NAME="DebugServer.signalClientSyntaxError" ID="DebugServer.signalClientSyntaxError"></a> |
2615 <h4>DebugServer.signalClientSyntaxError</h4> |
2987 <h4>DebugServer.signalClientSyntaxError</h4> |
2616 <b>signalClientSyntaxError</b>(<i>message, filename, lineNo, characterNo</i>) |
2988 <b>signalClientSyntaxError</b>(<i>message, filename, lineNo, characterNo, debuggerId</i>) |
2617 |
2989 |
2618 <p> |
2990 <p> |
2619 Public method to process the syntax error info from the client. |
2991 Public method to process a syntax error info from the client. |
2620 </p> |
2992 </p> |
2621 <dl> |
2993 <dl> |
2622 |
2994 |
2623 <dt><i>message</i></dt> |
2995 <dt><i>message</i> (str)</dt> |
2624 <dd> |
2996 <dd> |
2625 message of the syntax error (string) |
2997 message of the syntax error |
2626 </dd> |
2998 </dd> |
2627 <dt><i>filename</i></dt> |
2999 <dt><i>filename</i> (str)</dt> |
2628 <dd> |
3000 <dd> |
2629 translated filename of the syntax error position |
3001 translated filename of the syntax error position |
2630 (string) |
3002 </dd> |
2631 </dd> |
3003 <dt><i>lineNo</i> (int)</dt> |
2632 <dt><i>lineNo</i></dt> |
3004 <dd> |
2633 <dd> |
3005 line number of the syntax error position |
2634 line number of the syntax error position (integer) |
3006 </dd> |
2635 </dd> |
3007 <dt><i>characterNo</i> (int)</dt> |
2636 <dt><i>characterNo</i></dt> |
|
2637 <dd> |
3008 <dd> |
2638 character number of the syntax error position |
3009 character number of the syntax error position |
2639 (integer) |
3010 </dd> |
|
3011 <dt><i>debuggerId</i> (str)</dt> |
|
3012 <dd> |
|
3013 ID of the debugger backend |
2640 </dd> |
3014 </dd> |
2641 </dl> |
3015 </dl> |
2642 <a NAME="DebugServer.signalClientThreadList" ID="DebugServer.signalClientThreadList"></a> |
3016 <a NAME="DebugServer.signalClientThreadList" ID="DebugServer.signalClientThreadList"></a> |
2643 <h4>DebugServer.signalClientThreadList</h4> |
3017 <h4>DebugServer.signalClientThreadList</h4> |
2644 <b>signalClientThreadList</b>(<i>currentId, threadList</i>) |
3018 <b>signalClientThreadList</b>(<i>currentId, threadList, debuggerId</i>) |
2645 |
3019 |
2646 <p> |
3020 <p> |
2647 Public method to process the client thread list info. |
3021 Public method to process the client thread list info. |
2648 </p> |
3022 </p> |
2649 <dl> |
3023 <dl> |
2650 |
3024 |
2651 <dt><i>currentId</i></dt> |
3025 <dt><i>currentId</i> (int)</dt> |
2652 <dd> |
3026 <dd> |
2653 id of the current thread (integer) |
3027 id of the current thread |
2654 </dd> |
3028 </dd> |
2655 <dt><i>threadList</i></dt> |
3029 <dt><i>threadList</i> (list of dict)</dt> |
2656 <dd> |
3030 <dd> |
2657 list of dictionaries containing the thread data |
3031 list of dictionaries containing the thread data |
|
3032 </dd> |
|
3033 <dt><i>debuggerId</i> (str)</dt> |
|
3034 <dd> |
|
3035 ID of the debugger backend |
2658 </dd> |
3036 </dd> |
2659 </dl> |
3037 </dl> |
2660 <a NAME="DebugServer.signalClientThreadSet" ID="DebugServer.signalClientThreadSet"></a> |
3038 <a NAME="DebugServer.signalClientThreadSet" ID="DebugServer.signalClientThreadSet"></a> |
2661 <h4>DebugServer.signalClientThreadSet</h4> |
3039 <h4>DebugServer.signalClientThreadSet</h4> |
2662 <b>signalClientThreadSet</b>(<i></i>) |
3040 <b>signalClientThreadSet</b>(<i>debuggerId</i>) |
2663 |
3041 |
2664 <p> |
3042 <p> |
2665 Public method to handle the change of the client thread. |
3043 Public method to handle the change of the client thread. |
2666 </p> |
3044 </p> |
|
3045 <dl> |
|
3046 |
|
3047 <dt><i>debuggerId</i> (str)</dt> |
|
3048 <dd> |
|
3049 ID of the debugger backend |
|
3050 </dd> |
|
3051 </dl> |
2667 <a NAME="DebugServer.signalClientVariable" ID="DebugServer.signalClientVariable"></a> |
3052 <a NAME="DebugServer.signalClientVariable" ID="DebugServer.signalClientVariable"></a> |
2668 <h4>DebugServer.signalClientVariable</h4> |
3053 <h4>DebugServer.signalClientVariable</h4> |
2669 <b>signalClientVariable</b>(<i>scope, variables</i>) |
3054 <b>signalClientVariable</b>(<i>scope, variables, debuggerId</i>) |
2670 |
3055 |
2671 <p> |
3056 <p> |
2672 Public method to process the client variable info. |
3057 Public method to process the client variable info. |
2673 </p> |
3058 </p> |
2674 <dl> |
3059 <dl> |
2675 |
3060 |
2676 <dt><i>scope</i></dt> |
3061 <dt><i>scope</i> (int)</dt> |
2677 <dd> |
3062 <dd> |
2678 scope of the variables (-1 = empty global, 1 = global, |
3063 scope of the variables (-1 = empty global, 1 = global, |
2679 0 = local) |
3064 0 = local) |
2680 </dd> |
3065 </dd> |
2681 <dt><i>variables</i></dt> |
3066 <dt><i>variables</i> (list)</dt> |
2682 <dd> |
3067 <dd> |
2683 the list of members of a classvariable from the client |
3068 the list of members of a classvariable from the client |
|
3069 </dd> |
|
3070 <dt><i>debuggerId</i> (str)</dt> |
|
3071 <dd> |
|
3072 ID of the debugger backend |
2684 </dd> |
3073 </dd> |
2685 </dl> |
3074 </dl> |
2686 <a NAME="DebugServer.signalClientVariables" ID="DebugServer.signalClientVariables"></a> |
3075 <a NAME="DebugServer.signalClientVariables" ID="DebugServer.signalClientVariables"></a> |
2687 <h4>DebugServer.signalClientVariables</h4> |
3076 <h4>DebugServer.signalClientVariables</h4> |
2688 <b>signalClientVariables</b>(<i>scope, variables</i>) |
3077 <b>signalClientVariables</b>(<i>scope, variables, debuggerId</i>) |
2689 |
3078 |
2690 <p> |
3079 <p> |
2691 Public method to process the client variables info. |
3080 Public method to process the client variables info. |
2692 </p> |
3081 </p> |
2693 <dl> |
3082 <dl> |
2694 |
3083 |
2695 <dt><i>scope</i></dt> |
3084 <dt><i>scope</i> (int)</dt> |
2696 <dd> |
3085 <dd> |
2697 scope of the variables (-1 = empty global, 1 = global, |
3086 scope of the variables (-1 = empty global, 1 = global, |
2698 0 = local) |
3087 0 = local) |
2699 </dd> |
3088 </dd> |
2700 <dt><i>variables</i></dt> |
3089 <dt><i>variables</i> (list)</dt> |
2701 <dd> |
3090 <dd> |
2702 the list of variables from the client |
3091 the list of variables from the client |
|
3092 </dd> |
|
3093 <dt><i>debuggerId</i> (str)</dt> |
|
3094 <dd> |
|
3095 ID of the debugger backend |
2703 </dd> |
3096 </dd> |
2704 </dl> |
3097 </dl> |
2705 <a NAME="DebugServer.signalClientWatchConditionError" ID="DebugServer.signalClientWatchConditionError"></a> |
3098 <a NAME="DebugServer.signalClientWatchConditionError" ID="DebugServer.signalClientWatchConditionError"></a> |
2706 <h4>DebugServer.signalClientWatchConditionError</h4> |
3099 <h4>DebugServer.signalClientWatchConditionError</h4> |
2707 <b>signalClientWatchConditionError</b>(<i>condition</i>) |
3100 <b>signalClientWatchConditionError</b>(<i>condition, debuggerId</i>) |
2708 |
3101 |
2709 <p> |
3102 <p> |
2710 Public method to process the client watch expression error info. |
3103 Public method to process the client watch expression error info. |
2711 </p> |
3104 </p> |
2712 <dl> |
3105 <dl> |
2713 |
3106 |
2714 <dt><i>condition</i></dt> |
3107 <dt><i>condition</i> (str)</dt> |
2715 <dd> |
3108 <dd> |
2716 expression of watch expression to clear (string) |
3109 expression of watch expression to clear |
2717 </dd> |
3110 </dd> |
2718 </dl> |
3111 <dt><i>debuggerId</i> (str)</dt> |
|
3112 <dd> |
|
3113 ID of the debugger backend |
|
3114 </dd> |
|
3115 </dl> |
|
3116 <a NAME="DebugServer.signalLastClientExited" ID="DebugServer.signalLastClientExited"></a> |
|
3117 <h4>DebugServer.signalLastClientExited</h4> |
|
3118 <b>signalLastClientExited</b>(<i></i>) |
|
3119 |
|
3120 <p> |
|
3121 Public method to process the last client exit event. |
|
3122 </p> |
2719 <a NAME="DebugServer.startClient" ID="DebugServer.startClient"></a> |
3123 <a NAME="DebugServer.startClient" ID="DebugServer.startClient"></a> |
2720 <h4>DebugServer.startClient</h4> |
3124 <h4>DebugServer.startClient</h4> |
2721 <b>startClient</b>(<i>unplanned=True, clType=None, forProject=False, runInConsole=False, venvName="", workingDir=None</i>) |
3125 <b>startClient</b>(<i>unplanned=True, clType=None, forProject=False, runInConsole=False, venvName="", workingDir=None</i>) |
2722 |
3126 |
2723 <p> |
3127 <p> |
2724 Public method to start a debug client. |
3128 Public method to start a debug client. |
2725 </p> |
3129 </p> |
2726 <dl> |
3130 <dl> |
2727 |
3131 |
2728 <dt><i>unplanned=</i> (bool)</dt> |
3132 <dt><i>unplanned</i> (bool)</dt> |
2729 <dd> |
3133 <dd> |
2730 flag indicating that the client has died |
3134 flag indicating that the client has died |
2731 </dd> |
3135 </dd> |
2732 <dt><i>clType=</i> (str)</dt> |
3136 <dt><i>clType</i> (str)</dt> |
2733 <dd> |
3137 <dd> |
2734 type of client to be started |
3138 type of client to be started |
2735 </dd> |
3139 </dd> |
2736 <dt><i>forProject=</i> (bool)</dt> |
3140 <dt><i>forProject</i> (bool)</dt> |
2737 <dd> |
3141 <dd> |
2738 flag indicating a project related action |
3142 flag indicating a project related action |
2739 </dd> |
3143 </dd> |
2740 <dt><i>runInConsole=</i> (bool)</dt> |
3144 <dt><i>runInConsole</i> (bool)</dt> |
2741 <dd> |
3145 <dd> |
2742 flag indicating to start the debugger in a |
3146 flag indicating to start the debugger in a |
2743 console window |
3147 console window |
2744 </dd> |
3148 </dd> |
2745 <dt><i>venvName=</i> (str)</dt> |
3149 <dt><i>venvName</i> (str)</dt> |
2746 <dd> |
3150 <dd> |
2747 name of the virtual environment to be used |
3151 name of the virtual environment to be used |
2748 </dd> |
3152 </dd> |
2749 <dt><i>workingDir=</i> (str)</dt> |
3153 <dt><i>workingDir</i> (str)</dt> |
2750 <dd> |
3154 <dd> |
2751 directory to start the debugger client in |
3155 directory to start the debugger client in |
2752 </dd> |
3156 </dd> |
2753 </dl> |
3157 </dl> |
2754 <a NAME="DebugServer.unregisterDebuggerInterface" ID="DebugServer.unregisterDebuggerInterface"></a> |
3158 <a NAME="DebugServer.unregisterDebuggerInterface" ID="DebugServer.unregisterDebuggerInterface"></a> |