-
Notifications
You must be signed in to change notification settings - Fork 93
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Use of Tree line tracker in incremental mode
Fix #426 Signed-off-by: azerr <[email protected]>
- Loading branch information
1 parent
ca21f48
commit 4ecfce9
Showing
5 changed files
with
1,786 additions
and
51 deletions.
There are no files selected for viewing
150 changes: 150 additions & 0 deletions
150
org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/commons/ILineTracker.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,150 @@ | ||
/******************************************************************************* | ||
* Copyright (c) 2000, 2009 IBM Corporation and others. | ||
* | ||
* This program and the accompanying materials | ||
* are made available under the terms of the Eclipse Public License 2.0 | ||
* which accompanies this distribution, and is available at | ||
* https://www.eclipse.org/legal/epl-2.0/ | ||
* | ||
* SPDX-License-Identifier: EPL-2.0 | ||
* | ||
* Contributors: | ||
* IBM Corporation - initial API and implementation | ||
*******************************************************************************/ | ||
package org.eclipse.lsp4xml.commons; | ||
//package org.eclipse.jface.text; | ||
|
||
import org.eclipse.lsp4j.Position; | ||
|
||
/** | ||
* A line tracker maps character positions to line numbers and vice versa. | ||
* Initially the line tracker is informed about its underlying text in order to | ||
* initialize the mapping information. After that, the line tracker is informed | ||
* about all changes of the underlying text allowing for incremental updates of | ||
* the mapping information. It is the client's responsibility to actively inform | ||
* the line tacker about text changes. For example, when using a line tracker in | ||
* combination with a document the document controls the line tracker. | ||
* <p> | ||
* In order to provide backward compatibility for clients of <code>ILineTracker</code>, extension | ||
* interfaces are used to provide a means of evolution. The following extension interfaces | ||
* exist: | ||
* <ul> | ||
* <li> {@link org.eclipse.jface.text.ILineTrackerExtension} since version 3.1 introducing the concept | ||
* of rewrite sessions.</li> | ||
* </ul> | ||
* <p> | ||
* Clients may implement this interface or use the standard implementation | ||
* </p> | ||
* {@link org.eclipse.jface.text.DefaultLineTracker}or | ||
* {@link org.eclipse.jface.text.ConfigurableLineTracker}. | ||
*/ | ||
public interface ILineTracker { | ||
|
||
/** | ||
* Returns the line delimiter of the specified line. Returns <code>null</code> if the | ||
* line is not closed with a line delimiter. | ||
* | ||
* @param line the line whose line delimiter is queried | ||
* @return the line's delimiter or <code>null</code> if line does not have a delimiter | ||
* @exception BadLocationException if the line number is invalid in this tracker's line structure | ||
*/ | ||
String getLineDelimiter(int line) throws BadLocationException; | ||
|
||
/** | ||
* Computes the number of lines in the given text. | ||
* | ||
* @param text the text whose number of lines should be computed | ||
* @return the number of lines in the given text | ||
*/ | ||
int computeNumberOfLines(String text); | ||
|
||
/** | ||
* Returns the number of lines. | ||
* <p> | ||
* Note that a document always has at least one line. | ||
* </p> | ||
* | ||
* @return the number of lines in this tracker's line structure | ||
*/ | ||
int getNumberOfLines(); | ||
|
||
/** | ||
* Returns the number of lines which are occupied by a given text range. | ||
* | ||
* @param offset the offset of the specified text range | ||
* @param length the length of the specified text range | ||
* @return the number of lines occupied by the specified range | ||
* @exception BadLocationException if specified range is unknown to this tracker | ||
*/ | ||
int getNumberOfLines(int offset, int length) throws BadLocationException; | ||
|
||
/** | ||
* Returns the position of the first character of the specified line. | ||
* | ||
* @param line the line of interest | ||
* @return offset of the first character of the line | ||
* @exception BadLocationException if the line is unknown to this tracker | ||
*/ | ||
int getLineOffset(int line) throws BadLocationException; | ||
|
||
/** | ||
* Returns length of the specified line including the line's delimiter. | ||
* | ||
* @param line the line of interest | ||
* @return the length of the line | ||
* @exception BadLocationException if line is unknown to this tracker | ||
*/ | ||
int getLineLength(int line) throws BadLocationException; | ||
|
||
/** | ||
* Returns the line number the character at the given offset belongs to. | ||
* | ||
* @param offset the offset whose line number to be determined | ||
* @return the number of the line the offset is on | ||
* @exception BadLocationException if the offset is invalid in this tracker | ||
*/ | ||
int getLineNumberOfOffset(int offset) throws BadLocationException; | ||
|
||
/** | ||
* Returns a line description of the line at the given offset. | ||
* The description contains the start offset and the length of the line | ||
* excluding the line's delimiter. | ||
* | ||
* @param offset the offset whose line should be described | ||
* @return a region describing the line | ||
* @exception BadLocationException if offset is invalid in this tracker | ||
*/ | ||
Line getLineInformationOfOffset(int offset) throws BadLocationException; | ||
|
||
/** | ||
* Returns a line description of the given line. The description | ||
* contains the start offset and the length of the line excluding the line's | ||
* delimiter. | ||
* | ||
* @param line the line that should be described | ||
* @return a region describing the line | ||
* @exception BadLocationException if line is unknown to this tracker | ||
*/ | ||
Line getLineInformation(int line) throws BadLocationException; | ||
|
||
/** | ||
* Informs the line tracker about the specified change in the tracked text. | ||
* | ||
* @param offset the offset of the replaced text | ||
* @param length the length of the replaced text | ||
* @param text the substitution text | ||
* @exception BadLocationException if specified range is unknown to this tracker | ||
*/ | ||
void replace(int offset, int length, String text) throws BadLocationException; | ||
|
||
/** | ||
* Sets the tracked text to the specified text. | ||
* | ||
* @param text the new tracked text | ||
*/ | ||
void set(String text); | ||
|
||
Position getPositionAt(int position) throws BadLocationException; | ||
|
||
int getOffsetAt(Position position) throws BadLocationException; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.