|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' |
|
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> |
|
4 <html><head> |
|
5 <title>Plugin_Assistant_Eric.AssistantEric.APIsManager</title> |
|
6 <style> |
|
7 body { |
|
8 background:white; |
|
9 margin: 0em 1em 10em 1em; |
|
10 color: black; |
|
11 } |
|
12 |
|
13 h1 { color: white; background: #4FA4FF; } |
|
14 h2 { color: white; background: #4FA4FF; } |
|
15 h3 { color: white; background: #00557F; } |
|
16 h4 { color: white; background: #00557F; } |
|
17 |
|
18 a { color: #AA5500; } |
|
19 |
|
20 </style> |
|
21 </head> |
|
22 <body><a NAME="top" ID="top"></a> |
|
23 <h1>Plugin_Assistant_Eric.AssistantEric.APIsManager</h1> |
|
24 <p> |
|
25 Module implementing the APIsManager. |
|
26 </p> |
|
27 <h3>Global Attributes</h3> |
|
28 <table> |
|
29 <tr><td>ApisNameProject</td></tr><tr><td>WorkerAborted</td></tr><tr><td>WorkerFinished</td></tr><tr><td>WorkerStarted</td></tr> |
|
30 </table> |
|
31 <h3>Classes</h3> |
|
32 <table> |
|
33 <tr> |
|
34 <td><a href="#APIsManager">APIsManager</a></td> |
|
35 <td>Class implementing the APIsManager class, which is the central store for API information used by autocompletion and calltips.</td> |
|
36 </tr><tr> |
|
37 <td><a href="#DbAPIs">DbAPIs</a></td> |
|
38 <td>Class implementing an API storage entity.</td> |
|
39 </tr><tr> |
|
40 <td><a href="#DbAPIsWorker">DbAPIsWorker</a></td> |
|
41 <td>Class implementing a worker thread to prepare the API database.</td> |
|
42 </tr> |
|
43 </table> |
|
44 <h3>Functions</h3> |
|
45 <table> |
|
46 <tr><td>None</td></tr> |
|
47 </table> |
|
48 <hr /><hr /> |
|
49 <a NAME="APIsManager" ID="APIsManager"></a> |
|
50 <h2>APIsManager</h2> |
|
51 <p> |
|
52 Class implementing the APIsManager class, which is the central store for |
|
53 API information used by autocompletion and calltips. |
|
54 </p> |
|
55 <h3>Derived from</h3> |
|
56 QObject |
|
57 <h3>Class Attributes</h3> |
|
58 <table> |
|
59 <tr><td>None</td></tr> |
|
60 </table> |
|
61 <h3>Methods</h3> |
|
62 <table> |
|
63 <tr> |
|
64 <td><a href="#APIsManager.__init__">APIsManager</a></td> |
|
65 <td>Constructor</td> |
|
66 </tr><tr> |
|
67 <td><a href="#APIsManager.deactivate">deactivate</a></td> |
|
68 <td>Public method to perform actions upon deactivation.</td> |
|
69 </tr><tr> |
|
70 <td><a href="#APIsManager.getAPIs">getAPIs</a></td> |
|
71 <td>Public method to get an apis object for autocompletion/calltips.</td> |
|
72 </tr><tr> |
|
73 <td><a href="#APIsManager.reloadAPIs">reloadAPIs</a></td> |
|
74 <td>Public slot to reload the api information.</td> |
|
75 </tr> |
|
76 </table> |
|
77 <a NAME="APIsManager.__init__" ID="APIsManager.__init__"></a> |
|
78 <h4>APIsManager (Constructor)</h4> |
|
79 <b>APIsManager</b>(<i>parent = None</i>) |
|
80 <p> |
|
81 Constructor |
|
82 </p><dl> |
|
83 <dt><i>parent</i></dt> |
|
84 <dd> |
|
85 reference to the parent object (QObject) |
|
86 </dd> |
|
87 </dl><a NAME="APIsManager.deactivate" ID="APIsManager.deactivate"></a> |
|
88 <h4>APIsManager.deactivate</h4> |
|
89 <b>deactivate</b>(<i></i>) |
|
90 <p> |
|
91 Public method to perform actions upon deactivation. |
|
92 </p><a NAME="APIsManager.getAPIs" ID="APIsManager.getAPIs"></a> |
|
93 <h4>APIsManager.getAPIs</h4> |
|
94 <b>getAPIs</b>(<i>language</i>) |
|
95 <p> |
|
96 Public method to get an apis object for autocompletion/calltips. |
|
97 </p><p> |
|
98 This method creates and loads an APIs object dynamically upon request. |
|
99 This saves memory for languages, that might not be needed at the moment. |
|
100 </p><dl> |
|
101 <dt><i>language</i></dt> |
|
102 <dd> |
|
103 the language of the requested api object (string) |
|
104 </dd> |
|
105 </dl><dl> |
|
106 <dt>Returns:</dt> |
|
107 <dd> |
|
108 the apis object (APIs) |
|
109 </dd> |
|
110 </dl><a NAME="APIsManager.reloadAPIs" ID="APIsManager.reloadAPIs"></a> |
|
111 <h4>APIsManager.reloadAPIs</h4> |
|
112 <b>reloadAPIs</b>(<i></i>) |
|
113 <p> |
|
114 Public slot to reload the api information. |
|
115 </p> |
|
116 <div align="right"><a href="#top">Up</a></div> |
|
117 <hr /><hr /> |
|
118 <a NAME="DbAPIs" ID="DbAPIs"></a> |
|
119 <h2>DbAPIs</h2> |
|
120 <p> |
|
121 Class implementing an API storage entity. |
|
122 </p><h4>Signals</h4> |
|
123 <dl> |
|
124 <dt>apiPreparationCancelled()</dt> |
|
125 <dd> |
|
126 emitted after the API preparation has been |
|
127 cancelled |
|
128 </dd><dt>apiPreparationFinished()</dt> |
|
129 <dd> |
|
130 emitted after the API preparation has finished |
|
131 </dd><dt>apiPreparationStarted()</dt> |
|
132 <dd> |
|
133 emitted after the API preparation has started |
|
134 </dd> |
|
135 </dl> |
|
136 <h3>Derived from</h3> |
|
137 QObject |
|
138 <h3>Class Attributes</h3> |
|
139 <table> |
|
140 <tr><td>DB_VERSION</td></tr><tr><td>ac_context_stmt</td></tr><tr><td>ac_stmt</td></tr><tr><td>api_files_stmt</td></tr><tr><td>create_acWord_idx</td></tr><tr><td>create_api_stmt</td></tr><tr><td>create_context_idx</td></tr><tr><td>create_file_idx</td></tr><tr><td>create_file_stmt</td></tr><tr><td>create_fullContext_idx</td></tr><tr><td>create_mgmt_stmt</td></tr><tr><td>ct_context_stmt</td></tr><tr><td>ct_fullContext_stmt</td></tr><tr><td>ct_stmt</td></tr><tr><td>drop_acWord_idx</td></tr><tr><td>drop_api_stmt</td></tr><tr><td>drop_context_idx</td></tr><tr><td>drop_file_idx</td></tr><tr><td>drop_file_stmt</td></tr><tr><td>drop_fullContext_idx</td></tr><tr><td>drop_mgmt_stmt</td></tr><tr><td>format_select_stmt</td></tr><tr><td>mgmt_insert_stmt</td></tr> |
|
141 </table> |
|
142 <h3>Methods</h3> |
|
143 <table> |
|
144 <tr> |
|
145 <td><a href="#DbAPIs.__init__">DbAPIs</a></td> |
|
146 <td>Constructor</td> |
|
147 </tr><tr> |
|
148 <td><a href="#DbAPIs.__createApiDB">__createApiDB</a></td> |
|
149 <td>Private method to create an API database.</td> |
|
150 </tr><tr> |
|
151 <td><a href="#DbAPIs.__enoughCommas">__enoughCommas</a></td> |
|
152 <td>Private method to determine, if the given string contains enough commas.</td> |
|
153 </tr><tr> |
|
154 <td><a href="#DbAPIs.__initAsLanguage">__initAsLanguage</a></td> |
|
155 <td>Private method to initialize as a language API object.</td> |
|
156 </tr><tr> |
|
157 <td><a href="#DbAPIs.__initAsProject">__initAsProject</a></td> |
|
158 <td>Private method to initialize as a project API object.</td> |
|
159 </tr><tr> |
|
160 <td><a href="#DbAPIs.__isPrepared">__isPrepared</a></td> |
|
161 <td>Private method to check, if the database has been prepared.</td> |
|
162 </tr><tr> |
|
163 <td><a href="#DbAPIs.__openAPIs">__openAPIs</a></td> |
|
164 <td>Private method to open the API database.</td> |
|
165 </tr><tr> |
|
166 <td><a href="#DbAPIs.__openApiDb">__openApiDb</a></td> |
|
167 <td>Private method to open the API database.</td> |
|
168 </tr><tr> |
|
169 <td><a href="#DbAPIs.__processQueue">__processQueue</a></td> |
|
170 <td>Private slot to process the queue of files to load.</td> |
|
171 </tr><tr> |
|
172 <td><a href="#DbAPIs.__projectClosed">__projectClosed</a></td> |
|
173 <td>Private slot to perform actions after a project has been closed.</td> |
|
174 </tr><tr> |
|
175 <td><a href="#DbAPIs.__projectOpened">__projectOpened</a></td> |
|
176 <td>Private slot to perform actions after a project has been opened.</td> |
|
177 </tr><tr> |
|
178 <td><a href="#DbAPIs._apiDbName">_apiDbName</a></td> |
|
179 <td>Protected method to determine the name of the database file.</td> |
|
180 </tr><tr> |
|
181 <td><a href="#DbAPIs.autoCompletionWordSeparators">autoCompletionWordSeparators</a></td> |
|
182 <td>Private method to get the word separator characters.</td> |
|
183 </tr><tr> |
|
184 <td><a href="#DbAPIs.close">close</a></td> |
|
185 <td>Public method to close the database.</td> |
|
186 </tr><tr> |
|
187 <td><a href="#DbAPIs.editorSaved">editorSaved</a></td> |
|
188 <td>Public slot to handle the editorSaved signal.</td> |
|
189 </tr><tr> |
|
190 <td><a href="#DbAPIs.event">event</a></td> |
|
191 <td>Protected method to handle events from the worker thread.</td> |
|
192 </tr><tr> |
|
193 <td><a href="#DbAPIs.getApiFiles">getApiFiles</a></td> |
|
194 <td>Public method to get a list of API files loaded into the database.</td> |
|
195 </tr><tr> |
|
196 <td><a href="#DbAPIs.getCalltips">getCalltips</a></td> |
|
197 <td>Public method to determine the calltips.</td> |
|
198 </tr><tr> |
|
199 <td><a href="#DbAPIs.getCompletions">getCompletions</a></td> |
|
200 <td>Public method to determine the possible completions.</td> |
|
201 </tr><tr> |
|
202 <td><a href="#DbAPIs.getLexer">getLexer</a></td> |
|
203 <td>Public method to return a reference to our lexer object.</td> |
|
204 </tr><tr> |
|
205 <td><a href="#DbAPIs.prepareAPIs">prepareAPIs</a></td> |
|
206 <td>Public method to prepare the APIs if neccessary.</td> |
|
207 </tr> |
|
208 </table> |
|
209 <a NAME="DbAPIs.__init__" ID="DbAPIs.__init__"></a> |
|
210 <h4>DbAPIs (Constructor)</h4> |
|
211 <b>DbAPIs</b>(<i>language, parent = None</i>) |
|
212 <p> |
|
213 Constructor |
|
214 </p><dl> |
|
215 <dt><i>language</i></dt> |
|
216 <dd> |
|
217 language of the APIs object (string) |
|
218 </dd><dt><i>parent</i></dt> |
|
219 <dd> |
|
220 reference to the parent object (QObject) |
|
221 </dd> |
|
222 </dl><a NAME="DbAPIs.__createApiDB" ID="DbAPIs.__createApiDB"></a> |
|
223 <h4>DbAPIs.__createApiDB</h4> |
|
224 <b>__createApiDB</b>(<i></i>) |
|
225 <p> |
|
226 Private method to create an API database. |
|
227 </p><a NAME="DbAPIs.__enoughCommas" ID="DbAPIs.__enoughCommas"></a> |
|
228 <h4>DbAPIs.__enoughCommas</h4> |
|
229 <b>__enoughCommas</b>(<i>s, commas</i>) |
|
230 <p> |
|
231 Private method to determine, if the given string contains enough commas. |
|
232 </p><dl> |
|
233 <dt><i>s</i></dt> |
|
234 <dd> |
|
235 string to check (string) |
|
236 </dd><dt><i>commas</i></dt> |
|
237 <dd> |
|
238 number of commas to check for (integer) |
|
239 </dd> |
|
240 </dl><dl> |
|
241 <dt>Returns:</dt> |
|
242 <dd> |
|
243 flag indicating, that there are enough commas (boolean) |
|
244 </dd> |
|
245 </dl><a NAME="DbAPIs.__initAsLanguage" ID="DbAPIs.__initAsLanguage"></a> |
|
246 <h4>DbAPIs.__initAsLanguage</h4> |
|
247 <b>__initAsLanguage</b>(<i></i>) |
|
248 <p> |
|
249 Private method to initialize as a language API object. |
|
250 </p><a NAME="DbAPIs.__initAsProject" ID="DbAPIs.__initAsProject"></a> |
|
251 <h4>DbAPIs.__initAsProject</h4> |
|
252 <b>__initAsProject</b>(<i></i>) |
|
253 <p> |
|
254 Private method to initialize as a project API object. |
|
255 </p><a NAME="DbAPIs.__isPrepared" ID="DbAPIs.__isPrepared"></a> |
|
256 <h4>DbAPIs.__isPrepared</h4> |
|
257 <b>__isPrepared</b>(<i></i>) |
|
258 <p> |
|
259 Private method to check, if the database has been prepared. |
|
260 </p><dl> |
|
261 <dt>Returns:</dt> |
|
262 <dd> |
|
263 flag indicating the prepared status (boolean) |
|
264 </dd> |
|
265 </dl><a NAME="DbAPIs.__openAPIs" ID="DbAPIs.__openAPIs"></a> |
|
266 <h4>DbAPIs.__openAPIs</h4> |
|
267 <b>__openAPIs</b>(<i></i>) |
|
268 <p> |
|
269 Private method to open the API database. |
|
270 </p><a NAME="DbAPIs.__openApiDb" ID="DbAPIs.__openApiDb"></a> |
|
271 <h4>DbAPIs.__openApiDb</h4> |
|
272 <b>__openApiDb</b>(<i></i>) |
|
273 <p> |
|
274 Private method to open the API database. |
|
275 </p><a NAME="DbAPIs.__processQueue" ID="DbAPIs.__processQueue"></a> |
|
276 <h4>DbAPIs.__processQueue</h4> |
|
277 <b>__processQueue</b>(<i></i>) |
|
278 <p> |
|
279 Private slot to process the queue of files to load. |
|
280 </p><a NAME="DbAPIs.__projectClosed" ID="DbAPIs.__projectClosed"></a> |
|
281 <h4>DbAPIs.__projectClosed</h4> |
|
282 <b>__projectClosed</b>(<i></i>) |
|
283 <p> |
|
284 Private slot to perform actions after a project has been closed. |
|
285 </p><a NAME="DbAPIs.__projectOpened" ID="DbAPIs.__projectOpened"></a> |
|
286 <h4>DbAPIs.__projectOpened</h4> |
|
287 <b>__projectOpened</b>(<i></i>) |
|
288 <p> |
|
289 Private slot to perform actions after a project has been opened. |
|
290 </p><a NAME="DbAPIs._apiDbName" ID="DbAPIs._apiDbName"></a> |
|
291 <h4>DbAPIs._apiDbName</h4> |
|
292 <b>_apiDbName</b>(<i></i>) |
|
293 <p> |
|
294 Protected method to determine the name of the database file. |
|
295 </p><dl> |
|
296 <dt>Returns:</dt> |
|
297 <dd> |
|
298 name of the database file (string) |
|
299 </dd> |
|
300 </dl><a NAME="DbAPIs.autoCompletionWordSeparators" ID="DbAPIs.autoCompletionWordSeparators"></a> |
|
301 <h4>DbAPIs.autoCompletionWordSeparators</h4> |
|
302 <b>autoCompletionWordSeparators</b>(<i></i>) |
|
303 <p> |
|
304 Private method to get the word separator characters. |
|
305 </p><dl> |
|
306 <dt>Returns:</dt> |
|
307 <dd> |
|
308 word separator characters (list of strings) |
|
309 </dd> |
|
310 </dl><a NAME="DbAPIs.close" ID="DbAPIs.close"></a> |
|
311 <h4>DbAPIs.close</h4> |
|
312 <b>close</b>(<i></i>) |
|
313 <p> |
|
314 Public method to close the database. |
|
315 </p><a NAME="DbAPIs.editorSaved" ID="DbAPIs.editorSaved"></a> |
|
316 <h4>DbAPIs.editorSaved</h4> |
|
317 <b>editorSaved</b>(<i>filename</i>) |
|
318 <p> |
|
319 Public slot to handle the editorSaved signal. |
|
320 </p><dl> |
|
321 <dt><i>filename</i></dt> |
|
322 <dd> |
|
323 name of the file that was saved (string) |
|
324 </dd> |
|
325 </dl><a NAME="DbAPIs.event" ID="DbAPIs.event"></a> |
|
326 <h4>DbAPIs.event</h4> |
|
327 <b>event</b>(<i>evt</i>) |
|
328 <p> |
|
329 Protected method to handle events from the worker thread. |
|
330 </p><dl> |
|
331 <dt><i>evt</i></dt> |
|
332 <dd> |
|
333 reference to the event object (QEvent) |
|
334 </dd> |
|
335 </dl><dl> |
|
336 <dt>Returns:</dt> |
|
337 <dd> |
|
338 flag indicating, if the event was handled (boolean) |
|
339 </dd> |
|
340 </dl><a NAME="DbAPIs.getApiFiles" ID="DbAPIs.getApiFiles"></a> |
|
341 <h4>DbAPIs.getApiFiles</h4> |
|
342 <b>getApiFiles</b>(<i></i>) |
|
343 <p> |
|
344 Public method to get a list of API files loaded into the database. |
|
345 </p><dl> |
|
346 <dt>Returns:</dt> |
|
347 <dd> |
|
348 list of API filenames (list of strings) |
|
349 </dd> |
|
350 </dl><a NAME="DbAPIs.getCalltips" ID="DbAPIs.getCalltips"></a> |
|
351 <h4>DbAPIs.getCalltips</h4> |
|
352 <b>getCalltips</b>(<i>acWord, commas, context = None, fullContext = None, showContext = True</i>) |
|
353 <p> |
|
354 Public method to determine the calltips. |
|
355 </p><dl> |
|
356 <dt><i>acWord</i></dt> |
|
357 <dd> |
|
358 function to get calltips for (string) |
|
359 </dd><dt><i>commas</i></dt> |
|
360 <dd> |
|
361 minimum number of commas contained in the calltip (integer) |
|
362 </dd><dt><i>context</i></dt> |
|
363 <dd> |
|
364 string giving the context (e.g. classname) (string) |
|
365 </dd><dt><i>fullContext</i></dt> |
|
366 <dd> |
|
367 string giving the full context (string) |
|
368 </dd><dt><i>showContext</i></dt> |
|
369 <dd> |
|
370 flag indicating to show the calltip context (boolean) |
|
371 </dd> |
|
372 </dl><dl> |
|
373 <dt>Returns:</dt> |
|
374 <dd> |
|
375 list of calltips (list of string) |
|
376 </dd> |
|
377 </dl><a NAME="DbAPIs.getCompletions" ID="DbAPIs.getCompletions"></a> |
|
378 <h4>DbAPIs.getCompletions</h4> |
|
379 <b>getCompletions</b>(<i>start = None, context = None</i>) |
|
380 <p> |
|
381 Public method to determine the possible completions. |
|
382 </p><dl> |
|
383 <dt><i>start=</i></dt> |
|
384 <dd> |
|
385 string giving the start of the word to be |
|
386 completed (string) |
|
387 </dd><dt><i>context=</i></dt> |
|
388 <dd> |
|
389 string giving the context (e.g. classname) |
|
390 to be completed (string) |
|
391 </dd> |
|
392 </dl><dl> |
|
393 <dt>Returns:</dt> |
|
394 <dd> |
|
395 list of dictionaries with possible completions (key 'completion' |
|
396 contains the completion (string), key 'context' |
|
397 contains the context (string) and key 'pictureId' |
|
398 contains the ID of the icon to be shown (string)) |
|
399 </dd> |
|
400 </dl><a NAME="DbAPIs.getLexer" ID="DbAPIs.getLexer"></a> |
|
401 <h4>DbAPIs.getLexer</h4> |
|
402 <b>getLexer</b>(<i></i>) |
|
403 <p> |
|
404 Public method to return a reference to our lexer object. |
|
405 </p><dl> |
|
406 <dt>Returns:</dt> |
|
407 <dd> |
|
408 reference to the lexer object (QScintilla.Lexers.Lexer) |
|
409 </dd> |
|
410 </dl><a NAME="DbAPIs.prepareAPIs" ID="DbAPIs.prepareAPIs"></a> |
|
411 <h4>DbAPIs.prepareAPIs</h4> |
|
412 <b>prepareAPIs</b>(<i>rawList = None</i>) |
|
413 <p> |
|
414 Public method to prepare the APIs if neccessary. |
|
415 </p><dl> |
|
416 <dt><i>rawList=</i></dt> |
|
417 <dd> |
|
418 list of raw API files (list of strings) |
|
419 </dd> |
|
420 </dl> |
|
421 <div align="right"><a href="#top">Up</a></div> |
|
422 <hr /><hr /> |
|
423 <a NAME="DbAPIsWorker" ID="DbAPIsWorker"></a> |
|
424 <h2>DbAPIsWorker</h2> |
|
425 <p> |
|
426 Class implementing a worker thread to prepare the API database. |
|
427 </p> |
|
428 <h3>Derived from</h3> |
|
429 QThread |
|
430 <h3>Class Attributes</h3> |
|
431 <table> |
|
432 <tr><td>file_delete_id_stmt</td></tr><tr><td>file_id_stmt</td></tr><tr><td>file_loaded_stmt</td></tr><tr><td>populate_api_stmt</td></tr><tr><td>populate_del_api_stmt</td></tr><tr><td>populate_file_stmt</td></tr><tr><td>update_file_stmt</td></tr> |
|
433 </table> |
|
434 <h3>Methods</h3> |
|
435 <table> |
|
436 <tr> |
|
437 <td><a href="#DbAPIsWorker.__init__">DbAPIsWorker</a></td> |
|
438 <td>Constructor</td> |
|
439 </tr><tr> |
|
440 <td><a href="#DbAPIsWorker.__autoCompletionWordSeparators">__autoCompletionWordSeparators</a></td> |
|
441 <td>Private method to get the word separator characters for a language.</td> |
|
442 </tr><tr> |
|
443 <td><a href="#DbAPIsWorker.__deleteApiFile">__deleteApiFile</a></td> |
|
444 <td>Private method to delete all references to an api file.</td> |
|
445 </tr><tr> |
|
446 <td><a href="#DbAPIsWorker.__loadApiFile">__loadApiFile</a></td> |
|
447 <td>Private method to read a raw API file into the database.</td> |
|
448 </tr><tr> |
|
449 <td><a href="#DbAPIsWorker.__loadApiFileIfNewer">__loadApiFileIfNewer</a></td> |
|
450 <td>Private method to load an API file, if it is newer than the one read into the database.</td> |
|
451 </tr><tr> |
|
452 <td><a href="#DbAPIsWorker.__storeApis">__storeApis</a></td> |
|
453 <td>Private method to put the API entries into the database.</td> |
|
454 </tr><tr> |
|
455 <td><a href="#DbAPIsWorker.abort">abort</a></td> |
|
456 <td>Public method to ask the thread to stop.</td> |
|
457 </tr><tr> |
|
458 <td><a href="#DbAPIsWorker.run">run</a></td> |
|
459 <td>Public method to perform the threads work.</td> |
|
460 </tr> |
|
461 </table> |
|
462 <a NAME="DbAPIsWorker.__init__" ID="DbAPIsWorker.__init__"></a> |
|
463 <h4>DbAPIsWorker (Constructor)</h4> |
|
464 <b>DbAPIsWorker</b>(<i>proxy, language, apiFiles, projectPath = ""</i>) |
|
465 <p> |
|
466 Constructor |
|
467 </p><dl> |
|
468 <dt><i>proxy</i></dt> |
|
469 <dd> |
|
470 reference to the object that is proxied (DbAPIs) |
|
471 </dd><dt><i>language</i></dt> |
|
472 <dd> |
|
473 language of the APIs object (string) |
|
474 </dd><dt><i>apiFiles</i></dt> |
|
475 <dd> |
|
476 list of API files to process (list of strings) |
|
477 </dd><dt><i>projectPath</i></dt> |
|
478 <dd> |
|
479 path of the project. Only needed, if the APIs |
|
480 are extracted out of the sources of a project. (string) |
|
481 </dd> |
|
482 </dl><a NAME="DbAPIsWorker.__autoCompletionWordSeparators" ID="DbAPIsWorker.__autoCompletionWordSeparators"></a> |
|
483 <h4>DbAPIsWorker.__autoCompletionWordSeparators</h4> |
|
484 <b>__autoCompletionWordSeparators</b>(<i>language</i>) |
|
485 <p> |
|
486 Private method to get the word separator characters for a language. |
|
487 </p><dl> |
|
488 <dt><i>language</i></dt> |
|
489 <dd> |
|
490 language of the APIs object (string) |
|
491 </dd> |
|
492 </dl><dl> |
|
493 <dt>Returns:</dt> |
|
494 <dd> |
|
495 word separator characters (list of strings) |
|
496 </dd> |
|
497 </dl><a NAME="DbAPIsWorker.__deleteApiFile" ID="DbAPIsWorker.__deleteApiFile"></a> |
|
498 <h4>DbAPIsWorker.__deleteApiFile</h4> |
|
499 <b>__deleteApiFile</b>(<i>apiFile</i>) |
|
500 <p> |
|
501 Private method to delete all references to an api file. |
|
502 </p><dl> |
|
503 <dt><i>apiFile</i></dt> |
|
504 <dd> |
|
505 filename of the raw API file (string) |
|
506 </dd> |
|
507 </dl><a NAME="DbAPIsWorker.__loadApiFile" ID="DbAPIsWorker.__loadApiFile"></a> |
|
508 <h4>DbAPIsWorker.__loadApiFile</h4> |
|
509 <b>__loadApiFile</b>(<i>apiFile</i>) |
|
510 <p> |
|
511 Private method to read a raw API file into the database. |
|
512 </p><dl> |
|
513 <dt><i>apiFile</i></dt> |
|
514 <dd> |
|
515 filename of the raw API file (string) |
|
516 </dd> |
|
517 </dl><a NAME="DbAPIsWorker.__loadApiFileIfNewer" ID="DbAPIsWorker.__loadApiFileIfNewer"></a> |
|
518 <h4>DbAPIsWorker.__loadApiFileIfNewer</h4> |
|
519 <b>__loadApiFileIfNewer</b>(<i>apiFile</i>) |
|
520 <p> |
|
521 Private method to load an API file, if it is newer than the one read |
|
522 into the database. |
|
523 </p><dl> |
|
524 <dt><i>apiFile</i></dt> |
|
525 <dd> |
|
526 filename of the raw API file (string) |
|
527 </dd> |
|
528 </dl><a NAME="DbAPIsWorker.__storeApis" ID="DbAPIsWorker.__storeApis"></a> |
|
529 <h4>DbAPIsWorker.__storeApis</h4> |
|
530 <b>__storeApis</b>(<i>apis, apiFile, language</i>) |
|
531 <p> |
|
532 Private method to put the API entries into the database. |
|
533 </p><dl> |
|
534 <dt><i>apis</i></dt> |
|
535 <dd> |
|
536 list of api entries (list of strings) |
|
537 </dd><dt><i>apiFile</i></dt> |
|
538 <dd> |
|
539 filename of the file read to get the APIs (string) |
|
540 </dd><dt><i>language</i></dt> |
|
541 <dd> |
|
542 programming language of the file of the APIs (string) |
|
543 </dd> |
|
544 </dl><a NAME="DbAPIsWorker.abort" ID="DbAPIsWorker.abort"></a> |
|
545 <h4>DbAPIsWorker.abort</h4> |
|
546 <b>abort</b>(<i></i>) |
|
547 <p> |
|
548 Public method to ask the thread to stop. |
|
549 </p><a NAME="DbAPIsWorker.run" ID="DbAPIsWorker.run"></a> |
|
550 <h4>DbAPIsWorker.run</h4> |
|
551 <b>run</b>(<i></i>) |
|
552 <p> |
|
553 Public method to perform the threads work. |
|
554 </p> |
|
555 <div align="right"><a href="#top">Up</a></div> |
|
556 <hr /> |
|
557 </body></html> |