Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDiffParser.html

src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDiffParser.html

branch
eric7
changeset 10479
856476537696
parent 10438
4cd7e5a8b3cf
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.VcsPlugins.vcsGit.GitDiffParser</h1> 9 <h1>eric7.Plugins.VcsPlugins.vcsGit.GitDiffParser</h1>
10
11 <p> 10 <p>
12 Module implementing a class to store and parse diff output. 11 Module implementing a class to store and parse diff output.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#GitDiffParser">GitDiffParser</a></td> 22 <td><a href="#GitDiffParser">GitDiffParser</a></td>
25 <td>Class implementing a class to store and parse diff output.</td> 23 <td>Class implementing a class to store and parse diff output.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29
30 <table> 28 <table>
31 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
32 </table> 30 </table>
31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="GitDiffParser" ID="GitDiffParser"></a> 34 <a NAME="GitDiffParser" ID="GitDiffParser"></a>
36 <h2>GitDiffParser</h2> 35 <h2>GitDiffParser</h2>
37
38 <p> 36 <p>
39 Class implementing a class to store and parse diff output. 37 Class implementing a class to store and parse diff output.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 None 41 None
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44
45 <table> 43 <table>
46 <tr><td>HunkHeaderRegexp</td></tr> 44 <tr><td>HunkHeaderRegexp</td></tr>
47 </table> 45 </table>
46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49
50 <table> 48 <table>
51 <tr><td>None</td></tr> 49 <tr><td>None</td></tr>
52 </table> 50 </table>
51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54 53 <table>
55 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#GitDiffParser.__init__">GitDiffParser</a></td> 55 <td><a href="#GitDiffParser.__init__">GitDiffParser</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
89 <tr> 86 <tr>
90 <td><a href="#GitDiffParser.headerLength">headerLength</a></td> 87 <td><a href="#GitDiffParser.headerLength">headerLength</a></td>
91 <td>Public method to get the header length.</td> 88 <td>Public method to get the header length.</td>
92 </tr> 89 </tr>
93 </table> 90 </table>
91
94 <h3>Static Methods</h3> 92 <h3>Static Methods</h3>
95
96 <table> 93 <table>
97 <tr><td>None</td></tr> 94 <tr><td>None</td></tr>
98 </table> 95 </table>
96
99 97
100 <a NAME="GitDiffParser.__init__" ID="GitDiffParser.__init__"></a> 98 <a NAME="GitDiffParser.__init__" ID="GitDiffParser.__init__"></a>
101 <h4>GitDiffParser (Constructor)</h4> 99 <h4>GitDiffParser (Constructor)</h4>
102 <b>GitDiffParser</b>(<i>diff</i>) 100 <b>GitDiffParser</b>(<i>diff</i>)
103
104 <p> 101 <p>
105 Constructor 102 Constructor
106 </p> 103 </p>
104
107 <dl> 105 <dl>
108 106
109 <dt><i>diff</i> (list of str)</dt> 107 <dt><i>diff</i> (list of str)</dt>
110 <dd> 108 <dd>
111 output of the diff command 109 output of the diff command
112 </dd> 110 </dd>
113 </dl> 111 </dl>
114 <a NAME="GitDiffParser.__generateHunkHeader" ID="GitDiffParser.__generateHunkHeader"></a> 112 <a NAME="GitDiffParser.__generateHunkHeader" ID="GitDiffParser.__generateHunkHeader"></a>
115 <h4>GitDiffParser.__generateHunkHeader</h4> 113 <h4>GitDiffParser.__generateHunkHeader</h4>
116 <b>__generateHunkHeader</b>(<i>oldStart, oldCount, newStart, newCount, heading=os.linesep</i>) 114 <b>__generateHunkHeader</b>(<i>oldStart, oldCount, newStart, newCount, heading=os.linesep</i>)
117
118 <p> 115 <p>
119 Private method to generate a hunk header line. 116 Private method to generate a hunk header line.
120 </p> 117 </p>
118
121 <dl> 119 <dl>
122 120
123 <dt><i>oldStart</i> (int)</dt> 121 <dt><i>oldStart</i> (int)</dt>
124 <dd> 122 <dd>
125 start line of the old part 123 start line of the old part
154 </dd> 152 </dd>
155 </dl> 153 </dl>
156 <a NAME="GitDiffParser.__generateRange" ID="GitDiffParser.__generateRange"></a> 154 <a NAME="GitDiffParser.__generateRange" ID="GitDiffParser.__generateRange"></a>
157 <h4>GitDiffParser.__generateRange</h4> 155 <h4>GitDiffParser.__generateRange</h4>
158 <b>__generateRange</b>(<i>start, count</i>) 156 <b>__generateRange</b>(<i>start, count</i>)
159
160 <p> 157 <p>
161 Private method to generate a hunk header range. 158 Private method to generate a hunk header range.
162 </p> 159 </p>
160
163 <dl> 161 <dl>
164 162
165 <dt><i>start</i> (int)</dt> 163 <dt><i>start</i> (int)</dt>
166 <dd> 164 <dd>
167 start line 165 start line
184 </dd> 182 </dd>
185 </dl> 183 </dl>
186 <a NAME="GitDiffParser.__initHunk" ID="GitDiffParser.__initHunk"></a> 184 <a NAME="GitDiffParser.__initHunk" ID="GitDiffParser.__initHunk"></a>
187 <h4>GitDiffParser.__initHunk</h4> 185 <h4>GitDiffParser.__initHunk</h4>
188 <b>__initHunk</b>(<i></i>) 186 <b>__initHunk</b>(<i></i>)
189
190 <p> 187 <p>
191 Private method to initialize a hunk data structure. 188 Private method to initialize a hunk data structure.
192 </p> 189 </p>
190
193 <dl> 191 <dl>
194 <dt>Return:</dt> 192 <dt>Return:</dt>
195 <dd> 193 <dd>
196 hunk data structure 194 hunk data structure
197 </dd> 195 </dd>
203 </dd> 201 </dd>
204 </dl> 202 </dl>
205 <a NAME="GitDiffParser.__parseDiff" ID="GitDiffParser.__parseDiff"></a> 203 <a NAME="GitDiffParser.__parseDiff" ID="GitDiffParser.__parseDiff"></a>
206 <h4>GitDiffParser.__parseDiff</h4> 204 <h4>GitDiffParser.__parseDiff</h4>
207 <b>__parseDiff</b>(<i></i>) 205 <b>__parseDiff</b>(<i></i>)
208
209 <p> 206 <p>
210 Private method to parse the diff output. 207 Private method to parse the diff output.
211 </p> 208 </p>
209
212 <dl> 210 <dl>
213 211
214 <dt>Raises <b>AssertionError</b>:</dt> 212 <dt>Raises <b>AssertionError</b>:</dt>
215 <dd> 213 <dd>
216 raised when a malformed hunk header is 214 raised when a malformed hunk header is
218 </dd> 216 </dd>
219 </dl> 217 </dl>
220 <a NAME="GitDiffParser.__parseRange" ID="GitDiffParser.__parseRange"></a> 218 <a NAME="GitDiffParser.__parseRange" ID="GitDiffParser.__parseRange"></a>
221 <h4>GitDiffParser.__parseRange</h4> 219 <h4>GitDiffParser.__parseRange</h4>
222 <b>__parseRange</b>(<i>headerRange</i>) 220 <b>__parseRange</b>(<i>headerRange</i>)
223
224 <p> 221 <p>
225 Private method to parse the hunk header range part. 222 Private method to parse the hunk header range part.
226 </p> 223 </p>
224
227 <dl> 225 <dl>
228 226
229 <dt><i>headerRange</i> (str)</dt> 227 <dt><i>headerRange</i> (str)</dt>
230 <dd> 228 <dd>
231 hunk header range 229 hunk header range
244 </dd> 242 </dd>
245 </dl> 243 </dl>
246 <a NAME="GitDiffParser.createHunkPatch" ID="GitDiffParser.createHunkPatch"></a> 244 <a NAME="GitDiffParser.createHunkPatch" ID="GitDiffParser.createHunkPatch"></a>
247 <h4>GitDiffParser.createHunkPatch</h4> 245 <h4>GitDiffParser.createHunkPatch</h4>
248 <b>createHunkPatch</b>(<i>lineIndex</i>) 246 <b>createHunkPatch</b>(<i>lineIndex</i>)
249
250 <p> 247 <p>
251 Public method to create a hunk based patch. 248 Public method to create a hunk based patch.
252 </p> 249 </p>
250
253 <dl> 251 <dl>
254 252
255 <dt><i>lineIndex</i> (int)</dt> 253 <dt><i>lineIndex</i> (int)</dt>
256 <dd> 254 <dd>
257 line number of the hunk 255 line number of the hunk
270 </dd> 268 </dd>
271 </dl> 269 </dl>
272 <a NAME="GitDiffParser.createLinesPatch" ID="GitDiffParser.createLinesPatch"></a> 270 <a NAME="GitDiffParser.createLinesPatch" ID="GitDiffParser.createLinesPatch"></a>
273 <h4>GitDiffParser.createLinesPatch</h4> 271 <h4>GitDiffParser.createLinesPatch</h4>
274 <b>createLinesPatch</b>(<i>startIndex, endIndex, reverse=False</i>) 272 <b>createLinesPatch</b>(<i>startIndex, endIndex, reverse=False</i>)
275
276 <p> 273 <p>
277 Public method to create a selected lines based patch. 274 Public method to create a selected lines based patch.
278 </p> 275 </p>
276
279 <dl> 277 <dl>
280 278
281 <dt><i>startIndex</i> (int)</dt> 279 <dt><i>startIndex</i> (int)</dt>
282 <dd> 280 <dd>
283 start line number 281 start line number
304 </dd> 302 </dd>
305 </dl> 303 </dl>
306 <a NAME="GitDiffParser.headerLength" ID="GitDiffParser.headerLength"></a> 304 <a NAME="GitDiffParser.headerLength" ID="GitDiffParser.headerLength"></a>
307 <h4>GitDiffParser.headerLength</h4> 305 <h4>GitDiffParser.headerLength</h4>
308 <b>headerLength</b>(<i></i>) 306 <b>headerLength</b>(<i></i>)
309
310 <p> 307 <p>
311 Public method to get the header length. 308 Public method to get the header length.
312 </p> 309 </p>
310
313 <dl> 311 <dl>
314 <dt>Return:</dt> 312 <dt>Return:</dt>
315 <dd> 313 <dd>
316 length of the header 314 length of the header
317 </dd> 315 </dd>

Mercurial Repository: eric

eric ide

mercurial