Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues.html

eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues</h1>
24
25 <p>
26 Module implementing the queues extension interface.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#Queues">Queues</a></td>
39 <td>Class implementing the queues extension interface.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="Queues" ID="Queues"></a>
50 <h2>Queues</h2>
51
52 <p>
53 Class implementing the queues extension interface.
54 </p>
55 <h3>Derived from</h3>
56 HgExtension
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>APPLIED_LIST</td></tr><tr><td>GOTO</td></tr><tr><td>POP</td></tr><tr><td>PUSH</td></tr><tr><td>QUEUE_ACTIVATE</td></tr><tr><td>QUEUE_DELETE</td></tr><tr><td>QUEUE_PURGE</td></tr><tr><td>SERIES_LIST</td></tr><tr><td>UNAPPLIED_LIST</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#Queues.__init__">Queues</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#Queues.__getCommitMessage">__getCommitMessage</a></td>
77 <td>Private method to get the commit message of the current patch.</td>
78 </tr>
79 <tr>
80 <td><a href="#Queues.__getCurrentPatch">__getCurrentPatch</a></td>
81 <td>Private method to get the name of the current patch.</td>
82 </tr>
83 <tr>
84 <td><a href="#Queues.__getPatchesList">__getPatchesList</a></td>
85 <td>Private method to get a list of patches of a given type.</td>
86 </tr>
87 <tr>
88 <td><a href="#Queues.getGuardsList">getGuardsList</a></td>
89 <td>Public method to get a list of all guards defined.</td>
90 </tr>
91 <tr>
92 <td><a href="#Queues.hgQueueCreateRenameQueue">hgQueueCreateRenameQueue</a></td>
93 <td>Public method to create a new queue or rename the active queue.</td>
94 </tr>
95 <tr>
96 <td><a href="#Queues.hgQueueDeletePatch">hgQueueDeletePatch</a></td>
97 <td>Public method to delete a selected unapplied patch.</td>
98 </tr>
99 <tr>
100 <td><a href="#Queues.hgQueueDeletePurgeActivateQueue">hgQueueDeletePurgeActivateQueue</a></td>
101 <td>Public method to delete the reference to a queue and optionally remove the patch directory or set the active queue.</td>
102 </tr>
103 <tr>
104 <td><a href="#Queues.hgQueueFinishAppliedPatches">hgQueueFinishAppliedPatches</a></td>
105 <td>Public method to finish all applied patches.</td>
106 </tr>
107 <tr>
108 <td><a href="#Queues.hgQueueFoldUnappliedPatches">hgQueueFoldUnappliedPatches</a></td>
109 <td>Public method to fold patches into the current patch.</td>
110 </tr>
111 <tr>
112 <td><a href="#Queues.hgQueueGuardsDeactivate">hgQueueGuardsDeactivate</a></td>
113 <td>Public method to deactivate all active guards.</td>
114 </tr>
115 <tr>
116 <td><a href="#Queues.hgQueueGuardsDefine">hgQueueGuardsDefine</a></td>
117 <td>Public method to define guards for the current or a named patch.</td>
118 </tr>
119 <tr>
120 <td><a href="#Queues.hgQueueGuardsDropAll">hgQueueGuardsDropAll</a></td>
121 <td>Public method to drop all guards of the current or a named patch.</td>
122 </tr>
123 <tr>
124 <td><a href="#Queues.hgQueueGuardsIdentifyActive">hgQueueGuardsIdentifyActive</a></td>
125 <td>Public method to list all active guards.</td>
126 </tr>
127 <tr>
128 <td><a href="#Queues.hgQueueGuardsList">hgQueueGuardsList</a></td>
129 <td>Public method to list the guards for the current or a named patch.</td>
130 </tr>
131 <tr>
132 <td><a href="#Queues.hgQueueGuardsListAll">hgQueueGuardsListAll</a></td>
133 <td>Public method to list all guards of all patches.</td>
134 </tr>
135 <tr>
136 <td><a href="#Queues.hgQueueGuardsSetActive">hgQueueGuardsSetActive</a></td>
137 <td>Public method to set the active guards.</td>
138 </tr>
139 <tr>
140 <td><a href="#Queues.hgQueueInit">hgQueueInit</a></td>
141 <td>Public method to initialize a new queue repository.</td>
142 </tr>
143 <tr>
144 <td><a href="#Queues.hgQueueListPatches">hgQueueListPatches</a></td>
145 <td>Public method to show a list of all patches.</td>
146 </tr>
147 <tr>
148 <td><a href="#Queues.hgQueueListQueues">hgQueueListQueues</a></td>
149 <td>Public method to list available queues.</td>
150 </tr>
151 <tr>
152 <td><a href="#Queues.hgQueueNewPatch">hgQueueNewPatch</a></td>
153 <td>Public method to create a new named patch.</td>
154 </tr>
155 <tr>
156 <td><a href="#Queues.hgQueuePushPopPatches">hgQueuePushPopPatches</a></td>
157 <td>Public method to push patches onto the stack or pop patches off the stack.</td>
158 </tr>
159 <tr>
160 <td><a href="#Queues.hgQueueRefreshPatch">hgQueueRefreshPatch</a></td>
161 <td>Public method to refresh the current patch.</td>
162 </tr>
163 <tr>
164 <td><a href="#Queues.hgQueueRenamePatch">hgQueueRenamePatch</a></td>
165 <td>Public method to rename the current or a selected patch.</td>
166 </tr>
167 <tr>
168 <td><a href="#Queues.hgQueueShowHeader">hgQueueShowHeader</a></td>
169 <td>Public method to show the commit message of the current patch.</td>
170 </tr>
171 <tr>
172 <td><a href="#Queues.hgQueueShowPatch">hgQueueShowPatch</a></td>
173 <td>Public method to show the contents of the current patch.</td>
174 </tr>
175 <tr>
176 <td><a href="#Queues.hgQueueStatus">hgQueueStatus</a></td>
177 <td>Public method used to view the status of a queue repository.</td>
178 </tr>
179 <tr>
180 <td><a href="#Queues.shutdown">shutdown</a></td>
181 <td>Public method used to shutdown the queues interface.</td>
182 </tr>
183 </table>
184 <h3>Static Methods</h3>
185
186 <table>
187 <tr><td>None</td></tr>
188 </table>
189
190 <a NAME="Queues.__init__" ID="Queues.__init__"></a>
191 <h4>Queues (Constructor)</h4>
192 <b>Queues</b>(<i>vcs</i>)
193
194 <p>
195 Constructor
196 </p>
197 <dl>
198
199 <dt><i>vcs</i></dt>
200 <dd>
201 reference to the Mercurial vcs object
202 </dd>
203 </dl>
204 <a NAME="Queues.__getCommitMessage" ID="Queues.__getCommitMessage"></a>
205 <h4>Queues.__getCommitMessage</h4>
206 <b>__getCommitMessage</b>(<i></i>)
207
208 <p>
209 Private method to get the commit message of the current patch.
210 </p>
211 <dl>
212 <dt>Return:</dt>
213 <dd>
214 name of the current patch (string)
215 </dd>
216 </dl>
217 <a NAME="Queues.__getCurrentPatch" ID="Queues.__getCurrentPatch"></a>
218 <h4>Queues.__getCurrentPatch</h4>
219 <b>__getCurrentPatch</b>(<i></i>)
220
221 <p>
222 Private method to get the name of the current patch.
223 </p>
224 <dl>
225 <dt>Return:</dt>
226 <dd>
227 name of the current patch (string)
228 </dd>
229 </dl>
230 <a NAME="Queues.__getPatchesList" ID="Queues.__getPatchesList"></a>
231 <h4>Queues.__getPatchesList</h4>
232 <b>__getPatchesList</b>(<i>listType, withSummary=False</i>)
233
234 <p>
235 Private method to get a list of patches of a given type.
236 </p>
237 <dl>
238
239 <dt><i>listType</i></dt>
240 <dd>
241 type of patches list to get
242 (Queues.APPLIED_LIST, Queues.UNAPPLIED_LIST, Queues.SERIES_LIST)
243 </dd>
244 <dt><i>withSummary</i></dt>
245 <dd>
246 flag indicating to get a summary as well (boolean)
247 </dd>
248 </dl>
249 <dl>
250 <dt>Return:</dt>
251 <dd>
252 list of patches (list of string)
253 </dd>
254 </dl>
255 <dl>
256
257 <dt>Raises <b>ValueError</b>:</dt>
258 <dd>
259 raised to indicate an invalid patch list type
260 </dd>
261 </dl>
262 <a NAME="Queues.getGuardsList" ID="Queues.getGuardsList"></a>
263 <h4>Queues.getGuardsList</h4>
264 <b>getGuardsList</b>(<i>allGuards=True</i>)
265
266 <p>
267 Public method to get a list of all guards defined.
268 </p>
269 <dl>
270
271 <dt><i>allGuards</i></dt>
272 <dd>
273 flag indicating to get all guards (boolean)
274 </dd>
275 </dl>
276 <dl>
277 <dt>Return:</dt>
278 <dd>
279 sorted list of guards (list of strings)
280 </dd>
281 </dl>
282 <a NAME="Queues.hgQueueCreateRenameQueue" ID="Queues.hgQueueCreateRenameQueue"></a>
283 <h4>Queues.hgQueueCreateRenameQueue</h4>
284 <b>hgQueueCreateRenameQueue</b>(<i>isCreate</i>)
285
286 <p>
287 Public method to create a new queue or rename the active queue.
288 </p>
289 <dl>
290
291 <dt><i>isCreate</i></dt>
292 <dd>
293 flag indicating to create a new queue (boolean)
294 </dd>
295 </dl>
296 <a NAME="Queues.hgQueueDeletePatch" ID="Queues.hgQueueDeletePatch"></a>
297 <h4>Queues.hgQueueDeletePatch</h4>
298 <b>hgQueueDeletePatch</b>(<i></i>)
299
300 <p>
301 Public method to delete a selected unapplied patch.
302 </p>
303 <a NAME="Queues.hgQueueDeletePurgeActivateQueue" ID="Queues.hgQueueDeletePurgeActivateQueue"></a>
304 <h4>Queues.hgQueueDeletePurgeActivateQueue</h4>
305 <b>hgQueueDeletePurgeActivateQueue</b>(<i>operation</i>)
306
307 <p>
308 Public method to delete the reference to a queue and optionally
309 remove the patch directory or set the active queue.
310 </p>
311 <dl>
312
313 <dt><i>operation</i></dt>
314 <dd>
315 operation to be performed (Queues.QUEUE_DELETE,
316 Queues.QUEUE_PURGE, Queues.QUEUE_ACTIVATE)
317 </dd>
318 </dl>
319 <dl>
320
321 <dt>Raises <b>ValueError</b>:</dt>
322 <dd>
323 raised to indicate an invalid operation
324 </dd>
325 </dl>
326 <a NAME="Queues.hgQueueFinishAppliedPatches" ID="Queues.hgQueueFinishAppliedPatches"></a>
327 <h4>Queues.hgQueueFinishAppliedPatches</h4>
328 <b>hgQueueFinishAppliedPatches</b>(<i></i>)
329
330 <p>
331 Public method to finish all applied patches.
332 </p>
333 <a NAME="Queues.hgQueueFoldUnappliedPatches" ID="Queues.hgQueueFoldUnappliedPatches"></a>
334 <h4>Queues.hgQueueFoldUnappliedPatches</h4>
335 <b>hgQueueFoldUnappliedPatches</b>(<i></i>)
336
337 <p>
338 Public method to fold patches into the current patch.
339 </p>
340 <a NAME="Queues.hgQueueGuardsDeactivate" ID="Queues.hgQueueGuardsDeactivate"></a>
341 <h4>Queues.hgQueueGuardsDeactivate</h4>
342 <b>hgQueueGuardsDeactivate</b>(<i></i>)
343
344 <p>
345 Public method to deactivate all active guards.
346 </p>
347 <a NAME="Queues.hgQueueGuardsDefine" ID="Queues.hgQueueGuardsDefine"></a>
348 <h4>Queues.hgQueueGuardsDefine</h4>
349 <b>hgQueueGuardsDefine</b>(<i></i>)
350
351 <p>
352 Public method to define guards for the current or a named patch.
353 </p>
354 <a NAME="Queues.hgQueueGuardsDropAll" ID="Queues.hgQueueGuardsDropAll"></a>
355 <h4>Queues.hgQueueGuardsDropAll</h4>
356 <b>hgQueueGuardsDropAll</b>(<i></i>)
357
358 <p>
359 Public method to drop all guards of the current or a named patch.
360 </p>
361 <a NAME="Queues.hgQueueGuardsIdentifyActive" ID="Queues.hgQueueGuardsIdentifyActive"></a>
362 <h4>Queues.hgQueueGuardsIdentifyActive</h4>
363 <b>hgQueueGuardsIdentifyActive</b>(<i></i>)
364
365 <p>
366 Public method to list all active guards.
367 </p>
368 <a NAME="Queues.hgQueueGuardsList" ID="Queues.hgQueueGuardsList"></a>
369 <h4>Queues.hgQueueGuardsList</h4>
370 <b>hgQueueGuardsList</b>(<i></i>)
371
372 <p>
373 Public method to list the guards for the current or a named patch.
374 </p>
375 <a NAME="Queues.hgQueueGuardsListAll" ID="Queues.hgQueueGuardsListAll"></a>
376 <h4>Queues.hgQueueGuardsListAll</h4>
377 <b>hgQueueGuardsListAll</b>(<i></i>)
378
379 <p>
380 Public method to list all guards of all patches.
381 </p>
382 <a NAME="Queues.hgQueueGuardsSetActive" ID="Queues.hgQueueGuardsSetActive"></a>
383 <h4>Queues.hgQueueGuardsSetActive</h4>
384 <b>hgQueueGuardsSetActive</b>(<i></i>)
385
386 <p>
387 Public method to set the active guards.
388 </p>
389 <a NAME="Queues.hgQueueInit" ID="Queues.hgQueueInit"></a>
390 <h4>Queues.hgQueueInit</h4>
391 <b>hgQueueInit</b>(<i>name</i>)
392
393 <p>
394 Public method to initialize a new queue repository.
395 </p>
396 <dl>
397
398 <dt><i>name</i></dt>
399 <dd>
400 directory name (string)
401 </dd>
402 </dl>
403 <a NAME="Queues.hgQueueListPatches" ID="Queues.hgQueueListPatches"></a>
404 <h4>Queues.hgQueueListPatches</h4>
405 <b>hgQueueListPatches</b>(<i></i>)
406
407 <p>
408 Public method to show a list of all patches.
409 </p>
410 <a NAME="Queues.hgQueueListQueues" ID="Queues.hgQueueListQueues"></a>
411 <h4>Queues.hgQueueListQueues</h4>
412 <b>hgQueueListQueues</b>(<i></i>)
413
414 <p>
415 Public method to list available queues.
416 </p>
417 <a NAME="Queues.hgQueueNewPatch" ID="Queues.hgQueueNewPatch"></a>
418 <h4>Queues.hgQueueNewPatch</h4>
419 <b>hgQueueNewPatch</b>(<i></i>)
420
421 <p>
422 Public method to create a new named patch.
423 </p>
424 <a NAME="Queues.hgQueuePushPopPatches" ID="Queues.hgQueuePushPopPatches"></a>
425 <h4>Queues.hgQueuePushPopPatches</h4>
426 <b>hgQueuePushPopPatches</b>(<i>operation, doAll=False, named=False, force=False</i>)
427
428 <p>
429 Public method to push patches onto the stack or pop patches off the
430 stack.
431 </p>
432 <dl>
433
434 <dt><i>operation</i></dt>
435 <dd>
436 operation type to be performed (Queues.POP,
437 Queues.PUSH, Queues.GOTO)
438 </dd>
439 <dt><i>doAll</i></dt>
440 <dd>
441 flag indicating to push/pop all (boolean)
442 </dd>
443 <dt><i>named</i></dt>
444 <dd>
445 flag indicating to push/pop until a named patch
446 is at the top of the stack (boolean)
447 </dd>
448 <dt><i>force</i></dt>
449 <dd>
450 flag indicating a forceful pop (boolean)
451 </dd>
452 </dl>
453 <dl>
454 <dt>Return:</dt>
455 <dd>
456 flag indicating that the project should be reread (boolean)
457 </dd>
458 </dl>
459 <dl>
460
461 <dt>Raises <b>ValueError</b>:</dt>
462 <dd>
463 raised to indicate an invalid operation
464 </dd>
465 </dl>
466 <a NAME="Queues.hgQueueRefreshPatch" ID="Queues.hgQueueRefreshPatch"></a>
467 <h4>Queues.hgQueueRefreshPatch</h4>
468 <b>hgQueueRefreshPatch</b>(<i>editMessage=False</i>)
469
470 <p>
471 Public method to refresh the current patch.
472 </p>
473 <dl>
474
475 <dt><i>editMessage</i></dt>
476 <dd>
477 flag indicating to edit the current
478 commit message (boolean)
479 </dd>
480 </dl>
481 <a NAME="Queues.hgQueueRenamePatch" ID="Queues.hgQueueRenamePatch"></a>
482 <h4>Queues.hgQueueRenamePatch</h4>
483 <b>hgQueueRenamePatch</b>(<i></i>)
484
485 <p>
486 Public method to rename the current or a selected patch.
487 </p>
488 <a NAME="Queues.hgQueueShowHeader" ID="Queues.hgQueueShowHeader"></a>
489 <h4>Queues.hgQueueShowHeader</h4>
490 <b>hgQueueShowHeader</b>(<i></i>)
491
492 <p>
493 Public method to show the commit message of the current patch.
494 </p>
495 <a NAME="Queues.hgQueueShowPatch" ID="Queues.hgQueueShowPatch"></a>
496 <h4>Queues.hgQueueShowPatch</h4>
497 <b>hgQueueShowPatch</b>(<i>name</i>)
498
499 <p>
500 Public method to show the contents of the current patch.
501 </p>
502 <dl>
503
504 <dt><i>name</i></dt>
505 <dd>
506 file/directory name (string)
507 </dd>
508 </dl>
509 <a NAME="Queues.hgQueueStatus" ID="Queues.hgQueueStatus"></a>
510 <h4>Queues.hgQueueStatus</h4>
511 <b>hgQueueStatus</b>(<i>name</i>)
512
513 <p>
514 Public method used to view the status of a queue repository.
515 </p>
516 <dl>
517
518 <dt><i>name</i></dt>
519 <dd>
520 directory name (string)
521 </dd>
522 </dl>
523 <a NAME="Queues.shutdown" ID="Queues.shutdown"></a>
524 <h4>Queues.shutdown</h4>
525 <b>shutdown</b>(<i></i>)
526
527 <p>
528 Public method used to shutdown the queues interface.
529 </p>
530 <div align="right"><a href="#top">Up</a></div>
531 <hr />
532 </body></html>

Mercurial Repository: eric

eric ide

mercurial