001: /*BEGIN_COPYRIGHT_BLOCK
002: *
003: * Copyright (c) 2001-2007, JavaPLT group at Rice University (javaplt@rice.edu)
004: * All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions are met:
008: * * Redistributions of source code must retain the above copyright
009: * notice, this list of conditions and the following disclaimer.
010: * * Redistributions in binary form must reproduce the above copyright
011: * notice, this list of conditions and the following disclaimer in the
012: * documentation and/or other materials provided with the distribution.
013: * * Neither the names of DrJava, the JavaPLT group, Rice University, nor the
014: * names of its contributors may be used to endorse or promote products
015: * derived from this software without specific prior written permission.
016: *
017: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
018: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
019: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
020: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
021: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
022: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
023: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
024: * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
025: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
026: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
027: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
028: *
029: * This software is Open Source Initiative approved Open Source Software.
030: * Open Source Initative Approved is a trademark of the Open Source Initiative.
031: *
032: * This file is part of DrJava. Download the current version of this project
033: * from http://www.drjava.org/ or http://sourceforge.net/projects/drjava/
034: *
035: * END_COPYRIGHT_BLOCK*/
036:
037: package edu.rice.cs.drjava.model.definitions.indent;
038:
039: import edu.rice.cs.drjava.model.AbstractDJDocument;
040:
041: // TODO: Check synchronization.
042: import java.util.Vector;
043: import java.io.PrintStream;
044:
045: /**
046: * This class does almost all the work for keeping an indent tree trace. IndentRuleQuestion
047: * also does some of the work, and any subclass may substitute its own version of getRuleName()
048: * Note: traceing is disabled by default
049: * @version $Id: IndentRuleWithTrace.java 4255 2007-08-28 19:17:37Z mgricken $
050: */
051: public abstract class IndentRuleWithTrace implements IndentRule {
052:
053: private static Vector<String> trace = null;
054: private static boolean startOver = true;
055: private static boolean ruleTraceEnabled = false;
056:
057: public static final String YES = "Yes";
058: public static final String NO = "No";
059: public static final String TERMINUS_RULE = "";
060:
061: /* This method prints the most recent trace through the indent tree */
062: public static void printLastIndentTrace(PrintStream ps) {
063: if (trace == null) {
064: ps.println("No trace to print");
065: } else {
066: for (int x = 0; x < trace.size(); x++) {
067: ps.println(trace.get(x));
068: }
069: ps.println("******************************");
070: }
071: }
072:
073: public static void setRuleTraceEnabled(boolean ruleTraceEnabled) {
074: IndentRuleWithTrace.ruleTraceEnabled = ruleTraceEnabled;
075: }
076:
077: static Vector<String> getTrace() {
078: return trace;
079: }
080:
081: /**
082: * This rule just adds to the trace kept in trace
083: */
084: protected static void _addToIndentTrace(String ruleName,
085: String direction, boolean terminus) {
086: if (ruleTraceEnabled) {
087: if (startOver) {
088: trace = new Vector<String>();
089: }
090: startOver = terminus;
091: trace.add(ruleName + " " + direction);
092: }
093: }
094:
095: /** Properly indents the line that the current position is on.
096: * Replaces all whitespace characters at the beginning of the
097: * line with the appropriate spacing or characters.
098: * @param doc AbstractDJDocument containing the line to be indented.
099: * @param pos ?
100: * @param reason The reason that the indentation is taking place
101: * @return true if the caller should update the current location itself,
102: * false if the indenter has already handled this
103: */
104: public boolean indentLine(AbstractDJDocument doc, int pos,
105: Indenter.IndentReason reason) {
106: int oldPos = doc.getCurrentLocation();
107: doc.setCurrentLocation(pos);
108: indentLine(doc, reason);
109: if (oldPos > doc.getLength())
110: oldPos = doc.getLength();
111: doc.setCurrentLocation(oldPos);
112: return false;
113: }
114:
115: public boolean indentLine(AbstractDJDocument doc,
116: Indenter.IndentReason reason) {
117: _addToIndentTrace(getRuleName(), TERMINUS_RULE, true);
118:
119: //Add the next line, and every time something is indented, the indent trace will be printed
120: //printLastIndentTrace(System.out);
121: return true;
122: }
123:
124: /** The rule name to report to _addToIndentTrace */
125: public String getRuleName() {
126: return this.getClass().getName();
127: }
128: }
|