Refactor the mars package to rars

Additionally, remove many references in the code to mars.

Author: TheThirdOne

MARSlicense.txt License.txt

@@ -26,6 +26,8 @@ a copy of this software and associated documentation files (the
 (MIT license, http://www.opensource.org/licenses/mit-license.html)
  */
 
+import rars.Launch;
+
 /**
  * Portal to Mars
  *
@@ -35,7 +37,7 @@ a copy of this software and associated documentation files (the
 
 public class Mars {
     public static void main(String[] args) {
-        new mars.MarsLaunch(args);
+        new Launch(args);
     }
 }
 

Mars.java

@@ -55,7 +55,7 @@ <h3>Introduction</h3>
         state to before the exception, so jumping to the value in uepc instead is not recommended</li>
     <li> <i>ucause</i> contains the reason that the exception handler was called.
     </li>
-    <li>Exception types declared in <tt>mars.SimulatorException</tt>, but
+    <li>Exception types declared in <tt>rars.SimulatorException</tt>, but
         not necessarily implemented, are INSTRUCTION_ADDR_MISALIGNED (0),
         INSTRUCTION_ACCESS_FAULT (1), ILLEGAL_INSTRUCTION(2),
         LOAD_ADDRESS_MISALIGNED(4), LOAD_ACCESS_FAULT(5),

help/ExceptionsHelp.html

@@ -13,9 +13,9 @@ <h4>Cool Capability: Plug-in Tools</h4>
 program and system resources.
 The requirements for such a program are:
 <ol>
-<li>It implements the <tt>mars.tools.MarsTool</tt> interface.  
-<li>It is part of the <tt>mars.tools</tt> package.
-<li>It compiles cleanly into a ".class" file, stored in the <tt>mars/tools</tt> directory.
+<li>It implements the <tt>rars.tools.Tool</tt> interface.
+<li>It is part of the <tt>rars.tools</tt> package.
+<li>It compiles cleanly into a ".class" file, stored in the <tt>rars/tools</tt> directory.
 </ol>
 
 RARS will detect all qualifying tools upon startup and include them in
@@ -30,7 +30,7 @@ <h4>Cool Capability: Plug-in Tools</h4>
 need to be "connected" to the program by clicking a button or will already be connected.  Run
 the program as you normally would, to initiate tool interaction with the executing program.
 
-<p>The abstract class <tt>mars.tools.AbstractMarsToolAndApplication</tt>
+<p>The abstract class <tt>rars.tools.AbstractToolAndApplication</tt>
 is included in the RARS distribution to provide
 a substantial framework for implementing your own Tool.  A subclass that extends it by
 implementing at least its two abstract methods can be run not only from the Tools menu but also
@@ -48,10 +48,10 @@ <h4>Adding more system calls</h4>
 a technique similar to that for tools.  This permits anyone to add a new syscall by defining
 a new class that meets these requirements:
 <li>
-    <li>It extends the <tt>mars.riscv.AbstractSyscall</tt> class.</li>
-    <li>It is part of the <tt>mars.riscv.syscalls</tt> package.</li>
+    <li>It extends the <tt>rars.riscv.AbstractSyscall</tt> class.</li>
+    <li>It is part of the <tt>rars.riscv.syscalls</tt> package.</li>
     <li>It compiles cleanly into a ".class" file, stored in the
-    <tt>mars/riscv/syscalls</tt> directory.</li>
+    <tt>rars/riscv/syscalls</tt> directory.</li>
     <li>An entry is added to Syscall.properties</li>
 </ol>
 

help/Tools.html

@@ -1,4 +1,4 @@
-package mars;
+package rars;
 
 /*
 Copyright (c) 2017,  Benjamin Landers

mars/AssemblyException.java rars/AssemblyException.java

@@ -1,4 +1,4 @@
-package mars;
+package rars;
 
 /**
  * This exception is only used to trigger breakpoints for ebreak.

mars/BreakpointException.java rars/BreakpointException.java

@@ -1,4 +1,4 @@
-package mars;
+package rars;
 
 import java.util.ArrayList;
 /*

mars/ErrorList.java rars/ErrorList.java

@@ -1,4 +1,4 @@
-package mars;
+package rars;
 
 import java.io.File;
 import java.util.ArrayList;
@@ -95,7 +95,7 @@ public ErrorMessage(boolean isWarning, RISCVprogram sourceProgram, int line, int
                 this.filename = sourceProgram.getFilename();
                 this.line = line;
             } else {
-                mars.assembler.SourceLine sourceLine = sourceProgram.getSourceLineList().get(line - 1);
+                rars.assembler.SourceLine sourceLine = sourceProgram.getSourceLineList().get(line - 1);
                 this.filename = sourceLine.getFilename();
                 this.line = sourceLine.getLineNumber();
             }

mars/ErrorMessage.java rars/ErrorMessage.java

@@ -1,6 +1,6 @@
-package mars;
+package rars;
 
-import mars.riscv.hardware.AddressErrorException;
+import rars.riscv.hardware.AddressErrorException;
 
 /**
  * Exceptions that cannot be handled and must result in the ending of the simulation

mars/ExitingException.java rars/ExitingException.java

@@ -1,11 +1,11 @@
-package mars;
+package rars;
 
-import mars.assembler.SymbolTable;
-import mars.riscv.hardware.Memory;
-import mars.riscv.InstructionSet;
-import mars.riscv.SyscallNumberOverride;
-import mars.util.PropertiesFile;
-import mars.venus.VenusUI;
+import rars.assembler.SymbolTable;
+import rars.riscv.hardware.Memory;
+import rars.riscv.InstructionSet;
+import rars.riscv.SyscallNumberOverride;
+import rars.util.PropertiesFile;
+import rars.venus.VenusUI;
 
 import java.util.ArrayList;
 import java.util.Enumeration;
@@ -97,7 +97,7 @@ public class Globals {
     /* 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.
+     * The current version number. Can't wait for "initialize()" call to get it.
      */
     public static final String version = "1.0";
     /**
@@ -117,11 +117,11 @@ public class Globals {
      */
     public static final int maximumBacksteps = getBackstepLimit();
     /**
-     * MARS copyright years
+     * Copyright years
      */
     public static final String copyrightYears = getCopyrightYears();
     /**
-     * MARS copyright holders
+     * Copyright holders
      */
     public static final String copyrightHolders = getCopyrightHolders();
     /**
@@ -133,7 +133,7 @@ public class Globals {
      */
     public static final String[] ASCII_TABLE = getAsciiStrings();
     /**
-     * MARS exit code -- useful with SYSCALL 17 when running from command line (not GUI)
+     * Exit code -- useful with SYSCALL 17 when running from command line (not GUI)
      */
     public static int exitCode = 0;
 

mars/Globals.java rars/Globals.java

@@ -1,14 +1,14 @@
-package mars;
-
-import mars.riscv.dump.DumpFormat;
-import mars.riscv.dump.DumpFormatLoader;
-import mars.riscv.hardware.*;
-import mars.simulator.ProgramArgumentList;
-import mars.simulator.Simulator;
-import mars.util.Binary;
-import mars.util.FilenameFinder;
-import mars.util.MemoryDump;
-import mars.venus.VenusUI;
+package rars;
+
+import rars.riscv.dump.DumpFormat;
+import rars.riscv.dump.DumpFormatLoader;
+import rars.riscv.hardware.*;
+import rars.simulator.ProgramArgumentList;
+import rars.simulator.Simulator;
+import rars.util.Binary;
+import rars.util.FilenameFinder;
+import rars.util.MemoryDump;
+import rars.venus.VenusUI;
 
 import javax.swing.*;
 import java.io.File;
@@ -49,17 +49,17 @@ a copy of this software and associated documentation files (the
  */
 
 /**
- * Launch the Mars application
+ * Launch the application
  *
  * @author Pete Sanderson
  * @version December 2009
  **/
 
-public class MarsLaunch {
+public class Launch {
 
     /**
      * Main takes a number of command line arguments.<br>
-     * Usage:  Mars  [options] filename<br>
+     * Usage:  rars  [options] filename<br>
      * Valid options (not case sensitive, separate by spaces) are:<br>
      * a  -- assemble only, do not simulate<br>
      * ad  -- both a and d<br>
@@ -133,7 +133,7 @@ public class MarsLaunch {
     private int assembleErrorExitCode;  // RARS command exit code to return if assemble error occurs
     private int simulateErrorExitCode;// RARS command exit code to return if simulation error occurs
 
-    public MarsLaunch(String[] args) {
+    public Launch(String[] args) {
         boolean gui = (args.length == 0);
         Globals.initialize(gui);
         if (gui) {
@@ -232,7 +232,7 @@ private void dumpSegments() {
 
     private void launchIDE() {
         // System.setProperty("apple.laf.useScreenMenuBar", "true"); // Puts RARS menu on Mac OS menu bar
-        new MarsSplashScreen(splashDuration).showSplash();
+        new SplashScreen(splashDuration).showSplash();
         SwingUtilities.invokeLater(
                 new Runnable() {
                     public void run() {
@@ -438,7 +438,7 @@ private boolean parseCommandArgs(String[] args) {
 
 
     //////////////////////////////////////////////////////////////////////
-    // Carry out the mars command: assemble then optionally run
+    // Carry out the rars command: assemble then optionally run
     // Returns false if no simulation (run) occurs, true otherwise.
 
     private void runCommand() {
@@ -584,7 +584,7 @@ public void update(Observable o, Object obj) {
             try {
                 Globals.memory.addObserver(instructionCounter, Memory.textBaseAddress, Memory.textLimitAddress);
             } catch (AddressErrorException aee) {
-                out.println("Internal error: MarsLaunch uses incorrect text segment address for instruction observer");
+                out.println("Internal error: Launch uses incorrect text segment address for instruction observer");
             }
         }
     }

mars/MarsLaunch.java rars/Launch.java

@@ -1,15 +1,16 @@
-package mars;
-
-import mars.assembler.SymbolTable;
-import mars.assembler.Token;
-import mars.assembler.TokenList;
-import mars.assembler.TokenTypes;
-import mars.riscv.hardware.FloatingPointRegisterFile;
-import mars.riscv.hardware.RegisterFile;
-import mars.riscv.BasicInstruction;
-import mars.riscv.BasicInstructionFormat;
-import mars.riscv.Instruction;
-import mars.util.Binary;
+package rars;
+
+import rars.assembler.SymbolTable;
+import rars.assembler.Token;
+import rars.assembler.TokenList;
+import rars.assembler.TokenTypes;
+import rars.riscv.hardware.FloatingPointRegisterFile;
+import rars.riscv.hardware.RegisterFile;
+import rars.riscv.BasicInstruction;
+import rars.riscv.BasicInstructionFormat;
+import rars.riscv.Instruction;
+import rars.util.Binary;
+import rars.venus.NumberDisplayBaseChooser;
 
 import java.util.ArrayList;
 
@@ -232,7 +233,7 @@ public void buildBasicStatementFromBasicInstruction(ErrorList errors) {
                         address = (address - this.textAddress) >> 1;
                         if (address >= (1 << 19) || address < -(1 << 19)) {
                             // attempt to jump beyond 21-bit byte (20-bit word) address range.
-                            // SPIM flags as warning, I'll flag as error b/c MARS text segment not long enough for it to be OK.
+                            // SPIM flags as warning, I'll flag as error b/c RARS text segment not long enough for it to be OK.
                             errors.add(new ErrorMessage(this.sourceProgram, this.sourceLine, 0,
                                     "Jump target word address beyond 20-bit range"));
                             return;
@@ -274,7 +275,7 @@ public void buildBasicStatementFromBasicInstruction(ErrorList errors) {
                  * pseudo-instructions.
                  *
                  * This modification also appears inbuildBasicStatementFromBasicInstruction()
-                 * in mars.ProgramStatement.
+                 * in rars.ProgramStatement.
                  *
                  *  ///// Begin modification 1/4/05 KENV   ///////////////////////////////////////////
                  *  // We have decided to interpret non-signed (no + or -) 16-bit hexadecimal immediate
@@ -774,8 +775,8 @@ void addValue(int value) {
         }
 
         public String toString() {
-            int addressBase = (Globals.getSettings().getBooleanSetting(Settings.Bool.DISPLAY_ADDRESSES_IN_HEX)) ? mars.venus.NumberDisplayBaseChooser.HEXADECIMAL : mars.venus.NumberDisplayBaseChooser.DECIMAL;
-            int valueBase = (Globals.getSettings().getBooleanSetting(Settings.Bool.DISPLAY_VALUES_IN_HEX)) ? mars.venus.NumberDisplayBaseChooser.HEXADECIMAL : mars.venus.NumberDisplayBaseChooser.DECIMAL;
+            int addressBase = (Globals.getSettings().getBooleanSetting(Settings.Bool.DISPLAY_ADDRESSES_IN_HEX)) ? NumberDisplayBaseChooser.HEXADECIMAL : NumberDisplayBaseChooser.DECIMAL;
+            int valueBase = (Globals.getSettings().getBooleanSetting(Settings.Bool.DISPLAY_VALUES_IN_HEX)) ? NumberDisplayBaseChooser.HEXADECIMAL : NumberDisplayBaseChooser.DECIMAL;
 
             StringBuffer result = new StringBuffer();
             for (ListElement e : list) {
@@ -784,13 +785,13 @@ public String toString() {
                         result.append(e.sValue);
                         break;
                     case 1:
-                        result.append(mars.venus.NumberDisplayBaseChooser.formatNumber(e.iValue, addressBase));
+                        result.append(NumberDisplayBaseChooser.formatNumber(e.iValue, addressBase));
                         break;
                     case 2:
-                        if (valueBase == mars.venus.NumberDisplayBaseChooser.HEXADECIMAL) {
-                            result.append(mars.util.Binary.intToHexString(e.iValue)); // 13-July-2011, was: intToHalfHexString()
+                        if (valueBase == NumberDisplayBaseChooser.HEXADECIMAL) {
+                            result.append(rars.util.Binary.intToHexString(e.iValue)); // 13-July-2011, was: intToHalfHexString()
                         } else {
-                            result.append(mars.venus.NumberDisplayBaseChooser.formatNumber(e.iValue, valueBase));
+                            result.append(NumberDisplayBaseChooser.formatNumber(e.iValue, valueBase));
                         }
                     default:
                         break;

mars/ProgramStatement.java rars/ProgramStatement.java

@@ -1,9 +1,9 @@
-package mars;
+package rars;
 
-import mars.assembler.*;
-import mars.riscv.hardware.RegisterFile;
-import mars.simulator.BackStepper;
-import mars.simulator.Simulator;
+import rars.assembler.*;
+import rars.riscv.hardware.RegisterFile;
+import rars.simulator.BackStepper;
+import rars.simulator.Simulator;
 
 import java.io.BufferedReader;
 import java.io.FileReader;

mars/RISCVprogram.java rars/RISCVprogram.java

@@ -1,9 +1,9 @@
-package mars;
+package rars;
 
-import mars.util.Binary;
-import mars.util.EditorFont;
-import mars.venus.editors.jeditsyntax.SyntaxStyle;
-import mars.venus.editors.jeditsyntax.SyntaxUtilities;
+import rars.util.Binary;
+import rars.util.EditorFont;
+import rars.venus.editors.jeditsyntax.SyntaxStyle;
+import rars.venus.editors.jeditsyntax.SyntaxUtilities;
 
 import java.awt.*;
 import java.util.HashMap;
@@ -53,7 +53,7 @@ a copy of this software and associated documentation files (the
  * <p>
  * Actual implementation of the Preference objects is platform-dependent.
  * For Windows, they are stored in Registry.  To see, run regedit and browse to:
- * HKEY_CURRENT_USER\Software\JavaSoft\Prefs\mars
+ * HKEY_CURRENT_USER\Software\JavaSoft\Prefs\rars
  *
  * @author Pete Sanderson
  **/
@@ -381,7 +381,7 @@ public Settings(boolean gui) {
         colorSettingsValues = new String[colorSettingsKeys.length];
         // This determines where the values are actually stored.  Actual implementation
         // is platform-dependent.  For Windows, they are stored in Registry.  To see,
-        // run regedit and browse to: HKEY_CURRENT_USER\Software\JavaSoft\Prefs\mars
+        // run regedit and browse to: HKEY_CURRENT_USER\Software\JavaSoft\Prefs\rars
         preferences = Preferences.userNodeForPackage(this.getClass());
         // The gui parameter, formerly passed to initialize(), is no longer needed
         // because I removed (1/21/09) the call to generate the Font object for the text editor.
@@ -423,7 +423,7 @@ public void reset(boolean gui) {
 
     The fallback defaults will come not from an array here, but from the
     existing static method SyntaxUtilities.getDefaultSyntaxStyles()
-    in the mars.venus.editors.jeditsyntax package.  It returns an array
+    in the rars.venus.editors.jeditsyntax package.  It returns an array
     of SyntaxStyle objects.
 
     */

mars/Settings.java rars/Settings.java

@@ -1,9 +1,9 @@
-package mars;
+package rars;
 
-import mars.riscv.hardware.AddressErrorException;
-import mars.riscv.hardware.RegisterFile;
-import mars.riscv.Instruction;
-import mars.util.Binary;
+import rars.riscv.hardware.AddressErrorException;
+import rars.riscv.hardware.RegisterFile;
+import rars.riscv.Instruction;
+import rars.util.Binary;
 
 /**
  * For exceptions thrown during runtime