field.h

Go to the documentation of this file.

#ifndef __FIELD_H__
#define __FIELD_H__

/*
 * field.h - simple field manipulation functions to get students working
 *           with masking. This will be used in the simulator to extract
 *           information when executing an LC3 instruction. It may also be
 *           used in the assembler to "create" the 16 bit LC3 instructions.
 *           If an assignment involving floating point manipulation (e.g.
 *           16 bit floating point addition), this file can be used to
 *           provide support routines for extracting/setting the sign,
 *           exponent, and mantissa fields.
 *
 * "Copyright (c) 2013 by Fritz Sieker."
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation for any purpose, without fee, and without written
 * agreement is hereby granted, provided that the above copyright notice
 * and the following two paragraphs appear in all copies of this software,
 * that the files COPYING and NO_WARRANTY are included verbatim with
 * any distribution, and that the contents of the file README are included
 * verbatim as part of a file named README with any distribution.
 *
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
 * OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE AUTHOR
 * HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * THE AUTHOR SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS"
 * BASIS, AND THE AUTHOR NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
 * UPDATES, ENHANCEMENTS, OR MODIFICATIONS."
 */

#include <stdbool.h>

int getBit (int value, int position);

int setBit (int value, int position);

int clearBit (int value, int position);

int getField (int value, int hi, int lo, bool isSigned);

int setField (int oldValue, int hi, int lo, int newValue);

int fieldFits (int value, int width, bool isSigned);

#endif