diff options
Diffstat (limited to 'org.eclipse.jface.text/src/org/eclipse/jface/text/rules/IPartitionTokenScanner.java')
| -rw-r--r-- | org.eclipse.jface.text/src/org/eclipse/jface/text/rules/IPartitionTokenScanner.java | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/rules/IPartitionTokenScanner.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/rules/IPartitionTokenScanner.java new file mode 100644 index 00000000000..90ae6c7597e --- /dev/null +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/rules/IPartitionTokenScanner.java @@ -0,0 +1,42 @@ +/********************************************************************** +Copyright (c) 2000, 2002 IBM Corp. 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 implementation +**********************************************************************/ + +package org.eclipse.jface.text.rules; + + +import org.eclipse.jface.text.IDocument; + + +/** + * A partition token scanner returns tokens that represent partitions. For that reason, + * a partition token scanner is vulnerable in respect to the document offset it starts + * scanning. In a simple case, a partition token scanner must always start at a partition + * boundary. A partition token scanner can also start in the middle of a partition, + * if it knows the type of the partition. + * + * @since 2.0 + */ +public interface IPartitionTokenScanner extends ITokenScanner { + + /** + * Configures the scanner by providing access to the document range that should be scanned. + * The range may no only contain complete partitions but starts at the beginning of a line in the + * middle of a partition of the given content type. This requires that a partition delimiter can not + * contain a line delimiter. + * + * @param document the document to scan + * @param offset the offset of the document range to scan + * @param length the length of the document range to scan + * @param contentType the content type at the given offset + * @param partitionOffset the offset at which the partition of the given offset starts + */ + void setPartialRange(IDocument document, int offset, int length, String contentType, int partitionOffset); +} |