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.compiler;
038:
039: import java.io.IOException;
040: import java.io.File;
041: import java.util.List;
042: import edu.rice.cs.drjava.model.OpenDefinitionsDocument;
043:
044: /** Interface for all compiler functionality in the model. The compilation process itself can be monitored through
045: * the CompilerListener interface. The four primary uses of this interface will be to manage listeners, to trigger
046: * compilation of (a) document(s), to handle the results, and to manage available compilers.
047: *
048: * @version $Id: CompilerModel.java 4255 2007-08-28 19:17:37Z mgricken $
049: */
050: public interface CompilerModel {
051:
052: /** Legal source file name extensions */
053: public static final String[] EXTENSIONS = new String[] { ".java",
054: ".dj0", ".dj1", ".dj2" };
055:
056: //----------------------------Locking--------------------------------------//
057:
058: /** Returns the lock used to prevent simultaneous compilation and JUnit testing */
059: public Object getCompilerLock();
060:
061: //-------------------------- Listener Management --------------------------//
062:
063: /** Add a CompilerListener to the model.
064: * @param listener a listener that reacts to compiler events
065: */
066: public void addListener(CompilerListener listener);
067:
068: /** Remove a CompilerListener from the model. If the listener is not currently listening to this model, this method
069: * has no effect.
070: * @param listener a listener that reacts to compiler events
071: */
072: public void removeListener(CompilerListener listener);
073:
074: /** Removes all CompilerListeners from this model. */
075: public void removeAllListeners();
076:
077: //-------------------------------- Triggers --------------------------------//
078:
079: /** Compiles all documents, which requires that the documents be saved first.
080: * @throws IOException if a filesystem-related problem prevents compilation
081: */
082: public void compileAll() throws IOException;
083:
084: /** Compiles all documents in the project source tree, which requires that the documents be saved first.
085: * @throws IOException if a filesystem-related problem prevents compilation
086: */
087: public void compileProject() throws IOException;
088:
089: /** Compiles the specified documents which must be saved first.
090: * @param docs the documents to be compiled
091: * @throws IOException if a filesystem-related problem prevents compilation
092: */
093: public void compile(List<OpenDefinitionsDocument> docs)
094: throws IOException;
095:
096: /** Compiles a single document which must be saved first.
097: * @param doc the document to be compiled
098: * @throws IOException if a filesystem-related problem prevents compilation
099: */
100: public void compile(OpenDefinitionsDocument doc) throws IOException;
101:
102: //----------------------------- Error Results -----------------------------//
103:
104: /** Gets the CompilerErrorModel representing the last compile. */
105: public CompilerErrorModel getCompilerErrorModel();
106:
107: /** Gets the total number of current errors. */
108: public int getNumErrors();
109:
110: /** Resets the compiler error state to have no errors. */
111: public void resetCompilerErrors();
112:
113: //-------------------------- Compiler Management --------------------------//
114:
115: /**
116: * Returns all registered compilers that are actually available. If there are none,
117: * the result is {@link NoCompilerAvailable#ONLY}.
118: */
119: public Iterable<CompilerInterface> getAvailableCompilers();
120:
121: /**
122: * Gets the compiler that is the "active" compiler.
123: *
124: * @see #setActiveCompiler
125: */
126: public CompilerInterface getActiveCompiler();
127:
128: /**
129: * Sets which compiler is the "active" compiler.
130: *
131: * @param compiler Compiler to set active.
132: * @throws IllegalArgumentException If the compiler is not in the list of available compilers
133: *
134: * @see #getActiveCompiler
135: */
136: public void setActiveCompiler(CompilerInterface compiler);
137:
138: /** Add a compiler to the active list */
139: public void addCompiler(CompilerInterface compiler);
140:
141: }
|