Narya.abc work - get rid of unused imports in generated service targets:

* ServiceMethod import options:
  - Made argument type imports ignore first N args (0 for old behavior)
  - Made marshaller listener imports optional
* Added InvocationTask._verbose and several dumps of current imports to help 
  track down future superfluous imports
* Made the import of ServiceListener method arguments' types optional
* Wrapped up most of processService code into protected inner class 
  ServiceDescription and made configurable:
  - Optional import of the types of the first arguments of the service methods
  - Optinoal import of the types of listener method arguments
* Changed generate methods to take the service class and construct their own
  local ServiceDescription configured for their target
* Removed global import of service class and do it explicitly where required
  (via method addServiceImport)
* Made some imports conditional
  - InvocationResponseEvent for mashallers only if service has some listeners
  - InvocationException for providers only if service has some methods with 
    listener arguments
* Removed unused variables and imports


git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@5036 542714f4-19e9-0310-aa3c-eee0fc999fb1

src/java/com/threerings/presents/tools/GenReceiverTask.java

@@ -27,7 +27,6 @@ import java.io.StringWriter;
 import java.lang.reflect.Method;
 import java.lang.reflect.Modifier;
 
-import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.Iterator;
 import java.util.List;
@@ -84,7 +83,7 @@ public class GenReceiverTask extends InvocationTask
                 !Modifier.isAbstract(m.getModifiers())) {
                 continue;
             }
-            methods.add(new ServiceMethod(receiver, m, imports, null));
+            methods.add(new ServiceMethod(receiver, m, imports, null, 0, true));
         }
         methods.sort();
 
@@ -98,7 +97,6 @@ public class GenReceiverTask extends InvocationTask
                                    List methods, Iterator<String> imports)
     {
         String name = StringUtil.replace(rname, "Receiver", "");
-        String sname = StringUtil.replace(rname, "Receiver", "Sender");
         String spackage = StringUtil.replace(rpackage, ".client", ".server");
 
         // construct our imports list
@@ -138,7 +136,6 @@ public class GenReceiverTask extends InvocationTask
         Iterator<String> imports)
     {
         String name = StringUtil.replace(rname, "Receiver", "");
-        String dname = StringUtil.replace(rname, "Receiver", "Decoder");
 
         // construct our imports list
         ComparableArrayList<String> implist = new ComparableArrayList<String>();

src/java/com/threerings/presents/tools/GenServiceTask.java

@@ -31,8 +31,6 @@ import java.util.ArrayList;
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.HashSet;
-import java.util.Iterator;
-import java.util.List;
 
 import org.apache.velocity.VelocityContext;
 
@@ -64,7 +62,8 @@ public class GenServiceTask extends InvocationTask
 
         public ServiceListener (Class service, Class listener,
                                 HashMap<String,Boolean> imports,
-                                HashMap<String,Boolean> rawimports)
+                                HashMap<String,Boolean> rawimports,
+                                boolean importArguments)
         {
             this.listener = listener;
             Method[] methdecls = listener.getDeclaredMethods();
@@ -75,7 +74,17 @@ public class GenServiceTask extends InvocationTask
                     !Modifier.isAbstract(m.getModifiers())) {
                     continue;
                 }
-                methods.add(new ServiceMethod(service, m, imports, rawimports));
+                if (_verbose) {
+                	System.out.println("Adding " + m + ", imports are " + 
+                		StringUtil.toString(imports.keySet()));
+                }
+                methods.add(new ServiceMethod(
+                	service, m, imports, rawimports, importArguments ? 0 : 999,
+                	true));
+                if (_verbose) {
+                	System.out.println("Added " + m + ", imports are " + 
+                		StringUtil.toString(imports.keySet()));
+                }
             }
             methods.sort();
         }
