com.github.croesch.micro_debug.mic1.api.IReadableMemory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micro-debug Show documentation

A debugger for (micro-)assembler-programs for the Mic-1.

The newest version!

/*
 * Copyright (C) 2011-2012  Christian Roesch
 * 
 * This file is part of micro-debug.
 * 
 * micro-debug is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * micro-debug is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with micro-debug.  If not, see .
 */
package com.github.croesch.micro_debug.mic1.api;

/**
 * Represents the memory that exports only read access.
 * 
 * @author croesch
 * @since Date: Feb 3, 2012
 */
public interface IReadableMemory {

  /**
   * Returns the word value at the given address.
   * 
   * @since Date: Jan 21, 2012
   * @param addr the address, from where to fetch the word
   * @return the word value read from the memory
   */
  int getWord(final int addr);

  /**
   * Returns a single byte, unsigned, read from the address in the memory.
   * 
   * @since Date: Jan 22, 2012
   * @param addr the byte address of the byte to read from the memory
   * @return the byte from the memory at the given address.
   */
  int getByte(final int addr);

  /**
   * Returns the size of the memory.
   * 
   * @since Date: Feb 9, 2012
   * @return the size of the memory in words
   */
  int getSize();
}