Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgDiffGenerator.html
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgDiffGenerator.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10438
- 4cd7e5a8b3cf
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.HgDiffGenerator</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgDiffGenerator</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a class to generate the output of the hg diff command. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#HgDiffGenerator">HgDiffGenerator</a></td> | |
| 25 <td>Class implementing the generation of output of the hg diff command.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="HgDiffGenerator" ID="HgDiffGenerator"></a> | |
| 36 <h2>HgDiffGenerator</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the generation of output of the hg diff command. | |
| 40 </p> | |
| 41 <h3>Signals</h3> | |
| 42 <dl> | |
| 43 | |
| 44 <dt>finished()</dt> | |
| 45 <dd> | |
| 46 emitted when all processes have finished | |
| 47 </dd> | |
| 48 </dl> | |
| 49 <h3>Derived from</h3> | |
| 50 QObject | |
| 51 <h3>Class Attributes</h3> | |
| 52 | |
| 53 <table> | |
| 54 <tr><td>None</td></tr> | |
| 55 </table> | |
| 56 <h3>Class Methods</h3> | |
| 57 | |
| 58 <table> | |
| 59 <tr><td>None</td></tr> | |
| 60 </table> | |
| 61 <h3>Methods</h3> | |
| 62 | |
| 63 <table> | |
| 64 | |
| 65 <tr> | |
| 66 <td><a href="#HgDiffGenerator.__init__">HgDiffGenerator</a></td> | |
| 67 <td>Constructor</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#HgDiffGenerator.__extractFileName">__extractFileName</a></td> | |
| 71 <td>Private method to extract the file name out of a file separator line.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#HgDiffGenerator.__finish">__finish</a></td> | |
| 75 <td>Private slot called when the process finished or the user pressed the button.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#HgDiffGenerator.__getVersionArg">__getVersionArg</a></td> | |
| 79 <td>Private method to get a hg revision argument for the given revision.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#HgDiffGenerator.__processFileLine">__processFileLine</a></td> | |
| 83 <td>Private slot to process a line giving the old/new file.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#HgDiffGenerator.getResult">getResult</a></td> | |
| 87 <td>Public method to return the result data.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#HgDiffGenerator.start">start</a></td> | |
| 91 <td>Public slot to start the hg diff command.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#HgDiffGenerator.stopProcess">stopProcess</a></td> | |
| 95 <td>Public slot to stop the diff process.</td> | |
| 96 </tr> | |
| 97 </table> | |
| 98 <h3>Static Methods</h3> | |
| 99 | |
| 100 <table> | |
| 101 <tr><td>None</td></tr> | |
| 102 </table> | |
| 103 | |
| 104 <a NAME="HgDiffGenerator.__init__" ID="HgDiffGenerator.__init__"></a> | |
| 105 <h4>HgDiffGenerator (Constructor)</h4> | |
| 106 <b>HgDiffGenerator</b>(<i>vcs, parent=None</i>) | |
| 107 | |
| 108 <p> | |
| 109 Constructor | |
| 110 </p> | |
| 111 <dl> | |
| 112 | |
| 113 <dt><i>vcs</i></dt> | |
| 114 <dd> | |
| 115 reference to the vcs object | |
| 116 </dd> | |
| 117 <dt><i>parent</i></dt> | |
| 118 <dd> | |
| 119 parent widget (QWidget) | |
| 120 </dd> | |
| 121 </dl> | |
| 122 <a NAME="HgDiffGenerator.__extractFileName" ID="HgDiffGenerator.__extractFileName"></a> | |
| 123 <h4>HgDiffGenerator.__extractFileName</h4> | |
| 124 <b>__extractFileName</b>(<i>line</i>) | |
| 125 | |
| 126 <p> | |
| 127 Private method to extract the file name out of a file separator line. | |
| 128 </p> | |
| 129 <dl> | |
| 130 | |
| 131 <dt><i>line</i></dt> | |
| 132 <dd> | |
| 133 line to be processed (string) | |
| 134 </dd> | |
| 135 </dl> | |
| 136 <dl> | |
| 137 <dt>Return:</dt> | |
| 138 <dd> | |
| 139 extracted file name (string) | |
| 140 </dd> | |
| 141 </dl> | |
| 142 <a NAME="HgDiffGenerator.__finish" ID="HgDiffGenerator.__finish"></a> | |
| 143 <h4>HgDiffGenerator.__finish</h4> | |
| 144 <b>__finish</b>(<i></i>) | |
| 145 | |
| 146 <p> | |
| 147 Private slot called when the process finished or the user pressed | |
| 148 the button. | |
| 149 </p> | |
| 150 <a NAME="HgDiffGenerator.__getVersionArg" ID="HgDiffGenerator.__getVersionArg"></a> | |
| 151 <h4>HgDiffGenerator.__getVersionArg</h4> | |
| 152 <b>__getVersionArg</b>(<i>version</i>) | |
| 153 | |
| 154 <p> | |
| 155 Private method to get a hg revision argument for the given revision. | |
| 156 </p> | |
| 157 <dl> | |
| 158 | |
| 159 <dt><i>version</i></dt> | |
| 160 <dd> | |
| 161 revision (integer or string) | |
| 162 </dd> | |
| 163 </dl> | |
| 164 <dl> | |
| 165 <dt>Return:</dt> | |
| 166 <dd> | |
| 167 version argument (string) | |
| 168 </dd> | |
| 169 </dl> | |
| 170 <a NAME="HgDiffGenerator.__processFileLine" ID="HgDiffGenerator.__processFileLine"></a> | |
| 171 <h4>HgDiffGenerator.__processFileLine</h4> | |
| 172 <b>__processFileLine</b>(<i>lineno, line</i>) | |
| 173 | |
| 174 <p> | |
| 175 Private slot to process a line giving the old/new file. | |
| 176 </p> | |
| 177 <dl> | |
| 178 | |
| 179 <dt><i>lineno</i> (int)</dt> | |
| 180 <dd> | |
| 181 line number of line to be processed | |
| 182 </dd> | |
| 183 <dt><i>line</i> (str)</dt> | |
| 184 <dd> | |
| 185 line to be processed | |
| 186 </dd> | |
| 187 </dl> | |
| 188 <a NAME="HgDiffGenerator.getResult" ID="HgDiffGenerator.getResult"></a> | |
| 189 <h4>HgDiffGenerator.getResult</h4> | |
| 190 <b>getResult</b>(<i></i>) | |
| 191 | |
| 192 <p> | |
| 193 Public method to return the result data. | |
| 194 </p> | |
| 195 <dl> | |
| 196 <dt>Return:</dt> | |
| 197 <dd> | |
| 198 tuple of lists of string containing lines of the diff, the | |
| 199 list of errors and a list of tuples of filenames and the line | |
| 200 into the diff output. | |
| 201 </dd> | |
| 202 </dl> | |
| 203 <a NAME="HgDiffGenerator.start" ID="HgDiffGenerator.start"></a> | |
| 204 <h4>HgDiffGenerator.start</h4> | |
| 205 <b>start</b>(<i>fn, versions=None, bundle=None, qdiff=False</i>) | |
| 206 | |
| 207 <p> | |
| 208 Public slot to start the hg diff command. | |
| 209 </p> | |
| 210 <dl> | |
| 211 | |
| 212 <dt><i>fn</i></dt> | |
| 213 <dd> | |
| 214 filename to be diffed (string) | |
| 215 </dd> | |
| 216 <dt><i>versions</i></dt> | |
| 217 <dd> | |
| 218 list of versions to be diffed (list of up to | |
| 219 2 strings or None) | |
| 220 </dd> | |
| 221 <dt><i>bundle</i></dt> | |
| 222 <dd> | |
| 223 name of a bundle file (string) | |
| 224 </dd> | |
| 225 <dt><i>qdiff</i></dt> | |
| 226 <dd> | |
| 227 flag indicating qdiff command shall be used (boolean) | |
| 228 </dd> | |
| 229 </dl> | |
| 230 <dl> | |
| 231 <dt>Return:</dt> | |
| 232 <dd> | |
| 233 flag indicating a successful start of the diff command | |
| 234 (boolean) | |
| 235 </dd> | |
| 236 </dl> | |
| 237 <a NAME="HgDiffGenerator.stopProcess" ID="HgDiffGenerator.stopProcess"></a> | |
| 238 <h4>HgDiffGenerator.stopProcess</h4> | |
| 239 <b>stopProcess</b>(<i></i>) | |
| 240 | |
| 241 <p> | |
| 242 Public slot to stop the diff process. | |
| 243 </p> | |
| 244 <div align="right"><a href="#top">Up</a></div> | |
| 245 <hr /> | |
| 246 </body></html> |
