|
129
|
1 /*******************************************************************************
|
|
|
2 * Copyright (c) 2000, 2005 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.ICharacterPairMatcher;
|
|
|
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.TextInvocationContext; // packageimport
|
|
|
20 import dwtx.jface.text.source.LineChangeHover; // packageimport
|
|
|
21 import dwtx.jface.text.source.IChangeRulerColumn; // packageimport
|
|
|
22 import dwtx.jface.text.source.IAnnotationMap; // packageimport
|
|
|
23 import dwtx.jface.text.source.IAnnotationModelListenerExtension; // packageimport
|
|
|
24 import dwtx.jface.text.source.ISourceViewerExtension2; // packageimport
|
|
|
25 import dwtx.jface.text.source.IAnnotationHover; // packageimport
|
|
|
26 import dwtx.jface.text.source.ContentAssistantFacade; // packageimport
|
|
|
27 import dwtx.jface.text.source.IAnnotationAccess; // packageimport
|
|
|
28 import dwtx.jface.text.source.IVerticalRulerExtension; // packageimport
|
|
|
29 import dwtx.jface.text.source.IVerticalRulerColumn; // packageimport
|
|
|
30 import dwtx.jface.text.source.LineNumberRulerColumn; // packageimport
|
|
|
31 import dwtx.jface.text.source.MatchingCharacterPainter; // packageimport
|
|
|
32 import dwtx.jface.text.source.IAnnotationModelExtension; // packageimport
|
|
|
33 import dwtx.jface.text.source.ILineDifferExtension; // packageimport
|
|
|
34 import dwtx.jface.text.source.DefaultCharacterPairMatcher; // packageimport
|
|
|
35 import dwtx.jface.text.source.LineNumberChangeRulerColumn; // packageimport
|
|
|
36 import dwtx.jface.text.source.IAnnotationAccessExtension; // packageimport
|
|
|
37 import dwtx.jface.text.source.ISourceViewer; // packageimport
|
|
|
38 import dwtx.jface.text.source.AnnotationModel; // packageimport
|
|
|
39 import dwtx.jface.text.source.ILineDifferExtension2; // packageimport
|
|
|
40 import dwtx.jface.text.source.IAnnotationModelListener; // packageimport
|
|
|
41 import dwtx.jface.text.source.IVerticalRuler; // packageimport
|
|
|
42 import dwtx.jface.text.source.DefaultAnnotationHover; // packageimport
|
|
|
43 import dwtx.jface.text.source.SourceViewer; // packageimport
|
|
|
44 import dwtx.jface.text.source.SourceViewerConfiguration; // packageimport
|
|
|
45 import dwtx.jface.text.source.AnnotationBarHoverManager; // packageimport
|
|
|
46 import dwtx.jface.text.source.CompositeRuler; // packageimport
|
|
|
47 import dwtx.jface.text.source.ImageUtilities; // packageimport
|
|
|
48 import dwtx.jface.text.source.VisualAnnotationModel; // packageimport
|
|
|
49 import dwtx.jface.text.source.IAnnotationModel; // packageimport
|
|
|
50 import dwtx.jface.text.source.ISourceViewerExtension3; // packageimport
|
|
|
51 import dwtx.jface.text.source.ILineDiffInfo; // packageimport
|
|
|
52 import dwtx.jface.text.source.VerticalRulerEvent; // packageimport
|
|
|
53 import dwtx.jface.text.source.ChangeRulerColumn; // packageimport
|
|
|
54 import dwtx.jface.text.source.ILineDiffer; // 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.IDocument;
|
|
|
81 import dwtx.jface.text.IRegion;
|
|
|
82
|
|
|
83 /**
|
|
|
84 * A character pair matcher finds to a character at a certain document offset
|
|
|
85 * the matching peer character. It is the matchers responsibility to define the
|
|
|
86 * concepts of "matching" and "peer". The matching process starts at a given
|
|
|
87 * offset. Starting of this offset, the matcher chooses a character close to
|
|
|
88 * this offset. The anchor defines whether the chosen character is left or right
|
|
|
89 * of the initial offset. The matcher then searches for the matching peer
|
|
|
90 * character of the chosen character and if it finds one, delivers the minimal
|
|
|
91 * region of the document that contains both characters.
|
|
|
92 *
|
|
|
93 * @since 2.1
|
|
|
94 */
|
|
|
95 public interface ICharacterPairMatcher {
|
|
|
96
|
|
|
97 /**
|
|
|
98 * Indicates the anchor value "right".
|
|
|
99 */
|
|
|
100 int RIGHT= 0;
|
|
|
101 /**
|
|
|
102 * Indicates the anchor value "left".
|
|
|
103 */
|
|
|
104 int LEFT= 1;
|
|
|
105
|
|
|
106
|
|
|
107 /**
|
|
|
108 * Disposes this pair matcher.
|
|
|
109 */
|
|
|
110 void dispose();
|
|
|
111
|
|
|
112 /**
|
|
|
113 * Clears this pair matcher. I.e. the matcher throws away all state it might
|
|
|
114 * remember and prepares itself for a new call of the <code>match</code>
|
|
|
115 * method.
|
|
|
116 */
|
|
|
117 void clear();
|
|
|
118
|
|
|
119 /**
|
|
|
120 * Starting at the given offset, the matcher chooses a character close to this offset.
|
|
|
121 * The matcher then searches for the matching peer character of the chosen character
|
|
|
122 * and if it finds one, returns the minimal region of the document that contains both characters.
|
|
|
123 * It returns <code>null</code> if there is no peer character.
|
|
|
124 *
|
|
|
125 * @param iDocument the document to work on
|
|
|
126 * @param i the start offset
|
|
|
127 * @return the minimal region containing the peer characters
|
|
|
128 */
|
|
|
129 IRegion match(IDocument iDocument, int i);
|
|
|
130
|
|
|
131 /**
|
|
|
132 * Returns the anchor for the region of the matching peer characters. The anchor
|
|
|
133 * says whether the character that has been chosen to search for its peer character
|
|
|
134 * has been left or right of the initial offset.
|
|
|
135 *
|
|
|
136 * @return <code>RIGHT</code> or <code>LEFT</code>
|
|
|
137 */
|
|
|
138 int getAnchor();
|
|
|
139 }
|
