path: root/sources/scalac/backend/jvm/GenJVM.java

/*     ____ ____  ____ ____  ______                                     *\
**    / __// __ \/ __// __ \/ ____/    SOcos COmpiles Scala             **
**  __\_ \/ /_/ / /__/ /_/ /\_ \       (c) 2002, LAMP/EPFL              **
** /_____/\____/\___/\____/____/                                        **
\*                                                                      */

// $Id$

package scalac.backend.jvm;

import java.io.*;
import java.nio.ByteBuffer;
import java.util.*;

import ch.epfl.lamp.fjbg.*;
import ch.epfl.lamp.util.Pair;

import scala.tools.util.Position;

import scalac.*;
import scalac.ast.Tree;
import scalac.atree.AConstant;
import scalac.backend.*;
import scalac.symtab.*;
import scalac.symtab.classfile.ClassfileConstants;
import scalac.symtab.classfile.Pickle;
import scalac.transformer.*;
import scalac.util.*;


/* Several things which are done here should in fact be done in
 * previous phases, namely:
 *
 *   - code linearisation (i.e. representation of code as a list of
 *     instructions),
 *
 *   - removal of implicit "this" selection,
 *
 *   - removal of implicit "unit" values,
 *
 *   - removal of implicit conversion,
 *
 *   - removal of "if"s without explicit "else" part,
 *
 *   - expansion of "==",
 *
 *   - introduction of a special primitive for string concatenation,
 *
 *   - initialisation of module instance variable.
 */

/**
 * Backend generating JVM byte-codes.
 *
 * @version 2.0
 * @author Michel Schinz
 */

class GenJVM {
    protected final static String JAVA_LANG_OBJECT = "java.lang.Object";
    protected final static String JAVA_LANG_STRING = "java.lang.String";
    protected final static String JAVA_LANG_STRINGBUFFER = "java.lang.StringBuffer";
    protected final static String JAVA_RMI_REMOTE = "java.rmi.Remote";
    protected final static String JAVA_RMI_REMOTEEXCEPTION = "java.rmi.RemoteException";

    protected final static String SCALA_RUNTIME_RUNTIME = "scala.runtime.RunTime";
    protected final static String SCALA_UNIT = "scala.Unit";
    protected final static String SCALA_UNIT_VALUE = "UNIT_VAL";

    protected final static String SCALA_ATTR = ClassfileConstants.SCALA_N.toString();

    protected final static String MODULE_INSTANCE_FIELD_NAME = "MODULE$";

    protected final static String CONSTRUCTOR_STRING =
        "<init>";               // TODO get it from FJBG

    protected final JObjectType JAVA_LANG_OBJECT_T =
        new JObjectType(JAVA_LANG_OBJECT);
    protected final JObjectType JAVA_LANG_STRING_T =
        new JObjectType(JAVA_LANG_STRING);
    protected final JObjectType JAVA_LANG_STRINGBUFFER_T =
        new JObjectType (JAVA_LANG_STRINGBUFFER);
    protected final JObjectType JAVA_LANG_THROWABLE_T =
        new JObjectType("java.lang.Throwable");
    protected final JObjectType SCALA_UNIT_T =
        new JObjectType(SCALA_UNIT);

    protected final Symbol JAVA_RMI_REMOTE_CLASS;

    protected final Global global;
    protected final Definitions defs;
    protected final Primitives prims;

    protected final Phase refCheckPhase;
    protected final AddInterfacesPhase addInterfacesPhase;

    protected final FJBGContext fjbgContext;

    public GenJVM(Global global) {
        this.global = global;
        this.defs = global.definitions;
        this.prims = global.primitives;

        this.refCheckPhase = global.PHASE.REFCHECK.phase();
        this.addInterfacesPhase =
            (AddInterfacesPhase)global.PHASE.ADDINTERFACES.phase();

        this.fjbgContext = new FJBGContext();

        initTypeMap();
        initArithPrimMap();

        JAVA_RMI_REMOTE_CLASS = defs.getClass(JAVA_RMI_REMOTE);
    }

    /// Code generation
    //////////////////////////////////////////////////////////////////////

    /**
     * Generate code for the given unit.
     */
    public void translate(Unit unit) {
        try {
            for (int i = 0; i < unit.body.length; ++i)
                gen(Context.EMPTY.withSourceFileName(unit.source.getFile().getName()),
                    unit.body[i]);
        } catch (JCode.OffsetTooBigException e) {
            throw global.fail(e);
        }
    }

    /**
     * Generate code to perform the side effects associated with the
     * given tree (i.e. no value should remain on the stack
     * afterwards).
     */
    protected void gen(Context ctx, Tree tree) throws JCode.OffsetTooBigException {
        startCodeForTree(ctx, tree);

        Symbol sym = tree.symbol();

        switch (tree) {
        case PackageDef(_, Tree.Template impl):
            gen(ctx, impl);
            break;

        case ClassDef(_, _, _, _, _, Tree.Template impl) : {
            Tree.ClassDef classDef = (Tree.ClassDef)tree;

            Context ctx1 = enterClass(ctx, sym);

            addValueClassMembers(ctx1, classDef);
            addStaticClassMembers(ctx1, classDef);
            if (ctx1.isModuleClass)
                addModuleInstanceField(ctx1);

            JMethod clinit = getClassConstructorMethod(ctx1, false);
            if (clinit != null)
                clinit.getCode().emitRETURN();

            gen(ctx1, impl);
            leaveClass(ctx1, sym);
        } break;

        case Template(_, Tree[] body):
            gen(ctx, body);
            break;

        case ValDef(_, Name name, _, Tree rhs): {
            if (ctx.method == null)
                break;          // ignore ValDefs in classes, handled elsewhere

            JType valType = typeStoJ(sym.info());
            JLocalVariable var =
                ctx.method.addNewLocalVariable(valType, name.toString());
            ctx.locals.put(sym, new Integer(var.getIndex()));

            assert (rhs != Tree.Empty) : Debug.show(sym);
            genLoad(ctx, rhs, valType);
            ctx.code.emitSTORE(var);
        } break;

        case DefDef(_, _, _, _, _, Tree rhs): {
            Tree.DefDef defDef = (Tree.DefDef)tree;
            boolean retry = false;
            do {
                Context ctx1 = enterMethod(ctx, defDef, retry);
                try {
                    if (! Modifiers.Helper.isAbstract(sym.flags)) {
                        JType retType = ctx1.method.getReturnType();
                        genLoad(ctx1, rhs, retType);
                        ctx1.code.emitRETURN(retType);
                        ctx1.method.freeze();
                    }
                    leaveMethod(ctx1);
                    break;
                } catch (JCode.OffsetTooBigException e) {
                    ctx1.clazz.removeMethod(ctx1.method);
                    assert !retry;
                    retry = true;
                }
            } while (retry);
        } break;

        case Return(Tree expr): {
            JType retType = ctx.method.getReturnType();
            genLoad(ctx, expr, retType);
            ctx.code.emitRETURN(retType);
        } break;

        case Typed(Tree expr, _):
            gen(ctx, expr);
            break;

        case Empty:
        case AbsTypeDef(_, _, _, _):
        case AliasTypeDef(_, _, _, _):
        case TypeApply(_, _):
        case FunType(_, _):
        case CompoundType(_, _):
        case AppliedType(_,_):
            break;

        default:
            genLoad(ctx, tree, JType.VOID);
        }

        endCodeForTree(ctx, tree);
    }

    protected void gen(Context ctx, Tree[] trees)
        throws JCode.OffsetTooBigException {
        for (int i = 0; i < trees.length; ++i)
            gen(ctx, trees[i]);
    }

