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.repl;
038:
039: import java.io.File;
040:
041: import edu.rice.cs.drjava.model.EventNotifier;
042:
043: /** Keeps track of all listeners to an InteractionsModel, and has the ability to notify them of some event. <p>
044: * This class has a specific role of managing InteractionsListeners. Other classes with similar names use similar
045: * code to perform the same function for other interfaces, e.g. JavadocEventNotifier and GlobalEventNotifier.
046: * These classes implement the appropriate interface definition so that they can be used transparently as composite
047: * packaging for a particular listener interface. <p>
048: * Components which might otherwise manage their own list of listeners use EventNotifiers instead to simplify their
049: * internal implementation. Notifiers should therefore be considered a private implementation detail of the
050: * components, and should not be used directly outside of the "host" component. <p>
051: * All methods in this class must use the synchronization methods provided by ReaderWriterLock. This ensures
052: * that multiple notifications (reads) can occur simultaneously, but only one thread can be adding or removing
053: * listeners (writing) at a time, and no reads can occur during a write. <p>
054: * <i>No</i> methods on this class should be synchronized using traditional Java synchronization! <p>
055: * @version $Id: InteractionsEventNotifier.java 4255 2007-08-28 19:17:37Z mgricken $
056: */
057:
058: public class InteractionsEventNotifier extends
059: EventNotifier<InteractionsListener> implements
060: InteractionsListener {
061:
062: /** Called after an interaction is started by the GlobalModel. */
063: public void interactionStarted() {
064: _lock.startRead();
065: try {
066: int size = _listeners.size();
067: for (int i = 0; i < size; i++)
068: _listeners.get(i).interactionStarted();
069: } finally {
070: _lock.endRead();
071: }
072: }
073:
074: /** Called when an interaction has finished running. */
075: public void interactionEnded() {
076: _lock.startRead();
077: try {
078: int size = _listeners.size();
079: for (int i = 0; i < size; i++)
080: _listeners.get(i).interactionEnded();
081: } finally {
082: _lock.endRead();
083: }
084: }
085:
086: /** Called when the interactions window generates a syntax error.
087: * @param offset the error's offset into the InteractionsDocument
088: * @param length the length of the error
089: */
090: public void interactionErrorOccurred(int offset, int length) {
091: _lock.startRead();
092: try {
093: int size = _listeners.size();
094: for (int i = 0; i < size; i++)
095: _listeners.get(i).interactionErrorOccurred(offset,
096: length);
097: } finally {
098: _lock.endRead();
099: }
100: }
101:
102: /** Called when the interactionsJVM has begun resetting. */
103: public void interpreterResetting() {
104: _lock.startRead();
105: try {
106: int size = _listeners.size();
107: // Utilities.showDebug("InteractionsEventNotifier: interpreterResetting called on " + size + " listeners");
108: for (int i = 0; i < size; i++)
109: _listeners.get(i).interpreterResetting();
110: } finally {
111: _lock.endRead();
112: }
113: }
114:
115: /** Called when the interactions window is reset. */
116: public void interpreterReady(File wd) {
117: _lock.startRead();
118: try {
119: int size = _listeners.size();
120: for (int i = 0; i < size; i++)
121: _listeners.get(i).interpreterReady(wd);
122: } finally {
123: _lock.endRead();
124: }
125: }
126:
127: /** Called if the interpreter reset failed.
128: * @param t Throwable explaining why the reset failed. (Subclasses must maintain listeners.)
129: */
130: public void interpreterResetFailed(final Throwable t) {
131: _lock.startRead();
132: try {
133: int size = _listeners.size();
134: for (int i = 0; i < size; i++)
135: _listeners.get(i).interpreterResetFailed(t);
136: } finally {
137: _lock.endRead();
138: }
139: }
140:
141: /** Called when the interactions JVM was closed by System.exit or by being aborted. Immediately after this the
142: * interactions will be reset.
143: * @param status the exit code
144: */
145: public void interpreterExited(int status) {
146: _lock.startRead();
147: try {
148: int size = _listeners.size();
149: for (int i = 0; i < size; i++) {
150: _listeners.get(i).interpreterExited(status);
151: }
152: } finally {
153: _lock.endRead();
154: }
155: }
156:
157: /** Called when the active interpreter is changed.
158: * @param inProgress Whether the new interpreter is currently in progress with an interaction (ie. whether an
159: * interactionEnded event will be fired)
160: */
161: public void interpreterChanged(boolean inProgress) {
162: _lock.startRead();
163: try {
164: int size = _listeners.size();
165: for (int i = 0; i < size; i++)
166: _listeners.get(i).interpreterChanged(inProgress);
167: } finally {
168: _lock.endRead();
169: }
170: }
171:
172: /** Notifies the view that the current interaction is incomplete. */
173: public void interactionIncomplete() {
174: _lock.startRead();
175: try {
176: int size = _listeners.size();
177: for (int i = 0; i < size; i++)
178: _listeners.get(i).interactionIncomplete();
179: } finally {
180: _lock.endRead();
181: }
182: }
183:
184: /** Notifies listeners that the slaveJVM has been used. */
185: public void slaveJVMUsed() {
186: _lock.startRead();
187: try {
188: int size = _listeners.size();
189: for (int i = 0; i < size; i++)
190: _listeners.get(i).slaveJVMUsed();
191: } finally {
192: _lock.endRead();
193: }
194: }
195: }
|