KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > edu > rice > cs > drjava > model > definitions > indent > QuestionPrevLineStartsJavaDocWithText


1 /*BEGIN_COPYRIGHT_BLOCK
2  *
3  * This file is part of DrJava. Download the current version of this project from http://www.drjava.org/
4  * or http://sourceforge.net/projects/drjava/
5  *
6  * DrJava Open Source License
7  *
8  * Copyright (C) 2001-2006 JavaPLT group at Rice University (javaplt@rice.edu). All rights reserved.
9  *
10  * Developed by: Java Programming Languages Team, Rice University, http://www.cs.rice.edu/~javaplt/
11  *
12  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
13  * documentation files (the "Software"), to deal with the Software without restriction, including without limitation
14  * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
15  * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
16  *
17  * - Redistributions of source code must retain the above copyright notice, this list of conditions and the
18  * following disclaimers.
19  * - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
20  * following disclaimers in the documentation and/or other materials provided with the distribution.
21  * - Neither the names of DrJava, the JavaPLT, Rice University, nor the names of its contributors may be used to
22  * endorse or promote products derived from this Software without specific prior written permission.
23  * - Products derived from this software may not be called "DrJava" nor use the term "DrJava" as part of their
24  * names without prior written permission from the JavaPLT group. For permission, write to javaplt@rice.edu.
25  *
26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
27  * THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
28  * CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
29  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
30  * WITH THE SOFTWARE.
31  *
32  *END_COPYRIGHT_BLOCK*/
33
34 package edu.rice.cs.drjava.model.definitions.indent;
35
36 import javax.swing.text.*;
37 import edu.rice.cs.util.UnexpectedException;
38
39 import edu.rice.cs.drjava.model.AbstractDJDocument;
40 import static edu.rice.cs.drjava.model.AbstractDJDocument.ERROR_INDEX;
41
42 /** Question rule in the indentation decision tree. Determines if the
43   * line previous to the current position starts with the specified character.
44   * @version $Id: QuestionPrevLineStartsWith.java 3490 2006-01-07 19:22:33Z dlsmith $
45   */
46 public class QuestionPrevLineStartsJavaDocWithText extends IndentRuleQuestion {
47   
48   /** Constructs a rule that looks for "/**" as first non-whitespace followed by some additional non-whitespace text
49     * @param yesRule Rule to use if this rule holds
50     * @param noRule Rule to use if this rule does not hold
51     */
52   public QuestionPrevLineStartsJavaDocWithText(IndentRule yesRule, IndentRule noRule) { super(yesRule, noRule); }
53   
54   /** Determines if the previous line starts with "/**", ignoring whitespace, followed by more non-whitespace text
55     * @param doc AbstractDJDocument containing the line to be indented.
56     * @return true if this node's rule holds.
57     */
58   boolean applyRule(AbstractDJDocument doc, int reason) {
59
60     try {
61       // Find start of line
62 int here = doc.getCurrentLocation();
63       int startLine = doc.getLineStartPos(here);
64       
65       if (startLine <= AbstractDJDocument.DOCSTART) return false; // on first line
66
67       // Find start of previous line
68 int endPrevLine = startLine - 1;
69       int startPrevLine = doc.getLineStartPos(endPrevLine);
70       int firstChar = doc.getLineFirstCharPos(startPrevLine);
71       
72       // Compare prefix
73 String JavaDoc actualPrefix = doc.getText(firstChar, 3);
74       if (! actualPrefix.equals("/**")) return false;
75       int nextNonWSChar = doc.getFirstNonWSCharPos(firstChar + 3, true);
76       return nextNonWSChar != ERROR_INDEX && nextNonWSChar <= endPrevLine;
77     }
78     catch (BadLocationException e) {
79       // Shouldn't happen
80 throw new UnexpectedException(e);
81     }
82   }
83 }
84
Popular Tags