    /**
     * Generate code to load the value of the given tree on the
     * stack, and make sure it is of the given expected type.
     */
    protected JType genLoad(Context ctx, Tree tree, JType expectedType)
        throws JCode.OffsetTooBigException {
        startCodeForTree(ctx, tree);

        JType generatedType = null;
        Symbol sym = tree.symbol();

        switch (tree) {
        case LabelDef(_, Tree.Ident[] params, Tree rhs): {
            JCode.Label label = ctx.code.newLabel();
            label.anchorToNext();
            ctx.labels.put(sym, new Pair(label, params));
            generatedType = genLoad(ctx, rhs, expectedType);
            ctx.labels.remove(sym);
        } break;

        case Block(Tree[] stats, Tree value): {
            int statsNum = stats.length;
            for (int i = 0; i < stats.length; ++i)
                gen(ctx, stats[i]);
            genLoad(ctx, value, expectedType);
            generatedType = expectedType;
        } break;

        case Typed(Tree expr, _):
            genLoad(ctx, expr, expectedType);
            generatedType = expectedType;
            break;

        case New(Tree init):
            String className = javaName(tree.type.symbol());
            ctx.code.emitNEW(className);
            ctx.code.emitDUP();
            gen(ctx, init);
            generatedType = new JObjectType(className);
            break;

        case Apply(TypeApply(Tree fun, Tree[] args), _): {
            genLoadQualifier(ctx, fun);

            JType type = typeStoJ(args[0].type);
            if (fun.symbol() == defs.ANY_IS) {
                ctx.code.emitINSTANCEOF((JReferenceType)type);
                generatedType = JType.BOOLEAN;
            } else if (fun.symbol() == defs.ANY_AS) {
                ctx.code.emitCHECKCAST((JReferenceType)type);
                generatedType = type;
            } else
                global.fail("unexpected type application");
        } break;

        case Apply(Tree fun, Tree[] args): {
            Symbol funSym = fun.symbol();

            if (funSym.isLabel()) {
                Pair/*<Label, Tree[]>*/ labelAndIdents =
                    (Pair)ctx.labels.get(funSym);
                assert labelAndIdents != null : Debug.show(funSym);
                JMethodType funType = (JMethodType)typeStoJ(funSym.info());

                JCode.Label label = (JCode.Label)labelAndIdents.fst;
                Tree[] idents = (Tree[])labelAndIdents.snd;
                assert idents.length == args.length;

                for (int i = 0; i < args.length; ++i)
                    genLoad(ctx, args[i], typeStoJ(args[i].type));
                for (int i = idents.length; i > 0; --i)
                    genStoreEpilogue(ctx, idents[i-1]);
                ctx.code.emitGOTO_maybe_W(label, ctx.useWideJumps);
                generatedType = funType.getReturnType();
            } else if (isKnownPrimitive(funSym)) {
                Primitive prim = prims.getPrimitive(funSym);

                switch (prim) {
                case CONCAT:
                    genStringConcatenation(ctx, liftStringConcatenations(tree));
                    generatedType = JAVA_LANG_STRING_T;
                    break;

                case POS: case NEG:
                case ADD: case SUB: case MUL: case DIV: case MOD:
                case NOT: case OR : case XOR: case AND:
                case LSL: case LSR: case ASR:
                    Tree[] allArgs = extractPrimitiveArgs((Tree.Apply)tree);
                    allArgs[0] = unbox(allArgs[0]);
                    JType resType = typeStoJ(tree.type);
                    genArithPrim(ctx, prim, allArgs, resType, expectedType);
                    generatedType = resType;
                    break;

                case ID:
                case EQ: case NE: case LT: case LE: case GE: case GT:
                case ZNOT: case ZOR: case ZAND:
                    JCode.Label falseLabel = ctx.code.newLabel();
                    JCode.Label afterLabel = ctx.code.newLabel();
                    genCond(ctx, tree, falseLabel, false);
                    ctx.code.emitICONST_1();
                    ctx.code.emitGOTO_maybe_W(afterLabel, ctx.useWideJumps);
                    falseLabel.anchorToNext();
                    ctx.code.emitICONST_0();
                    afterLabel.anchorToNext();
                    generatedType = JType.BOOLEAN;
                    break;

                case THROW:
                    assert args.length == 0;
                    genThrow(ctx, ((Tree.Select)fun).qualifier);
                    // We pretend that we generated something of the
                    // expected type, to avoid trying to generate
                    // bogus conversions.
                    generatedType = expectedType;
                    break;

                case SYNCHRONIZED: {
                    assert args.length == 1;
                    Tree qual = ((Tree.Select)fun).qualifier;
                    genSynchronized(ctx, qual, args[0], expectedType);
                    generatedType = expectedType;
                } break;

                case NEW_OARRAY: {
                    assert args.length == 2;
                    genRefArrayCreate(ctx, args[0], args[1]);
                    generatedType = expectedType;
                } break;

                case NEW_ZARRAY : case NEW_BARRAY : case NEW_SARRAY :
                case NEW_CARRAY : case NEW_IARRAY : case NEW_LARRAY :
                case NEW_FARRAY : case NEW_DARRAY :
                    assert args.length == 1;
                    genArrayCreate(ctx, prim, args[0]);
                    generatedType = JAVA_LANG_OBJECT_T; // TODO refine
                    break;

                case ZARRAY_SET : case BARRAY_SET : case SARRAY_SET :
                case CARRAY_SET : case IARRAY_SET : case LARRAY_SET :
                case FARRAY_SET : case DARRAY_SET : case OARRAY_SET :
                    assert args.length == 3;
                    genArrayUpdate(ctx, args[0], args[1], args[2]);
                    generatedType = JType.VOID;
                    break;

                case ZARRAY_GET : case BARRAY_GET : case SARRAY_GET :
                case CARRAY_GET : case IARRAY_GET : case LARRAY_GET :
                case FARRAY_GET : case DARRAY_GET : case OARRAY_GET :
                    assert args.length == 2 : "get - " + args.length;
                    genArrayAccess(ctx, args[0], args[1]);
                    generatedType = getArrayElementType(args[0]);
                    break;

                case ZARRAY_LENGTH : case BARRAY_LENGTH : case SARRAY_LENGTH :
                case CARRAY_LENGTH : case IARRAY_LENGTH : case LARRAY_LENGTH :
                case FARRAY_LENGTH : case DARRAY_LENGTH : case OARRAY_LENGTH :
                    assert args.length == 1 : args.length;
                    genArrayLength(ctx, args[0]);
                    generatedType = JType.INT;
                    break;

                case B2B: case B2S: case B2C: case B2I: case B2L: case B2F: case B2D:
                case S2B: case S2S: case S2C: case S2I: case S2L: case S2F: case S2D:
                case C2B: case C2S: case C2C: case C2I: case C2L: case C2F: case C2D:
                case I2B: case I2S: case I2C: case I2I: case I2L: case I2F: case I2D:
                case L2B: case L2S: case L2C: case L2I: case L2L: case L2F: case L2D:
                case F2B: case F2S: case F2C: case F2I: case F2L: case F2F: case F2D:
                case D2B: case D2S: case D2C: case D2I: case D2L: case D2F: case D2D:
                    assert args.length == 1 : args.length;
                    JType fromType = typeStoJ(args[0].type);
                    genLoad(ctx, args[0], fromType);
                    ctx.code.emitT2T(fromType, expectedType);
                    generatedType = expectedType;
                    break;

                default:
                    throw Debug.abort("unknown primitive ", prim);
                }
            } else {
                JMethodType funType = (JMethodType)typeStoJ(funSym.info());
                JType[] argTypes = funType.getArgumentTypes();

                boolean isConstrCall = funSym.isInitializer();
                boolean isSuperCall = false;
                switch (fun) {
                case Select(Super(_, _), _): isSuperCall = true;
                }

                boolean isStatic = isStaticMember(funSym);
                if (!isStatic)
                    genLoadQualifier(ctx, fun);
                for (int i = 0; i < args.length; ++i)
                    genLoad(ctx, args[i], argTypes[i]);

                String clsName = isSuperCall
                    ? ctx.clazz.getSuperclassName()
                    : javaName(funSym.owner());
                String mthName = funSym.name.toString();

                funSym.owner().info(); // [HACK] ensure that flags are
                                       // transformed.

                if (funSym.owner().isInterface())
                    ctx.code.emitINVOKEINTERFACE(clsName, mthName, funType);
                else {
                    if (isConstrCall || isSuperCall) {
                        ctx.code.emitINVOKESPECIAL(clsName, mthName, funType);
                        if (isConstrCall && isSuperCall && ctx.isModuleClass) {
                            // Initialise module instance field ASAP
                            ctx.code.emitALOAD_0();
                            ctx.code.emitPUTSTATIC(ctx.clazz.getName(),
                                                   MODULE_INSTANCE_FIELD_NAME,
                                                   ctx.clazz.getType());
                        }
                    } else if (isStatic)
                        ctx.code.emitINVOKESTATIC(clsName, mthName, funType);
                    else
                        ctx.code.emitINVOKEVIRTUAL(clsName, mthName, funType);
                }
                generatedType = funType.getReturnType();
            }
        } break;

        case Ident(_):
            JType type = typeStoJ(sym.info());
            if (sym.isModule()) {
                String javaSymName = javaName(sym.moduleClass());
                ctx.code.emitGETSTATIC(javaSymName,
                                       MODULE_INSTANCE_FIELD_NAME,
                                       type);
                generatedType = type;
            } else if (sym.owner().isClass()) {
                JType fieldType = typeStoJ(sym.info());
                String className = javaName(sym.owner());
                String fieldName = sym.name.toString();
                ctx.code.emitGETSTATIC(className, fieldName, fieldType);
                generatedType = type;
            } else {
                assert ctx.locals.containsKey(sym)
                    : Debug.show(sym) + " not in " + ctx.locals;
                int index = ((Integer)(ctx.locals.get(sym))).intValue();
                ctx.code.emitLOAD(index, type);
                generatedType = type;
            }
            break;

        case Select(Tree qualifier, _):
            JType fieldType = typeStoJ(sym.info());
            String className = javaName(sym.owner());
            String fieldName = sym.name.toString();
            genLoadQualifier(ctx, tree);
            ctx.code.emitGETFIELD(className, fieldName, fieldType);
            generatedType = fieldType;
            break;

        case Assign(Tree lhs, Tree rhs): {
            genStorePrologue(ctx, lhs);
            genLoad(ctx, rhs, typeStoJ(lhs.symbol().info()));
            genStoreEpilogue(ctx, lhs);
            generatedType = JType.VOID;
        } break;

        case If(Tree cond, Tree thenp, Tree elsep): {
            JType finalType = typeStoJ(tree.type);

            JCode.Label elseLabel = ctx.code.newLabel();
            genCond(ctx, cond, elseLabel, false);
            genLoad(ctx, thenp, finalType);
            JCode.Label afterLabel = ctx.code.newLabel();
            ctx.code.emitGOTO_maybe_W(afterLabel, ctx.useWideJumps);
            elseLabel.anchorToNext();
            if (elsep == Tree.Empty)
                maybeGenLoadUnit(ctx, finalType);
            else
                genLoad(ctx, elsep, finalType);
            afterLabel.anchorToNext();
            generatedType = finalType;
        } break;

        case Switch(Tree test, int[] tags, Tree[] bodies, Tree otherwise): {
            JCode.Label[] labels = ctx.code.newLabels(bodies.length);
            JCode.Label defaultLabel = ctx.code.newLabel();
            JCode.Label afterLabel = ctx.code.newLabel();

            genLoad(ctx, test, JType.INT);
            ctx.code.emitSWITCH(tags, labels, defaultLabel, 0.9);
            for (int i = 0; i < bodies.length; ++i) {
                labels[i].anchorToNext();
                genLoad(ctx, bodies[i], expectedType);
                ctx.code.emitGOTO_maybe_W(afterLabel, ctx.useWideJumps);
            }
            defaultLabel.anchorToNext();
            genLoad(ctx, otherwise, expectedType);
            afterLabel.anchorToNext();
            generatedType = expectedType;
        } break;

        case This(_):
        case Super(_, _):
            ctx.code.emitALOAD_0();
            generatedType = JAVA_LANG_OBJECT_T;
            break;

        case Literal(AConstant value):
            generatedType = genLoadLiteral(ctx, value, expectedType);
            break;

        case Empty:
        case AbsTypeDef(_, _, _, _):
        case AliasTypeDef(_, _, _, _):
        case TypeApply(_, _):
        case FunType(_, _):
        case CompoundType(_, _):
        case AppliedType(_,_):
            generatedType = JType.VOID;
            break;

        case Sequence(_):
        case ModuleDef(_,_,_,_):
        case PatDef(_,_,_):
        case Import(_, _):
        case CaseDef(_, _, _):
        case Visitor(_):
        case Function(_, _):
            throw global.fail("unexpected node", tree);
        default:
            throw global.fail("unknown node", tree);
        }

        // Pop unneeded result from stack, or widen it if needed.
        if (expectedType == JType.VOID && generatedType != JType.VOID) {
            if (generatedType == JType.LONG || generatedType == JType.DOUBLE)
                ctx.code.emitPOP2();
            else
                ctx.code.emitPOP();
        } else if (! (expectedType == JType.VOID
                      || generatedType == expectedType
                      || generatedType.isReferenceType()))
            ctx.code.emitT2T(generatedType, expectedType);

        endCodeForTree(ctx, tree);
        return expectedType;
    }

