Word.java

/*
 *  This file is part of the Jikes RVM project (http://jikesrvm.org).
 *
 *  This file is licensed to You under the Common Public License (CPL);
 *  You may not use this file except in compliance with the License. You
 *  may obtain a copy of the License at
 *
 *      http://www.opensource.org/licenses/cpl1.0.php
 *
 *  See the COPYRIGHT.txt file distributed with this work for information
 *  regarding copyright ownership.
 */
 
package org.vmmagic.unboxed;

import org.jnode.annotation.KernelSpace;
import org.jnode.annotation.Uninterruptible;

/**
 * <p/>
 * <u>JNode specific notes</u> : This class contains some "magic"
 * methods that are interpreted by the VM itself, instead of being executed
 * as normal java methods.  <b>The actual method bodies are never used</b>.
 * See {@link org.jnode.vm.classmgr.VmType VmType} to get the list of "magic" classes
 * and see {@link org.jnode.vm.compiler.BaseMagicHelper.MagicMethod MagicMethod}
 * to get the list of "magic" methods
 * @author Ewout Prangsma (epr@users.sourceforge.net)
 * @author Daniel Frampton
 * @see Address
 */
public final class Word implements UnboxedObject {

    final long v;
    
    /**
     * Constructor used during the bootimage creation.
     * @param v
     */
    Word(long v) {
        this.v = v;
    }

    /**
     * @deprecated
     */
    public static Word fromInt(int val) {
        return new Word(val);
    }

    @Uninterruptible
    public static Word fromIntSignExtend(int val) {
        return new Word(val);
    }

    @Uninterruptible
    public static Word fromIntZeroExtend(int val) {
        return new Word(0xFFFFFFFFL & val);
    }

    /**
     * Size of an address in bytes (typically 4 or 8)
     * @return the size in bytes
     */
    @Uninterruptible
    public static int size() {
        throw new RuntimeException("Not supported at buildtime");
    }

    @Uninterruptible
    public static Word zero() {
        return new Word(0);
    }

    @KernelSpace
    @Uninterruptible
    public static Word one() {
        return new Word(1);
    }

    @Uninterruptible
    public static Word max() {
        return new Word(0xFFFFFFFFFFFFFFFFL);
    }

    @Uninterruptible
    public int toInt() {
        return (int)v;
    }

    @Uninterruptible
    public long toLong() {
        return v;
    }

    @Uninterruptible
    public Address toAddress() {
        return new Address(v);
    }

    @Uninterruptible
    public Offset toOffset() {
        return new Offset(v);
    }

    @Uninterruptible
    public Extent toExtent() {
        return new Extent(v);
    }

    @Uninterruptible
    public Word add(int w2) {
        return new Word(this.v + w2);
    }

    @KernelSpace
    @Uninterruptible
    public Word add(Word w2) {
        return new Word(this.v + w2.v);
    }

    @Uninterruptible
    public Word add(Offset w2) {
        return new Word(this.v + w2.v);
    }

    @Uninterruptible
    public Word add(Extent w2) {
        return new Word(this.v + w2.v);
    }

    @Uninterruptible
    public Word sub(int w2) {
        return new Word(this.v - w2);
    }

    @KernelSpace
    @Uninterruptible
    public Word sub(Word w2) {
        return new Word(this.v - w2.v);
    }

    @Uninterruptible
    public Word sub(Offset w2) {
        return new Word(this.v - w2.v);
    }

    @Uninterruptible
    public Word sub(Extent w2) {
        return new Word(this.v - w2.v);
    }

    @KernelSpace
    @Uninterruptible
    public boolean isZero() {
        return EQ(zero());
    }

    @Uninterruptible
    public boolean isMax() {
        return EQ(max());
    }

    @Uninterruptible
    public boolean LT(Word w2) {
        if (this.v >= 0 && w2.v >= 0) return (this.v < w2.v);
        if (this.v < 0 && w2.v < 0) return (this.v < w2.v);
        if (this.v < 0) return true;
        return false;
    }

    @Uninterruptible
    public boolean LE(Word w2) {
        return (this.v == w2.v) || LT(w2);
    }

    @Uninterruptible
    public boolean GT(Word w2) {
        return w2.LT(this);
    }

    @Uninterruptible
    public boolean GE(Word w2) {
        return w2.LE(this);
    }

    @Uninterruptible
    public boolean EQ(Word w2) {
        return (this.v == w2.v);
    }

    @Uninterruptible
    public boolean NE(Word w2) {
        return !EQ(w2);
    }

    @Uninterruptible
    public Word and(Word w2) {
        return new Word(this.v & w2.v);
    }

    @Uninterruptible
    public Word or(Word w2) {
        return new Word(this.v | w2.v);
    }

    @Uninterruptible
    public Word not() {
        return new Word(~this.v);
    }

    @Uninterruptible
    public Word xor(Word w2) {
        return new Word(this.v ^ w2.v);
    }

    @Uninterruptible
    public Word lsh(int amt) {
        return new Word(this.v << amt);
    }

    @Uninterruptible
    public Word rshl(int amt) {
        return new Word(this.v >>> amt);
    }

    @Uninterruptible
    public Word rsha(int amt) {
        return new Word(this.v >> amt);
    }
}