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.BadLocationException;
40:
41: import edu.rice.cs.util.UnexpectedException;
42: import edu.rice.cs.drjava.model.AbstractDJDocument;
43:
44: /** Determines whether or not the current line in the document starts with "//"
45: * @version $Id: QuestionCurrLineIsWingComment.java 4255 2007-08-28 19:17:37Z mgricken $
46: */
47: public class QuestionCurrLineIsWingComment extends IndentRuleQuestion {
48:
49: /** @param yesRule The decision subtree for the case that this rule applies in the current context.
50: * @param noRule The decision subtree for the case that this rule does not apply in the current context.
51: */
52: public QuestionCurrLineIsWingComment(IndentRule yesRule,
53: IndentRule noRule) {
54: super (yesRule, noRule);
55: }
56:
57: /** Determines whether or not the current line in the document starts with the wing comment prefix "//".
58: * Does not test to determine if this line is embedded in a block comment.
59: * @param doc The AbstractDJDocument containing the current line.
60: * @param reason The reason that the indentation is being done
61: * @return true iff the current line is a wing comment.
62: * @pre current line is not embedded in a block comment
63: */
64: boolean applyRule(AbstractDJDocument doc,
65: Indenter.IndentReason reason) {
66: try {
67: // Find the first non-whitespace character on the current line.
68:
69: int currentPos = doc.getCurrentLocation();
70: int startPos = doc.getLineStartPos(currentPos);
71: int maxPos = doc.getLength();
72: int diff = maxPos - startPos;
73:
74: if (diff < 2)
75: return false;
76:
77: String text = doc.getText(startPos, 2);
78:
79: return text.equals("//");
80: } catch (BadLocationException e) {
81: throw new UnexpectedException();
82: }
83: }
84:
85: }
|