package bluej.extensions.event;

import java.io.File;

import threadchecker.OnThread;
import threadchecker.Tag;




| This class encapsulates compiler events.
| It allows an extension writer to know when a compilation starts and
| finishes, whether it succeeds or fails, and what warnings or errors are
| generated.
|
| @author Damiano Bolla, University of Kent at Canterbury, 2003
|
@OnThread(Tag.Any)
public class CompileEvent
implements ExtensionEvent {    
   


| Event generated when compilation begins.
|
public static final int COMPILE_START_EVENT = 1;

   
   


| Event generated when a compilation warning occurs.
| A warning event is one that will not invalidate the compilation.
|
public static final int COMPILE_WARNING_EVENT = 2;

   
   


| Event generated when a compilation error occurs.
| An error event is one that will invalidate the compilation
|
public static final int COMPILE_ERROR_EVENT = 3;

   
   


| Event generated when a compilation finishes successfully.
|
public static final int COMPILE_DONE_EVENT = 4;

   
   


| Event generated when a compilation finishes unsuccessfully.
|
public static final int COMPILE_FAILED_EVENT = 5;

   
   private final boolean keepClasses;
   
   private int    eventId;
   
   private File[] fileNames;   
   private int    errorLineNumber;
   
   private int    errorColumn;
   
   private int    endErrorLine;
   
   private int    endErrorColumn;
   
   private String errorMessage;

   
   


| Constructor for a CompileEvent.
|
public CompileEvent(int anEventId, File[] aFileNames)
   {        
      eventId   = anEventId;
       
      fileNames = aFileNames;
       
      
      this.keepClasses = true;     
      }

   
   


| Constructor for a CompileEvent.
|
public CompileEvent(int anEventId, boolean keepClasses, File[] aFileNames)
   {        
      eventId   = anEventId;
       
      this.keepClasses = keepClasses;
       
      fileNames = aFileNames;     
      }

   
   


| Returns the eventId, one of the values defined.
|
public int getEvent()
   {        
      return eventId;     
      }

   
   


| Returns an array of zero, one or more files related to this event.
|
public File[] getFiles()
   {        
      return fileNames;     
      }

   
   


| Sets the line number where an error or warning occurred.
|
public void setErrorLineNumber(int aLineNumber)
   {        
      errorLineNumber = aLineNumber;     
      }
    
   
   


| Set the error position - beginning line [0] and column [1], ending line [2] and column [3]
|
public void setErrorPosition(int [] errorPosition)
   {        
      errorLineNumber = errorPosition[0];
       
      errorColumn = errorPosition[1];
       
      endErrorLine = errorPosition[2];
       
      endErrorColumn = errorPosition[3];     
      }

   
   


| Returns the line number where the compilation error occurs.
| Only valid in the case of an error or warning event.
|
public int getErrorLineNumber()
   {        
      return errorLineNumber;     
      }
    
   
   


| Get the error position - beginning line [0] and column [1], ending line [2] and column [3].
|
public int[] getErrorPosition()
   {        
      int [] r = new int[4];
       
      r[0] = errorLineNumber;
       
      r[1] = errorColumn;
       
      r[2] = endErrorLine;
       
      r[3] = endErrorColumn;
       
      return r;     
      }

   
   


| Sets the error message for an error or warning event.
|
public void setErrorMessage(String anErrorMessage)
   {        
      errorMessage = anErrorMessage;     
      }

   
   


| Returns the error message generated by the compiler.
| Only valid in the case of an error or warning event.
|
public String getErrorMessage()
   {        
      return errorMessage;     
      }

   
   


| With the addition of auto-compilation into BlueJ, there are now two types of compile.
|
| One is an automatic check for errors, which does a full compilation (and thus will trigger
| these compile events), but discards the resulting class files.  The other is proper
| compilations which compile and keep the class files.  This method lets you distinguish
| between the two.
|
| @return True if the classes generated by this compilation will be retained, false
| if they will be discarded (because the compilation is just an internal check for errors)
|
public boolean keepClasses()
   {        
      return keepClasses;     
      }

   
   


| Returns a meaningful description of this event.
|
@Override
   
   public String toString()
   {        
      StringBuffer aRisul = new StringBuffer(500);

      aRisul.append("CompileEvent:");

      if ( eventId == COMPILE_START_EVENT ) aRisul.append(" COMPILE_START_EVENT");
      if ( eventId == COMPILE_WARNING_EVENT ) aRisul.append(" COMPILE_WARNING_EVENT");
      if ( eventId == COMPILE_ERROR_EVENT ) aRisul.append(" COMPILE_ERROR_EVENT");
      if ( eventId == COMPILE_DONE_EVENT ) aRisul.append(" COMPILE_DONE_EVENT");
      if ( eventId == COMPILE_FAILED_EVENT ) aRisul.append(" COMPILE_FAILED_EVENT");

      aRisul.append(" getFiles().length=");
      aRisul.append(fileNames.length);

       
      for (int i = 0; i < fileNames.length; i++) {
         aRisul.append(" getFiles()[" + i + "]=");
         aRisul.append(fileNames[i]);         
         }

      if ( eventId == COMPILE_WARNING_EVENT || eventId == COMPILE_ERROR_EVENT )
       {
         aRisul.append(" errorLineNumber=" + errorLineNumber);
         aRisul.append(" errorMessage=" + errorMessage);         
         }

      return aRisul.toString();     
      } 
   }