package mars;
   import mars.mips.instructions.syscalls.*;
   import mars.mips.instructions.*;
   import mars.mips.hardware.*;
   import mars.assembler.*;
   import mars.venus.*;
   import mars.util.*;
   import java.io.*;
   import java.util.*;
	
/*
Copyright (c) 2003-2008,  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)
 */

/**
 * Collection of globally-available data structures.
 * 
 * @author Pete Sanderson 
 * @version August 2003
 */
    public class Globals
   {
      // List these first because they are referenced by methods called at initialization.
      private static String configPropertiesFile = "Config";
      private static String syscallPropertiesFile = "Syscall";
   	
    /** The set of implemented MIPS instructions. **/
      public static InstructionSet instructionSet;
   /** the program currently being worked with.  Used by GUI only, not command line. **/
      public static MIPSprogram program;
   /** Symbol table for file currently being assembled. **/
      public static SymbolTable symbolTable;
    /** Simulated MIPS memory component. **/
      public static Memory memory;
    /** Lock variable used at head of synchronized block to guard MIPS memory and registers **/
      public static Object memoryAndRegistersLock = new Object();
    /** Flag to determine whether or not to produce internal debugging information. **/
      public static boolean debug = false;
    /** Object that contains various settings that can be accessed modified internally. **/
      static Settings settings;
    /** String to GUI's RunI/O text area when echoing user input from pop-up dialog. */
      public static String userInputAlert = "**** user input : ";
    /** Path to folder that contains images */	
    // The leading "/" in filepath prevents package name from being pre-pended.
      public static final String imagesPath = "/images/";
   	/** Path to folder that contains help text */	
      public static final String helpPath = "/help/";
    /* Flag that indicates whether or not instructionSet has been initialized. */
      private static boolean initialized = false;
    /* The GUI being used (if any) with this simulator. */
      static VenusUI gui = null;
    /** The current MARS version number. Can't wait for "initialize()" call to get it. */
      public static final String version = "4.5";
    /** List of accepted file extensions for MIPS assembly source files. */
      public static final ArrayList fileExtensions = getFileExtensions();
    /** Maximum length of scrolled message window (MARS Messages and Run I/O) */
      public static final int maximumMessageCharacters = getMessageLimit();
    /** Maximum number of assembler errors produced by one assemble operation */
      public static final int maximumErrorMessages = getErrorLimit();
    /** Maximum number of back-step operations to buffer */
      public static final int maximumBacksteps = getBackstepLimit();
   	/** MARS copyright years */
      public static final String copyrightYears = getCopyrightYears();
   	/** MARS copyright holders */
      public static final String copyrightHolders = getCopyrightHolders(); 
		/** Placeholder for non-printable ASCII codes */
		public static final String ASCII_NON_PRINT = getAsciiNonPrint();
		/** Array of strings to display for ASCII codes in ASCII display of data segment. ASCII code 0-255 is array index. */
		public static final String[] ASCII_TABLE = getAsciiStrings();
      /** MARS exit code -- useful with SYSCALL 17 when running from command line (not GUI) */
      public static int exitCode = 0;
   	
      public static boolean runSpeedPanelExists = false;
   	
       private static String getCopyrightYears() {
         return "2003-2014";
      }
       private static String getCopyrightHolders() {
         return "Pete Sanderson and Kenneth Vollmar";
      }
    
       public static void setGui(VenusUI g) {
         gui = g;
      }
       public static VenusUI getGui() {
         return gui;
      }
    
       public static Settings getSettings() {
         return settings;
      }
   
    /**
     * Method called once upon system initialization to create the global data structures.
     **/
     
       public static void initialize(boolean gui) {
         if (!initialized) {
            memory = Memory.getInstance();  //clients can use Memory.getInstance instead of Globals.memory
            instructionSet = new InstructionSet();
            instructionSet.populate();    
            symbolTable = new SymbolTable("global");
            settings = new Settings(gui);
            initialized = true;
            debug = false; 
				memory.clear(); // will establish memory configuration from setting
         }
      }
   	
   	// Read byte limit of Run I/O or MARS Messages text to buffer.
       private static int getMessageLimit() {
         return getIntegerProperty(configPropertiesFile, "MessageLimit", 1000000);
      }
		
   	// Read limit on number of error messages produced by one assemble operation.
       private static int getErrorLimit() {
         return getIntegerProperty(configPropertiesFile, "ErrorLimit", 200);
      }
   
   	// Read backstep limit (number of operations to buffer) from properties file.
       private static int getBackstepLimit() {
         return getIntegerProperty(configPropertiesFile, "BackstepLimit", 1000);
      } 
		
   	// Read ASCII default display character for non-printing characters, from properties file.
       public static String getAsciiNonPrint() {
		   String anp = getPropertyEntry(configPropertiesFile, "AsciiNonPrint");
			return (anp == null) ? "." : ( (anp.equals("space")) ? " " : anp );
      }    
		
   	// Read ASCII strings for codes 0-255, from properties file. If string
		// value is "null", substitute value of ASCII_NON_PRINT.  If string is
		// "space", substitute string containing one space character.
       public static String[] getAsciiStrings() {
		   String let = getPropertyEntry(configPropertiesFile,"AsciiTable");
		   String placeHolder = getAsciiNonPrint();
			String[] lets = let.split(" +");			
			int maxLength = 0;
			for (int i = 0; i < lets.length; i++) {
			    if (lets[i].equals("null")) lets[i] = placeHolder;
				 if (lets[i].equals("space")) lets[i] = " ";
				 if (lets[i].length() > maxLength) maxLength = lets[i].length();
			}
			String padding = "        ";
			maxLength++;
			for (int i = 0; i < lets.length; i++) {
             lets[i] = padding.substring(0,maxLength-lets[i].length()) + lets[i];
			}
			return lets;
      }   
			
      // Read and return integer property value for given file and property name.
   	// Default value is returned if property file or name not found.
       private static int getIntegerProperty(String propertiesFile, String propertyName, int defaultValue) {
         int limit = defaultValue;  // just in case no entry is found
         Properties properties = PropertiesFile.loadPropertiesFromFile(propertiesFile);
         try {
            limit = Integer.parseInt(properties.getProperty(propertyName, Integer.toString(defaultValue)));
         } 
             catch (NumberFormatException nfe) { } // do nothing, I already have a default
         return limit;
      }
   
   
   	// Read assembly language file extensions from properties file.  Resulting
   	// string is tokenized into array list (assume StringTokenizer default delimiters).
       private static ArrayList getFileExtensions() {
         ArrayList extensionsList = new ArrayList();
         String extensions = getPropertyEntry(configPropertiesFile,"Extensions");
         if (extensions != null) {
            StringTokenizer st = new StringTokenizer(extensions); 
            while (st.hasMoreTokens()) { 
               extensionsList.add(st.nextToken()); 
            } 
         }
         return extensionsList;
      }
   
      /**
   	 * Get list of MarsTools that reside outside the MARS distribution. 
   	 * Currently this is done by adding the tool's path name to the list
   	 * of values for the external_tools property. Use ";" as delimiter!
   	 * @return ArrayList.  Each item is file path to .class file
   	 * of a class that implements MarsTool.  If none, returns empty list.
   	 */
       public static ArrayList getExternalTools() {
         ArrayList toolsList = new ArrayList();
         String delimiter = ";";
         String tools = getPropertyEntry(configPropertiesFile,"ExternalTools");
         if (tools != null) {
            StringTokenizer st = new StringTokenizer(tools, delimiter); 
            while (st.hasMoreTokens()) { 
               toolsList.add(st.nextToken()); 
            } 
         }
         return toolsList;
      }
   	
   	/**
   	 * Read and return property file value (if any) for requested property.
   	 * @param propertiesFile  name of properties file (do NOT include filename extension,
   	 * which is assumed to be ".properties")
   	 * @param propertyName String containing desired property name
   	 * @return String containing associated value; null if property not found
   	 */
       public static String getPropertyEntry(String propertiesFile, String propertyName) {
         return PropertiesFile.loadPropertiesFromFile(propertiesFile).getProperty(propertyName);
      }
   	   
   	/**
   	 * Read any syscall number assignment overrides from config file.
   	 * @return ArrayList of SyscallNumberOverride objects
   	 */
       public ArrayList getSyscallOverrides() {
         ArrayList overrides = new ArrayList();
         Properties properties = PropertiesFile.loadPropertiesFromFile(syscallPropertiesFile);
         Enumeration keys = properties.keys();
         while (keys.hasMoreElements()) {
            String key = (String) keys.nextElement();
            overrides.add(new SyscallNumberOverride(key,properties.getProperty(key)));
         }
         return overrides;
      }
   
   }