    /**
     * Generate code to load the qualifier of the given tree, which
     * can be implicitely "this".
     */
    protected void genLoadQualifier(Context ctx, Tree tree)
        throws JCode.OffsetTooBigException {
        switch (tree) {
        case Ident(_):
            break;
        case Select(Create(_, _), _):
            break;
        case Select(Tree qualifier, _):
            genLoad(ctx, qualifier, JAVA_LANG_OBJECT_T);
            break;
        default:
            throw global.fail("unknown qualifier");
        }
    }

    protected JType genLoadLiteral(Context ctx, AConstant lit, JType type) {
        switch (lit) {
        case UNIT:
            maybeGenLoadUnit(ctx, type);
            return type;
        case BOOLEAN(boolean value):
            ctx.code.emitPUSH(value);
            return JType.BOOLEAN;
        case BYTE(byte value):
            ctx.code.emitPUSH(value);
            return JType.BYTE;
        case SHORT(short value):
            ctx.code.emitPUSH(value);
            return JType.SHORT;
        case CHAR(char value):
            ctx.code.emitPUSH(value);
            return JType.CHAR;
        case INT(int value):
            ctx.code.emitPUSH(value);
            return JType.INT;
        case LONG(long value):
            ctx.code.emitPUSH(value);
            return JType.LONG;
        case FLOAT(float value):
            ctx.code.emitPUSH(value);
            return JType.FLOAT;
        case DOUBLE(double value):
            ctx.code.emitPUSH(value);
            return JType.DOUBLE;
        case STRING(String value):
            ctx.code.emitPUSH(value);
            return JAVA_LANG_STRING_T;
        case NULL:
            if (type != JType.VOID) ctx.code.emitACONST_NULL();
            return type;
        default:
            throw Debug.abort("unknown literal", lit);
        }
    }

    /**
     * Generate code to load the Unit value, iff the given type is an
     * object type (i.e. something really has to be loaded on stack).
     */
    protected void maybeGenLoadUnit(Context ctx, JType type) {
        if (type != JType.VOID)
            ctx.code.emitGETSTATIC(SCALA_RUNTIME_RUNTIME,
                                   SCALA_UNIT_VALUE,
                                   SCALA_UNIT_T);
    }

    /**
     * Generate code to prepare the storage of a value in the location
     * represented by the tree.
     */
    protected void genStorePrologue(Context ctx, Tree tree)
        throws JCode.OffsetTooBigException {
        genLoadQualifier(ctx, tree);
    }

    /**
     * Generate code to perform the storage of the value on top of
     * stack in the location represented by the tree.
     */
    protected void genStoreEpilogue(Context ctx, Tree tree) {
        Symbol sym = tree.symbol();
        if (sym.owner().isClass()) {
            String ownerName = javaName(sym.owner());
            if (isStaticMember(sym))
                ctx.code.emitPUTSTATIC(ownerName,
                                       sym.name.toString(),
                                       typeStoJ(sym.info()));
            else
                ctx.code.emitPUTFIELD(ownerName,
                                      sym.name.toString(),
                                      typeStoJ(sym.info()));
        } else {
            assert ctx.locals.containsKey(sym)
                : Debug.show(sym) + " not in " + ctx.locals;
            int index = ((Integer)(ctx.locals.get(sym))).intValue();
            ctx.code.emitSTORE(index, typeStoJ(sym.info()));
        }
    }