@@ -128,90 +137,54 @@ public class GenServiceTask extends InvocationTask
     protected void processService (File source, Class service)
     {
         System.out.println("Processing " + service.getName() + "...");
-        String sname = service.getName();
+        
-        String spackage = "";
-        int didx = sname.lastIndexOf(".");
-        if (didx != -1) {
-            spackage = sname.substring(0, didx);
-            sname = sname.substring(didx+1);
-        }
-
         // verify that the service class name is as we expect it to be
-        if (!sname.endsWith("Service")) {
+        if (!service.getName().endsWith("Service")) {
-            System.err.println("Cannot process '" + sname + "':");
+            System.err.println("Cannot process '" + service.getName() + "':");
             System.err.println(
                 "Service classes must be named SomethingService.");
             return;
         }
 
-        HashMap<String,Boolean> imports = new HashMap<String,Boolean>();
+        generateMarshaller(source, service);
-        HashMap<String,Boolean> rawimports = new HashMap<String,Boolean>();
+        generateDispatcher(source, service);
-        ComparableArrayList<ServiceMethod> methods =
+        if (!_providerless.contains(service.getSimpleName())) {
-            new ComparableArrayList<ServiceMethod>();
+            generateProvider(source, service);
-        ComparableArrayList<ServiceListener> listeners =
-            new ComparableArrayList<ServiceListener>();
-
-        // we need to import the service itself
-        imports.put(importify(service.getName()), Boolean.TRUE);
-        rawimports.put(service.getName(), Boolean.TRUE);
-
-        // look through and locate our service methods, also locating any
-        // custom InvocationListener derivations along the way
-        Method[] methdecls = service.getDeclaredMethods();
-        for (int ii = 0; ii < methdecls.length; ii++) {
-            Method m = methdecls[ii];
-            // service interface methods must be public and abstract
-            if (!Modifier.isPublic(m.getModifiers()) &&
-                !Modifier.isAbstract(m.getModifiers())) {
-                continue;
-            }
-            // check this method for custom listener declarations
-            Class[] args = m.getParameterTypes();
-            for (int aa = 0; aa < args.length; aa++) {
-                if (_ilistener.isAssignableFrom(args[aa]) &&
-                    GenUtil.simpleName(
-                        args[aa], null).startsWith(sname + ".")) {
-                    checkedAdd(listeners, new ServiceListener(
-                                   service, args[aa], imports, rawimports));
-                }
-            }
-            methods.add(new ServiceMethod(service, m, imports, rawimports));
-        }
-        listeners.sort();
-        methods.sort();
-
-        generateMarshaller(source, sname, spackage, methods, listeners,
-                           imports.keySet(), rawimports.keySet());
-        generateDispatcher(source, sname, spackage, methods,
-                           imports.keySet());
-        if (!_providerless.contains(sname)) {
-            generateProvider(source, sname, spackage, methods, listeners,
-                             imports.keySet());
         }
     }
 
-    protected void generateMarshaller (
+    protected void generateMarshaller (File source, Class service)
-        File source, String sname, String spackage, List methods,
-        List<ServiceListener> listeners, Collection<String> imports,
-        Collection<String> rawimports)
     {
+        if (_verbose) {
+        	System.out.println("Generating marshaller");
+        }
+
+        ServiceDescription sdesc = new ServiceDescription(service, true, true);
+
+        // Marshallers always require the service
+        sdesc.addServiceImport();
+
+        String sname = sdesc.sname;
         String name = StringUtil.replace(sname, "Service", "");
         String mname = StringUtil.replace(sname, "Service", "Marshaller");
-        String mpackage = StringUtil.replace(spackage, ".client", ".data");
+        String mpackage = StringUtil.replace(
+        	sdesc.spackage, ".client", ".data");
 
         // construct our imports list
         ComparableArrayList<String> implist = new ComparableArrayList<String>();
-        implist.addAll(imports);
+        implist.addAll(sdesc.imports.keySet());
         checkedAdd(implist, Client.class.getName());
         checkedAdd(implist, InvocationMarshaller.class.getName());
-        checkedAdd(implist, InvocationResponseEvent.class.getName());
+        if (sdesc.listeners.size() > 0) {
+        	checkedAdd(implist, InvocationResponseEvent.class.getName());
+        }
         implist.sort();
 
         VelocityContext ctx = new VelocityContext();
         ctx.put("name", name);
         ctx.put("package", mpackage);
-        ctx.put("methods", methods);
+        ctx.put("methods", sdesc.methods);
-        ctx.put("listeners", listeners);
+        ctx.put("listeners", sdesc.listeners);
         ctx.put("imports", implist);
 
         // determine the path to our marshaller file
@@ -238,7 +211,7 @@ public class GenServiceTask extends InvocationTask
         // convert the raw imports into ActionScript versions (inner-classes
         // become Foo_Bar)
         Collection<String> asimports = new ArrayList<String>();
-        for (String impy : rawimports) {
+        for (String impy : sdesc.rawimports.keySet()) {
             asimports.add(impy.replace("$", "_"));
         }
 
@@ -267,10 +240,10 @@ public class GenServiceTask extends InvocationTask
 
             // now generate ActionScript versions of our listener marshallers
             // because those have to be in separate files
-            for (ServiceListener listener : listeners) {
+            for (ServiceListener listener : sdesc.listeners) {
                 // recreate our imports with just what we need here
                 implist = new ComparableArrayList<String>();
-                implist.addAll(imports);
+                implist.addAll(sdesc.imports.keySet());
                 checkedAdd(implist, imlm.getName().replace("$", "_"));
                 String lname = listener.listener.getName();
                 checkedAdd(implist, lname.replace("$", "_"));
@@ -302,11 +275,11 @@ public class GenServiceTask extends InvocationTask
         checkedAdd(implist, isil.getName().replace("$", "_"));
         implist.sort();
         ctx.put("imports", implist);
-        ctx.put("package", spackage);
+        ctx.put("package", sdesc.spackage);
 
         try {
             // make sure our service directory exists
-            String sppath = spackage.replace('.', File.separatorChar);
+            String sppath = sdesc.spackage.replace('.', File.separatorChar);
             new File(_asroot + File.separator + sppath).mkdirs();
 
             // generate an ActionScript version of our service
@@ -318,7 +291,7 @@ public class GenServiceTask extends InvocationTask
 
             // also generate ActionScript versions of any inner listener
             // interfaces because those have to be in separate files
-            for (ServiceListener listener : listeners) {
+            for (ServiceListener listener : sdesc.listeners) {
                 // recreate our imports with just what we need here
                 implist = new ComparableArrayList<String>();
                 implist.addAll(asimports);
@@ -344,30 +317,40 @@ public class GenServiceTask extends InvocationTask
         }
     }
 
-    protected void generateDispatcher (
+    protected void generateDispatcher (File source, Class service)
-        File source, String sname, String spackage, List methods,
-        Collection<String> imports)
     {
-        String name = StringUtil.replace(sname, "Service", "");
+        if (_verbose) {
-        String dname = StringUtil.replace(sname, "Service", "Dispatcher");
+        	System.out.println("Generating dispatcher");
-        String dpackage = StringUtil.replace(spackage, ".client", ".server");
+        }
+
+        ServiceDescription sdesc = new ServiceDescription(service, false, false);
+
+        // If any listeners are to be used in dispatches, we need to import the service
+        if (sdesc.listeners.size() > 0) {
+        	sdesc.addServiceImport();
+        }
+
+        String name = StringUtil.replace(sdesc.sname, "Service", "");
+        String dpackage = StringUtil.replace(
+        	sdesc.spackage, ".client", ".server");
 
         // construct our imports list
         ComparableArrayList<String> implist = new ComparableArrayList<String>();
-        implist.addAll(imports);
+        implist.addAll(sdesc.imports.keySet());
         checkedAdd(implist, ClientObject.class.getName());
         checkedAdd(implist, InvocationMarshaller.class.getName());
         checkedAdd(implist, InvocationDispatcher.class.getName());
         checkedAdd(implist, InvocationException.class.getName());
-        String mname = StringUtil.replace(sname, "Service", "Marshaller");
+        String mname = StringUtil.replace(sdesc.sname, "Service", "Marshaller");
-        String mpackage = StringUtil.replace(spackage, ".client", ".data");
+        String mpackage = StringUtil.replace(
+        	sdesc.spackage, ".client", ".data");
         checkedAdd(implist, mpackage + "." + mname);
         implist.sort();
 
         VelocityContext ctx = new VelocityContext();
         ctx.put("name", name);
         ctx.put("package", dpackage);
-        ctx.put("methods", methods);
+        ctx.put("methods", sdesc.methods);
         ctx.put("imports", implist);
 
         try {
@@ -387,27 +370,33 @@ public class GenServiceTask extends InvocationTask
         }
     }
 
-    protected void generateProvider (
+    protected void generateProvider (File source, Class service)
-        File source, String sname, String spackage, List methods,
-        List listeners, Collection<String> imports)
     {
-        String name = StringUtil.replace(sname, "Service", "");
+        if (_verbose) {
-        String mname = StringUtil.replace(sname, "Service", "Provider");
+        	System.out.println("Generating provider");
-        String mpackage = StringUtil.replace(spackage, ".client", ".server");
+        }
+        
+        ServiceDescription sdesc = new ServiceDescription(service, false, false);
+
+        String name = StringUtil.replace(sdesc.sname, "Service", "");
+        String mpackage = StringUtil.replace(
+        	sdesc.spackage, ".client", ".server");
 
         // construct our imports list
         ComparableArrayList<String> implist = new ComparableArrayList<String>();
-        implist.addAll(imports);
+        implist.addAll(sdesc.imports.keySet());
         checkedAdd(implist, ClientObject.class.getName());
         checkedAdd(implist, InvocationProvider.class.getName());
-        checkedAdd(implist, InvocationException.class.getName());
+        if (sdesc.hasAnyListenerArgs()) {
+        	checkedAdd(implist, InvocationException.class.getName());
+        }
         implist.sort();
 
         VelocityContext ctx = new VelocityContext();
         ctx.put("name", name);
         ctx.put("package", mpackage);
-        ctx.put("methods", methods);
+        ctx.put("methods", sdesc.methods);
-        ctx.put("listeners", listeners);
+        ctx.put("listeners", sdesc.listeners);
         ctx.put("imports", implist);
 
         try {
@@ -427,6 +416,82 @@ public class GenServiceTask extends InvocationTask
         }
     }
 
+    // rolls up everything needed for the generate* methods
+    protected class ServiceDescription
+    {
+    	ServiceDescription (
+    		Class service, 
+    		boolean importServiceMethodsFirstArgument,
+    		boolean importListenerArguments)
+    	{
+    		this.service = service;
+    		sname = service.getSimpleName();
+    		spackage = service.getPackage().getName();
+
+            // look through and locate our service methods, also locating any
+            // custom InvocationListener derivations along the way
+            Method[] methdecls = service.getDeclaredMethods();
+            for (int ii = 0; ii < methdecls.length; ii++) {
+                Method m = methdecls[ii];
+                // service interface methods must be public and abstract
+                if (!Modifier.isPublic(m.getModifiers()) &&
+                    !Modifier.isAbstract(m.getModifiers())) {
+                    continue;
+                }
+                // check this method for custom listener declarations
+                Class[] args = m.getParameterTypes();
+                for (int aa = 0; aa < args.length; aa++) {
+                    if (_ilistener.isAssignableFrom(args[aa]) &&
+                        GenUtil.simpleName(
+                            args[aa], null).startsWith(sname + ".")) {
+                        checkedAdd(listeners, new ServiceListener(
+                                       service, args[aa], imports, rawimports, 
+                                       importListenerArguments));
+                    }
+                }
+                if (_verbose) {
+                	System.out.println("Adding " + m + ", imports are " + 
+                		StringUtil.toString(imports.keySet()));
+                }
+                methods.add(new ServiceMethod(service, m, imports, rawimports, 
+                		importServiceMethodsFirstArgument ? 0 : 1,
+                		importListenerArguments));
+                if (_verbose) {
+                	System.out.println("Added " + m + ", imports are " + 
+                		StringUtil.toString(imports.keySet()));
+                }
+            }
+            listeners.sort();
+            methods.sort();
+    	}
+    	
+    	boolean hasAnyListenerArgs ()
+    	{
+    		for (ServiceMethod sm : methods) {
+    			if (!sm.listenerArgs.isEmpty()) {
+    				return true;
+    			}
+    		}
+    		return false;
+    	}
+    	
+    	void addServiceImport ()
+    	{
+    		imports.put(importify(service.getName()), Boolean.TRUE);
+    		rawimports.put(service.getName(), Boolean.TRUE);
+    	}
+
+    	Class service;
+    	String sname;
+        String spackage;
+        HashMap<String,Boolean> imports = new HashMap<String,Boolean>();
+        HashMap<String,Boolean> rawimports = new HashMap<String,Boolean>();
+        ComparableArrayList<ServiceMethod> methods =
+            new ComparableArrayList<ServiceMethod>();
+        ComparableArrayList<ServiceListener> listeners =
+            new ComparableArrayList<ServiceListener>();
+    }
+    
     /** The path to our ActionScript source files. */
     protected File _asroot;
 

src/java/com/threerings/presents/tools/InvocationTask.java

@@ -30,7 +30,6 @@ import java.lang.reflect.Type;
 
 import java.util.ArrayList;
 import java.util.HashMap;
-import java.util.Iterator;
 import java.util.List;
 
 import org.apache.commons.io.FileUtils;
@@ -46,7 +45,6 @@ import org.apache.tools.ant.util.ClasspathUtils;
 import org.apache.velocity.app.VelocityEngine;
 
 import com.samskivert.util.ObjectUtil;
-import com.samskivert.util.SortableArrayList;
 import com.samskivert.util.StringUtil;
 import com.samskivert.velocity.VelocityUtil;
 
@@ -94,7 +92,8 @@ public abstract class InvocationTask extends Task
         }
     }
 
-    /** Used to keep track of invocation service methods. */
+    /** Used to keep track of invocation service methods (or listener 
+     *  methods). */
     public class ServiceMethod implements Comparable<ServiceMethod>
     {
         public Method method;
@@ -104,14 +103,16 @@ public abstract class InvocationTask extends Task
 
         public ServiceMethod (Class<?> service, Method method,
                               HashMap<String,Boolean> imports,
-                              HashMap<String,Boolean> rawimports)
+                              HashMap<String,Boolean> rawimports,
+                              int ignoreArguments,
+                              boolean importMarshallerListeners)
         {
             this.method = method;
 
             // we need to look through our arguments and note any needed
             // imports in the supplied table
             Class<?>[] args = method.getParameterTypes();
-            for (int ii = 0; ii < args.length; ii++) {
+            for (int ii = ignoreArguments; ii < args.length; ii++) {
                 Class<?> arg = args[ii];
                 while (arg.isArray()) {
                     arg = arg.getComponentType();
@@ -144,7 +145,8 @@ public abstract class InvocationTask extends Task
                 // InvocationService listeners, we need to import its
                 // marshaller as well
                 String sname = GenUtil.simpleName(arg, null);
-                if (_ilistener.isAssignableFrom(arg)) {
+                if (importMarshallerListeners && 
+                	_ilistener.isAssignableFrom(arg)) {
                     String mname = arg.getName();
                     mname = StringUtil.replace(mname, "Service", "Marshaller");
                     mname = StringUtil.replace(mname, "Listener", "Marshaller");
@@ -265,7 +267,6 @@ public abstract class InvocationTask extends Task
         {
             StringBuilder buf = new StringBuilder();
             Class<?>[] args = method.getParameterTypes();
-            Type[] ptypes = method.getGenericParameterTypes();
             for (int ii = (listenerMode ? 0 : 1); ii < args.length; ii++) {
                 if (buf.length() > 0) {
                     buf.append(", ");
@@ -327,6 +328,14 @@ public abstract class InvocationTask extends Task
         }
     }
 
+    /**
+     * Configures to output extra information when generating code.
+     */
+    public void setVerbose (boolean verbose)
+    {
+    	_verbose = verbose;
+    }
+
     /** Configures our classpath which we'll use to load service classes. */
     public void setClasspathref (Reference pathref)
     {
@@ -432,6 +441,9 @@ public abstract class InvocationTask extends Task
     /** A header to put on all generated source files. */
     protected String _header;
 
+    /** Show extra output if set. */
+    protected boolean _verbose;
+    
     /** Used to do our own classpath business. */
     protected ClassLoader _cloader;