Mercurial Repositories > Rope Refactoring / file comparison

comparison: RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistServer.html

RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistServer.html

changeset 321
d51e810107ec
parent 295
8318a6881e63
child 347
b5048b5ff454
equal deleted inserted replaced
320:91b171fdd85f 321:d51e810107ec
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>Plugin_Refactoring_Rope.RefactoringRope.CodeAssistServer</h1> 23 <h1>Plugin_Refactoring_Rope.RefactoringRope.CodeAssistServer</h1>
24
23 <p> 25 <p>
24 Module implementing the autocompletion interface to rope. 26 Module implementing the autocompletion interface to rope.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
34
31 <table> 35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#CodeAssistServer">CodeAssistServer</a></td> 38 <td><a href="#CodeAssistServer">CodeAssistServer</a></td>
34 <td>Class implementing the autocompletion interface to rope.</td> 39 <td>Class implementing the autocompletion interface to rope.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
39 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
40 </table> 46 </table>
41 <hr /><hr /> 47 <hr />
48 <hr />
42 <a NAME="CodeAssistServer" ID="CodeAssistServer"></a> 49 <a NAME="CodeAssistServer" ID="CodeAssistServer"></a>
43 <h2>CodeAssistServer</h2> 50 <h2>CodeAssistServer</h2>
51
44 <p> 52 <p>
45 Class implementing the autocompletion interface to rope. 53 Class implementing the autocompletion interface to rope.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 JsonServer 56 JsonServer
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>IdProject</td></tr><tr><td>PictureIDs</td></tr> 60 <tr><td>IdProject</td></tr><tr><td>PictureIDs</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
68
58 <table> 69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#CodeAssistServer.__init__">CodeAssistServer</a></td> 72 <td><a href="#CodeAssistServer.__init__">CodeAssistServer</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#CodeAssistServer.__configChanged">__configChanged</a></td> 76 <td><a href="#CodeAssistServer.__configChanged">__configChanged</a></td>
64 <td>Private slot called, when the rope config file has changed.</td> 77 <td>Private slot called, when the rope config file has changed.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#CodeAssistServer.__ensureActive">__ensureActive</a></td> 80 <td><a href="#CodeAssistServer.__ensureActive">__ensureActive</a></td>
67 <td>Private method to ensure, that the requested client is active.</td> 81 <td>Private method to ensure, that the requested client is active.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#CodeAssistServer.__getConfigs">__getConfigs</a></td> 84 <td><a href="#CodeAssistServer.__getConfigs">__getConfigs</a></td>
70 <td>Private method to get the configurations of all connected clients.</td> 85 <td>Private method to get the configurations of all connected clients.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#CodeAssistServer.__gotoDefinitionResult">__gotoDefinitionResult</a></td> 88 <td><a href="#CodeAssistServer.__gotoDefinitionResult">__gotoDefinitionResult</a></td>
73 <td>Private method to handle the "Goto Definition" result sent by the client.</td> 89 <td>Private method to handle the "Goto Definition" result sent by the client.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#CodeAssistServer.__idString">__idString</a></td> 92 <td><a href="#CodeAssistServer.__idString">__idString</a></td>
76 <td>Private method to determine the ID string for the back-end.</td> 93 <td>Private method to determine the ID string for the back-end.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#CodeAssistServer.__interpreterForProject">__interpreterForProject</a></td> 96 <td><a href="#CodeAssistServer.__interpreterForProject">__interpreterForProject</a></td>
79 <td>Private method to determine the interpreter for the current project and the environment to run it.</td> 97 <td>Private method to determine the interpreter for the current project and the environment to run it.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#CodeAssistServer.__processCallTipsResult">__processCallTipsResult</a></td> 100 <td><a href="#CodeAssistServer.__processCallTipsResult">__processCallTipsResult</a></td>
82 <td>Private method to process the calltips sent by the client.</td> 101 <td>Private method to process the calltips sent by the client.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#CodeAssistServer.__processClientException">__processClientException</a></td> 104 <td><a href="#CodeAssistServer.__processClientException">__processClientException</a></td>
85 <td>Private method to handle exceptions of the refactoring client.</td> 105 <td>Private method to handle exceptions of the refactoring client.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#CodeAssistServer.__processCompletionsResult">__processCompletionsResult</a></td> 108 <td><a href="#CodeAssistServer.__processCompletionsResult">__processCompletionsResult</a></td>
88 <td>Private method to process the completions sent by the client.</td> 109 <td>Private method to process the completions sent by the client.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#CodeAssistServer.__processDocumentationResult">__processDocumentationResult</a></td> 112 <td><a href="#CodeAssistServer.__processDocumentationResult">__processDocumentationResult</a></td>
91 <td>Private method to process the documentation sent by the client.</td> 113 <td>Private method to process the documentation sent by the client.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#CodeAssistServer.__projectClosed">__projectClosed</a></td> 116 <td><a href="#CodeAssistServer.__projectClosed">__projectClosed</a></td>
94 <td>Private slot to handle the projectClosed signal.</td> 117 <td>Private slot to handle the projectClosed signal.</td>
95 </tr><tr> 118 </tr>
119 <tr>
96 <td><a href="#CodeAssistServer.__ropeConfigFile">__ropeConfigFile</a></td> 120 <td><a href="#CodeAssistServer.__ropeConfigFile">__ropeConfigFile</a></td>
97 <td>Private method to get the name of the rope configuration file.</td> 121 <td>Private method to get the name of the rope configuration file.</td>
98 </tr><tr> 122 </tr>
123 <tr>
99 <td><a href="#CodeAssistServer.__setConfig">__setConfig</a></td> 124 <td><a href="#CodeAssistServer.__setConfig">__setConfig</a></td>
100 <td>Private method to set the rope client configuration data.</td> 125 <td>Private method to set the rope client configuration data.</td>
101 </tr><tr> 126 </tr>
127 <tr>
102 <td><a href="#CodeAssistServer.__startCodeAssistClient">__startCodeAssistClient</a></td> 128 <td><a href="#CodeAssistServer.__startCodeAssistClient">__startCodeAssistClient</a></td>
103 <td>Private method to start the code assist client with the given interpreter.</td> 129 <td>Private method to start the code assist client with the given interpreter.</td>
104 </tr><tr> 130 </tr>
131 <tr>
105 <td><a href="#CodeAssistServer.__updateEditorLanguageMapping">__updateEditorLanguageMapping</a></td> 132 <td><a href="#CodeAssistServer.__updateEditorLanguageMapping">__updateEditorLanguageMapping</a></td>
106 <td>Private method to update the editor language to connection mapping.</td> 133 <td>Private method to update the editor language to connection mapping.</td>
107 </tr><tr> 134 </tr>
135 <tr>
108 <td><a href="#CodeAssistServer.activate">activate</a></td> 136 <td><a href="#CodeAssistServer.activate">activate</a></td>
109 <td>Public method to activate the code assist server.</td> 137 <td>Public method to activate the code assist server.</td>
110 </tr><tr> 138 </tr>
139 <tr>
111 <td><a href="#CodeAssistServer.deactivate">deactivate</a></td> 140 <td><a href="#CodeAssistServer.deactivate">deactivate</a></td>
112 <td>Public method to deactivate the code assist server.</td> 141 <td>Public method to deactivate the code assist server.</td>
113 </tr><tr> 142 </tr>
143 <tr>
114 <td><a href="#CodeAssistServer.editConfig">editConfig</a></td> 144 <td><a href="#CodeAssistServer.editConfig">editConfig</a></td>
115 <td>Public slot to open the rope configuration file in an editor.</td> 145 <td>Public slot to open the rope configuration file in an editor.</td>
116 </tr><tr> 146 </tr>
147 <tr>
117 <td><a href="#CodeAssistServer.getCallTips">getCallTips</a></td> 148 <td><a href="#CodeAssistServer.getCallTips">getCallTips</a></td>
118 <td>Public method to calculate calltips.</td> 149 <td>Public method to calculate calltips.</td>
119 </tr><tr> 150 </tr>
151 <tr>
120 <td><a href="#CodeAssistServer.getCompletions">getCompletions</a></td> 152 <td><a href="#CodeAssistServer.getCompletions">getCompletions</a></td>
121 <td>Public method to calculate the possible completions.</td> 153 <td>Public method to calculate the possible completions.</td>
122 </tr><tr> 154 </tr>
155 <tr>
123 <td><a href="#CodeAssistServer.gotoDefinition">gotoDefinition</a></td> 156 <td><a href="#CodeAssistServer.gotoDefinition">gotoDefinition</a></td>
124 <td>Public slot to find the definition for the word at the cursor position and go to it.</td> 157 <td>Public slot to find the definition for the word at the cursor position and go to it.</td>
125 </tr><tr> 158 </tr>
159 <tr>
126 <td><a href="#CodeAssistServer.handleCall">handleCall</a></td> 160 <td><a href="#CodeAssistServer.handleCall">handleCall</a></td>
127 <td>Public method to handle a method call from the client.</td> 161 <td>Public method to handle a method call from the client.</td>
128 </tr><tr> 162 </tr>
163 <tr>
129 <td><a href="#CodeAssistServer.handleNewConnection">handleNewConnection</a></td> 164 <td><a href="#CodeAssistServer.handleNewConnection">handleNewConnection</a></td>
130 <td>Public slot for new incoming connections from a client.</td> 165 <td>Public slot for new incoming connections from a client.</td>
131 </tr><tr> 166 </tr>
167 <tr>
132 <td><a href="#CodeAssistServer.isSupportedLanguage">isSupportedLanguage</a></td> 168 <td><a href="#CodeAssistServer.isSupportedLanguage">isSupportedLanguage</a></td>
133 <td>Public method to check, if the given language is supported.</td> 169 <td>Public method to check, if the given language is supported.</td>
134 </tr><tr> 170 </tr>
171 <tr>
135 <td><a href="#CodeAssistServer.reportChanged">reportChanged</a></td> 172 <td><a href="#CodeAssistServer.reportChanged">reportChanged</a></td>
136 <td>Public slot to report some changed sources.</td> 173 <td>Public slot to report some changed sources.</td>
137 </tr><tr> 174 </tr>
175 <tr>
138 <td><a href="#CodeAssistServer.requestCodeDocumentation">requestCodeDocumentation</a></td> 176 <td><a href="#CodeAssistServer.requestCodeDocumentation">requestCodeDocumentation</a></td>
139 <td>Public method to request source code documentation for the given editor.</td> 177 <td>Public method to request source code documentation for the given editor.</td>
140 </tr><tr> 178 </tr>
179 <tr>
141 <td><a href="#CodeAssistServer.requestCompletions">requestCompletions</a></td> 180 <td><a href="#CodeAssistServer.requestCompletions">requestCompletions</a></td>
142 <td>Public method to request a list of possible completions.</td> 181 <td>Public method to request a list of possible completions.</td>
143 </tr><tr> 182 </tr>
183 <tr>
144 <td><a href="#CodeAssistServer.setAsyncCompletions">setAsyncCompletions</a></td> 184 <td><a href="#CodeAssistServer.setAsyncCompletions">setAsyncCompletions</a></td>
145 <td>Public method to set the asynchronous completions flag.</td> 185 <td>Public method to set the asynchronous completions flag.</td>
146 </tr> 186 </tr>
147 </table> 187 </table>
148 <h3>Static Methods</h3> 188 <h3>Static Methods</h3>
189
149 <table> 190 <table>
150 <tr><td>None</td></tr> 191 <tr><td>None</td></tr>
151 </table> 192 </table>
193
152 <a NAME="CodeAssistServer.__init__" ID="CodeAssistServer.__init__"></a> 194 <a NAME="CodeAssistServer.__init__" ID="CodeAssistServer.__init__"></a>
153 <h4>CodeAssistServer (Constructor)</h4> 195 <h4>CodeAssistServer (Constructor)</h4>
154 <b>CodeAssistServer</b>(<i>plugin, parent=None</i>) 196 <b>CodeAssistServer</b>(<i>plugin, parent=None</i>)
197
155 <p> 198 <p>
156 Constructor 199 Constructor
157 </p><dl> 200 </p>
201 <dl>
202
158 <dt><i>plugin</i> (RefactoringRopePlugin)</dt> 203 <dt><i>plugin</i> (RefactoringRopePlugin)</dt>
159 <dd> 204 <dd>
160 reference to the plugin object 205 reference to the plugin object
161 </dd><dt><i>parent</i> (QObject)</dt> 206 </dd>
207 <dt><i>parent</i> (QObject)</dt>
162 <dd> 208 <dd>
163 parent 209 parent
164 </dd> 210 </dd>
165 </dl><a NAME="CodeAssistServer.__configChanged" ID="CodeAssistServer.__configChanged"></a> 211 </dl>
212 <a NAME="CodeAssistServer.__configChanged" ID="CodeAssistServer.__configChanged"></a>
166 <h4>CodeAssistServer.__configChanged</h4> 213 <h4>CodeAssistServer.__configChanged</h4>
167 <b>__configChanged</b>(<i>idString</i>) 214 <b>__configChanged</b>(<i>idString</i>)
215
168 <p> 216 <p>
169 Private slot called, when the rope config file has changed. 217 Private slot called, when the rope config file has changed.
170 </p><dl> 218 </p>
219 <dl>
220
171 <dt><i>idString</i> (str)</dt> 221 <dt><i>idString</i> (str)</dt>
172 <dd> 222 <dd>
173 id for which to get the configuration file 223 id for which to get the configuration file
174 </dd> 224 </dd>
175 </dl><a NAME="CodeAssistServer.__ensureActive" ID="CodeAssistServer.__ensureActive"></a> 225 </dl>
226 <a NAME="CodeAssistServer.__ensureActive" ID="CodeAssistServer.__ensureActive"></a>
176 <h4>CodeAssistServer.__ensureActive</h4> 227 <h4>CodeAssistServer.__ensureActive</h4>
177 <b>__ensureActive</b>(<i>idString</i>) 228 <b>__ensureActive</b>(<i>idString</i>)
229
178 <p> 230 <p>
179 Private method to ensure, that the requested client is active. 231 Private method to ensure, that the requested client is active.
180 </p><p> 232 </p>
233 <p>
181 A non-active client will be started. 234 A non-active client will be started.
182 </p><dl> 235 </p>
236 <dl>
237
183 <dt><i>idString</i> (str)</dt> 238 <dt><i>idString</i> (str)</dt>
184 <dd> 239 <dd>
185 id of the client to be checked 240 id of the client to be checked
186 </dd> 241 </dd>
187 </dl><dl> 242 </dl>
243 <dl>
188 <dt>Returns:</dt> 244 <dt>Returns:</dt>
189 <dd> 245 <dd>
190 flag indicating an active client 246 flag indicating an active client
191 </dd> 247 </dd>
192 </dl><dl> 248 </dl>
249 <dl>
193 <dt>Return Type:</dt> 250 <dt>Return Type:</dt>
194 <dd> 251 <dd>
195 bool 252 bool
196 </dd> 253 </dd>
197 </dl><a NAME="CodeAssistServer.__getConfigs" ID="CodeAssistServer.__getConfigs"></a> 254 </dl>
255 <a NAME="CodeAssistServer.__getConfigs" ID="CodeAssistServer.__getConfigs"></a>
198 <h4>CodeAssistServer.__getConfigs</h4> 256 <h4>CodeAssistServer.__getConfigs</h4>
199 <b>__getConfigs</b>(<i></i>) 257 <b>__getConfigs</b>(<i></i>)
258
200 <p> 259 <p>
201 Private method to get the configurations of all connected clients. 260 Private method to get the configurations of all connected clients.
202 </p><a NAME="CodeAssistServer.__gotoDefinitionResult" ID="CodeAssistServer.__gotoDefinitionResult"></a> 261 </p>
262 <a NAME="CodeAssistServer.__gotoDefinitionResult" ID="CodeAssistServer.__gotoDefinitionResult"></a>
203 <h4>CodeAssistServer.__gotoDefinitionResult</h4> 263 <h4>CodeAssistServer.__gotoDefinitionResult</h4>
204 <b>__gotoDefinitionResult</b>(<i>result</i>) 264 <b>__gotoDefinitionResult</b>(<i>result</i>)
265
205 <p> 266 <p>
206 Private method to handle the "Goto Definition" result sent by 267 Private method to handle the "Goto Definition" result sent by
207 the client. 268 the client.
208 </p><dl> 269 </p>
270 <dl>
271
209 <dt><i>result</i> (dict)</dt> 272 <dt><i>result</i> (dict)</dt>
210 <dd> 273 <dd>
211 dictionary containing the result data 274 dictionary containing the result data
212 </dd> 275 </dd>
213 </dl><a NAME="CodeAssistServer.__idString" ID="CodeAssistServer.__idString"></a> 276 </dl>
277 <a NAME="CodeAssistServer.__idString" ID="CodeAssistServer.__idString"></a>
214 <h4>CodeAssistServer.__idString</h4> 278 <h4>CodeAssistServer.__idString</h4>
215 <b>__idString</b>(<i>editor</i>) 279 <b>__idString</b>(<i>editor</i>)
280
216 <p> 281 <p>
217 Private method to determine the ID string for the back-end. 282 Private method to determine the ID string for the back-end.
218 </p><dl> 283 </p>
284 <dl>
285
219 <dt><i>editor</i> (QScintilla.Editor)</dt> 286 <dt><i>editor</i> (QScintilla.Editor)</dt>
220 <dd> 287 <dd>
221 reference to the editor to determine the ID string for 288 reference to the editor to determine the ID string for
222 </dd> 289 </dd>
223 </dl><dl> 290 </dl>
291 <dl>
224 <dt>Returns:</dt> 292 <dt>Returns:</dt>
225 <dd> 293 <dd>
226 ID string 294 ID string
227 </dd> 295 </dd>
228 </dl><dl> 296 </dl>
297 <dl>
229 <dt>Return Type:</dt> 298 <dt>Return Type:</dt>
230 <dd> 299 <dd>
231 str 300 str
232 </dd> 301 </dd>
233 </dl><a NAME="CodeAssistServer.__interpreterForProject" ID="CodeAssistServer.__interpreterForProject"></a> 302 </dl>
303 <a NAME="CodeAssistServer.__interpreterForProject" ID="CodeAssistServer.__interpreterForProject"></a>
234 <h4>CodeAssistServer.__interpreterForProject</h4> 304 <h4>CodeAssistServer.__interpreterForProject</h4>
235 <b>__interpreterForProject</b>(<i></i>) 305 <b>__interpreterForProject</b>(<i></i>)
306
236 <p> 307 <p>
237 Private method to determine the interpreter for the current project and 308 Private method to determine the interpreter for the current project and
238 the environment to run it. 309 the environment to run it.
239 </p><dl> 310 </p>
311 <dl>
240 <dt>Returns:</dt> 312 <dt>Returns:</dt>
241 <dd> 313 <dd>
242 tuple containing the interpreter of the current project and the 314 tuple containing the interpreter of the current project and the
243 environment variables 315 environment variables
244 </dd> 316 </dd>
245 </dl><dl> 317 </dl>
318 <dl>
246 <dt>Return Type:</dt> 319 <dt>Return Type:</dt>
247 <dd> 320 <dd>
248 tuple of (str, dict) 321 tuple of (str, dict)
249 </dd> 322 </dd>
250 </dl><a NAME="CodeAssistServer.__processCallTipsResult" ID="CodeAssistServer.__processCallTipsResult"></a> 323 </dl>
324 <a NAME="CodeAssistServer.__processCallTipsResult" ID="CodeAssistServer.__processCallTipsResult"></a>
251 <h4>CodeAssistServer.__processCallTipsResult</h4> 325 <h4>CodeAssistServer.__processCallTipsResult</h4>
252 <b>__processCallTipsResult</b>(<i>result</i>) 326 <b>__processCallTipsResult</b>(<i>result</i>)
327
253 <p> 328 <p>
254 Private method to process the calltips sent by the client. 329 Private method to process the calltips sent by the client.
255 </p><dl> 330 </p>
331 <dl>
332
256 <dt><i>result</i> (dict)</dt> 333 <dt><i>result</i> (dict)</dt>
257 <dd> 334 <dd>
258 dictionary containing the result sent by the client 335 dictionary containing the result sent by the client
259 </dd> 336 </dd>
260 </dl><a NAME="CodeAssistServer.__processClientException" ID="CodeAssistServer.__processClientException"></a> 337 </dl>
338 <a NAME="CodeAssistServer.__processClientException" ID="CodeAssistServer.__processClientException"></a>
261 <h4>CodeAssistServer.__processClientException</h4> 339 <h4>CodeAssistServer.__processClientException</h4>
262 <b>__processClientException</b>(<i>params</i>) 340 <b>__processClientException</b>(<i>params</i>)
341
263 <p> 342 <p>
264 Private method to handle exceptions of the refactoring client. 343 Private method to handle exceptions of the refactoring client.
265 </p><dl> 344 </p>
345 <dl>
346
266 <dt><i>params</i> (dict)</dt> 347 <dt><i>params</i> (dict)</dt>
267 <dd> 348 <dd>
268 dictionary containing the exception data 349 dictionary containing the exception data
269 </dd> 350 </dd>
270 </dl><a NAME="CodeAssistServer.__processCompletionsResult" ID="CodeAssistServer.__processCompletionsResult"></a> 351 </dl>
352 <a NAME="CodeAssistServer.__processCompletionsResult" ID="CodeAssistServer.__processCompletionsResult"></a>
271 <h4>CodeAssistServer.__processCompletionsResult</h4> 353 <h4>CodeAssistServer.__processCompletionsResult</h4>
272 <b>__processCompletionsResult</b>(<i>result</i>) 354 <b>__processCompletionsResult</b>(<i>result</i>)
355
273 <p> 356 <p>
274 Private method to process the completions sent by the client. 357 Private method to process the completions sent by the client.
275 </p><dl> 358 </p>
359 <dl>
360
276 <dt><i>result</i> (dict)</dt> 361 <dt><i>result</i> (dict)</dt>
277 <dd> 362 <dd>
278 dictionary containing the result sent by the client 363 dictionary containing the result sent by the client
279 </dd> 364 </dd>
280 </dl><a NAME="CodeAssistServer.__processDocumentationResult" ID="CodeAssistServer.__processDocumentationResult"></a> 365 </dl>
366 <a NAME="CodeAssistServer.__processDocumentationResult" ID="CodeAssistServer.__processDocumentationResult"></a>
281 <h4>CodeAssistServer.__processDocumentationResult</h4> 367 <h4>CodeAssistServer.__processDocumentationResult</h4>
282 <b>__processDocumentationResult</b>(<i>result</i>) 368 <b>__processDocumentationResult</b>(<i>result</i>)
369
283 <p> 370 <p>
284 Private method to process the documentation sent by the client. 371 Private method to process the documentation sent by the client.
285 </p><dl> 372 </p>
373 <dl>
374
286 <dt><i>result</i> (dict with keys 'name', 'argspec', 'note', 'docstring', 'typ')</dt> 375 <dt><i>result</i> (dict with keys 'name', 'argspec', 'note', 'docstring', 'typ')</dt>
287 <dd> 376 <dd>
288 dictionary containing the result sent by the client 377 dictionary containing the result sent by the client
289 </dd> 378 </dd>
290 </dl><a NAME="CodeAssistServer.__projectClosed" ID="CodeAssistServer.__projectClosed"></a> 379 </dl>
380 <a NAME="CodeAssistServer.__projectClosed" ID="CodeAssistServer.__projectClosed"></a>
291 <h4>CodeAssistServer.__projectClosed</h4> 381 <h4>CodeAssistServer.__projectClosed</h4>
292 <b>__projectClosed</b>(<i></i>) 382 <b>__projectClosed</b>(<i></i>)
383
293 <p> 384 <p>
294 Private slot to handle the projectClosed signal. 385 Private slot to handle the projectClosed signal.
295 </p><a NAME="CodeAssistServer.__ropeConfigFile" ID="CodeAssistServer.__ropeConfigFile"></a> 386 </p>
387 <a NAME="CodeAssistServer.__ropeConfigFile" ID="CodeAssistServer.__ropeConfigFile"></a>
296 <h4>CodeAssistServer.__ropeConfigFile</h4> 388 <h4>CodeAssistServer.__ropeConfigFile</h4>
297 <b>__ropeConfigFile</b>(<i>idString</i>) 389 <b>__ropeConfigFile</b>(<i>idString</i>)
390
298 <p> 391 <p>
299 Private method to get the name of the rope configuration file. 392 Private method to get the name of the rope configuration file.
300 </p><dl> 393 </p>
394 <dl>
395
301 <dt><i>idString</i> (str)</dt> 396 <dt><i>idString</i> (str)</dt>
302 <dd> 397 <dd>
303 id for which to get the configuration file 398 id for which to get the configuration file
304 </dd> 399 </dd>
305 </dl><dl> 400 </dl>
401 <dl>
306 <dt>Returns:</dt> 402 <dt>Returns:</dt>
307 <dd> 403 <dd>
308 name of the rope configuration file 404 name of the rope configuration file
309 </dd> 405 </dd>
310 </dl><dl> 406 </dl>
407 <dl>
311 <dt>Return Type:</dt> 408 <dt>Return Type:</dt>
312 <dd> 409 <dd>
313 str 410 str
314 </dd> 411 </dd>
315 </dl><a NAME="CodeAssistServer.__setConfig" ID="CodeAssistServer.__setConfig"></a> 412 </dl>
413 <a NAME="CodeAssistServer.__setConfig" ID="CodeAssistServer.__setConfig"></a>
316 <h4>CodeAssistServer.__setConfig</h4> 414 <h4>CodeAssistServer.__setConfig</h4>
317 <b>__setConfig</b>(<i>params</i>) 415 <b>__setConfig</b>(<i>params</i>)
416
318 <p> 417 <p>
319 Private method to set the rope client configuration data. 418 Private method to set the rope client configuration data.
320 </p><dl> 419 </p>
420 <dl>
421
321 <dt><i>params</i> (dict)</dt> 422 <dt><i>params</i> (dict)</dt>
322 <dd> 423 <dd>
323 dictionary containing the configuration data 424 dictionary containing the configuration data
324 </dd> 425 </dd>
325 </dl><a NAME="CodeAssistServer.__startCodeAssistClient" ID="CodeAssistServer.__startCodeAssistClient"></a> 426 </dl>
427 <a NAME="CodeAssistServer.__startCodeAssistClient" ID="CodeAssistServer.__startCodeAssistClient"></a>
326 <h4>CodeAssistServer.__startCodeAssistClient</h4> 428 <h4>CodeAssistServer.__startCodeAssistClient</h4>
327 <b>__startCodeAssistClient</b>(<i>interpreter, idString, clientEnv</i>) 429 <b>__startCodeAssistClient</b>(<i>interpreter, idString, clientEnv</i>)
430
328 <p> 431 <p>
329 Private method to start the code assist client with the given 432 Private method to start the code assist client with the given
330 interpreter. 433 interpreter.
331 </p><dl> 434 </p>
435 <dl>
436
332 <dt><i>interpreter</i> (str)</dt> 437 <dt><i>interpreter</i> (str)</dt>
333 <dd> 438 <dd>
334 interpreter to be used for the code assist client 439 interpreter to be used for the code assist client
335 </dd><dt><i>idString</i> (str)</dt> 440 </dd>
441 <dt><i>idString</i> (str)</dt>
336 <dd> 442 <dd>
337 id of the client to be started 443 id of the client to be started
338 </dd><dt><i>clientEnv</i> (dict)</dt> 444 </dd>
445 <dt><i>clientEnv</i> (dict)</dt>
339 <dd> 446 <dd>
340 dictionary with environment variables to run the 447 dictionary with environment variables to run the
341 interpreter with 448 interpreter with
342 </dd> 449 </dd>
343 </dl><dl> 450 </dl>
451 <dl>
344 <dt>Returns:</dt> 452 <dt>Returns:</dt>
345 <dd> 453 <dd>
346 flag indicating a successful start of the client 454 flag indicating a successful start of the client
347 </dd> 455 </dd>
348 </dl><dl> 456 </dl>
457 <dl>
349 <dt>Return Type:</dt> 458 <dt>Return Type:</dt>
350 <dd> 459 <dd>
351 bool 460 bool
352 </dd> 461 </dd>
353 </dl><a NAME="CodeAssistServer.__updateEditorLanguageMapping" ID="CodeAssistServer.__updateEditorLanguageMapping"></a> 462 </dl>
463 <a NAME="CodeAssistServer.__updateEditorLanguageMapping" ID="CodeAssistServer.__updateEditorLanguageMapping"></a>
354 <h4>CodeAssistServer.__updateEditorLanguageMapping</h4> 464 <h4>CodeAssistServer.__updateEditorLanguageMapping</h4>
355 <b>__updateEditorLanguageMapping</b>(<i></i>) 465 <b>__updateEditorLanguageMapping</b>(<i></i>)
466
356 <p> 467 <p>
357 Private method to update the editor language to connection mapping. 468 Private method to update the editor language to connection mapping.
358 </p><a NAME="CodeAssistServer.activate" ID="CodeAssistServer.activate"></a> 469 </p>
470 <a NAME="CodeAssistServer.activate" ID="CodeAssistServer.activate"></a>
359 <h4>CodeAssistServer.activate</h4> 471 <h4>CodeAssistServer.activate</h4>
360 <b>activate</b>(<i></i>) 472 <b>activate</b>(<i></i>)
473
361 <p> 474 <p>
362 Public method to activate the code assist server. 475 Public method to activate the code assist server.
363 </p><a NAME="CodeAssistServer.deactivate" ID="CodeAssistServer.deactivate"></a> 476 </p>
477 <a NAME="CodeAssistServer.deactivate" ID="CodeAssistServer.deactivate"></a>
364 <h4>CodeAssistServer.deactivate</h4> 478 <h4>CodeAssistServer.deactivate</h4>
365 <b>deactivate</b>(<i></i>) 479 <b>deactivate</b>(<i></i>)
480
366 <p> 481 <p>
367 Public method to deactivate the code assist server. 482 Public method to deactivate the code assist server.
368 </p><a NAME="CodeAssistServer.editConfig" ID="CodeAssistServer.editConfig"></a> 483 </p>
484 <a NAME="CodeAssistServer.editConfig" ID="CodeAssistServer.editConfig"></a>
369 <h4>CodeAssistServer.editConfig</h4> 485 <h4>CodeAssistServer.editConfig</h4>
370 <b>editConfig</b>(<i>idString</i>) 486 <b>editConfig</b>(<i>idString</i>)
487
371 <p> 488 <p>
372 Public slot to open the rope configuration file in an editor. 489 Public slot to open the rope configuration file in an editor.
373 </p><dl> 490 </p>
491 <dl>
492
374 <dt><i>idString</i> (str)</dt> 493 <dt><i>idString</i> (str)</dt>
375 <dd> 494 <dd>
376 id for which to get the configuration file 495 id for which to get the configuration file
377 </dd> 496 </dd>
378 </dl><a NAME="CodeAssistServer.getCallTips" ID="CodeAssistServer.getCallTips"></a> 497 </dl>
498 <a NAME="CodeAssistServer.getCallTips" ID="CodeAssistServer.getCallTips"></a>
379 <h4>CodeAssistServer.getCallTips</h4> 499 <h4>CodeAssistServer.getCallTips</h4>
380 <b>getCallTips</b>(<i>editor, pos, commas</i>) 500 <b>getCallTips</b>(<i>editor, pos, commas</i>)
501
381 <p> 502 <p>
382 Public method to calculate calltips. 503 Public method to calculate calltips.
383 </p><dl> 504 </p>
505 <dl>
506
384 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt> 507 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
385 <dd> 508 <dd>
386 reference to the editor object, that called this method 509 reference to the editor object, that called this method
387 </dd><dt><i>pos</i> (int)</dt> 510 </dd>
511 <dt><i>pos</i> (int)</dt>
388 <dd> 512 <dd>
389 position in the text for the calltip 513 position in the text for the calltip
390 </dd><dt><i>commas</i> (int)</dt> 514 </dd>
515 <dt><i>commas</i> (int)</dt>
391 <dd> 516 <dd>
392 minimum number of commas contained in the calltip 517 minimum number of commas contained in the calltip
393 </dd> 518 </dd>
394 </dl><dl> 519 </dl>
520 <dl>
395 <dt>Returns:</dt> 521 <dt>Returns:</dt>
396 <dd> 522 <dd>
397 list of possible calltips 523 list of possible calltips
398 </dd> 524 </dd>
399 </dl><dl> 525 </dl>
526 <dl>
400 <dt>Return Type:</dt> 527 <dt>Return Type:</dt>
401 <dd> 528 <dd>
402 list of str 529 list of str
403 </dd> 530 </dd>
404 </dl><a NAME="CodeAssistServer.getCompletions" ID="CodeAssistServer.getCompletions"></a> 531 </dl>
532 <a NAME="CodeAssistServer.getCompletions" ID="CodeAssistServer.getCompletions"></a>
405 <h4>CodeAssistServer.getCompletions</h4> 533 <h4>CodeAssistServer.getCompletions</h4>
406 <b>getCompletions</b>(<i>editor, context</i>) 534 <b>getCompletions</b>(<i>editor, context</i>)
535
407 <p> 536 <p>
408 Public method to calculate the possible completions. 537 Public method to calculate the possible completions.
409 </p><p> 538 </p>
539 <p>
410 Note: This is the synchronous variant for eric6 before 17.11. 540 Note: This is the synchronous variant for eric6 before 17.11.
411 </p><dl> 541 </p>
542 <dl>
543
412 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt> 544 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
413 <dd> 545 <dd>
414 reference to the editor object, that called this method 546 reference to the editor object, that called this method
415 </dd><dt><i>context</i> (bool)</dt> 547 </dd>
548 <dt><i>context</i> (bool)</dt>
416 <dd> 549 <dd>
417 flag indicating to autocomplete a context 550 flag indicating to autocomplete a context
418 </dd> 551 </dd>
419 </dl><dl> 552 </dl>
553 <dl>
420 <dt>Returns:</dt> 554 <dt>Returns:</dt>
421 <dd> 555 <dd>
422 list of possible completions 556 list of possible completions
423 </dd> 557 </dd>
424 </dl><dl> 558 </dl>
559 <dl>
425 <dt>Return Type:</dt> 560 <dt>Return Type:</dt>
426 <dd> 561 <dd>
427 list of str 562 list of str
428 </dd> 563 </dd>
429 </dl><a NAME="CodeAssistServer.gotoDefinition" ID="CodeAssistServer.gotoDefinition"></a> 564 </dl>
565 <a NAME="CodeAssistServer.gotoDefinition" ID="CodeAssistServer.gotoDefinition"></a>
430 <h4>CodeAssistServer.gotoDefinition</h4> 566 <h4>CodeAssistServer.gotoDefinition</h4>
431 <b>gotoDefinition</b>(<i>editor</i>) 567 <b>gotoDefinition</b>(<i>editor</i>)
568
432 <p> 569 <p>
433 Public slot to find the definition for the word at the cursor position 570 Public slot to find the definition for the word at the cursor position
434 and go to it. 571 and go to it.
435 </p><p> 572 </p>
573 <p>
436 Note: This is executed upon a mouse click sequence. 574 Note: This is executed upon a mouse click sequence.
437 </p><dl> 575 </p>
576 <dl>
577
438 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt> 578 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
439 <dd> 579 <dd>
440 reference to the calling editor 580 reference to the calling editor
441 </dd> 581 </dd>
442 </dl><a NAME="CodeAssistServer.handleCall" ID="CodeAssistServer.handleCall"></a> 582 </dl>
583 <a NAME="CodeAssistServer.handleCall" ID="CodeAssistServer.handleCall"></a>
443 <h4>CodeAssistServer.handleCall</h4> 584 <h4>CodeAssistServer.handleCall</h4>
444 <b>handleCall</b>(<i>method, params</i>) 585 <b>handleCall</b>(<i>method, params</i>)
586
445 <p> 587 <p>
446 Public method to handle a method call from the client. 588 Public method to handle a method call from the client.
447 </p><dl> 589 </p>
590 <dl>
591
448 <dt><i>method</i> (str)</dt> 592 <dt><i>method</i> (str)</dt>
449 <dd> 593 <dd>
450 requested method name 594 requested method name
451 </dd><dt><i>params</i> (dict)</dt> 595 </dd>
596 <dt><i>params</i> (dict)</dt>
452 <dd> 597 <dd>
453 dictionary with method specific parameters 598 dictionary with method specific parameters
454 </dd> 599 </dd>
455 </dl><a NAME="CodeAssistServer.handleNewConnection" ID="CodeAssistServer.handleNewConnection"></a> 600 </dl>
601 <a NAME="CodeAssistServer.handleNewConnection" ID="CodeAssistServer.handleNewConnection"></a>
456 <h4>CodeAssistServer.handleNewConnection</h4> 602 <h4>CodeAssistServer.handleNewConnection</h4>
457 <b>handleNewConnection</b>(<i></i>) 603 <b>handleNewConnection</b>(<i></i>)
604
458 <p> 605 <p>
459 Public slot for new incoming connections from a client. 606 Public slot for new incoming connections from a client.
460 </p><a NAME="CodeAssistServer.isSupportedLanguage" ID="CodeAssistServer.isSupportedLanguage"></a> 607 </p>
608 <a NAME="CodeAssistServer.isSupportedLanguage" ID="CodeAssistServer.isSupportedLanguage"></a>
461 <h4>CodeAssistServer.isSupportedLanguage</h4> 609 <h4>CodeAssistServer.isSupportedLanguage</h4>
462 <b>isSupportedLanguage</b>(<i>language</i>) 610 <b>isSupportedLanguage</b>(<i>language</i>)
611
463 <p> 612 <p>
464 Public method to check, if the given language is supported. 613 Public method to check, if the given language is supported.
465 </p><dl> 614 </p>
615 <dl>
616
466 <dt><i>language</i> (str)</dt> 617 <dt><i>language</i> (str)</dt>
467 <dd> 618 <dd>
468 editor programming language to check 619 editor programming language to check
469 </dd> 620 </dd>
470 </dl><dl> 621 </dl>
622 <dl>
471 <dt>Returns:</dt> 623 <dt>Returns:</dt>
472 <dd> 624 <dd>
473 flag indicating the support status 625 flag indicating the support status
474 </dd> 626 </dd>
475 </dl><dl> 627 </dl>
628 <dl>
476 <dt>Return Type:</dt> 629 <dt>Return Type:</dt>
477 <dd> 630 <dd>
478 bool 631 bool
479 </dd> 632 </dd>
480 </dl><a NAME="CodeAssistServer.reportChanged" ID="CodeAssistServer.reportChanged"></a> 633 </dl>
634 <a NAME="CodeAssistServer.reportChanged" ID="CodeAssistServer.reportChanged"></a>
481 <h4>CodeAssistServer.reportChanged</h4> 635 <h4>CodeAssistServer.reportChanged</h4>
482 <b>reportChanged</b>(<i>filename, oldSource</i>) 636 <b>reportChanged</b>(<i>filename, oldSource</i>)
637
483 <p> 638 <p>
484 Public slot to report some changed sources. 639 Public slot to report some changed sources.
485 </p><dl> 640 </p>
641 <dl>
642
486 <dt><i>filename</i> (str)</dt> 643 <dt><i>filename</i> (str)</dt>
487 <dd> 644 <dd>
488 file name of the changed source 645 file name of the changed source
489 </dd><dt><i>oldSource</i> (str)</dt> 646 </dd>
647 <dt><i>oldSource</i> (str)</dt>
490 <dd> 648 <dd>
491 source code before the change 649 source code before the change
492 </dd> 650 </dd>
493 </dl><a NAME="CodeAssistServer.requestCodeDocumentation" ID="CodeAssistServer.requestCodeDocumentation"></a> 651 </dl>
652 <a NAME="CodeAssistServer.requestCodeDocumentation" ID="CodeAssistServer.requestCodeDocumentation"></a>
494 <h4>CodeAssistServer.requestCodeDocumentation</h4> 653 <h4>CodeAssistServer.requestCodeDocumentation</h4>
495 <b>requestCodeDocumentation</b>(<i>editor</i>) 654 <b>requestCodeDocumentation</b>(<i>editor</i>)
655
496 <p> 656 <p>
497 Public method to request source code documentation for the given 657 Public method to request source code documentation for the given
498 editor. 658 editor.
499 </p><dl> 659 </p>
660 <dl>
661
500 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt> 662 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
501 <dd> 663 <dd>
502 reference to the editor to get source code documentation 664 reference to the editor to get source code documentation
503 for 665 for
504 </dd> 666 </dd>
505 </dl><a NAME="CodeAssistServer.requestCompletions" ID="CodeAssistServer.requestCompletions"></a> 667 </dl>
668 <a NAME="CodeAssistServer.requestCompletions" ID="CodeAssistServer.requestCompletions"></a>
506 <h4>CodeAssistServer.requestCompletions</h4> 669 <h4>CodeAssistServer.requestCompletions</h4>
507 <b>requestCompletions</b>(<i>editor, context, acText</i>) 670 <b>requestCompletions</b>(<i>editor, context, acText</i>)
671
508 <p> 672 <p>
509 Public method to request a list of possible completions. 673 Public method to request a list of possible completions.
510 </p><p> 674 </p>
675 <p>
511 Note: This is part of the asynchronous variant for eric6 17.11 and 676 Note: This is part of the asynchronous variant for eric6 17.11 and
512 later. 677 later.
513 </p><dl> 678 </p>
679 <dl>
680
514 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt> 681 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
515 <dd> 682 <dd>
516 reference to the editor object, that called this method 683 reference to the editor object, that called this method
517 </dd><dt><i>context</i> (bool)</dt> 684 </dd>
685 <dt><i>context</i> (bool)</dt>
518 <dd> 686 <dd>
519 flag indicating to autocomplete a context 687 flag indicating to autocomplete a context
520 </dd><dt><i>acText</i> (str)</dt> 688 </dd>
689 <dt><i>acText</i> (str)</dt>
521 <dd> 690 <dd>
522 text to be completed 691 text to be completed
523 </dd> 692 </dd>
524 </dl><a NAME="CodeAssistServer.setAsyncCompletions" ID="CodeAssistServer.setAsyncCompletions"></a> 693 </dl>
694 <a NAME="CodeAssistServer.setAsyncCompletions" ID="CodeAssistServer.setAsyncCompletions"></a>
525 <h4>CodeAssistServer.setAsyncCompletions</h4> 695 <h4>CodeAssistServer.setAsyncCompletions</h4>
526 <b>setAsyncCompletions</b>(<i>asynchronous</i>) 696 <b>setAsyncCompletions</b>(<i>asynchronous</i>)
697
527 <p> 698 <p>
528 Public method to set the asynchronous completions flag. 699 Public method to set the asynchronous completions flag.
529 </p><dl> 700 </p>
701 <dl>
702
530 <dt><i>asynchronous</i> (bool)</dt> 703 <dt><i>asynchronous</i> (bool)</dt>
531 <dd> 704 <dd>
532 flag indicating asynchronous completions 705 flag indicating asynchronous completions
533 </dd> 706 </dd>
534 </dl> 707 </dl>

Mercurial Repository: Rope Refactoring

eric ide

mercurial