    /**
     * Generate code to evaluate the condition associated with the
     * given tree and jump to the target when the condition is equal
     * to the given value.
     */
    protected void genCond(Context ctx,
                           Tree tree,
                           JCode.Label target,
                           boolean when)
        throws JCode.OffsetTooBigException {
        switch (tree) {
        case Apply(Tree fun, Tree[] args):
            if (isKnownPrimitive(fun.symbol())) {
                Primitive prim = prims.getPrimitive(fun.symbol());
                Tree[] allArgs = extractPrimitiveArgs((Tree.Apply)tree);

                switch (prim) {
                case ID: case EQ: case NE:
                    assert allArgs.length == 2;
                    Tree unbox1 = unbox(allArgs[0]);
                    Tree unbox2 = unbox(allArgs[1]);
                    if (!getMaxType(unbox1, unbox2).isReferenceType()) {
                        allArgs[0] = unbox1;
                        allArgs[1] = unbox2;
                        genCompPrim(ctx, prim, allArgs, target, when);
                    } else {
                        genEqPrim(ctx, prim, allArgs, target, when);
                    }
                    return;

                case LT: case LE: case GE: case GT:
                    assert allArgs.length == 2;
                    allArgs[0] = unbox(allArgs[0]);
                    genCompPrim(ctx, prim, allArgs, target, when);
                    return;

                case ZNOT:
                    assert allArgs.length == 1;
                    genCond(ctx, unbox(allArgs[0]), target, !when);
                    return;

                case ZOR:
                case ZAND:
                    if (when ^ (prim == Primitive.ZAND)) {
                        // x || y jump if true  -or-  x && y jump if false
                        genCond(ctx, unbox(allArgs[0]), target, when);
                        genCond(ctx, allArgs[1], target, when);
                    } else {
                        // x || y jump if false  -or-  x && y jump if true
                        JCode.Label afterLabel = ctx.code.newLabel();
                        genCond(ctx, unbox(allArgs[0]), afterLabel, !when);
                        genCond(ctx, allArgs[1], target, when);
                        afterLabel.anchorToNext();
                    }
                    return;
                }
            }
        }
        // Default case: the condition is not a comparison or logical
        // primitive.
        genLoad(ctx, tree, JType.BOOLEAN);
        if (when)
            ctx.code.emitIFNE(target);
        else
            ctx.code.emitIFEQ(target);
    }

    protected Map/*<Primitive, Instruction>*/ arithPrimMap;
    protected void addPrim(Primitive prim,
                           JOpcode z,
                           JOpcode i,
                           JOpcode l,
                           JOpcode f,
                           JOpcode d) {
        arithPrimMap.put(prim, new JOpcode[] { z, i, l, f, d });
    }

    protected void initArithPrimMap() {
        arithPrimMap = new HashMap();
        /* boolean, int & al., long, float, double */
        addPrim(Primitive.ADD,
                null, JOpcode.IADD, JOpcode.LADD, JOpcode.FADD, JOpcode.DADD);
        addPrim(Primitive.SUB,
                null, JOpcode.ISUB, JOpcode.LSUB, JOpcode.FSUB, JOpcode.DSUB);
        addPrim(Primitive.MUL,
                null, JOpcode.IMUL, JOpcode.LMUL, JOpcode.FMUL, JOpcode.DMUL);
        addPrim(Primitive.DIV,
                null, JOpcode.IDIV, JOpcode.LDIV, JOpcode.FDIV, JOpcode.DDIV);
        addPrim(Primitive.MOD,
                null, JOpcode.IREM, JOpcode.LREM, JOpcode.FREM, JOpcode.DREM);
        addPrim(Primitive.AND,
                JOpcode.IAND, JOpcode.IAND, JOpcode.LAND, null, null);
        addPrim(Primitive.OR,
                JOpcode.IOR, JOpcode.IOR, JOpcode.LOR, null, null);
        addPrim(Primitive.XOR,
                JOpcode.IXOR, JOpcode.IXOR, JOpcode.LXOR, null, null);
        addPrim(Primitive.LSL,
                null, JOpcode.ISHL, JOpcode.LSHL, null, null);
        addPrim(Primitive.LSR,
                null, JOpcode.IUSHR, JOpcode.LUSHR, null, null);
        addPrim(Primitive.ASR,
                null, JOpcode.ISHR, JOpcode.LSHR, null, null);
        addPrim(Primitive.POS,
                null, null, null, null, null);
        addPrim(Primitive.NEG,
                null, JOpcode.INEG, JOpcode.LNEG, JOpcode.FNEG, JOpcode.DNEG);
    }

    /**
     * Generate code for the given arithmetic primitive, applied on
     * the given arguments.
     */
    protected void genArithPrim(Context ctx,
                                Primitive prim,
                                Tree[] args,
                                JType resType,
                                JType expectedType)
        throws JCode.OffsetTooBigException {
        int arity = args.length;
        int resTypeIdx = getTypeIndex(resType);

        if ((prim == Primitive.LSL)
            || (prim == Primitive.LSR)
            || (prim == Primitive.ASR)) {
            genLoad(ctx, args[0], resType);
            genLoad(ctx, args[1], JType.INT);
        } else {
            for (int i = 0; i < arity; ++i)
            	genLoad(ctx, args[i], resType);
        }

        if (prim == Primitive.NOT) {
            if (resType == JType.LONG) {
                ctx.code.emitPUSH(-1L);
                ctx.code.emitLXOR();
            } else {
                assert resType == JType.INT;
                ctx.code.emitPUSH(-1);
                ctx.code.emitIXOR();
            }
        } else {
            assert arithPrimMap.containsKey(prim);
            JOpcode primInst = ((JOpcode[])arithPrimMap.get(prim))[resTypeIdx];
            if (primInst != null)
                ctx.code.emit(primInst);
        }
    }

    /** Variable in which temporary objects are stored by the
     * implementation of == */
    protected JLocalVariable eqEqTempVar;

    /**
     * Generate code for the given equality primitive, applied on the
     * given arguments.
     */
    protected void genEqPrim(Context ctx,
                             Primitive prim,
                             Tree[] args,
                             JCode.Label target,
                             boolean when)
        throws JCode.OffsetTooBigException {
        JType maxType = getMaxType(args);
        assert maxType.isReferenceType(): args[0]+" - "+args[1]+" : "+maxType;
        // Generate code for all arguments
        for (int i = 0; i < args.length; ++i) genLoad(ctx, args[i], maxType);

        if (prim == Primitive.ID) {
            if (when) ctx.code.emitIF_ACMPEQ(target);
            else ctx.code.emitIF_ACMPNE(target);
        } else {
            // Comparison between two references. We inline the code
            // for the predefined (and final) "=="/"!=" operators,
            // which check for null values and then forward the call
            // to "equals". "==" could be defined as follows, if
            // "null" was an object:
            //   final def ==(other: Any): boolean =
            //     if (this == null) other == null else this.equals(other)
            assert prim == Primitive.EQ || prim == Primitive.NE;

            if (eqEqTempVar == null || eqEqTempVar.getOwner() != ctx.method)
                eqEqTempVar =
                    ctx.method.addNewLocalVariable(JObjectType.JAVA_LANG_OBJECT,
                                                   "eqEqTemp$");

            ctx.code.emitSTORE(eqEqTempVar);
            ctx.code.emitDUP();
            JCode.Label ifNonNullLabel = ctx.code.newLabel();
            ctx.code.emitIFNONNULL(ifNonNullLabel);
            ctx.code.emitPOP();
            ctx.code.emitLOAD(eqEqTempVar);
            if (when ^ (prim != Primitive.EQ))
                ctx.code.emitIFNULL(target);
            else
                ctx.code.emitIFNONNULL(target);
            JCode.Label afterLabel = ctx.code.newLabel();
            ctx.code.emitGOTO_maybe_W(afterLabel, ctx.useWideJumps);
            ifNonNullLabel.anchorToNext();
            ctx.code.emitLOAD(eqEqTempVar);
            JMethodType equalsType =
                new JMethodType(JType.BOOLEAN,
                                new JType[] { JObjectType.JAVA_LANG_OBJECT });
            ctx.code.emitINVOKEVIRTUAL(JAVA_LANG_OBJECT, "equals", equalsType);
            if (when ^ (prim != Primitive.EQ))
                ctx.code.emitIFNE(target);
            else
                ctx.code.emitIFEQ(target);
            afterLabel.anchorToNext();
        }
    }

