Mercurial > projects > dwt2

comparison org.eclipse.jface.text/src/org/eclipse/jface/text/rules/IPredicateRule.d @ 12:bc29606a740c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added dwt-addons in original directory structure of eclipse.org
author Frank Benoit <benoit@tionex.de>
date Sat, 14 Mar 2009 18:23:29 +0100
parents
children
comparison
equal deleted inserted replaced
11:43904fec5dca 12:bc29606a740c
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
14
15 module org.eclipse.jface.text.rules.IPredicateRule;
16
17 import org.eclipse.jface.text.rules.FastPartitioner; // packageimport
18 import org.eclipse.jface.text.rules.ITokenScanner; // packageimport
19 import org.eclipse.jface.text.rules.Token; // packageimport
20 import org.eclipse.jface.text.rules.RuleBasedScanner; // packageimport
21 import org.eclipse.jface.text.rules.EndOfLineRule; // packageimport
22 import org.eclipse.jface.text.rules.WordRule; // packageimport
23 import org.eclipse.jface.text.rules.WhitespaceRule; // packageimport
24 import org.eclipse.jface.text.rules.WordPatternRule; // packageimport
25 import org.eclipse.jface.text.rules.DefaultPartitioner; // packageimport
26 import org.eclipse.jface.text.rules.NumberRule; // packageimport
27 import org.eclipse.jface.text.rules.SingleLineRule; // packageimport
28 import org.eclipse.jface.text.rules.PatternRule; // packageimport
29 import org.eclipse.jface.text.rules.RuleBasedDamagerRepairer; // packageimport
30 import org.eclipse.jface.text.rules.ICharacterScanner; // packageimport
31 import org.eclipse.jface.text.rules.IRule; // packageimport
32 import org.eclipse.jface.text.rules.DefaultDamagerRepairer; // packageimport
33 import org.eclipse.jface.text.rules.IToken; // packageimport
34 import org.eclipse.jface.text.rules.IPartitionTokenScanner; // packageimport
35 import org.eclipse.jface.text.rules.MultiLineRule; // packageimport
36 import org.eclipse.jface.text.rules.RuleBasedPartitioner; // packageimport
37 import org.eclipse.jface.text.rules.RuleBasedPartitionScanner; // packageimport
38 import org.eclipse.jface.text.rules.BufferedRuleBasedScanner; // packageimport
39 import org.eclipse.jface.text.rules.IWhitespaceDetector; // packageimport
40
41 import java.lang.all;
42 import java.util.Set;
43
44 /**
45 * Defines the interface for a rule used in the scanning of text for the purpose of
46 * document partitioning or text styling. A predicate rule can only return one single
47 * token after having successfully detected content. This token is called success token.
48 * Also, it also returns a token indicating that this rule has not been successful.
49 *
50 * @see ICharacterScanner
51 * @since 2.0
52 */
53 public interface IPredicateRule : IRule {
54
55 /**
56 * Returns the success token of this predicate rule.
57 *
58 * @return the success token of this rule
59 */
60 IToken getSuccessToken();
61
62 /**
63 * Evaluates the rule by examining the characters available from
64 * the provided character scanner. The token returned by this rule
65 * returns <code>true</code> when calling <code>isUndefined</code>,
66 * if the text that the rule investigated does not match the rule's requirements. Otherwise,
67 * this method returns this rule's success token. If this rules relies on a text pattern
68 * comprising a opening and a closing character sequence this method can also be called
69 * when the scanner is positioned already between the opening and the closing sequence.
70 * In this case, <code>resume</code> must be set to <code>true</code>.
71 *
72 * @param scanner the character scanner to be used by this rule
73 * @param resume indicates that the rule starts working between the opening and the closing character sequence
74 * @return the token computed by the rule
75 */
76 IToken evaluate(ICharacterScanner scanner, bool resume);
77 }