EMARS/mars/ErrorMessage.java

   package mars;
	
   import java.util.regex.Pattern;
   import java.util.regex.Matcher;
   import java.util.ArrayList;
/*
Copyright (c) 2003-2012,  Pete Sanderson and Kenneth Vollmar

Developed by Pete Sanderson (psanderson@otterbein.edu)
and Kenneth Vollmar (kenvollmar@missouristate.edu)

Permission is hereby granted, free of charge, to any person obtaining 
a copy of this software and associated documentation files (the 
"Software"), to deal in the Software without restriction, including 
without limitation the rights to use, copy, modify, merge, publish, 
distribute, sublicense, and/or sell copies of the Software, and to 
permit persons to whom the Software is furnished to do so, subject 
to the following conditions:

The above copyright notice and this permission notice shall be 
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR 
ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF 
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

(MIT license, http://www.opensource.org/licenses/mit-license.html)
 */

/**
 * Represents occurrance of an error detected during tokenizing, assembly or simulation.
 * @author Pete Sanderson
 * @version August 2003
 **/

    public class ErrorMessage {
      private boolean isWarning; // allow for warnings too (added Nov 2006)
      private String filename; // name of source file  (added Oct 2006)
      private int line;     // line in source code where error detected
      private int position; // position in source line where error detected
      private String message;
      private String macroExpansionHistory;
   
   /**
    *  Constant to indicate this message is warning not error
    */
      public static final boolean WARNING = true;
   
   /**
    *  Constant to indicate this message is error not warning
    */
      public static final boolean ERROR = false;
   
   /**
    * Constructor for ErrorMessage.
    * @param filename String containing name of source file in which this error appears.
    * @param line Line number in source program being processed when error occurred.
    * @param position Position within line being processed when error occurred.  Normally is starting
    * position of source token.
    * @param message String containing appropriate error message.
    * @deprecated  Newer constructors replace the String filename parameter with a MIPSprogram parameter to provide more information.
    **/
    // Added filename October 2006 
       @Deprecated
       public ErrorMessage(String filename, int line, int position, String message) {
         this(ERROR, filename, line, position, message, "");
      }  
   	 
   /**
    * Constructor for ErrorMessage.
    * @param filename String containing name of source file in which this error appears.
    * @param line Line number in source program being processed when error occurred.
    * @param position Position within line being processed when error occurred.  Normally is starting
    * position of source token.
    * @param message String containing appropriate error message.
    * @param macroExpansionHistory
    * @deprecated  Newer constructors replace the String filename parameter with a MIPSprogram parameter to provide more information.
    **/
    // Added macroExpansionHistory Dec 2012
    
       @Deprecated   
       public ErrorMessage(String filename, int line, int position, String message, String macroExpansionHistory) {
         this(ERROR, filename, line, position, message, macroExpansionHistory);
      }
   
   /**
    * Constructor for ErrorMessage.
    * @param isWarning set to WARNING if message is a warning not error, else set to ERROR or omit.
    * @param filename String containing name of source file in which this error appears.
    * @param line Line number in source program being processed when error occurred.
    * @param position Position within line being processed when error occurred.  Normally is starting
    * position of source token.
    * @param message String containing appropriate error message.
    * @param macroExpansionHistory provided so message for macro can include both definition and usage line numbers
    * @deprecated  Newer constructors replace the String filename parameter with a MIPSprogram parameter to provide more information.
    **/
       @Deprecated
       public ErrorMessage(boolean isWarning, String filename, int line, int position, String message, String macroExpansionHistory) {
         this.isWarning = isWarning;
         this.filename = filename;
         this.line = line;
         this.position = position;
         this.message = message;
         this.macroExpansionHistory=macroExpansionHistory;
      }
   
   
   /**
    * Constructor for ErrorMessage.  Assumes line number is calculated after any .include files expanded, and
    * if there were, it will adjust filename and line number so message reflects original file and line number.
    * @param sourceMIPSprogram MIPSprogram object of source file in which this error appears.
    * @param line Line number in source program being processed when error occurred.
    * @param position Position within line being processed when error occurred.  Normally is starting
    * position of source token.
    * @param message String containing appropriate error message.
    **/
    
       public ErrorMessage(MIPSprogram sourceMIPSprogram, int line, int position, String message) {
         this(ERROR, sourceMIPSprogram, line, position, message);
      }
   
   
   /**
    * Constructor for ErrorMessage.  Assumes line number is calculated after any .include files expanded, and
    * if there were, it will adjust filename and line number so message reflects original file and line number.
    * @param isWarning set to WARNING if message is a warning not error, else set to ERROR or omit.
    * @param sourceMIPSprogram MIPSprogram object of source file in which this error appears.
    * @param line Line number in source program being processed when error occurred.
    * @param position Position within line being processed when error occurred.  Normally is starting
    * position of source token.
    * @param message String containing appropriate error message.
    **/
    
       public ErrorMessage(boolean isWarning, MIPSprogram sourceMIPSprogram, int line, int position, String message) {
         this.isWarning = isWarning;
         if (sourceMIPSprogram == null) {
            this.filename = "";
            this.line = line;
         } 
         else {
            if (sourceMIPSprogram.getSourceLineList() == null) {
               this.filename = sourceMIPSprogram.getFilename();
               this.line = line;
            } 
            else {
               mars.assembler.SourceLine sourceLine = sourceMIPSprogram.getSourceLineList().get(line-1);
               this.filename = sourceLine.getFilename();
               this.line = sourceLine.getLineNumber();
            }
         }
         this.position = position;
         this.message = message;
         this.macroExpansionHistory = getExpansionHistory(sourceMIPSprogram);
      }
   	
   /**
    * Constructor for ErrorMessage, to be used for runtime exceptions.  
    * @param statement The ProgramStatement object for the instruction causing the runtime error
    * @param message String containing appropriate error message.
    **/
   // Added January 2013
   
       public ErrorMessage(ProgramStatement statement, String message) {
         this.isWarning = ERROR;
         this.filename = (statement.getSourceMIPSprogram() == null) 
			                 ? "" : statement.getSourceMIPSprogram().getFilename();
         this.position = 0;
         this.message = message;
      	// Somewhere along the way we lose the macro history, but can
      	// normally recreate it here.  The line number for macro use (in the
      	// expansion) comes with the ProgramStatement.getSourceLine().  
      	// The line number for the macro definition comes embedded in
      	// the source code from ProgramStatement.getSource(), which is
      	// displayed in the Text Segment display.  It would previously
      	// have had the macro definition line prepended in brackets,
      	// e.g. "<13>  syscall  # finished".  So I'll extract that
      	// bracketed number here and include it in the error message.
      	// Looks bass-ackwards, but to get the line numbers to display correctly
      	// for runtime error occurring in macro expansion (expansion->definition), need 
      	// to assign to the opposite variables.
         ArrayList<Integer> defineLine = parseMacroHistory(statement.getSource());
         if (defineLine.size() == 0) {
            this.line = statement.getSourceLine();
            this.macroExpansionHistory = "";
         } 
         else {
            this.line = defineLine.get(0);
            this.macroExpansionHistory = ""+statement.getSourceLine();
         }
      }
    	
       private ArrayList<Integer> parseMacroHistory(String string) {	
         Pattern pattern = Pattern.compile("<\\d+>");
         Matcher matcher = pattern.matcher(string);
         String verify = new String(string).trim();
         ArrayList<Integer> macroHistory = new ArrayList<Integer>();
         while (matcher.find()) {
            String match = matcher.group();
            if (verify.indexOf(match)==0) {
               try {
                  int line = Integer.parseInt(match.substring(1,match.length()-1));
                  macroHistory.add(line);
               } 
                   catch (NumberFormatException e) {
                     break;
                  }
               verify = verify.substring(match.length()).trim();
            } 
            else {
               break;
            }
         } 
         return macroHistory;
      }  
   
   /**
    * Produce name of file containing error.
    * @return Returns String containing name of source file containing the error.
    */
   // Added October 2006
   
       public String getFilename() {
         return filename;
      }
   
   /**
    * Produce line number of error.
    * @return Returns line number in source program where error occurred.
    */
   
       public int getLine() {
         return line;
      }
   
   /**
    * Produce position within erroneous line.
    * @return Returns position within line of source program where error occurred.
    */
   
       public int getPosition() {
         return position;
      }
   
   /**
    * Produce error message.
    * @return Returns String containing textual error message.
    */
   
       public String getMessage() {
         return message;
      }
   
   /**
    * Determine whether this message represents error or warning.
    * @return Returns true if this message reflects warning, false if error.
    */
    // Method added 28 Nov 2006
       public boolean isWarning() {
         return this.isWarning;
      }
   	
   /**
    * Returns string describing macro expansion.  Empty string if none.
    * @return string describing macro expansion
    */
    // Method added by Mohammad Sekavat Dec 2012
   
       public String getMacroExpansionHistory() {
         if (macroExpansionHistory==null || macroExpansionHistory.length()==0)
            return "";
         return macroExpansionHistory+"->";
      }
   	
   	 // Added by Mohammad Sekavat Dec 2012
       private static String getExpansionHistory(MIPSprogram sourceMIPSprogram) {
         if (sourceMIPSprogram==null || sourceMIPSprogram.getLocalMacroPool()==null)
            return "";
         return sourceMIPSprogram.getLocalMacroPool().getExpansionHistory();
      }
   	
   }  // ErrorMessage