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 edu.rice.cs.drjava.model.AbstractDJDocument;
40: import edu.rice.cs.drjava.model.definitions.reducedmodel.*;
41:
42: /** Given the start of the current line is inside a block comment, asks
43: * whether the comment begins on the "previous line," ignoring white space.
44: *
45: * @version $Id: QuestionPrevLineStartsComment.java 4255 2007-08-28 19:17:37Z mgricken $
46: */
47: class QuestionPrevLineStartsComment extends IndentRuleQuestion {
48:
49: QuestionPrevLineStartsComment(IndentRule yesRule, IndentRule noRule) {
50: super (yesRule, noRule);
51: }
52:
53: /** Determines if the previous line in the document starts a block comment.
54: * We know that the current line is in a block comment. Therefore, if the
55: * start of the previous line is not inside of a block comment, then the
56: * previous line must have started the comment.
57: * <p>
58: * There is an exception to this; however, it is handled adequately. Consider
59: * the case when the previous line contains the following code:
60: * <code>*/ bar(); /*</code>
61: * <p>
62: * Our approach will say that since the beginning of the previous line is
63: * inside of a comment, the previous line did not start the comment. This
64: * is acceptable because we think of the previous line as a continuation
65: * of a larger commented out region.
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:
72: int cursor;
73:
74: // Move back to start of current line
75: cursor = doc.getLineStartPos(doc.getCurrentLocation());
76:
77: /* If the start of the current line is the start of the document, there was no previous line and so this line must
78: * have started the comment. */
79: if (cursor == AbstractDJDocument.DOCSTART)
80: return false;
81:
82: // Move the cursor to the previous line
83: cursor = cursor - 1;
84:
85: // Move it to the start of the previous line
86: cursor = doc.getLineStartPos(cursor);
87:
88: // Return if the start of the previous line is in a comment.
89: // BraceReduction reduced = doc.getReduced();
90: doc.resetReducedModelLocation();
91: ReducedModelState state = doc.stateAtRelLocation(cursor
92: - doc.getCurrentLocation());
93: return !state.equals(ReducedModelStates.INSIDE_BLOCK_COMMENT);
94: }
95: }
|