Mercurial > projects > dwt2
annotate org.eclipse.text/src/org/eclipse/jface/text/ITextStore.d @ 15:c4b1a29263fc
Successful build of org.eclipse.text
author | Frank Benoit <benoit@tionex.de> |
---|---|
date | Sun, 15 Mar 2009 19:51:07 +0100 |
parents | 5feec68b4556 |
children |
rev | line source |
---|---|
12
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
1 /******************************************************************************* |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
2 * Copyright (c) 2000, 2006 IBM Corporation and others. |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
3 * All rights reserved. This program and the accompanying materials |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
4 * are made available under the terms of the Eclipse Public License v1.0 |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
5 * which accompanies this distribution, and is available at |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
6 * http://www.eclipse.org/legal/epl-v10.html |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
7 * |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
8 * Contributors: |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
9 * IBM Corporation - initial API and implementation |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
10 * Port to the D programming language: |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
11 * Frank Benoit <benoit@tionex.de> |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
12 *******************************************************************************/ |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
13 module org.eclipse.jface.text.ITextStore; |
14
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
14 import org.eclipse.jface.text.IRepairableDocument; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
15 import org.eclipse.jface.text.AbstractDocument; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
16 import org.eclipse.jface.text.IDocumentPartitionerExtension3; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
17 import org.eclipse.jface.text.ConfigurableLineTracker; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
18 import org.eclipse.jface.text.IRegion; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
19 import org.eclipse.jface.text.TypedRegion; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
20 import org.eclipse.jface.text.IDocumentExtension2; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
21 import org.eclipse.jface.text.TypedPosition; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
22 import org.eclipse.jface.text.RewriteSessionEditProcessor; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
23 import org.eclipse.jface.text.SlaveDocumentEvent; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
24 import org.eclipse.jface.text.IDocumentExtension3; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
25 import org.eclipse.jface.text.IDocumentListener; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
26 import org.eclipse.jface.text.ISynchronizable; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
27 import org.eclipse.jface.text.DocumentEvent; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
28 import org.eclipse.jface.text.Position; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
29 import org.eclipse.jface.text.IRepairableDocumentExtension; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
30 import org.eclipse.jface.text.DocumentRewriteSessionType; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
31 import org.eclipse.jface.text.Region; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
32 import org.eclipse.jface.text.IDocumentExtension4; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
33 import org.eclipse.jface.text.BadLocationException; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
34 import org.eclipse.jface.text.TextMessages; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
35 import org.eclipse.jface.text.IDocumentPartitioningListenerExtension2; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
36 import org.eclipse.jface.text.IDocumentInformationMappingExtension; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
37 import org.eclipse.jface.text.IDocumentPartitioningListenerExtension; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
38 import org.eclipse.jface.text.IDocumentPartitionerExtension; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
39 import org.eclipse.jface.text.DocumentRewriteSession; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
40 import org.eclipse.jface.text.IPositionUpdater; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
41 import org.eclipse.jface.text.ISlaveDocumentManagerExtension; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
42 import org.eclipse.jface.text.ILineTracker; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
43 import org.eclipse.jface.text.ListLineTracker; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
44 import org.eclipse.jface.text.IDocumentInformationMapping; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
45 import org.eclipse.jface.text.IDocumentRewriteSessionListener; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
46 import org.eclipse.jface.text.AbstractLineTracker; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
47 import org.eclipse.jface.text.DefaultLineTracker; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
48 import org.eclipse.jface.text.BadPositionCategoryException; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
49 import org.eclipse.jface.text.BadPartitioningException; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
50 import org.eclipse.jface.text.SequentialRewriteTextStore; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
51 import org.eclipse.jface.text.IDocumentInformationMappingExtension2; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
52 import org.eclipse.jface.text.DocumentPartitioningChangedEvent; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
53 import org.eclipse.jface.text.FindReplaceDocumentAdapter; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
54 import org.eclipse.jface.text.TextUtilities; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
55 import org.eclipse.jface.text.ISlaveDocumentManager; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
56 import org.eclipse.jface.text.IDocument; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
57 import org.eclipse.jface.text.ILineTrackerExtension; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
58 import org.eclipse.jface.text.IDocumentPartitioner; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
59 import org.eclipse.jface.text.GapTextStore; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
60 import org.eclipse.jface.text.Document; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
61 import org.eclipse.jface.text.IDocumentExtension; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
62 import org.eclipse.jface.text.IDocumentPartitioningListener; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
63 import org.eclipse.jface.text.CopyOnWriteTextStore; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
64 import org.eclipse.jface.text.DefaultPositionUpdater; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
65 import org.eclipse.jface.text.Line; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
66 import org.eclipse.jface.text.DocumentRewriteSessionEvent; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
67 import org.eclipse.jface.text.IDocumentPartitionerExtension2; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
68 import org.eclipse.jface.text.ITypedRegion; |
5feec68b4556
First run of automatic package imports
Frank Benoit <benoit@tionex.de>
parents:
12
diff
changeset
|
69 import org.eclipse.jface.text.TreeLineTracker; |
12
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
70 |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
71 |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
72 |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
73 import java.lang.all; |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
74 import java.util.Set; |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
75 |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
76 |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
77 /** |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
78 * Interface for storing and managing text. |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
79 * <p> |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
80 * Provides access to the stored text and allows to manipulate it.</p> |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
81 * <p> |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
82 * Clients may |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
83 * implement this interface or use {@link org.eclipse.jface.text.GapTextStore} or |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
84 * {@link org.eclipse.jface.text.CopyOnWriteTextStore}.</p> |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
85 */ |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
86 public interface ITextStore { |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
87 |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
88 /** |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
89 * Returns the character at the specified offset. |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
90 * |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
91 * @param offset the offset in this text store |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
92 * @return the character at this offset |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
93 */ |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
94 char get(int offset); |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
95 |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
96 /** |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
97 * Returns the text of the specified character range. |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
98 * |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
99 * @param offset the offset of the range |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
100 * @param length the length of the range |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
101 * @return the text of the range |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
102 */ |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
103 String get(int offset, int length); |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
104 |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
105 /** |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
106 * Returns number of characters stored in this text store. |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
107 * |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
108 * @return the number of characters stored in this text store |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
109 */ |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
110 int getLength(); |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
111 |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
112 /** |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
113 * Replaces the specified character range with the given text. |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
114 * <code>replace(getLength(), 0, "some text")</code> is a valid |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
115 * call and appends text to the end of the text store. |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
116 * |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
117 * @param offset the offset of the range to be replaced |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
118 * @param length the number of characters to be replaced |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
119 * @param text the substitution text |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
120 */ |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
121 void replace(int offset, int length, String text); |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
122 |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
123 /** |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
124 * Replace the content of the text store with the given text. |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
125 * Convenience method for <code>replace(0, getLength(), text</code>. |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
126 * |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
127 * @param text the new content of the text store |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
128 */ |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
129 void set(String text); |
bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
Frank Benoit <benoit@tionex.de>
parents:
diff
changeset
|
130 } |