    /**
     * Generate code for the given comparison primitive, applied on
     * the given arguments.
     */
    protected void genCompPrim(Context ctx,
                               Primitive prim,
                               Tree[] args,
                               JCode.Label target,
                               boolean when)
        throws JCode.OffsetTooBigException {
        JType maxType = getMaxType(args);
        assert !maxType.isReferenceType(): args[0]+" - "+args[1]+" : "+maxType;
        int maxTypeIdx = getTypeIndex(maxType);
        int intTypeIdx = getTypeIndex(JType.INT);
        boolean intCompareWithZero = false;
        // Generate code for all arguments, while detecting
        // comparisons with 0, which can be optimised.
        for (int i = 0; i < args.length; ++i) {
            boolean isIntZero = false;
            if (maxTypeIdx <= intTypeIdx) {
                switch (args[i]) {
                case Literal(AConstant constant):
                    int intVal;
                    switch (constant) {
                    case BOOLEAN(boolean value):
                        intVal = value ? 1 : 0;
                        break;
                    case BYTE(byte value):
                        intVal = value;
                        break;
                    case SHORT(short value):
                        intVal = value;
                        break;
                    case CHAR(char value):
                        intVal = value;
                        break;
                    case INT(int value):
                        intVal = value;
                        break;
                    default:
                        throw Debug.abort("unknown literal", constant);
                    }
                    if (intVal == 0) {
                        isIntZero = true;
                        if (i == 0) prim = prim.swap();
                    }
                }
            }
            if (intCompareWithZero || !isIntZero)
                genLoad(ctx, args[i], maxType);
            intCompareWithZero |= isIntZero;
        }

        if (maxTypeIdx <= intTypeIdx && !intCompareWithZero) {
            // Comparison between ints, no zeros involved
            switch (maybeNegatedPrim(prim, !when)) {
            case LT: ctx.code.emitIF_ICMPLT(target); break;
            case LE: ctx.code.emitIF_ICMPLE(target); break;
            case EQ: ctx.code.emitIF_ICMPEQ(target); break;
            case NE: ctx.code.emitIF_ICMPNE(target); break;
            case GE: ctx.code.emitIF_ICMPGE(target); break;
            case GT: ctx.code.emitIF_ICMPGT(target); break;
            default: throw global.fail("unknown primitive " + prim);
            }
        } else {
            // Comparison between longs, floats or double, or between
            // one int and zero.
            switch (maxType.getTag()) {
            case JType.T_LONG:   ctx.code.emitLCMP();  break;
            case JType.T_FLOAT:  ctx.code.emitFCMPG(); break;
            case JType.T_DOUBLE: ctx.code.emitDCMPG(); break;
            default:
                ;               // do nothing (int comparison with 0)
            }
            switch (maybeNegatedPrim(prim, !when)) {
            case LT: ctx.code.emitIFLT(target); break;
            case LE: ctx.code.emitIFLE(target); break;
            case EQ: ctx.code.emitIFEQ(target); break;
            case NE: ctx.code.emitIFNE(target); break;
            case GE: ctx.code.emitIFGE(target); break;
            case GT: ctx.code.emitIFGT(target); break;
            default: throw global.fail("unknown primitive " + prim);
            }
        }
    }

    /**
     * Generate code to throw the value returned by the argument.
     */
    protected void genThrow(Context ctx, Tree arg)
        throws JCode.OffsetTooBigException {
        genLoad(ctx, arg, JAVA_LANG_OBJECT_T);
        ctx.code.emitCHECKCAST(JAVA_LANG_THROWABLE_T);
        ctx.code.emitATHROW();
    }

    /**
     * Generate code to synchronise on the object and evaluate the
     * code fragment.
     */
    protected void genSynchronized(Context ctx,
                                   Tree object,
                                   Tree code,
                                   JType expectedType)
        throws JCode.OffsetTooBigException {
        JLocalVariable monitorVar =
            ctx.method.addNewLocalVariable(JAVA_LANG_OBJECT_T, "monitor");
        genLoad(ctx, object, JAVA_LANG_OBJECT_T);
        ctx.code.emitSTORE(monitorVar);
        ctx.code.emitLOAD(monitorVar);
        ctx.code.emitMONITORENTER();
        int startPC = ctx.code.getPC();
        genLoad(ctx, code, expectedType);
        int endPC = ctx.code.getPC();
        ctx.code.emitLOAD(monitorVar);
        ctx.code.emitMONITOREXIT();

        JCode.Label afterLabel = ctx.code.newLabel();
        ctx.code.emitGOTO(afterLabel);
        int handlerPC = ctx.code.getPC();
        ctx.code.emitLOAD(monitorVar);
        ctx.code.emitMONITOREXIT();
        ctx.code.emitATHROW();
        afterLabel.anchorToNext();

        ctx.code.addFinallyHandler(startPC, endPC, handlerPC);
    }

    /// Arrays
    //////////////////////////////////////////////////////////////////////

    /**
     * Generate code to create an array of some basic type, whose size
     * will be dynamically computed.
     */
    protected void genArrayCreate(Context ctx, Primitive prim, Tree size)
        throws JCode.OffsetTooBigException {
        genLoad(ctx, size, JType.INT);
        JType type;
        switch (prim) {
        case NEW_ZARRAY : type = JType.BOOLEAN; break;
        case NEW_BARRAY : type = JType.BYTE;    break;
        case NEW_SARRAY : type = JType.SHORT;   break;
        case NEW_CARRAY : type = JType.CHAR;    break;
        case NEW_IARRAY : type = JType.INT;     break;
        case NEW_LARRAY : type = JType.LONG;    break;
        case NEW_FARRAY : type = JType.FLOAT;   break;
        case NEW_DARRAY : type = JType.DOUBLE;  break;
        default: throw Debug.abort("unexpected primitive", prim);
        }
        ctx.code.emitNEWARRAY(type);
    }

    /**
     * Generate code to create an array of references, whose size will
     * be dynamically computed.
     */
    protected void genRefArrayCreate(Context ctx, Tree size, Tree classNameLit)
        throws JCode.OffsetTooBigException {
        genLoad(ctx, size, JType.INT);

        String className;
        switch (classNameLit) {
        case Literal(STRING(String name)): className = name; break;
        default: throw global.fail("invalid argument for oarray " + classNameLit);
        }

        JReferenceType elemType;
        switch (className.charAt(0)) {
        case '[': case 'L':
            elemType = (JReferenceType)JType.parseSignature(className); break;
        default:
            elemType = new JObjectType(className);
        }
        ctx.code.emitANEWARRAY(elemType);
    }

    /**
     * Generate code to update an array.
     */
    protected void genArrayUpdate(Context ctx, Tree array, Tree index, Tree value)
        throws JCode.OffsetTooBigException {
        genLoad(ctx, array, JAVA_LANG_OBJECT_T);
        genLoad(ctx, index, JType.INT);
        JType elemType = getArrayElementType(array);
        if (elemType.isValueType())
            value = unbox(value);
        genLoad(ctx, value, elemType);
        ctx.code.emitASTORE(elemType);
    }

    /**
     * Generate code to load an element of an array.
     */
    protected void genArrayAccess(Context ctx, Tree array, Tree index)
        throws JCode.OffsetTooBigException {
        genLoad(ctx, array, JAVA_LANG_OBJECT_T);
        genLoad(ctx, index, JType.INT);
        ctx.code.emitALOAD(getArrayElementType(array));
    }

    /**
     * Generate code to load the length of an array.
     */
    protected void genArrayLength(Context ctx, Tree array)
        throws JCode.OffsetTooBigException {
        genLoad(ctx, array, JAVA_LANG_OBJECT_T);
        ctx.code.emitARRAYLENGTH();
    }

    /**
     * Return the Java type of the elements of the array represented
     * by the given tree.
     */
    protected JType getArrayElementType(Tree array) {
        JArrayType arrayType = (JArrayType)typeStoJ(array.type);
        return arrayType.getElementType();
    }

    /// String concatenation
    //////////////////////////////////////////////////////////////////////

    protected Tree[] liftStringConcatenations(Tree tree) {
        LinkedList accu = new LinkedList();
        liftStringConcatenations(tree, accu);
        return (Tree[])accu.toArray(new Tree[accu.size()]);
    }

    protected void liftStringConcatenations(Tree tree, LinkedList accu) {
        switch (tree) {
        case Apply(Select(Tree qualifier, Name selector), Tree[] args): {
            Symbol funSym = ((Tree.Apply)tree).fun.symbol();
            if  (prims.isPrimitive(funSym)
                 && prims.getPrimitive(funSym) == Primitive.CONCAT) {
                liftStringConcatenations(qualifier, accu);
                liftStringConcatenations(args[0], accu);
            } else
                accu.addLast(tree);
            } break;
        default:
            accu.addLast(tree);
        }
    }

