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.ui;
038:
039: import edu.rice.cs.drjava.model.OpenDefinitionsDocument;
040: import edu.rice.cs.drjava.model.compiler.CompilerError;
041: import edu.rice.cs.drjava.model.compiler.CompilerErrorModel;
042: import edu.rice.cs.util.swing.Utilities;
043:
044: import java.awt.EventQueue;
045:
046: import javax.swing.event.CaretEvent;
047: import javax.swing.event.CaretListener;
048: import javax.swing.text.Position;
049:
050: /** Listens to the caret in the associated DefinitionsPane and highlights the text containing CompilerErrors.
051: * @version $Id: ErrorCaretListener.java 4255 2007-08-28 19:17:37Z mgricken $
052: */
053: public class ErrorCaretListener implements CaretListener {
054: private final OpenDefinitionsDocument _openDoc;
055: private final DefinitionsPane _definitionsPane;
056: protected final MainFrame _frame;
057:
058: /** Constructs a new caret listener to highlight errors. */
059: public ErrorCaretListener(OpenDefinitionsDocument doc,
060: DefinitionsPane defPane, MainFrame frame) {
061: _openDoc = doc;
062: _definitionsPane = defPane;
063: _frame = frame;
064: }
065:
066: /** Gets the OpenDefinitionsDocument corresponding to this listener. */
067: public OpenDefinitionsDocument getOpenDefDoc() {
068: return _openDoc;
069: }
070:
071: /** After each update to the caret, determine if changes in highlighting need to be made. Highlights the line
072: * if the compiler output tab is showing. Only runs in the event thread.
073: */
074: public void caretUpdate(final CaretEvent evt) {
075: // Now we can assume at least one error.
076: updateHighlight(evt.getDot()); // invokeLater unnecessary here; this method runs in the event thread!
077: }
078:
079: /** Update the highlight appropriately. */
080: public void updateHighlight(final int curPos) {
081: Utilities.invokeLater(new Runnable() {
082: public void run() {
083: ErrorPanel panel = _frame.getSelectedErrorPanel();
084: if (panel == null) {
085: // no error panel is currently selected
086: return;
087: }
088: CompilerErrorModel model = panel.getErrorModel();
089:
090: if (!model.hasErrorsWithPositions(_openDoc))
091: return;
092:
093: // Utilities.showDebug("ErrorCaretListener.updateHighlight invoked");
094:
095: CompilerError error = model.getErrorAtOffset(_openDoc,
096: curPos);
097:
098: ErrorPanel.ErrorListPane errorListPane = panel
099: .getErrorListPane();
100: // if no error is on this line, select the (none) item
101: if (error == null)
102: errorListPane.selectNothing();
103: else {
104: if (errorListPane.shouldShowHighlightsInSource()) {
105: // No need to move the caret since it's already here!
106: _highlightErrorInSource(model
107: .getPosition(error));
108: }
109:
110: // Select item wants the CompilerError
111: errorListPane.selectItem(error);
112: }
113: }
114: });
115: }
116:
117: /** Hides the error highlight in the document. */
118: public void removeHighlight() {
119: Utilities.invokeLater(new Runnable() {
120: public void run() {
121: _definitionsPane.removeErrorHighlight();
122: }
123: });
124: }
125:
126: /** Highlights the given error in the source. Only runs in event thread.
127: * @param pos the position of the error
128: */
129: private void _highlightErrorInSource(Position pos) {
130: assert EventQueue.isDispatchThread();
131: if (pos == null)
132: return;
133: int errPos = pos.getOffset();
134:
135: String text = _openDoc.getText();
136:
137: // Look for the previous newline BEFORE this character. Thus start looking
138: // on the character one before this character. If this is not the case,
139: // if the error is at a newline character, both prev and next newlines
140: // will be set to that place, resulting in nothing being highlighted.
141: int prevNewline = text.lastIndexOf('\n', errPos - 1);
142: if (prevNewline == -1)
143: prevNewline = 0;
144:
145: int nextNewline = text.indexOf('\n', errPos);
146: if (nextNewline == -1)
147: nextNewline = text.length();
148:
149: removeHighlight();
150:
151: //Add 1 if not the first line of the file, so that the highlight range
152: // will match the range chosen for the highlight manager.
153: if (prevNewline > 0)
154: prevNewline++;
155:
156: if (prevNewline <= nextNewline) {
157: _definitionsPane
158: .addErrorHighlight(prevNewline, nextNewline);
159: }
160: }
161: }
|