blob: 3e6926ca501fc1a8d151996fe5bc6e5d83e07adc (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
/*******************************************************************************
* Copyright (c) 2000, 2003 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/cpl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jface.text.source;
import org.eclipse.jface.text.BadLocationException;
/**
* Protocol that allows direct access to line information. Usually, implementations will also
* implement <code>IAnnotationModel</code>, which only allows <code>Iterator</code> based access
* to annotations.
* <p>
* This interface may be implemented by clients.
* </p>
*
* @since 3.0
*/
public interface ILineDiffer {
/**
* Determines the line state for line <code>line</code> in the targeted document.
*
* @param line the line to get diff information for
* @return the line information object for <code>line</code>.
*/
ILineDiffInfo getLineInfo(int line);
/**
* Reverts a single changed line to its original state, not touching any lines that
* are deleted at its borders.
*
* @param line the line number of the line to be restored.
* @throws BadLocationException if <code>line</code> is out of bounds.
*/
void revertLine(int line) throws BadLocationException;
/**
* Reverts a block of modified / added lines to their original state, including any deleted
* lines inside the block or at its borders. A block is considered to be a range of modified
* (e.g. changed, or added) lines.
*
* @param line any line in the block to be reverted.
* @throws BadLocationException if <code>line</code> is out of bounds.
*/
void revertBlock(int line) throws BadLocationException;
/**
* Reverts a range of lines to their original state, including any deleted
* lines inside the block or at its borders.
*
* @param line any line in the block to be reverted.
* @param nLines the number of lines to be reverted, must be > 0.
* @throws BadLocationException if <code>line</code> is out of bounds.
*/
void revertSelection(int line, int nLines) throws BadLocationException;
/**
* Restores the deleted lines after <code>line</code>.
*
* @param line the deleted lines following this line number are restored.
* @return the number of restored lines.
* @throws BadLocationException if <code>line</code> is out of bounds.
*/
int restoreAfterLine(int line) throws BadLocationException;
}
|