    /**
     * Generate code to concatenate a list of expressions which return
     * strings.
     */
    protected void genStringConcatenation(Context ctx, Tree[] elements)
        throws JCode.OffsetTooBigException {
        // Create string buffer
        ctx.code.emitNEW(JAVA_LANG_STRINGBUFFER);
        ctx.code.emitDUP();
        ctx.code.emitINVOKESPECIAL(JAVA_LANG_STRINGBUFFER,
                                   "<init>",
                                   JMethodType.ARGLESS_VOID_FUNCTION);

        // Append all strings
        for (int i = 0; i < elements.length; ++i) {
            JType elemType = typeStoJ(elements[i].type);
            if (!elemType.equals(JObjectType.JAVA_LANG_STRING)
                && elemType.isReferenceType())
                elemType = JObjectType.JAVA_LANG_OBJECT;
            genLoad(ctx, elements[i], elemType);
            ctx.code.emitINVOKEVIRTUAL(JAVA_LANG_STRINGBUFFER,
                                       "append",
                                       new JMethodType(JAVA_LANG_STRINGBUFFER_T,
                                                       new JType[] { elemType }));
        }

        // Get resulting string
        ctx.code.emitINVOKEVIRTUAL(JAVA_LANG_STRINGBUFFER,
                                   "toString",
                                   new JMethodType(JObjectType.JAVA_LANG_STRING,
                                                   JType.EMPTY_ARRAY));
    }

    /// Primitives
    //////////////////////////////////////////////////////////////////////

    /**
     * Return true iff the given symbol is a primitive, AND that
     * primitive is recognized by this back-end.
     */
    protected boolean isKnownPrimitive(Symbol sym) {
        if (prims.isPrimitive(sym)) {
            switch (prims.getPrimitive(sym)) {
            case POS : case NEG :
            case ADD : case SUB : case MUL : case DIV : case MOD :
            case NOT : case OR : case XOR : case AND :
            case LSL : case LSR : case ASR :
            case EQ : case NE : case LT : case LE : case GE : case GT :
            case ZNOT : case ZOR : case ZAND :
            case NEW_ZARRAY : case NEW_BARRAY : case NEW_SARRAY :
            case NEW_CARRAY : case NEW_IARRAY : case NEW_LARRAY :
            case NEW_FARRAY : case NEW_DARRAY : case NEW_OARRAY :
            case ZARRAY_GET : case BARRAY_GET : case SARRAY_GET :
            case CARRAY_GET : case IARRAY_GET : case LARRAY_GET :
            case FARRAY_GET : case DARRAY_GET : case OARRAY_GET :
            case ZARRAY_SET : case BARRAY_SET : case SARRAY_SET :
            case CARRAY_SET : case IARRAY_SET : case LARRAY_SET :
            case FARRAY_SET : case DARRAY_SET : case OARRAY_SET :
            case ZARRAY_LENGTH : case BARRAY_LENGTH : case SARRAY_LENGTH :
            case CARRAY_LENGTH : case IARRAY_LENGTH : case LARRAY_LENGTH :
            case FARRAY_LENGTH : case DARRAY_LENGTH : case OARRAY_LENGTH :
            case IS : case AS : case ID :
            case CONCAT : case THROW : case SYNCHRONIZED:
            case B2B: case B2S: case B2C: case B2I: case B2L: case B2F: case B2D:
            case S2B: case S2S: case S2C: case S2I: case S2L: case S2F: case S2D:
            case C2B: case C2S: case C2C: case C2I: case C2L: case C2F: case C2D:
            case I2B: case I2S: case I2C: case I2I: case I2L: case I2F: case I2D:
            case L2B: case L2S: case L2C: case L2I: case L2L: case L2F: case L2D:
            case F2B: case F2S: case F2C: case F2I: case F2L: case F2F: case F2D:
            case D2B: case D2S: case D2C: case D2I: case D2L: case D2F: case D2D:
                return true;

            case EQUALS  :
            case HASHCODE :
            case TOSTRING :
            case COERCE :
            case BOX :
            case UNBOX :
            case APPLY : case UPDATE : case LENGTH :
                return false;
            default:
                throw Debug.abort("unknown primitive", sym);
            }
        } else
            return false;
    }

    /**
     * Negate the given primitive only if the second argument is
     * true, otherwise return it as is.
     */
    protected Primitive maybeNegatedPrim(Primitive prim, boolean negate) {
        return negate ? prim.negate() : prim;
    }

    /**
     * Return all the arguments associated with the primitive
     * represented by the given function call.
     */
    protected Tree[] extractPrimitiveArgs(Tree.Apply call) {
        Tree[] allArgs = Tree.cloneArray(1, call.args);
        allArgs[0] = ((Tree.Select)(call.fun)).qualifier;
        return allArgs;
    }

    /**
     * Return the unboxed version of the given tree.
     */
    protected Tree unbox(Tree tree) {
        switch (tree) {
        case Apply(Tree fun, Tree[] args):
            if (prims.getPrimitive(fun.symbol()) == Primitive.BOX) {
                assert args.length == 1;
                return args[0];
            } else
                return tree;
        default:
            return tree;
        }
    }

    /// Modules
    //////////////////////////////////////////////////////////////////////

    /**
     * Add field containing module instance, and code to initialize
     * it, to current class.
     */
    protected void addModuleInstanceField(Context ctx) {
        ctx.clazz.addNewField(JAccessFlags.ACC_PUBLIC
                              | JAccessFlags.ACC_FINAL
                              | JAccessFlags.ACC_STATIC,
                              MODULE_INSTANCE_FIELD_NAME,
                              ctx.clazz.getType());

        JMethod initMethod = getClassConstructorMethod(ctx, true);
        JExtendedCode code = (JExtendedCode)initMethod.getCode();

        code.emitNEW(ctx.clazz.getName());
        code.emitINVOKESPECIAL(ctx.clazz.getName(),
                               CONSTRUCTOR_STRING,
                               JMethodType.ARGLESS_VOID_FUNCTION);
        // The field is initialised by the constructor, so we don't
        // need to do it here, creating the instance is sufficient.
    }

    protected JMethod addNewScalaMethod(JClass clazz,
                                        Symbol method,
                                        int addFlags) {
        JMethodType methodType = (JMethodType)typeStoJ(method.type());

        Symbol[] params = method.valueParams();
        String[] argNames = new String[params.length];

        for (int i = 0; i < argNames.length; ++i)
            argNames[i] = params[i].name.toString();

        return clazz.addNewMethod(modifiersStoJ(method.flags) | addFlags,
                                  method.name.toString(),
                                  methodType.getReturnType(),
                                  methodType.getArgumentTypes(),
                                  argNames);
    }

    /**
     * Create a class which mirrors all public methods of the given
     * module class as static methods, to enable the use of the module
     * from Java.
     */
    protected void dumpModuleMirrorClass(Context ctx, Symbol cSym, Pickle pickle) {
        String mainName = javaName(cSym);
        String mirrorName = mainName.substring(0, mainName.length() - 1);

        JClass mirrorClass = fjbgContext.JClass(JAccessFlags.ACC_SUPER
                                                | JAccessFlags.ACC_PUBLIC
                                                | JAccessFlags.ACC_FINAL,
                                                mirrorName,
                                                JAVA_LANG_OBJECT,
                                                JClass.NO_INTERFACES,
                                                ctx.sourceFileName);
        Scope.SymbolIterator memberIt =
            new Scope.UnloadIterator(cSym.members().iterator());
        while (memberIt.hasNext()) {
            Symbol member = memberIt.next();
            if (!member.isMethod() || member.isInitializer())
                continue;

            JMethod mirrorMeth =
                addNewScalaMethod(mirrorClass, member, JAccessFlags.ACC_STATIC);
            JExtendedCode mirrorCode = (JExtendedCode)mirrorMeth.getCode();

            mirrorCode.emitGETSTATIC(mainName,
                                     MODULE_INSTANCE_FIELD_NAME,
                                     new JObjectType(mainName));
            JType[] argTypes = mirrorMeth.getArgumentTypes();
            for (int index = 0, i = 0; i < argTypes.length; ++i) {
                mirrorCode.emitLOAD(index, argTypes[i]);
                index += argTypes[i].getSize();
            }
            mirrorCode.emitINVOKEVIRTUAL(mainName,
                                         mirrorMeth.getName(),
                                         (JMethodType)mirrorMeth.getType());
            mirrorCode.emitRETURN(mirrorMeth.getReturnType());

            mirrorCode.setLineNumber(0,
                                     mirrorCode.getPC(),
                                     Position.line(member.pos));
        }
        addScalaAttr(mirrorClass, pickle);

        try {
            String fileName = javaFileName(mirrorName);
            mirrorClass.writeTo(fileName);
            global.operation("wrote " + fileName);
        } catch (java.io.IOException e) {
            throw global.fail(e.getMessage());
        }
    }

