package mars.mips.dump;

import mars.Globals;
import mars.mips.hardware.AddressErrorException;
import mars.mips.hardware.Memory;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.PrintStream;
/*
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)
 */

/**
 * Class that represents the "binary" memory dump format.  The output is a binary file containing the memory words as a
 * byte stream.  Output is produced using PrintStream's write() method.
 *
 * @author Pete Sanderson
 * @version December 2007
 */


public class BinaryDumpFormat extends AbstractDumpFormat
{

    /**
     * Constructor.  There is no standard file extension for this format.
     */
    public BinaryDumpFormat()
    {
        super("Binary", "Binary", "Written as byte stream to binary file", null);
    }


    /**
     * Write MIPS memory contents in pure binary format.  One byte at a time using PrintStream's write() method.
     * Adapted by Pete Sanderson from code written by Greg Gibeling.
     *
     * @param file File in which to store MIPS memory contents.
     * @param firstAddress first (lowest) memory address to dump.  In bytes but must be on word boundary.
     * @param lastAddress last (highest) memory address to dump.  In bytes but must be on word boundary.  Will dump
     *     the word that starts at this address.
     * @throws AddressErrorException if firstAddress is invalid or not on a word boundary.
     * @throws IOException if error occurs during file output.
     */
    public void dumpMemoryRange(File file, int firstAddress, int lastAddress)
        throws AddressErrorException, IOException
    {
        PrintStream out = new PrintStream(new FileOutputStream(file));
        try
        {
            for (int address = firstAddress; address <= lastAddress; address += Memory.WORD_LENGTH_BYTES)
            {
                Integer temp = Globals.memory.getRawWordOrNull(address);
                if (temp == null)
                {
                    break;
                }
                int word = temp.intValue();
                for (int i = 0; i < 4; i++)
                {
                    out.write((word >>> (i << 3)) & 0xFF);
                }
            }
        }
        finally
        {
            out.close();
        }
    }

}
