KickJava   Java API By Example, From Geeks To Geeks.

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


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 edu.rice.cs.drjava.model.AbstractDJDocument;
37
38 /** Determines if the given search character is found between the start of the current statement and the end character.
39  * Accomplishes this by searching backwards from the end character, for the search character until one of the
40  * following characters is found: '}', '{', ';', DOCSTART.
41  * <b>The given end character must exist on the current line and not be part of a quote or comment.</b> If there is
42  * more than end character on the given line, then the first end character is used.
43  * <p>This question is useful for determining if, when a colon is found on a line, it is part of a ternary operator
44  * or not (construct this question with '?' for search character and ':' for end character).
45  * <p>It can also be used to determine if a statement contains a particular character by constructing it with the
46  * desired character as a search character and the end character as ';'.
47  * <p>Note that characters in comments and quotes are disregarded.
48  *
49  * @version $Id: QuestionExistsCharInStmt.java 3901 2006-06-30 05:28:11Z rcartwright $
50  */
51 public class QuestionExistsCharInStmt extends IndentRuleQuestion {
52   /**
53    * The character to search for
54    */
55   private char _findChar;
56   
57   /**
58    * The character which marks the end of the search
59    * space. i.e. search from the start of the statment
60    * to the end char.
61    */
62   private char _endChar;
63
64   /**
65    * Constructs a rule to determine if findChar exists
66    * between the start of the current statement and endChar.
67    *
68    * @param findChar Character to search for from the start of the
69    * statement to endChar
70    * @param endChar Character that marks the end of the search space. Must
71    * exist on the current line and not be in quotes or comments.
72    * @param yesRule Rule to use if this rule holds
73    * @param noRule Rule to use if this rule does not hold
74    */
75   public QuestionExistsCharInStmt(char findChar, char endChar, IndentRule yesRule, IndentRule noRule) {
76     super(yesRule, noRule);
77     _findChar = findChar;
78     _endChar = endChar;
79   }
80  
81   /** Searches backwards from endChar to the start of the statement looking for findChar. Ignores characters in
82    * comments and quotes. Start of the statement is the point right after when one of the following characters
83    * is found: ';', '{', '}', DOCSTART.
84    *
85    * @param doc AbstractDJDocument containing the line to be indented.
86    * @return true if this node's rule holds.
87    */
88   boolean applyRule(AbstractDJDocument doc, int reason) {
89
90    // Find the position of endChar on the current line
91 int endCharPos = doc.findCharOnLine(doc.getCurrentLocation(), _endChar);
92     return doc.findCharInStmtBeforePos(_findChar, endCharPos);
93   }
94 }
95
Popular Tags