    /**
     * Add the "Scala" attribute to the given class, in which the
     * symbol table is saved.
     */
    protected void addScalaAttr(JClass cls, Pickle pickle) {
        JOtherAttribute scalaAttr =
            fjbgContext.JOtherAttribute(cls,
                                        cls,
                                        SCALA_ATTR,
                                        pickle.bytes,
                                        pickle.size());
        cls.addAttribute(scalaAttr);
    }

    /// Names
    //////////////////////////////////////////////////////////////////////

    protected HashMap nameMap/*<Symbol,String>*/ = new HashMap();

    /**
     * Return a Java-compatible version of the name of the given
     * symbol. The returned name is mangled and includes the names of
     * the owners.
     */
    protected String javaName(Symbol sym) {
        Object value = nameMap.get(sym);
        if (value != null) return (String)value;
        String name = prims.getJREClassName(sym);
        nameMap.put(sym, name);
        return name;
    }

    /**
     * Return the name of the file in which to store the given class.
     */
    protected String javaFileName(String className) {
        StringTokenizer tokens = new StringTokenizer(className, ".");
        File file = new File(global.outpath);
        while (tokens.hasMoreElements())
            file = new File(file, tokens.nextToken());

        return file.getPath() + ".class";
    }

    /// Types
    //////////////////////////////////////////////////////////////////////

    /**
     * Return the Java modifiers corresponding to the given Scala
     * modifiers.
     */
    protected int modifiersStoJ(int flags) {
        int jFlags = 0;

        if (Modifiers.Helper.isPrivate(flags))
            jFlags |= JAccessFlags.ACC_PRIVATE;
        else
            jFlags |= JAccessFlags.ACC_PUBLIC;

        if (Modifiers.Helper.isAbstract(flags))
            jFlags |= JAccessFlags.ACC_ABSTRACT;
        if (Modifiers.Helper.isInterface(flags))
            jFlags |= JAccessFlags.ACC_INTERFACE;

        if (Modifiers.Helper.isFinal(flags)
            && !(Modifiers.Helper.isAbstract(flags)
                 || Modifiers.Helper.isInterface(flags)))
            jFlags |= JAccessFlags.ACC_FINAL;

        return jFlags;
    }

    protected HashMap typeMap/*<Symbol,Type>*/ = new HashMap();
    protected void initTypeMap() {
        typeMap.put(defs.ANY_CLASS,    JObjectType.JAVA_LANG_OBJECT);
        typeMap.put(defs.ANYREF_CLASS, JObjectType.JAVA_LANG_OBJECT);
    }

    /**
     * Return the Java type corresponding to the given Scala type.
     */
    protected JType typeStoJ(Type tp) {
        switch (tp) {
        case ConstantType(Type base, _):
            return typeStoJ(base);
        case TypeRef(_, Symbol sym, _):
            Object value = typeMap.get(sym);
            if (value != null) return (JType)value;
            JType jTp = new JObjectType(javaName(sym));
            typeMap.put(sym, jTp);
            return jTp;
        case UnboxedType(TypeTags.BYTE):
            return JType.BYTE;
        case UnboxedType(TypeTags.CHAR):
            return JType.CHAR;
        case UnboxedType(TypeTags.SHORT):
            return JType.SHORT;
        case UnboxedType(TypeTags.INT):
            return JType.INT;
        case UnboxedType(TypeTags.LONG):
            return JType.LONG;
        case UnboxedType(TypeTags.FLOAT):
            return JType.FLOAT;
        case UnboxedType(TypeTags.DOUBLE):
            return JType.DOUBLE;
        case UnboxedType(TypeTags.BOOLEAN):
            return JType.BOOLEAN;
        case UnboxedType(TypeTags.UNIT):
            return JType.VOID;
        case UnboxedType(TypeTags.STRING):
            return JObjectType.JAVA_LANG_STRING;
        case UnboxedArrayType(Type elementType):
            return new JArrayType(typeStoJ(elementType));
        case MethodType(Symbol[] vparams, Type result):
            JType[] argTypes = new JType[vparams.length];
            for (int i = 0; i < vparams.length; ++i)
                argTypes[i] = typeStoJ(vparams[i].info());
            return new JMethodType(typeStoJ(result), argTypes);
        default:
            throw Debug.abort("invalid type", tp);
        }
    }

    /**
     * Return the "index" of the given type. This index encodes the
     * level in the hierarchy of basic types, with arrays and objects
     * on top of everything.
     */
    protected int getTypeIndex(JType tp) {
        return getTypeIndex(tp.getTag());
    }

    /**
     * Return the "index" of the given type.
     */
    protected int getTypeIndex(int tp) {
        switch (tp) {
        case JType.T_BOOLEAN: return 0;
        case JType.T_BYTE:
        case JType.T_CHAR:
        case JType.T_SHORT:
        case JType.T_INT:     return 1;
        case JType.T_LONG:    return 2;
        case JType.T_FLOAT:   return 3;
        case JType.T_DOUBLE:  return 4;
        case JType.T_ARRAY:
        case JType.T_OBJECT:  return 5;
        default: return -1;
        }
    }

    /**
     * Return the maximum of the types of all the given trees. All
     * reference types are considered to be equivalent, and if several
     * reference types are present in the trees, any one of them is
     * returned.
     */
    protected JType getMaxType(Tree[] trees) {
        JType maxType = JType.BOOLEAN;
        int maxTypeIdx = getTypeIndex(maxType);

        for (int i = 0; i < trees.length; ++i) {
            JType argType = typeStoJ(trees[i].type);
            if (getTypeIndex(argType) > maxTypeIdx) {
                maxType = argType;
                maxTypeIdx = getTypeIndex(maxType);
            }
        }
        return maxType;
    }
    protected JType getMaxType(Tree tree1, Tree tree2) {
        JType type1 = typeStoJ(tree1.type);
        JType type2 = typeStoJ(tree2.type);
        return getTypeIndex(type1) > getTypeIndex(type2) ? type1 : type2;
    }

    /// Line numbers
    //////////////////////////////////////////////////////////////////////

    int[] pcStack = new int[32];
    int pcStackDepth = 0;
    void startCodeForTree(Context ctx, Tree tree) {
        if (pcStackDepth == pcStack.length) {
            int[] newPCStack = new int[pcStack.length * 2];
            System.arraycopy(pcStack, 0, newPCStack, 0, pcStack.length);
            pcStack = newPCStack;
        }
        pcStack[pcStackDepth++] = (ctx.code == null ? 0 : ctx.code.getPC());
    }

    void endCodeForTree(Context ctx, Tree tree) {
        assert pcStackDepth > 0;
        int startPC = pcStack[--pcStackDepth];
        if (ctx.code != null)
            ctx.code.completeLineNumber(startPC,
                                        ctx.code.getPC(),
                                        Position.line(tree.pos));
    }

    /// Context
    //////////////////////////////////////////////////////////////////////

    /**
     * Record the entry into a class, and return the appropriate
     * context.
     */
    protected Context enterClass(Context ctx, Symbol cSym) {
        String javaName = javaName(cSym);

        scalac.symtab.Type[] baseTps = cSym.info().parents();
        assert baseTps.length > 0 : Debug.show(cSym);

        int offset;
        String superClassName;
        if (cSym.isInterface()) {
            offset = baseTps[0].symbol() == defs.ANY_CLASS ? 1 : 0;
            superClassName = JAVA_LANG_OBJECT;
        } else {
            offset = 1;
            superClassName = javaName(baseTps[0].symbol());
        }
        String[] interfaceNames = new String[baseTps.length - offset];
        for (int i = offset; i < baseTps.length; ++i) {
            Symbol baseSym = baseTps[i].symbol();
            assert baseSym.isInterface() : cSym + " implements " + baseSym;
            interfaceNames[i - offset] = javaName(baseSym);
        }

        JClass cls = fjbgContext.JClass(modifiersStoJ(cSym.flags)
                                        | JAccessFlags.ACC_SUPER,
                                        javaName,
                                        superClassName,
                                        interfaceNames,
                                        ctx.sourceFileName);

        return ctx.withClass(cls,
                             cSym.isModuleClass() && ctx.clazz == null,
                             cSym.isSubClass(JAVA_RMI_REMOTE_CLASS));
    }

