01: /*BEGIN_COPYRIGHT_BLOCK
02: *
03: * Copyright (c) 2001-2007, JavaPLT group at Rice University (javaplt@rice.edu)
04: * All rights reserved.
05: *
06: * Redistribution and use in source and binary forms, with or without
07: * modification, are permitted provided that the following conditions are met:
08: * * Redistributions of source code must retain the above copyright
09: * notice, this list of conditions and the following disclaimer.
10: * * Redistributions in binary form must reproduce the above copyright
11: * notice, this list of conditions and the following disclaimer in the
12: * documentation and/or other materials provided with the distribution.
13: * * Neither the names of DrJava, the JavaPLT group, Rice University, nor the
14: * names of its contributors may be used to endorse or promote products
15: * derived from this software without specific prior written permission.
16: *
17: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
21: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24: * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28: *
29: * This software is Open Source Initiative approved Open Source Software.
30: * Open Source Initative Approved is a trademark of the Open Source Initiative.
31: *
32: * This file is part of DrJava. Download the current version of this project
33: * from http://www.drjava.org/ or http://sourceforge.net/projects/drjava/
34: *
35: * END_COPYRIGHT_BLOCK*/
36:
37: package edu.rice.cs.drjava.model.definitions.indent;
38:
39: import javax.swing.text.*;
40: import edu.rice.cs.util.UnexpectedException;
41:
42: import edu.rice.cs.drjava.model.AbstractDJDocument;
43:
44: /** Question rule in the indentation decision tree. Determines if the
45: * next non-whitespace character is a star '*'. This is useful for determining
46: * if we are at the beginning of a previously ill-formed block comment.
47: * <p>
48: * <b>Does not work if character being searched for is a '/' or a '*'</b>
49: *
50: * @version $Id: QuestionFollowedByStar.java 4255 2007-08-28 19:17:37Z mgricken $
51: */
52: public class QuestionFollowedByStar extends IndentRuleQuestion {
53:
54: /** Constructs a new rule which determines if the current position is
55: * immediately followed by a star '*'.
56: * @param yesRule Rule to use if this rule holds
57: * @param noRule Rule to use if this rule does not hold
58: */
59: public QuestionFollowedByStar(IndentRule yesRule, IndentRule noRule) {
60: super (yesRule, noRule);
61: }
62:
63: /** Determines if the next non WS character is '*'. Does not search in quotes or comments.
64: * <p>
65: * <b>Does not work if character being searched for is a '/' or a '*'</b>
66: * @param doc AbstractDJDocument containing the line to be indented.
67: * @return true if this node's rule holds.
68: */
69: boolean applyRule(AbstractDJDocument doc,
70: Indenter.IndentReason reason) {
71: try {
72: int charPos = doc.getFirstNonWSCharPos(doc
73: .getCurrentLocation(), true);
74:
75: return !(charPos == AbstractDJDocument.ERROR_INDEX)
76: && doc.getText(charPos, 1).equals("*");
77: } catch (BadLocationException ble) {
78: throw new UnexpectedException(ble);
79: }
80: }
81: }
|