Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgDiffGenerator.html
eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgDiffGenerator.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.HgDiffGenerator</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.HgDiffGenerator</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing a class to generate the output of the hg diff command. | |
| 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="#HgDiffGenerator">HgDiffGenerator</a></td> | |
| 39 <td>Class implementing the generation of output of the hg diff command.</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="HgDiffGenerator" ID="HgDiffGenerator"></a> | |
| 50 <h2>HgDiffGenerator</h2> | |
| 51 | |
| 52 <p> | |
| 53 Class implementing the generation of output of the hg diff command. | |
| 54 </p> | |
| 55 <h3>Signals</h3> | |
| 56 <dl> | |
| 57 | |
| 58 <dt>finished()</dt> | |
| 59 <dd> | |
| 60 emitted when all processes have finished | |
| 61 </dd> | |
| 62 </dl> | |
| 63 <h3>Derived from</h3> | |
| 64 QObject | |
| 65 <h3>Class Attributes</h3> | |
| 66 | |
| 67 <table> | |
| 68 <tr><td>None</td></tr> | |
| 69 </table> | |
| 70 <h3>Class Methods</h3> | |
| 71 | |
| 72 <table> | |
| 73 <tr><td>None</td></tr> | |
| 74 </table> | |
| 75 <h3>Methods</h3> | |
| 76 | |
| 77 <table> | |
| 78 | |
| 79 <tr> | |
| 80 <td><a href="#HgDiffGenerator.__init__">HgDiffGenerator</a></td> | |
| 81 <td>Constructor</td> | |
| 82 </tr> | |
| 83 <tr> | |
| 84 <td><a href="#HgDiffGenerator.__extractFileName">__extractFileName</a></td> | |
| 85 <td>Private method to extract the file name out of a file separator line.</td> | |
| 86 </tr> | |
| 87 <tr> | |
| 88 <td><a href="#HgDiffGenerator.__finish">__finish</a></td> | |
| 89 <td>Private slot called when the process finished or the user pressed the button.</td> | |
| 90 </tr> | |
| 91 <tr> | |
| 92 <td><a href="#HgDiffGenerator.__getVersionArg">__getVersionArg</a></td> | |
| 93 <td>Private method to get a hg revision argument for the given revision.</td> | |
| 94 </tr> | |
| 95 <tr> | |
| 96 <td><a href="#HgDiffGenerator.__processFileLine">__processFileLine</a></td> | |
| 97 <td>Private slot to process a line giving the old/new file.</td> | |
| 98 </tr> | |
| 99 <tr> | |
| 100 <td><a href="#HgDiffGenerator.getResult">getResult</a></td> | |
| 101 <td>Public method to return the result data.</td> | |
| 102 </tr> | |
| 103 <tr> | |
| 104 <td><a href="#HgDiffGenerator.start">start</a></td> | |
| 105 <td>Public slot to start the hg diff command.</td> | |
| 106 </tr> | |
| 107 <tr> | |
| 108 <td><a href="#HgDiffGenerator.stopProcess">stopProcess</a></td> | |
| 109 <td>Public slot to stop the diff process.</td> | |
| 110 </tr> | |
| 111 </table> | |
| 112 <h3>Static Methods</h3> | |
| 113 | |
| 114 <table> | |
| 115 <tr><td>None</td></tr> | |
| 116 </table> | |
| 117 | |
| 118 <a NAME="HgDiffGenerator.__init__" ID="HgDiffGenerator.__init__"></a> | |
| 119 <h4>HgDiffGenerator (Constructor)</h4> | |
| 120 <b>HgDiffGenerator</b>(<i>vcs, parent=None</i>) | |
| 121 | |
| 122 <p> | |
| 123 Constructor | |
| 124 </p> | |
| 125 <dl> | |
| 126 | |
| 127 <dt><i>vcs</i></dt> | |
| 128 <dd> | |
| 129 reference to the vcs object | |
| 130 </dd> | |
| 131 <dt><i>parent</i></dt> | |
| 132 <dd> | |
| 133 parent widget (QWidget) | |
| 134 </dd> | |
| 135 </dl> | |
| 136 <a NAME="HgDiffGenerator.__extractFileName" ID="HgDiffGenerator.__extractFileName"></a> | |
| 137 <h4>HgDiffGenerator.__extractFileName</h4> | |
| 138 <b>__extractFileName</b>(<i>line</i>) | |
| 139 | |
| 140 <p> | |
| 141 Private method to extract the file name out of a file separator line. | |
| 142 </p> | |
| 143 <dl> | |
| 144 | |
| 145 <dt><i>line</i></dt> | |
| 146 <dd> | |
| 147 line to be processed (string) | |
| 148 </dd> | |
| 149 </dl> | |
| 150 <dl> | |
| 151 <dt>Return:</dt> | |
| 152 <dd> | |
| 153 extracted file name (string) | |
| 154 </dd> | |
| 155 </dl> | |
| 156 <a NAME="HgDiffGenerator.__finish" ID="HgDiffGenerator.__finish"></a> | |
| 157 <h4>HgDiffGenerator.__finish</h4> | |
| 158 <b>__finish</b>(<i></i>) | |
| 159 | |
| 160 <p> | |
| 161 Private slot called when the process finished or the user pressed | |
| 162 the button. | |
| 163 </p> | |
| 164 <a NAME="HgDiffGenerator.__getVersionArg" ID="HgDiffGenerator.__getVersionArg"></a> | |
| 165 <h4>HgDiffGenerator.__getVersionArg</h4> | |
| 166 <b>__getVersionArg</b>(<i>version</i>) | |
| 167 | |
| 168 <p> | |
| 169 Private method to get a hg revision argument for the given revision. | |
| 170 </p> | |
| 171 <dl> | |
| 172 | |
| 173 <dt><i>version</i></dt> | |
| 174 <dd> | |
| 175 revision (integer or string) | |
| 176 </dd> | |
| 177 </dl> | |
| 178 <dl> | |
| 179 <dt>Return:</dt> | |
| 180 <dd> | |
| 181 version argument (string) | |
| 182 </dd> | |
| 183 </dl> | |
| 184 <a NAME="HgDiffGenerator.__processFileLine" ID="HgDiffGenerator.__processFileLine"></a> | |
| 185 <h4>HgDiffGenerator.__processFileLine</h4> | |
| 186 <b>__processFileLine</b>(<i>lineno, line</i>) | |
| 187 | |
| 188 <p> | |
| 189 Private slot to process a line giving the old/new file. | |
| 190 </p> | |
| 191 <dl> | |
| 192 | |
| 193 <dt><i>lineno</i> (int)</dt> | |
| 194 <dd> | |
| 195 line number of line to be processed | |
| 196 </dd> | |
| 197 <dt><i>line</i> (str)</dt> | |
| 198 <dd> | |
| 199 line to be processed | |
| 200 </dd> | |
| 201 </dl> | |
| 202 <a NAME="HgDiffGenerator.getResult" ID="HgDiffGenerator.getResult"></a> | |
| 203 <h4>HgDiffGenerator.getResult</h4> | |
| 204 <b>getResult</b>(<i></i>) | |
| 205 | |
| 206 <p> | |
| 207 Public method to return the result data. | |
| 208 </p> | |
| 209 <dl> | |
| 210 <dt>Return:</dt> | |
| 211 <dd> | |
| 212 tuple of lists of string containing lines of the diff, the | |
| 213 list of errors and a list of tuples of filenames and the line | |
| 214 into the diff output. | |
| 215 </dd> | |
| 216 </dl> | |
| 217 <a NAME="HgDiffGenerator.start" ID="HgDiffGenerator.start"></a> | |
| 218 <h4>HgDiffGenerator.start</h4> | |
| 219 <b>start</b>(<i>fn, versions=None, bundle=None, qdiff=False</i>) | |
| 220 | |
| 221 <p> | |
| 222 Public slot to start the hg diff command. | |
| 223 </p> | |
| 224 <dl> | |
| 225 | |
| 226 <dt><i>fn</i></dt> | |
| 227 <dd> | |
| 228 filename to be diffed (string) | |
| 229 </dd> | |
| 230 <dt><i>versions</i></dt> | |
| 231 <dd> | |
| 232 list of versions to be diffed (list of up to | |
| 233 2 strings or None) | |
| 234 </dd> | |
| 235 <dt><i>bundle</i></dt> | |
| 236 <dd> | |
| 237 name of a bundle file (string) | |
| 238 </dd> | |
| 239 <dt><i>qdiff</i></dt> | |
| 240 <dd> | |
| 241 flag indicating qdiff command shall be used (boolean) | |
| 242 </dd> | |
| 243 </dl> | |
| 244 <dl> | |
| 245 <dt>Return:</dt> | |
| 246 <dd> | |
| 247 flag indicating a successful start of the diff command | |
| 248 (boolean) | |
| 249 </dd> | |
| 250 </dl> | |
| 251 <a NAME="HgDiffGenerator.stopProcess" ID="HgDiffGenerator.stopProcess"></a> | |
| 252 <h4>HgDiffGenerator.stopProcess</h4> | |
| 253 <b>stopProcess</b>(<i></i>) | |
| 254 | |
| 255 <p> | |
| 256 Public slot to stop the diff process. | |
| 257 </p> | |
| 258 <div align="right"><a href="#top">Up</a></div> | |
| 259 <hr /> | |
| 260 </body></html> |