    protected void leaveClass(Context ctx, Symbol cSym) {
        Pickle pickle = (Pickle)global.symdata.get(cSym);
        if (pickle != null)
            if (ctx.isModuleClass)
                dumpModuleMirrorClass(ctx, cSym, pickle);
            else
                addScalaAttr(ctx.clazz, pickle);

        try {
            String fileName = javaFileName(ctx.clazz.getName());
            ctx.clazz.writeTo(fileName);
            global.operation("wrote " + fileName);
        } catch (java.io.IOException e) {
            throw global.fail(e.getMessage());
        }
    }

    /**
     * Record the entry into a method, and return the appropriate
     * context.
     */
    protected Context enterMethod(Context ctx,
                                  Tree.DefDef mDef,
                                  boolean useWideJumps) {
        Symbol mSym = mDef.symbol();

        global.log("entering method " + Debug.toString(mSym)
                   + " (type: " + Debug.toString(mSym.info()) + ")"
                   + " wide jumps? " + useWideJumps);

        JMethod method = addNewScalaMethod(ctx.clazz, mSym, 0);

        Map locals = new HashMap();
        Symbol[] args = mSym.valueParams();
        JType[] argTypes = method.getArgumentTypes();

        for (int i = 0, pos = 1; i < argTypes.length; ++i) {
            locals.put(args[i], new Integer(pos));
            pos += argTypes[i].getSize();
        }

        if ((mSym.flags & Modifiers.BRIDGE) != 0)
            method.addAttribute(fjbgContext.JOtherAttribute(ctx.clazz,
                                                            method,
                                                            "Bridge",
                                                            new byte[]{}));

        if (ctx.isRemote && mSym.isPublic()) {
            // (see http://java.sun.com/docs/books/vmspec/html/ClassFile.doc.html#3129)
            // Exceptions_attribute {
            // ..
            // u2 number_of_exceptions;
    	    // u2 exception_index_table[number_of_exceptions];
            // }
            JConstantPool cp = ctx.clazz.getConstantPool();
            int reInx = cp.addClass(JAVA_RMI_REMOTEEXCEPTION);
            ByteBuffer contents = ByteBuffer.allocate(4); // u2 + u2[1]
            contents.putShort((short) 1);
            contents.putShort((short) reInx);
            global.log("adding 'Exceptions_attribute' " + contents.toString()
                       + " for remote method " + mSym.name.toString());
            method.addAttribute(fjbgContext.JOtherAttribute(ctx.clazz,
                                                            method,
                                                            "Exceptions",
                                                            contents.array()));
        }

        return ctx.withMethod(method, locals, useWideJumps);
    }

    protected void leaveMethod(Context ctx) {
        global.log("leaving method");
    }

    /// Misc.
    //////////////////////////////////////////////////////////////////////

    /**
     * Return the class constructor method of the given class.
     */
    private JMethod getClassConstructorMethod(Context ctx, boolean create) {
        JMethod[] methods = ctx.clazz.getMethods();
        JMethod clinit = null;
        for (int i = 0; i < methods.length; ++i) {
            if (methods[i].getName().equals("<clinit>")) {
                clinit = methods[i];
                break;
            }
        }
        if (clinit == null && create) {
            clinit = ctx.clazz.addNewMethod(JAccessFlags.ACC_PUBLIC
                                            | JAccessFlags.ACC_STATIC,
                                            "<clinit>",
                                            JType.VOID,
                                            JType.EMPTY_ARRAY,
                                            Strings.EMPTY_ARRAY);
        }
        return clinit;
    }

    /**
     * Add value members (i.e. fields) to current class.
     */
    protected void addValueClassMembers(Context ctx, Tree.ClassDef cDef) {
        Symbol cSym = cDef.symbol();
        Scope.SymbolIterator memberIt =
            new Scope.UnloadIterator(cSym.members().iterator());
        while (memberIt.hasNext()) {
            Symbol member = memberIt.next();
            if (member.isTerm() && !member.isMethod())
                ctx.clazz.addNewField(modifiersStoJ(member.flags),
                                      member.name.toString(),
                                      typeStoJ(member.info()));
        }
    }

    // The following function is a single big hack.
    protected void addStaticClassMembers(Context ctx, Tree.ClassDef cDef) {
        Symbol cSym = cDef.symbol();
        HashMap/*<Symbol, AConstant>*/ staticMembers = new HashMap();
        Symbol iSym = ctx.isModuleClass
            ? cSym : addInterfacesPhase.getInterfaceSymbol(cSym);
        if (iSym != null) {
            // Compute the list of static members to add.
            Phase bkpCurrent = global.currentPhase;
            global.currentPhase = refCheckPhase;
            Scope.SymbolIterator memberIt =
                new Scope.UnloadIterator(iSym.members().iterator());
            while (memberIt.hasNext()) {
                Symbol member = memberIt.next();
                if (member.isTerm() && !member.isMethod() && member.isPrivate())
                    switch (member.info()) {
                    case ConstantType(_, AConstant value):
                        staticMembers.put(member, value);
                    }
            }
            global.currentPhase = bkpCurrent;

            // Add them and initialize them.
            JMethod classInitMeth = getClassConstructorMethod(ctx, true);
            Context ctx1 =
                ctx.withMethod(classInitMeth, Collections.EMPTY_MAP, false);

            Iterator smIt = staticMembers.keySet().iterator();
            while (smIt.hasNext()) {
                Symbol sm = (Symbol)smIt.next();
                String smName = sm.name.toString();
                JType tp = typeStoJ(sm.info());
                JField field =
                    ctx1.clazz.addNewField((modifiersStoJ(sm.flags)
                                            | JAccessFlags.ACC_STATIC
                                            | JAccessFlags.ACC_PUBLIC)
                                           & ~JAccessFlags.ACC_PRIVATE,
                                           smName.substring(0,
                                                            smName.length()-1),
                                           tp);
                genLoadLiteral(ctx1, (AConstant)staticMembers.get(sm), tp);
                ctx1.code.emitPUTSTATIC(ctx1.clazz.getName(),
                                        field.getName(),
                                        tp);
            }
        }
    }

    /**
     * Return true iff the given symbol is a static (in the Java
     * sense) member of its owner.
     */
    protected boolean isStaticMember(Symbol sym) {
        return !sym.isInitializer()
            && sym.owner().isModuleClass()
            && sym.owner().isJava();
    }
}

/**
 * A compilation context, which records information about the class
 * and the method currently being generated.
 */
class Context {
    public final String sourceFileName;
    public final JClass clazz;
    public final JMethod method;
    public final JExtendedCode code;
    public final Map/*<Symbol,JLocalVariable>*/ locals;
    public final Map/*<Symbol,Pair<JCode.Label,Tree[]>>*/ labels;
    public final boolean useWideJumps;
    public final boolean isModuleClass;
    public final boolean isRemote;

    public final static Context EMPTY =
        new Context(null, null, null, null, null, false, false, false);

    private Context(String sourceFileName,
                    JClass clazz,
                    JMethod method,
                    Map locals,
                    Map labels,
                    boolean useWideJumps,
                    boolean isModuleClass,
                    boolean isRemote) {
        this.sourceFileName = sourceFileName;
        this.clazz = clazz;
        this.method = method;
        if (method == null || method.isAbstract())
            this.code = null;
        else
            this.code = (JExtendedCode)method.getCode();
        this.locals = locals;
        this.labels = labels;
        this.useWideJumps = useWideJumps;
        this.isModuleClass = isModuleClass;
        this.isRemote = isRemote;
    }

    public Context withSourceFileName(String sourceFileName) {
        return new Context(sourceFileName,
                           null,
                           null,
                           null,
                           null,
                           false,
                           false,
                           false);
    }

    public Context withClass(JClass clazz, boolean isModuleClass, boolean isRemote) {
        return new Context(this.sourceFileName,
                           clazz,
                           null,
                           null,
                           null,
                           false,
                           isModuleClass,
                           isRemote);
    }

    public Context withMethod(JMethod method, Map locals, boolean useWideJumps) {
        assert this.clazz == method.getOwner();
        return new Context(this.sourceFileName,
                           this.clazz,
                           method,
                           locals,
                           new HashMap(),
                           useWideJumps,
                           this.isModuleClass,
                           this.isRemote);
    }
}