KickJava   Java API By Example, From Geeks To Geeks.

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


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 // TODO: Check synchronization.
39 import java.util.Vector JavaDoc;
40 import java.io.PrintStream JavaDoc;
41
42 /**
43  * This class does almost all the work for keeping an indent tree trace. IndentRuleQuestion
44  * also does some of the work, and any subclass may substitute its own version of getRuleName()
45  * Note: traceing is disabled by default
46  * @version $Id: IndentRuleWithTrace.java 3901 2006-06-30 05:28:11Z rcartwright $
47  */
48 public abstract class IndentRuleWithTrace implements IndentRule{
49
50   private static Vector JavaDoc<String JavaDoc> trace = null;
51   private static boolean startOver = true;
52   private static boolean ruleTraceEnabled = false;
53
54   public static final String JavaDoc YES = "Yes";
55   public static final String JavaDoc NO = "No";
56   public static final String JavaDoc TERMINUS_RULE = "";
57
58   /* This method prints the most recent trace through the indent tree */
59   public static void printLastIndentTrace(PrintStream JavaDoc ps) {
60     if (trace == null) {
61       ps.println("No trace to print");
62     } else {
63       for (int x = 0; x < trace.size(); x++) {
64         ps.println(trace.get(x));
65       }
66       ps.println("******************************");
67     }
68   }
69
70   public static void setRuleTraceEnabled(boolean ruleTraceEnabled) {
71     IndentRuleWithTrace.ruleTraceEnabled = ruleTraceEnabled;
72   }
73
74   static Vector JavaDoc<String JavaDoc> getTrace() {
75     return trace;
76   }
77
78   /**
79    * This rule just adds to the trace kept in trace
80    */
81   protected static void _addToIndentTrace(String JavaDoc ruleName, String JavaDoc direction, boolean terminus) {
82     if (ruleTraceEnabled) {
83       if (startOver) {
84  trace = new Vector JavaDoc<String JavaDoc>();
85       }
86       startOver = terminus;
87       trace.add(ruleName + " " + direction);
88     }
89   }
90
91
92   /** Properly indents the line that the current position is on.
93    * Replaces all whitespace characters at the beginning of the
94    * line with the appropriate spacing or characters.
95    * @param doc AbstractDJDocument containing the line to be indented.
96    * @param pos ?
97    * @param reason ?
98    * @return true if the caller should update the current location itself,
99    * false if the indenter has already handled this
100    */
101   public boolean indentLine(AbstractDJDocument doc, int pos, int reason) {
102     int oldPos = doc.getCurrentLocation();
103     doc.setCurrentLocation(pos);
104     indentLine(doc, reason);
105     if (oldPos > doc.getLength()) oldPos = doc.getLength();
106     doc.setCurrentLocation(oldPos);
107     return false;
108   }
109
110   public boolean indentLine(AbstractDJDocument doc, int reason) {
111     _addToIndentTrace(getRuleName(), TERMINUS_RULE, true);
112
113     //Add the next line, and every time something is indented, the indent trace will be printed
114 //printLastIndentTrace(System.out);
115 return true;
116   }
117
118   /** The rule name to report to _addToIndentTrace */
119   public String JavaDoc getRuleName() { return this.getClass().getName(); }
120 }
121
Popular Tags