|
|||||||||||||||||||
| Source file | Conditionals | Statements | Methods | TOTAL | |||||||||||||||
| IndentRuleQuestion.java | 75% | 88.2% | 83.3% | 85.2% |
|
||||||||||||||
| 1 | /*BEGIN_COPYRIGHT_BLOCK | |
| 2 | * | |
| 3 | * Copyright (c) 2001-2010, JavaPLT group at Rice University (drjava@rice.edu) | |
| 4 | * All rights reserved. | |
| 5 | * | |
| 6 | * Redistribution and use in source and binary forms, with or without | |
| 7 | * modification, are permitted provided that the following conditions are met: | |
| 8 | * * Redistributions of source code must retain the above copyright | |
| 9 | * 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 | ||
| 41 | /** A question node in the decision tree for the indentation system. Calls to <code>indentLine</code> on an | |
| 42 | * IndentRuleQuestion will make a decision based on context and call the same method on one of its children. | |
| 43 | * The leaves of the tree are represented by IndentRuleAction objects. | |
| 44 | * @version $Id: IndentRuleQuestion.java 5175 2010-01-20 08:46:32Z mgricken $ | |
| 45 | */ | |
| 46 | public abstract class IndentRuleQuestion extends IndentRuleWithTrace { | |
| 47 | /** Node in decision tree to use if the rule holds in this context. */ | |
| 48 | private final IndentRule _yesRule; | |
| 49 | ||
| 50 | /** Node in decision tree to use if the rule does not hold in this context. */ | |
| 51 | private final IndentRule _noRule; | |
| 52 | ||
| 53 | /** Constructs a new Question indent rule using the two given children. | |
| 54 | * @param yesRule Rule to use if this rule holds | |
| 55 | * @param noRule Rule to use if this rule does not hold | |
| 56 | */ | |
| 57 | 39843 | public IndentRuleQuestion(final IndentRule yesRule, final IndentRule noRule) { |
| 58 | 39838 | _yesRule = yesRule; |
| 59 | 39838 | _noRule = noRule; |
| 60 | } | |
| 61 | ||
| 62 | /** Determines if the given rule holds in this context. | |
| 63 | * @param doc AbstractDJDocument containing the line to be indented. | |
| 64 | * @param reason The reason that indentation was initiated, specified in Indenter | |
| 65 | * @return true if this node's rule holds. | |
| 66 | */ | |
| 67 | abstract boolean applyRule(AbstractDJDocument doc, Indenter.IndentReason reason); | |
| 68 | ||
| 69 | /** Determines if the given rule holds in this context. | |
| 70 | * @param doc The AbstractDJDocument containing the line to be indented. | |
| 71 | * @param pos The Position within line to be indented. | |
| 72 | * @param reason The reason that indentation was initiated, specified in Indenter | |
| 73 | * @return true if this node's rule holds. | |
| 74 | */ | |
| 75 | 660 | boolean applyRule(AbstractDJDocument doc, int pos, Indenter.IndentReason reason) { |
| 76 | 660 | int oldPos = doc.getCurrentLocation(); |
| 77 | 660 | doc.setCurrentLocation(pos); |
| 78 | 660 | boolean result = applyRule(doc, reason); |
| 79 | 0 | if (oldPos > doc.getLength()) oldPos = doc.getLength(); |
| 80 | 660 | doc.setCurrentLocation(oldPos); |
| 81 | 660 | return result; |
| 82 | } | |
| 83 | ||
| 84 | /** Determines if the given rule holds in this context and calls the same method on one of its child nodes. | |
| 85 | * @param doc AbstractDJDocument containing the line to be indented. | |
| 86 | * @param reason The reason that indentation was initiated, specified in Indenter | |
| 87 | * @return true if the caller should update the current location itself, false if the indenter has already handled this | |
| 88 | */ | |
| 89 | 1684 | public boolean indentLine(AbstractDJDocument doc, Indenter.IndentReason reason) { |
| 90 | 1684 | if (applyRule(doc, reason)) { |
| 91 | 396 | _addToIndentTrace(getRuleName(), YES, false); |
| 92 | 396 | return _yesRule.indentLine(doc, reason); |
| 93 | } | |
| 94 | else { | |
| 95 | 1288 | _addToIndentTrace(getRuleName(), NO, false); |
| 96 | 1288 | return _noRule.indentLine(doc, reason); |
| 97 | } | |
| 98 | } | |
| 99 | ||
| 100 | /** Convenience method that wraps calls on applyRule in a read lock. Only used in testing. */ | |
| 101 | 37 | boolean testApplyRule(AbstractDJDocument doc, Indenter.IndentReason reason) { return applyRule(doc, reason); } |
| 102 | ||
| 103 | /** Convenience method that wraps calls on applyRule in a read lock. Only used in testing. */ | |
| 104 | 660 | boolean testApplyRule(AbstractDJDocument doc, int pos, Indenter.IndentReason reason) { |
| 105 | 660 | return applyRule(doc, pos, reason); |
| 106 | } | |
| 107 | ||
| 108 | /** Convenience method that wraps calls on indentLine in a write lock. Only used in testing. */ | |
| 109 | 0 | public boolean testIndentLine(AbstractDJDocument doc, Indenter.IndentReason reason) { |
| 110 | 0 | return indentLine(doc, reason); |
| 111 | } | |
| 112 | } | |
| 113 | ||
| 114 | ||
| 115 | ||
| 116 | ||
| 117 |
|
||||||||||