Mercurial > projects > dwt-addons
annotate dwtx/jface/text/source/ILineDiffer.d @ 139:93a6ec48fd28
Regexp throws removal in interfaces
| author | Frank Benoit <benoit@tionex.de> |
|---|---|
| date | Sun, 24 Aug 2008 02:31:41 +0200 |
| parents | c4fb132a086c |
| children |
| rev | line source |
|---|---|
| 129 | 1 /******************************************************************************* |
| 2 * Copyright (c) 2000, 2006 IBM Corporation and others. | |
| 3 * All rights reserved. This program and the accompanying materials | |
| 4 * are made available under the terms of the Eclipse Public License v1.0 | |
| 5 * which accompanies this distribution, and is available at | |
| 6 * http://www.eclipse.org/legal/epl-v10.html | |
| 7 * | |
| 8 * Contributors: | |
| 9 * IBM Corporation - initial API and implementation | |
| 10 * Port to the D programming language: | |
| 11 * Frank Benoit <benoit@tionex.de> | |
| 12 *******************************************************************************/ | |
| 13 module dwtx.jface.text.source.ILineDiffer; | |
| 14 | |
| 131 | 15 import dwtx.jface.text.source.ISharedTextColors; // packageimport |
| 16 import dwtx.jface.text.source.ILineRange; // packageimport | |
| 17 import dwtx.jface.text.source.IAnnotationPresentation; // packageimport | |
| 18 import dwtx.jface.text.source.IVerticalRulerInfoExtension; // packageimport | |
| 19 import dwtx.jface.text.source.ICharacterPairMatcher; // packageimport | |
| 20 import dwtx.jface.text.source.TextInvocationContext; // packageimport | |
| 21 import dwtx.jface.text.source.LineChangeHover; // packageimport | |
| 22 import dwtx.jface.text.source.IChangeRulerColumn; // packageimport | |
| 23 import dwtx.jface.text.source.IAnnotationMap; // packageimport | |
| 24 import dwtx.jface.text.source.IAnnotationModelListenerExtension; // packageimport | |
| 25 import dwtx.jface.text.source.ISourceViewerExtension2; // packageimport | |
| 26 import dwtx.jface.text.source.IAnnotationHover; // packageimport | |
| 27 import dwtx.jface.text.source.ContentAssistantFacade; // packageimport | |
| 28 import dwtx.jface.text.source.IAnnotationAccess; // packageimport | |
| 29 import dwtx.jface.text.source.IVerticalRulerExtension; // packageimport | |
| 30 import dwtx.jface.text.source.IVerticalRulerColumn; // packageimport | |
| 31 import dwtx.jface.text.source.LineNumberRulerColumn; // packageimport | |
| 32 import dwtx.jface.text.source.MatchingCharacterPainter; // packageimport | |
| 33 import dwtx.jface.text.source.IAnnotationModelExtension; // packageimport | |
| 34 import dwtx.jface.text.source.ILineDifferExtension; // packageimport | |
| 35 import dwtx.jface.text.source.DefaultCharacterPairMatcher; // packageimport | |
| 36 import dwtx.jface.text.source.LineNumberChangeRulerColumn; // packageimport | |
| 37 import dwtx.jface.text.source.IAnnotationAccessExtension; // packageimport | |
| 38 import dwtx.jface.text.source.ISourceViewer; // packageimport | |
| 39 import dwtx.jface.text.source.AnnotationModel; // packageimport | |
| 40 import dwtx.jface.text.source.ILineDifferExtension2; // packageimport | |
| 41 import dwtx.jface.text.source.IAnnotationModelListener; // packageimport | |
| 42 import dwtx.jface.text.source.IVerticalRuler; // packageimport | |
| 43 import dwtx.jface.text.source.DefaultAnnotationHover; // packageimport | |
| 44 import dwtx.jface.text.source.SourceViewer; // packageimport | |
| 45 import dwtx.jface.text.source.SourceViewerConfiguration; // packageimport | |
| 46 import dwtx.jface.text.source.AnnotationBarHoverManager; // packageimport | |
| 47 import dwtx.jface.text.source.CompositeRuler; // packageimport | |
| 48 import dwtx.jface.text.source.ImageUtilities; // packageimport | |
| 49 import dwtx.jface.text.source.VisualAnnotationModel; // packageimport | |
| 50 import dwtx.jface.text.source.IAnnotationModel; // packageimport | |
| 51 import dwtx.jface.text.source.ISourceViewerExtension3; // packageimport | |
| 52 import dwtx.jface.text.source.ILineDiffInfo; // packageimport | |
| 53 import dwtx.jface.text.source.VerticalRulerEvent; // packageimport | |
| 54 import dwtx.jface.text.source.ChangeRulerColumn; // packageimport | |
| 55 import dwtx.jface.text.source.AnnotationModelEvent; // packageimport | |
| 56 import dwtx.jface.text.source.AnnotationColumn; // packageimport | |
| 57 import dwtx.jface.text.source.AnnotationRulerColumn; // packageimport | |
| 58 import dwtx.jface.text.source.IAnnotationHoverExtension; // packageimport | |
| 59 import dwtx.jface.text.source.AbstractRulerColumn; // packageimport | |
| 60 import dwtx.jface.text.source.ISourceViewerExtension; // packageimport | |
| 61 import dwtx.jface.text.source.AnnotationMap; // packageimport | |
| 62 import dwtx.jface.text.source.IVerticalRulerInfo; // packageimport | |
| 63 import dwtx.jface.text.source.IAnnotationModelExtension2; // packageimport | |
| 64 import dwtx.jface.text.source.LineRange; // packageimport | |
| 65 import dwtx.jface.text.source.IAnnotationAccessExtension2; // packageimport | |
| 66 import dwtx.jface.text.source.VerticalRuler; // packageimport | |
| 67 import dwtx.jface.text.source.JFaceTextMessages; // packageimport | |
| 68 import dwtx.jface.text.source.IOverviewRuler; // packageimport | |
| 69 import dwtx.jface.text.source.Annotation; // packageimport | |
| 70 import dwtx.jface.text.source.IVerticalRulerListener; // packageimport | |
| 71 import dwtx.jface.text.source.ISourceViewerExtension4; // packageimport | |
| 72 import dwtx.jface.text.source.AnnotationPainter; // packageimport | |
| 73 import dwtx.jface.text.source.IAnnotationHoverExtension2; // packageimport | |
| 74 import dwtx.jface.text.source.OverviewRuler; // packageimport | |
| 75 import dwtx.jface.text.source.OverviewRulerHoverManager; // packageimport | |
| 76 | |
| 77 | |
| 129 | 78 import dwt.dwthelper.utils; |
| 79 | |
| 80 import dwtx.jface.text.BadLocationException; | |
| 81 | |
| 82 | |
| 83 /** | |
| 84 * Protocol that allows direct access to line information. Usually, implementations will also | |
| 85 * implement <code>IAnnotationModel</code>, which only allows <code>Iterator</code> based access | |
| 86 * to annotations. | |
| 87 * <p> | |
| 88 * <code>ILineDiffer</code> also allows to revert any lines to their original | |
| 89 * contents as defined by the quick diff reference used by the receiver. | |
| 90 * </p> | |
| 91 * <p> | |
| 92 * This interface may be implemented by clients. | |
| 93 * </p> | |
| 94 * <p> | |
| 95 * In order to provide backward compatibility for clients of <code>ILineDiffer</code>, extension | |
| 96 * interfaces are used to provide a means of evolution. The following extension interface | |
| 97 * exists: | |
| 98 * <ul> | |
| 99 * <li> {@link ILineDifferExtension} (since version 3.1): introducing the concept | |
| 100 * suspending and resuming an <code>ILineDiffer</code>.</li> | |
| 101 * <li> {@link ILineDifferExtension2} (since version 3.3): allowing to query the suspension state | |
| 102 * of an <code>ILineDiffer</code>.</li> | |
| 103 * </ul> | |
| 104 * </p> | |
| 105 * | |
| 106 * @since 3.0 | |
| 107 */ | |
| 108 public interface ILineDiffer { | |
| 109 | |
| 110 /** | |
| 111 * Determines the line state for line <code>line</code> in the targeted document. | |
| 112 * | |
| 113 * @param line the line to get diff information for | |
| 114 * @return the line information object for <code>line</code> or <code>null</code> if none | |
| 115 */ | |
| 116 ILineDiffInfo getLineInfo(int line); | |
| 117 | |
| 118 /** | |
| 119 * Reverts a single changed line to its original state, not touching any lines that | |
| 120 * are deleted at its borders. | |
| 121 * | |
| 122 * @param line the line number of the line to be restored. | |
| 123 * @throws BadLocationException if <code>line</code> is out of bounds. | |
| 124 */ | |
|
139
93a6ec48fd28
Regexp throws removal in interfaces
Frank Benoit <benoit@tionex.de>
parents:
131
diff
changeset
|
125 void revertLine(int line) ; |
| 129 | 126 |
| 127 /** | |
| 128 * Reverts a block of modified / added lines to their original state, including any deleted | |
| 129 * lines inside the block or at its borders. A block is considered to be a range of modified | |
| 130 * (e.g. changed, or added) lines. | |
| 131 * | |
| 132 * @param line any line in the block to be reverted. | |
| 133 * @throws BadLocationException if <code>line</code> is out of bounds. | |
| 134 */ | |
|
139
93a6ec48fd28
Regexp throws removal in interfaces
Frank Benoit <benoit@tionex.de>
parents:
131
diff
changeset
|
135 void revertBlock(int line) ; |
| 129 | 136 |
| 137 /** | |
| 138 * Reverts a range of lines to their original state, including any deleted | |
| 139 * lines inside the block or at its borders. | |
| 140 * | |
| 141 * @param line any line in the block to be reverted. | |
| 142 * @param nLines the number of lines to be reverted, must be > 0. | |
| 143 * @throws BadLocationException if <code>line</code> is out of bounds. | |
| 144 */ | |
|
139
93a6ec48fd28
Regexp throws removal in interfaces
Frank Benoit <benoit@tionex.de>
parents:
131
diff
changeset
|
145 void revertSelection(int line, int nLines) ; |
| 129 | 146 |
| 147 /** | |
| 148 * Restores the deleted lines after <code>line</code>. | |
| 149 * | |
| 150 * @param line the deleted lines following this line number are restored. | |
| 151 * @return the number of restored lines. | |
| 152 * @throws BadLocationException if <code>line</code> is out of bounds. | |
| 153 */ | |
|
139
93a6ec48fd28
Regexp throws removal in interfaces
Frank Benoit <benoit@tionex.de>
parents:
131
diff
changeset
|
154 int restoreAfterLine(int line) ; |
| 129 | 155 } |