com.google.gwt.dev.shell.rewrite.UseMirroredClasses.java Source code

Java tutorial

Introduction

Here is the source code for com.google.gwt.dev.shell.rewrite.UseMirroredClasses.java

Source

/*
 * Copyright 2010 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package com.google.gwt.dev.shell.rewrite;

import org.objectweb.asm.ClassVisitor;
import org.objectweb.asm.MethodVisitor;
import org.objectweb.asm.Opcodes;
import org.objectweb.asm.Type;

import java.util.HashMap;
import java.util.Map;

/**
 * A general Class Visitor which will take any of the method calls in it's
 * list and replace them with static calls to another method (the "mirrored"
 * method) in another class (the "mirrored" class). This method should
 * take the original object as it's first argument, followed by the rest of
 * the arguments to the method.  The "mirrored" class will not be rewritten,
 * allowing the "mirrored" method to do whatever modifications are necessary
 * before calling the original method (if desired).  Methods which should be
 * rewritten are listed in the mirroredMethods map below. Note that our
 * mirroring process is not robust enough to rewrite methods on subtypes.
 */
public class UseMirroredClasses extends ClassVisitor {
    private static class MethodInterceptor extends MethodVisitor {
        private static HashMap<String, HashMap<String, String>> mirrorMap;
        static {
            // The list of mirrored methods
            // TODO(unnurg): Find a better way to track methods that will get
            // rewritten - possibly by using annotations
            mirrorMap = new HashMap<String, HashMap<String, String>>();

            HashMap<String, String> logRecordMethods = new HashMap<String, String>();
            logRecordMethods.put("getLoggerName", "com/google/gwt/logging/impl/DevModeLoggingFixes:getLoggerName");
            mirrorMap.put("java/util/logging/LogRecord", logRecordMethods);

            HashMap<String, String> logManagerMethods = new HashMap<String, String>();
            logManagerMethods.put("getLogger",
                    "com/google/gwt/logging/impl/DevModeLoggingFixes:logManagerGetLogger");
            logManagerMethods.put("getLoggerNames",
                    "com/google/gwt/logging/impl/DevModeLoggingFixes:logManagerGetLoggerNames");
            mirrorMap.put("java/util/logging/LogManager", logManagerMethods);

            HashMap<String, String> loggerMethods = new HashMap<String, String>();
            loggerMethods.put("getName", "com/google/gwt/logging/impl/DevModeLoggingFixes:getName");
            loggerMethods.put("getLogger", "com/google/gwt/logging/impl/DevModeLoggingFixes:loggerGetLogger");
            mirrorMap.put("java/util/logging/Logger", loggerMethods);
        }

        private String className;

        protected MethodInterceptor(MethodVisitor mv, String className) {
            super(Opcodes.ASM6, mv);
            this.className = className;
        }

        @Override
        public void visitMethodInsn(int opcode, String owner, String name, String desc, boolean dintf) {

            // Check if this method is in our list
            Map<String, String> mirroredMethods = mirrorMap.get(owner);
            if (mirroredMethods == null) {
                super.visitMethodInsn(opcode, owner, name, desc, dintf);
                return;
            }

            String mirrorClassMethod = mirroredMethods.get(name);
            if (mirrorClassMethod == null) {
                super.visitMethodInsn(opcode, owner, name, desc, dintf);
                return;
            }

            // Confirm that the replacement method string is correctly formatted
            // and split it into a class and a method
            String[] temp = mirrorClassMethod.split(":");
            if (temp.length < 2) {
                super.visitMethodInsn(opcode, owner, name, desc, dintf);
                return;
            }

            String mirrorClass = temp[0];
            String mirrorMethod = temp[1];

            // Confirm that this is not the mirrored class itself (this would
            // lead to infinite loops if the mirrored method wants to call
            // the original method in it's implementation).
            if (className.equals(mirrorClass.replace("/", "."))) {
                super.visitMethodInsn(opcode, owner, name, desc, dintf);
                return;
            }

            if (opcode == Opcodes.INVOKESTATIC) {
                super.visitMethodInsn(opcode, mirrorClass, mirrorMethod, desc, dintf);
                return;
            }

            // Get the types of the current method being invoked
            // using the method descriptor string
            final Type[] argTypes = Type.getArgumentTypes(desc);

            // The new types for the new method
            final Type[] newArgTypes = new Type[argTypes.length + 1];

            // Make the first argument be the instance type (i.e. "this")
            newArgTypes[0] = Type.getType("L" + owner + ";");

            // Copy over all the other args
            System.arraycopy(argTypes, 0, newArgTypes, 1, argTypes.length);

            // Specify the new descriptor that includes the "this" arg.
            String newDesc = Type.getMethodDescriptor(Type.getReturnType(desc), newArgTypes);

            // Call the corresponding static method on the mirror class
            super.visitMethodInsn(Opcodes.INVOKESTATIC, mirrorClass, mirrorMethod, newDesc, dintf);
            return;
        }
    }

    private String className;

    public UseMirroredClasses(ClassVisitor cv, String className) {
        super(Opcodes.ASM6, cv);
        this.className = className;
    }

    @Override
    public MethodVisitor visitMethod(int access, String name, String desc, String signature, String[] exceptions) {
        MethodVisitor mv = super.visitMethod(access, name, desc, signature, exceptions);
        if (mv == null) {
            return null;
        }
        return new MethodInterceptor(mv, className);
    }
}