Rewrote the InvocationReceiver generation process in Java as an Ant task. I had
previously redone the InvocationService and DObject generation tools but not the InvocationReceiver tool. git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@3913 542714f4-19e9-0310-aa3c-eee0fc999fb1
This commit is contained in:
Michael Bayne
@@ -0,0 +1,178 @@
|
||||
//
|
||||
// $Id$
|
||||
//
|
||||
// Narya library - tools for developing networked games
|
||||
// Copyright (C) 2002-2006 Three Rings Design, Inc., All Rights Reserved
|
||||
// http://www.threerings.net/code/narya/
|
||||
//
|
||||
// This library is free software; you can redistribute it and/or modify it
|
||||
// under the terms of the GNU Lesser General Public License as published
|
||||
// by the Free Software Foundation; either version 2.1 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// This library is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
// Lesser General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU Lesser General Public
|
||||
// License along with this library; if not, write to the Free Software
|
||||
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
|
||||
package com.threerings.presents.tools;
|
||||
|
||||
import java.io.File;
|
||||
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;
|
||||
|
||||
import org.apache.velocity.VelocityContext;
|
||||
|
||||
import com.samskivert.util.CollectionUtil;
|
||||
import com.samskivert.util.SortableArrayList;
|
||||
import com.samskivert.util.StringUtil;
|
||||
|
||||
import com.threerings.presents.client.InvocationDecoder;
|
||||
import com.threerings.presents.data.ClientObject;
|
||||
import com.threerings.presents.server.InvocationSender;
|
||||
|
||||
/**
|
||||
* An Ant task for generating invocation receiver marshalling and unmarshalling
|
||||
* classes.
|
||||
*/
|
||||
public class GenReceiverTask extends InvocationTask
|
||||
{
|
||||
// documentation inherited
|
||||
protected void processService (File source, Class receiver)
|
||||
{
|
||||
System.out.println("Processing " + receiver.getName() + "...");
|
||||
String rname = receiver.getName();
|
||||
String rpackage = "";
|
||||
int didx = rname.lastIndexOf(".");
|
||||
if (didx != -1) {
|
||||
rpackage = rname.substring(0, didx);
|
||||
rname = rname.substring(didx+1);
|
||||
}
|
||||
|
||||
// verify that the receiver class name is as we expect it to be
|
||||
if (!rname.endsWith("Receiver")) {
|
||||
System.err.println("Cannot process '" + rname + "':");
|
||||
System.err.println(
|
||||
"Receiver classes must be named SomethingReceiver.");
|
||||
return;
|
||||
}
|
||||
|
||||
HashMap imports = new HashMap();
|
||||
SortableArrayList methods = new SortableArrayList();
|
||||
|
||||
// we need to import the receiver itself
|
||||
imports.put(importify(receiver.getName()), Boolean.TRUE);
|
||||
|
||||
// look through and locate our receiver methods
|
||||
Method[] methdecls = receiver.getDeclaredMethods();
|
||||
for (int ii = 0; ii < methdecls.length; ii++) {
|
||||
Method m = methdecls[ii];
|
||||
// receiver interface methods must be public and abstract
|
||||
if (!Modifier.isPublic(m.getModifiers()) &&
|
||||
!Modifier.isAbstract(m.getModifiers())) {
|
||||
continue;
|
||||
}
|
||||
methods.add(new ServiceMethod(receiver, m, imports));
|
||||
}
|
||||
methods.sort();
|
||||
|
||||
generateSender(source, rname, rpackage, methods,
|
||||
imports.keySet().iterator());
|
||||
generateDecoder(source, rname, rpackage, methods,
|
||||
imports.keySet().iterator());
|
||||
}
|
||||
|
||||
protected void generateSender (File source, String rname, String rpackage,
|
||||
List methods, Iterator 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
|
||||
SortableArrayList implist = new SortableArrayList();
|
||||
CollectionUtil.addAll(implist, imports);
|
||||
checkedAdd(implist, ClientObject.class.getName());
|
||||
checkedAdd(implist, InvocationSender.class.getName());
|
||||
String dname = StringUtil.replace(rname, "Receiver", "Decoder");
|
||||
checkedAdd(implist, rpackage + "." + dname);
|
||||
implist.sort();
|
||||
|
||||
VelocityContext ctx = new VelocityContext();
|
||||
ctx.put("name", name);
|
||||
ctx.put("package", spackage);
|
||||
ctx.put("methods", methods);
|
||||
ctx.put("imports", implist);
|
||||
|
||||
try {
|
||||
StringWriter sw = new StringWriter();
|
||||
_velocity.mergeTemplate(SENDER_TMPL, "UTF-8", ctx, sw);
|
||||
|
||||
// determine the path to our sender file
|
||||
String mpath = source.getPath();
|
||||
mpath = StringUtil.replace(mpath, "Receiver", "Sender");
|
||||
mpath = StringUtil.replace(mpath, "/client/", "/server/");
|
||||
|
||||
writeFile(mpath, sw.toString());
|
||||
|
||||
} catch (Exception e) {
|
||||
System.err.println("Failed processing template");
|
||||
e.printStackTrace(System.err);
|
||||
}
|
||||
}
|
||||
|
||||
protected void generateDecoder (
|
||||
File source, String rname, String rpackage, List methods,
|
||||
Iterator imports)
|
||||
{
|
||||
String name = StringUtil.replace(rname, "Receiver", "");
|
||||
String dname = StringUtil.replace(rname, "Receiver", "Decoder");
|
||||
|
||||
// construct our imports list
|
||||
SortableArrayList implist = new SortableArrayList();
|
||||
CollectionUtil.addAll(implist, imports);
|
||||
checkedAdd(implist, InvocationDecoder.class.getName());
|
||||
implist.sort();
|
||||
|
||||
VelocityContext ctx = new VelocityContext();
|
||||
ctx.put("name", name);
|
||||
ctx.put("receiver_code", StringUtil.md5hex(rpackage + "." + rname));
|
||||
ctx.put("package", rpackage);
|
||||
ctx.put("methods", methods);
|
||||
ctx.put("imports", implist);
|
||||
|
||||
try {
|
||||
StringWriter sw = new StringWriter();
|
||||
_velocity.mergeTemplate(DECODER_TMPL, "UTF-8", ctx, sw);
|
||||
|
||||
// determine the path to our sender file
|
||||
String mpath = source.getPath();
|
||||
mpath = StringUtil.replace(mpath, "Receiver", "Decoder");
|
||||
|
||||
writeFile(mpath, sw.toString());
|
||||
|
||||
} catch (Exception e) {
|
||||
System.err.println("Failed processing template");
|
||||
e.printStackTrace(System.err);
|
||||
}
|
||||
}
|
||||
|
||||
/** Specifies the path to the sender template. */
|
||||
protected static final String SENDER_TMPL =
|
||||
"com/threerings/presents/tools/sender.tmpl";
|
||||
|
||||
/** Specifies the path to the decoder template. */
|
||||
protected static final String DECODER_TMPL =
|
||||
"com/threerings/presents/tools/decoder.tmpl";
|
||||
}
|
||||
@@ -119,6 +119,16 @@ public abstract class InvocationTask extends Task
|
||||
return StringUtil.unStudlyName(method.getName()).toUpperCase();
|
||||
}
|
||||
|
||||
public String getSenderMethodName ()
|
||||
{
|
||||
String mname = method.getName();
|
||||
if (mname.startsWith("received")) {
|
||||
return "send" + mname.substring("received".length());
|
||||
} else {
|
||||
return mname;
|
||||
}
|
||||
}
|
||||
|
||||
public String getArgList (boolean providerMode)
|
||||
{
|
||||
StringBuffer buf = new StringBuffer();
|
||||
|
||||
@@ -0,0 +1,52 @@
|
||||
package $package;
|
||||
|
||||
#foreach ($import in $imports)
|
||||
import $import;
|
||||
#end
|
||||
|
||||
/**
|
||||
* Dispatches calls to a {@link ${name}Receiver} instance.
|
||||
*/
|
||||
public class ${name}Decoder extends InvocationDecoder
|
||||
{
|
||||
/** The generated hash code used to identify this receiver class. */
|
||||
public static final String RECEIVER_CODE = "$receiver_code";
|
||||
|
||||
#foreach ($m in $methods)
|
||||
/** The method id used to dispatch {@link ${name}Receiver#$m.method.name}
|
||||
* notifications. */
|
||||
public static final int $m.code = $velocityCount;
|
||||
|
||||
#end
|
||||
/**
|
||||
* Creates a decoder that may be registered to dispatch invocation
|
||||
* service notifications to the specified receiver.
|
||||
*/
|
||||
public ${name}Decoder (${name}Receiver receiver)
|
||||
{
|
||||
this.receiver = receiver;
|
||||
}
|
||||
|
||||
// documentation inherited
|
||||
public String getReceiverCode ()
|
||||
{
|
||||
return RECEIVER_CODE;
|
||||
}
|
||||
|
||||
// documentation inherited
|
||||
public void dispatchNotification (int methodId, Object[] args)
|
||||
{
|
||||
switch (methodId) {
|
||||
#foreach ($m in $methods)
|
||||
case $m.code:
|
||||
((${name}Receiver)receiver).${m.method.name}(
|
||||
$m.getUnwrappedArgList(true)
|
||||
);
|
||||
return;
|
||||
|
||||
#end
|
||||
default:
|
||||
super.dispatchNotification(methodId, args);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,27 @@
|
||||
package $package;
|
||||
|
||||
#foreach ($import in $imports)
|
||||
import $import;
|
||||
#end
|
||||
|
||||
/**
|
||||
* Used to issue notifications to a {@link ${name}Receiver} instance on a
|
||||
* client.
|
||||
*/
|
||||
public class ${name}Sender extends InvocationSender
|
||||
{
|
||||
#foreach ($m in $methods)
|
||||
/**
|
||||
* Issues a notification that will result in a call to {@link
|
||||
* ${name}Receiver#$m.method.name} on a client.
|
||||
*/
|
||||
public static void $m.senderMethodName (
|
||||
ClientObject target, $m.getArgList(false))
|
||||
{
|
||||
sendNotification(
|
||||
target, ${name}Decoder.RECEIVER_CODE, ${name}Decoder.$m.code,
|
||||
new Object[] { $m.getWrappedArgList(false) });
|
||||
}
|
||||
|
||||
#end
|
||||
}
|
||||
Reference in New Issue
Block a user