binding-xml/compiler/src/main/java/org/apache/etch/bindings/xml/compiler/Compiler.java - etch - Git at Google

 /* $Id$
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements. See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership. The ASF licenses this file
  * to you 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 org.apache.etch.bindings.xml.compiler;

 import java.io.IOException;
 import java.io.PrintWriter;
 import java.io.StringReader;
 import java.util.Date;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Set;

 import org.apache.etch.compiler.Backend;
 import org.apache.etch.compiler.CmdLineOptions;
 import org.apache.etch.compiler.EtchGrammarConstants;
 import org.apache.etch.compiler.LogHandler;
 import org.apache.etch.compiler.Output;
 import org.apache.etch.compiler.ParseException;
 import org.apache.etch.compiler.Token;
 import org.apache.etch.compiler.Version;
 import org.apache.etch.compiler.ast.Except;
 import org.apache.etch.compiler.ast.Extern;
 import org.apache.etch.compiler.ast.Item;
 import org.apache.etch.compiler.ast.Message;
 import org.apache.etch.compiler.ast.MessageDirection;
 import org.apache.etch.compiler.ast.Module;
 import org.apache.etch.compiler.ast.MsgDirHelper;
 import org.apache.etch.compiler.ast.Named;
 import org.apache.etch.compiler.ast.ParamList;
 import org.apache.etch.compiler.ast.Parameter;
 import org.apache.etch.compiler.ast.Service;
 import org.apache.etch.compiler.ast.Thrown;
 import org.apache.etch.compiler.ast.TypeRef;
 import org.apache.etch.compiler.opt.ToString;
 import org.apache.etch.compiler.opt.ToString.FieldItem;
 import org.apache.etch.compiler.opt.ToString.FmtItem;
 import org.apache.etch.compiler.opt.ToString.StringItem;
 import org.apache.etch.util.Hash;
 import org.apache.velocity.Template;
 import org.apache.velocity.VelocityContext;
 import org.apache.velocity.app.Velocity;
 import org.apache.velocity.exception.ResourceNotFoundException;
 import org.apache.velocity.runtime.RuntimeServices;
 import org.apache.velocity.runtime.log.LogChute;


 /**
  * Compiler is a helper class not only for Backend, but also
  * for the templates. They call methods here to perform
  * "hard" tasks.
  */
 public class Compiler extends Backend
 {
 	private final static String tmplPath1 = "org/apache/etch/bindings/xml/compiler/";
 	private final static String tmplPath2 = "resources/org/apache/etch/bindings/xml/compiler/";

 	private final static String fnSuffix = ".xml";

 	private final static String VERSION = Version.VERSION + " / " + CompilerVersion.VERSION;

 	private LogHandler lh;

 	/**
 	 * Initializes use of velocity engine and sets up
 	 * resource loaders.
 	 * @throws Exception
 	 */
 	private void initVelocity()
 		throws Exception
 	{
 		Velocity.setProperty( Velocity.RUNTIME_LOG_LOGSYSTEM, new MyLogger() );

 		Velocity.setProperty( Velocity.RESOURCE_LOADER, "file, class" );

 		Velocity.setProperty( "file.resource.loader.description", "Velocity File Resource Loader" );
 		Velocity.setProperty( "file.resource.loader.class", "org.apache.velocity.runtime.resource.loader.FileResourceLoader" );
 		Velocity.setProperty( "file.resource.loader.path", "." );

 		Velocity.setProperty( "class.resource.loader.description", "Velocity Classpath Resource Loader" );
 		Velocity.setProperty( "class.resource.loader.class", "org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader" );

 		Velocity.init();
 	}

 	private static class MyLogger implements LogChute
 	{
 		private final LogHandler lh = null;

 		public void init( RuntimeServices rts ) throws Exception
 		{
 			// ignore.
 		}

 		public boolean isLevelEnabled( int level )
 		{
 			return level >= 2;
 		}

 		public void log( int level, String msg )
 		{
 			if (level < 2)
 				return;

 			if (lh != null)
 				lh.report( level == 2 ? LogHandler.LEVEL_WARNING : LogHandler.LEVEL_ERROR, null, msg );
 			else
 				System.out.printf( "Velocity msg (%d): %s\n", level, msg );
 		}

 		public void log( int level, String msg, Throwable e )
 		{
 			if (level < 2)
 				return;

 			if (lh != null)
 				lh.report( level == 2 ? LogHandler.LEVEL_WARNING : LogHandler.LEVEL_ERROR, null, msg );
 			else
 				System.out.printf( "Velocity msg (%d): %s: %s\n", level, msg, e );
 		}
 	}

 	/**
 	 * @param path
 	 * @param fn
 	 * @return the velocity template
 	 * @throws Exception
 	 */
 	private Template getTemplate( String[] path, String fn )
 		throws Exception
 	{
 		ResourceNotFoundException rnfe = null;

 		for (String p: path)
 		{
 			if (p == null)
 				continue;

 //			System.out.println( "trying to load template "+(p+fn) );
 			try
 			{
 				if (Velocity.resourceExists( p+fn ))
 					return Velocity.getTemplate( p+fn );
 			}
 			catch ( ResourceNotFoundException e )
 			{
 				rnfe = e;
 			}
 			catch ( Exception e )
 			{
 				System.out.println( "ignoring "+e);
 			}
 		}

 		if (rnfe != null)
 			throw rnfe;

 		throw new ResourceNotFoundException("could not find resource: "+fn);
 	}

 	/**
 	 * Constructs the Compiler. This is a helper class not only
 	 * for Backend, but also for the templates. They call methods
 	 * here to perform "hard" tasks.
 	 *
 	 * @throws Exception
 	 */
 	public Compiler() throws Exception
 	{
 		initVelocity();

 		String[] path = { tmplPath1, tmplPath2 };
 		vf_vm = getTemplate( path, "vf.vm" );
 	}

 	private final Template vf_vm;

 	@Override
 	public void generate( Module module, CmdLineOptions options )
 		throws Exception
 	{
 		// xml always wants to not flatten packages:
 		options.noFlattenPackages = true;

 		lh = options.lh;

 		Output dir = options.output;

 		String m = module.name().name;
 		if (m.length() > 0)
 		{
 			dir = dir.newPackage( m );
 		}

 		// generate code for each service.

 		for (Service intf : module)
 		{
 			generate( intf, dir );
 		}
 	}

 	private void generate( final Service intf, Output dir )
 		throws Exception
 	{
 		// Generate the value factory file

 		doFile( dir, getVfName( intf ) + fnSuffix, lh, new Gen()
 		{
 			public void run( PrintWriter pw ) throws Exception
 			{
 				generateVf( pw, intf );
 			}
 		} );
 	}

 	/**
 	 * Generate the value factory for the service.
 	 * @param pw
 	 * @param intf
 	 * @throws Exception
 	 */
 	void generateVf( PrintWriter pw, Service intf )
 		throws Exception
 	{
 		// params keeps track of the total set of parameters
 		// named (for enums, structs, exceptions, and messages).
 		Set<String> params = new HashSet<String>();
 		VelocityContext context = new VelocityContext();
 		context.put( "now", new Date() );
 		context.put( "version", VERSION );
 		context.put( "helper", this );
 		context.put( "intf", intf );
 		context.put( "params", params );
 		vf_vm.merge( context, pw );
 	}

 	private String getVfName( Service intf )
 	{
 		return getIntfName( intf, MessageDirection.BOTH );
 	}

 	private String getIntfName( Service intf, MessageDirection mc )
 	{
 		String suffix = MsgDirHelper.getSuffix( mc );
 		return intf.name()+suffix;
 	}

 	@Override
 	public String asyncReceiverPoolName( Message msg )
 	{
 		return msg.getAsyncReceiver().toString().toLowerCase();
 	}

 	@Override
 	public String getTypeValue( TypeRef type, Token value ) throws Exception
 	{
 //		System.out.println( "getTypeValue called with: "+type+": "+value );
 		Token t = type.type();
 		switch (t.kind)
 		{
 			case EtchGrammarConstants.STRING: return protectString( value.image );
 			default: return value.image;
 		}
 	}

 	private String protectString( String s ) throws Exception
 	{
 		return s;
 		//return protectAttr(s);
 	}

 	/**
 	 * @param type
 	 * @return type name appropriate for use as a structure
 	 * element or exception parameter or function parameter
 	 * or result.
 	 */
 	@Override
 	public String getTypeName( TypeRef type )
 	{
 		if (type.dim() > 0)
 			return getNativeTypeName( type )/*+dim2spec( type.dim() )*/;
 		return getRefTypeName( type );
 	}

 	/**
 	 * @param type the etch type
 	 * @return the fundamental native type for java. so etch
 	 * int -> java int, while etch string -> java String.
 	 */
 	@Override
 	public String getNativeTypeName( TypeRef type )
 	{
 		Token t = type.type();
 		switch (t.kind)
 		{
 			case EtchGrammarConstants.VOID: return "void";
 			case EtchGrammarConstants.BOOLEAN: return "boolean";
 			case EtchGrammarConstants.BYTE: return "byte";
 			case EtchGrammarConstants.SHORT: return "short";
 			case EtchGrammarConstants.INT: return "int";
 			case EtchGrammarConstants.LONG: return "long";
 			case EtchGrammarConstants.FLOAT: return "float";
 			case EtchGrammarConstants.DOUBLE: return "double";
 			case EtchGrammarConstants.STRING: return "string";
 			case EtchGrammarConstants.OBJECT: return "object";
 			default:
 			{
 				// we have to use a fully qualified name here.
 				// find the actual type...
 				Named<?> n = type.intf().get( t.image );
 				if (n == null)
 					throw new IllegalArgumentException( String.format(
 						"undefined or ambiguous name at line %d: %s",
 						t.beginLine, t.image ) );
 				String s = n.efqname( this );

 				if ( s == null && n instanceof Extern )
 					s = t.image;

 				return s;
 			}
 		}
 	}


 	/**
 	 * @param type
 	 * @return true if the type is an etch builtin type.
 	 */
 	public boolean isBasicType(TypeRef type) {

 		Token t = type.type();

 		switch (t.kind)
 		{
 		case EtchGrammarConstants.VOID:
 			return true;
 		case EtchGrammarConstants.BOOLEAN:
 			return true;
 		case EtchGrammarConstants.BYTE:
 			return true;
 		case EtchGrammarConstants.SHORT:
 			return true;
 		case EtchGrammarConstants.INT:
 			return true;
 		case EtchGrammarConstants.LONG:
 			return true;
 		case EtchGrammarConstants.FLOAT:
 			return true;
 		case EtchGrammarConstants.DOUBLE:
 			return true;
 		case EtchGrammarConstants.STRING:
 			return true;
 		case EtchGrammarConstants.OBJECT:
 			return true;

 		// patch here. more generic approach needed.
 		// currently, only taking care of Map, Set, List & Datetime
 		case EtchGrammarConstants.ID:
 			if ( t.toString().equals("Map") || t.toString().equals("List") ||
 					t.toString().equals("Set") || t.toString().equals("Datetime") )
 				return true;
 		}
 		return false;
 	}

 	/**
 	 * @param type the etch type
 	 * @return the fundamental native reference type for java.
 	 * so etch int -> java Integer, while etch string -> java String.
 	 */
 	private String getRefTypeName( TypeRef type )
 	{
 		Token t = type.type();
 		switch (t.kind)
 		{
 			case EtchGrammarConstants.VOID: return "void";
 			case EtchGrammarConstants.BOOLEAN: return "boolean";
 			case EtchGrammarConstants.BYTE: return "byte";
 			case EtchGrammarConstants.SHORT: return "short";
 			case EtchGrammarConstants.INT: return "int";
 			case EtchGrammarConstants.LONG: return "long";
 			case EtchGrammarConstants.FLOAT: return "float";
 			case EtchGrammarConstants.DOUBLE: return "double";
 			case EtchGrammarConstants.STRING: return "string";
 			case EtchGrammarConstants.OBJECT: return "object";
 			default:
 			{
 				// we have to use a fully qualified name here.
 				// find the actual type...
 				Named<?> n = type.intf().get( t.image );
 				if (n == null)
 					throw new IllegalArgumentException( String.format(
 						"undefined or ambiguous name at line %d: %s",
 						t.beginLine, t.image ) );


 				if ( n.isExtern() )
 					return n.fqname();

 				return n.efqname( this );
 			}
 		}
 	}

 	@Override
 	public String formatString( ParamList<Service> n, boolean isExcept )
 		throws ParseException, IOException
 	{
 		ToString ts = (ToString) n.getOpt( "ToString" );
 		List<FmtItem> list;
 		if (ts != null)
 		{
 			list = ts.getFormat();
 			n.checkFormatList( ts.lineno(), list );
 		}
 		else
 			list = n.mkFormatList( isExcept, false );

 		if (list.size() == 1)
 		{
 			return list.get( 0 ).value();
 		}

 		StringBuffer sb = new StringBuffer();
 		sb.append( "String.format( " );
 		sb.append( "\"" );
 		for (FmtItem i: list)
 		{
 			if (i instanceof FieldItem)
 			{
 				sb.append( "%s" );
 			}
 			else
 			{
 				escape( sb, ((StringItem) i).value() );
 			}
 		}
 		sb.append( "\"" );
 		for (FmtItem i: list)
 		{
 			if (i instanceof FieldItem)
 			{
 				sb.append( ", " );
 				sb.append( ((FieldItem) i).value() );
 			}
 		}
 		sb.append( " )" );
 		return sb.toString();
 	}

 	private void escape( StringBuffer sb, String s ) throws IOException
 	{
 		StringReader rdr = new StringReader( s );
 		int c;
 		while ((c = rdr.read()) >= 0)
 		{
 			if (c == '"') sb.append( "\\\"" );
 			else if (c == '\\') sb.append( "\\\\" );
 			else if (c == '\t') sb.append( "\\t" );
 			else if (c == '\r') sb.append( "\\r" );
 			else if (c == '\n') sb.append( "\\n" );
 			else sb.append( (char) c );
 		}
 	}

 	@Override
 	public String mfvname( String vname )
 	{
 		return "_mf_"+vname;
 	}

 	@Override
 	public String mtvname( String vname )
 	{
 		return "_mt_"+vname;
 	}

 	@Override
 	public String getLang()
 	{
 		return "xml";
 	}

 	@Override
 	public String enum_efqname( String fqname, String moduleName,
 		String serviceName, String enumName )
 	{
 		return fqname;
 	}

 	@Override
 	public String except_efqname(String fqname, String moduleName, String serviceName, String exceptName) {

 		return fqname;
 	}

 	@Override
 	public String struct_efqname(String fqname, String moduleName, String serviceName, String enumName) {

 		return fqname;
 	}

 	@Override
 	public String qualifyParameterName( Token name )
 	{
 		return name.image;
 	}

 	@Override
 	public String qualifyConstantName( Service intf, Token name )
 	{
 		return intf.fqname()+'.'+name.image;
 	}

 	@Override
 	public String qualifyEnumName( Service intf, Token name )
 	{
 		return intf.fqname()+'.'+name.image;
 	}

 	@Override
 	public String getValidator( Named<?> named )
 	{
 		if (named instanceof Parameter)
 		{
 			Parameter param = (Parameter) named;
 			TypeRef type = param.type();

 			if (type.isBuiltin())
 				return "Validator_"+type.type()+".get( "+type.dim()+" )";

 			return "Validator_custom.getCustom( "+type.getNamed( type.intf() ).efqname( this )+".class, "+type.dim()+" )";
 		}

 		if (named instanceof Thrown)
 		{
 			Thrown thrown = (Thrown) named;
 			Except e = (Except) thrown.getNamed();
 			return "Validator_custom.getCustom( "+e.efqname( this )+".class, 0 )";
 		}

 		if (named instanceof Item)
 			return "Validator_boolean.get( 0 )";

 		return "null";
 	}

 	/**
 	 * @param descriptions
 	 * @return string with descriptions
 	 */
 	public String emitXml(List<String> descriptions)
 	{
 		StringBuffer buffer = new StringBuffer();
 		for(int i = 0; i < descriptions.size(); i++)
 		{
 			Object objMessage = descriptions.get(i);
 			String message = "";
 			if(objMessage != null)
 			{
 				message = objMessage.toString();
 			}

 			buffer.append(message);

 			if(i < descriptions.size() - 1)
 			{
 				buffer.append("\r\n");
 			}
 		}

 		return buffer.toString();
 	}

 	/**
 	 * @param unprotected
 	 * @return attribute value protected.
 	 * @throws IOException
 	 */
 	public String protectAttr(String unprotected) throws IOException
 	{
 		return org.apache.etch.util.core.xml.XmlParser.ProtectAttrValue.toString(unprotected);
 	}

 	/**
 	 * @param unprotected
 	 * @return cdata value protected.
 	 * @throws IOException
 	 */
 	public String protectCData(String unprotected) throws IOException
 	{
 		return org.apache.etch.util.core.xml.XmlParser.ProtectCData.toString(unprotected);
 	}

 	@Override
 	public void addDefaults( Service service ) throws ParseException
 	{
 		addBuiltin( service, newName( "List" ), "List", true );
 		addBuiltin( service, newName( "Map" ), "Map", true );
 		addBuiltin( service, newName( "Set" ), "Set", true );
 		addBuiltin( service, newName( "Datetime" ), "Datetime", false );
 	}

 	/**
 	 * @param n
 	 * @return the id of the named item.
 	 */
 	public int id( Named<?> n )
 	{
 		if (n instanceof Item || n instanceof Parameter)
 			return Hash.hash( n.name().name() );

 		return Hash.hash( n.fqname() );
 	}
 }
	/* $Id$
	*
	* Licensed to the Apache Software Foundation (ASF) under one
	* or more contributor license agreements. See the NOTICE file
	* distributed with this work for additional information
	* regarding copyright ownership. The ASF licenses this file
	* to you 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 org.apache.etch.bindings.xml.compiler;

	import java.io.IOException;
	import java.io.PrintWriter;
	import java.io.StringReader;
	import java.util.Date;
	import java.util.HashSet;
	import java.util.List;
	import java.util.Set;

	import org.apache.etch.compiler.Backend;
	import org.apache.etch.compiler.CmdLineOptions;
	import org.apache.etch.compiler.EtchGrammarConstants;
	import org.apache.etch.compiler.LogHandler;
	import org.apache.etch.compiler.Output;
	import org.apache.etch.compiler.ParseException;
	import org.apache.etch.compiler.Token;
	import org.apache.etch.compiler.Version;
	import org.apache.etch.compiler.ast.Except;
	import org.apache.etch.compiler.ast.Extern;
	import org.apache.etch.compiler.ast.Item;
	import org.apache.etch.compiler.ast.Message;
	import org.apache.etch.compiler.ast.MessageDirection;
	import org.apache.etch.compiler.ast.Module;
	import org.apache.etch.compiler.ast.MsgDirHelper;
	import org.apache.etch.compiler.ast.Named;
	import org.apache.etch.compiler.ast.ParamList;
	import org.apache.etch.compiler.ast.Parameter;
	import org.apache.etch.compiler.ast.Service;
	import org.apache.etch.compiler.ast.Thrown;
	import org.apache.etch.compiler.ast.TypeRef;
	import org.apache.etch.compiler.opt.ToString;
	import org.apache.etch.compiler.opt.ToString.FieldItem;
	import org.apache.etch.compiler.opt.ToString.FmtItem;
	import org.apache.etch.compiler.opt.ToString.StringItem;
	import org.apache.etch.util.Hash;
	import org.apache.velocity.Template;
	import org.apache.velocity.VelocityContext;
	import org.apache.velocity.app.Velocity;
	import org.apache.velocity.exception.ResourceNotFoundException;
	import org.apache.velocity.runtime.RuntimeServices;
	import org.apache.velocity.runtime.log.LogChute;


	/**
	* Compiler is a helper class not only for Backend, but also
	* for the templates. They call methods here to perform
	* "hard" tasks.
	*/
	public class Compiler extends Backend
	{
	private final static String tmplPath1 = "org/apache/etch/bindings/xml/compiler/";
	private final static String tmplPath2 = "resources/org/apache/etch/bindings/xml/compiler/";

	private final static String fnSuffix = ".xml";

	private final static String VERSION = Version.VERSION + " / " + CompilerVersion.VERSION;

	private LogHandler lh;

	/**
	* Initializes use of velocity engine and sets up
	* resource loaders.
	* @throws Exception
	*/
	private void initVelocity()
	throws Exception
	{
	Velocity.setProperty( Velocity.RUNTIME_LOG_LOGSYSTEM, new MyLogger() );

	Velocity.setProperty( Velocity.RESOURCE_LOADER, "file, class" );

	Velocity.setProperty( "file.resource.loader.description", "Velocity File Resource Loader" );
	Velocity.setProperty( "file.resource.loader.class", "org.apache.velocity.runtime.resource.loader.FileResourceLoader" );
	Velocity.setProperty( "file.resource.loader.path", "." );

	Velocity.setProperty( "class.resource.loader.description", "Velocity Classpath Resource Loader" );
	Velocity.setProperty( "class.resource.loader.class", "org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader" );

	Velocity.init();
	}

	private static class MyLogger implements LogChute
	{
	private final LogHandler lh = null;

	public void init( RuntimeServices rts ) throws Exception
	{
	// ignore.
	}

	public boolean isLevelEnabled( int level )
	{
	return level >= 2;
	}

	public void log( int level, String msg )
	{
	if (level < 2)
	return;

	if (lh != null)
	lh.report( level == 2 ? LogHandler.LEVEL_WARNING : LogHandler.LEVEL_ERROR, null, msg );
	else
	System.out.printf( "Velocity msg (%d): %s\n", level, msg );
	}

	public void log( int level, String msg, Throwable e )
	{
	if (level < 2)
	return;

	if (lh != null)
	lh.report( level == 2 ? LogHandler.LEVEL_WARNING : LogHandler.LEVEL_ERROR, null, msg );
	else
	System.out.printf( "Velocity msg (%d): %s: %s\n", level, msg, e );
	}
	}

	/**
	* @param path
	* @param fn
	* @return the velocity template
	* @throws Exception
	*/
	private Template getTemplate( String[] path, String fn )
	throws Exception
	{
	ResourceNotFoundException rnfe = null;

	for (String p: path)
	{
	if (p == null)
	continue;

	// System.out.println( "trying to load template "+(p+fn) );
	try
	{
	if (Velocity.resourceExists( p+fn ))
	return Velocity.getTemplate( p+fn );
	}
	catch ( ResourceNotFoundException e )
	{
	rnfe = e;
	}
	catch ( Exception e )
	{
	System.out.println( "ignoring "+e);
	}
	}

	if (rnfe != null)
	throw rnfe;

	throw new ResourceNotFoundException("could not find resource: "+fn);
	}

	/**
	* Constructs the Compiler. This is a helper class not only
	* for Backend, but also for the templates. They call methods
	* here to perform "hard" tasks.
	*
	* @throws Exception
	*/
	public Compiler() throws Exception
	{
	initVelocity();

	String[] path = { tmplPath1, tmplPath2 };
	vf_vm = getTemplate( path, "vf.vm" );
	}

	private final Template vf_vm;

	@Override
	public void generate( Module module, CmdLineOptions options )
	throws Exception
	{
	// xml always wants to not flatten packages:
	options.noFlattenPackages = true;

	lh = options.lh;

	Output dir = options.output;

	String m = module.name().name;
	if (m.length() > 0)
	{
	dir = dir.newPackage( m );
	}

	// generate code for each service.

	for (Service intf : module)
	{
	generate( intf, dir );
	}
	}

	private void generate( final Service intf, Output dir )
	throws Exception
	{
	// Generate the value factory file

	doFile( dir, getVfName( intf ) + fnSuffix, lh, new Gen()
	{
	public void run( PrintWriter pw ) throws Exception
	{
	generateVf( pw, intf );
	}
	} );
	}

	/**
	* Generate the value factory for the service.
	* @param pw
	* @param intf
	* @throws Exception
	*/
	void generateVf( PrintWriter pw, Service intf )
	throws Exception
	{
	// params keeps track of the total set of parameters
	// named (for enums, structs, exceptions, and messages).
	Set<String> params = new HashSet<String>();
	VelocityContext context = new VelocityContext();
	context.put( "now", new Date() );
	context.put( "version", VERSION );
	context.put( "helper", this );
	context.put( "intf", intf );
	context.put( "params", params );
	vf_vm.merge( context, pw );
	}

	private String getVfName( Service intf )
	{
	return getIntfName( intf, MessageDirection.BOTH );
	}

	private String getIntfName( Service intf, MessageDirection mc )
	{
	String suffix = MsgDirHelper.getSuffix( mc );
	return intf.name()+suffix;
	}

	@Override
	public String asyncReceiverPoolName( Message msg )
	{
	return msg.getAsyncReceiver().toString().toLowerCase();
	}

	@Override
	public String getTypeValue( TypeRef type, Token value ) throws Exception
	{
	// System.out.println( "getTypeValue called with: "+type+": "+value );
	Token t = type.type();
	switch (t.kind)
	{
	case EtchGrammarConstants.STRING: return protectString( value.image );
	default: return value.image;
	}
	}

	private String protectString( String s ) throws Exception
	{
	return s;
	//return protectAttr(s);
	}

	/**
	* @param type
	* @return type name appropriate for use as a structure
	* element or exception parameter or function parameter
	* or result.
	*/
	@Override
	public String getTypeName( TypeRef type )
	{
	if (type.dim() > 0)
	return getNativeTypeName( type )/+dim2spec( type.dim() )/;
	return getRefTypeName( type );
	}

	/**
	* @param type the etch type
	* @return the fundamental native type for java. so etch
	* int -> java int, while etch string -> java String.
	*/
	@Override
	public String getNativeTypeName( TypeRef type )
	{
	Token t = type.type();
	switch (t.kind)
	{
	case EtchGrammarConstants.VOID: return "void";
	case EtchGrammarConstants.BOOLEAN: return "boolean";
	case EtchGrammarConstants.BYTE: return "byte";
	case EtchGrammarConstants.SHORT: return "short";
	case EtchGrammarConstants.INT: return "int";
	case EtchGrammarConstants.LONG: return "long";
	case EtchGrammarConstants.FLOAT: return "float";
	case EtchGrammarConstants.DOUBLE: return "double";
	case EtchGrammarConstants.STRING: return "string";
	case EtchGrammarConstants.OBJECT: return "object";
	default:
	{
	// we have to use a fully qualified name here.
	// find the actual type...
	Named<?> n = type.intf().get( t.image );
	if (n == null)
	throw new IllegalArgumentException( String.format(
	"undefined or ambiguous name at line %d: %s",
	t.beginLine, t.image ) );
	String s = n.efqname( this );

	if ( s == null && n instanceof Extern )
	s = t.image;

	return s;
	}
	}
	}


	/**
	* @param type
	* @return true if the type is an etch builtin type.
	*/
	public boolean isBasicType(TypeRef type) {

	Token t = type.type();

	switch (t.kind)
	{
	case EtchGrammarConstants.VOID:
	return true;
	case EtchGrammarConstants.BOOLEAN:
	return true;
	case EtchGrammarConstants.BYTE:
	return true;
	case EtchGrammarConstants.SHORT:
	return true;
	case EtchGrammarConstants.INT:
	return true;
	case EtchGrammarConstants.LONG:
	return true;
	case EtchGrammarConstants.FLOAT:
	return true;
	case EtchGrammarConstants.DOUBLE:
	return true;
	case EtchGrammarConstants.STRING:
	return true;
	case EtchGrammarConstants.OBJECT:
	return true;

	// patch here. more generic approach needed.
	// currently, only taking care of Map, Set, List & Datetime
	case EtchGrammarConstants.ID:
	if ( t.toString().equals("Map") \|\| t.toString().equals("List") \|\|
	t.toString().equals("Set") \|\| t.toString().equals("Datetime") )
	return true;
	}
	return false;
	}

	/**
	* @param type the etch type
	* @return the fundamental native reference type for java.
	* so etch int -> java Integer, while etch string -> java String.
	*/
	private String getRefTypeName( TypeRef type )
	{
	Token t = type.type();
	switch (t.kind)
	{
	case EtchGrammarConstants.VOID: return "void";
	case EtchGrammarConstants.BOOLEAN: return "boolean";
	case EtchGrammarConstants.BYTE: return "byte";
	case EtchGrammarConstants.SHORT: return "short";
	case EtchGrammarConstants.INT: return "int";
	case EtchGrammarConstants.LONG: return "long";
	case EtchGrammarConstants.FLOAT: return "float";
	case EtchGrammarConstants.DOUBLE: return "double";
	case EtchGrammarConstants.STRING: return "string";
	case EtchGrammarConstants.OBJECT: return "object";
	default:
	{
	// we have to use a fully qualified name here.
	// find the actual type...
	Named<?> n = type.intf().get( t.image );
	if (n == null)
	throw new IllegalArgumentException( String.format(
	"undefined or ambiguous name at line %d: %s",
	t.beginLine, t.image ) );


	if ( n.isExtern() )
	return n.fqname();

	return n.efqname( this );
	}
	}
	}

	@Override
	public String formatString( ParamList<Service> n, boolean isExcept )
	throws ParseException, IOException
	{
	ToString ts = (ToString) n.getOpt( "ToString" );
	List<FmtItem> list;
	if (ts != null)
	{
	list = ts.getFormat();
	n.checkFormatList( ts.lineno(), list );
	}
	else
	list = n.mkFormatList( isExcept, false );

	if (list.size() == 1)
	{
	return list.get( 0 ).value();
	}

	StringBuffer sb = new StringBuffer();
	sb.append( "String.format( " );
	sb.append( "\"" );
	for (FmtItem i: list)
	{
	if (i instanceof FieldItem)
	{
	sb.append( "%s" );
	}
	else
	{
	escape( sb, ((StringItem) i).value() );
	}
	}
	sb.append( "\"" );
	for (FmtItem i: list)
	{
	if (i instanceof FieldItem)
	{
	sb.append( ", " );
	sb.append( ((FieldItem) i).value() );
	}
	}
	sb.append( " )" );
	return sb.toString();
	}

	private void escape( StringBuffer sb, String s ) throws IOException
	{
	StringReader rdr = new StringReader( s );
	int c;
	while ((c = rdr.read()) >= 0)
	{
	if (c == '"') sb.append( "\\\"" );
	else if (c == '\\') sb.append( "\\\\" );
	else if (c == '\t') sb.append( "\\t" );
	else if (c == '\r') sb.append( "\\r" );
	else if (c == '\n') sb.append( "\\n" );
	else sb.append( (char) c );
	}
	}

	@Override
	public String mfvname( String vname )
	{
	return "_mf_"+vname;
	}

	@Override
	public String mtvname( String vname )
	{
	return "_mt_"+vname;
	}

	@Override
	public String getLang()
	{
	return "xml";
	}

	@Override
	public String enum_efqname( String fqname, String moduleName,
	String serviceName, String enumName )
	{
	return fqname;
	}

	@Override
	public String except_efqname(String fqname, String moduleName, String serviceName, String exceptName) {

	return fqname;
	}

	@Override
	public String struct_efqname(String fqname, String moduleName, String serviceName, String enumName) {

	return fqname;
	}

	@Override
	public String qualifyParameterName( Token name )
	{
	return name.image;
	}

	@Override
	public String qualifyConstantName( Service intf, Token name )
	{
	return intf.fqname()+'.'+name.image;
	}

	@Override
	public String qualifyEnumName( Service intf, Token name )
	{
	return intf.fqname()+'.'+name.image;
	}

	@Override
	public String getValidator( Named<?> named )
	{
	if (named instanceof Parameter)
	{
	Parameter param = (Parameter) named;
	TypeRef type = param.type();

	if (type.isBuiltin())
	return "Validator_"+type.type()+".get( "+type.dim()+" )";

	return "Validator_custom.getCustom( "+type.getNamed( type.intf() ).efqname( this )+".class, "+type.dim()+" )";
	}

	if (named instanceof Thrown)
	{
	Thrown thrown = (Thrown) named;
	Except e = (Except) thrown.getNamed();
	return "Validator_custom.getCustom( "+e.efqname( this )+".class, 0 )";
	}

	if (named instanceof Item)
	return "Validator_boolean.get( 0 )";

	return "null";
	}

	/**
	* @param descriptions
	* @return string with descriptions
	*/
	public String emitXml(List<String> descriptions)
	{
	StringBuffer buffer = new StringBuffer();
	for(int i = 0; i < descriptions.size(); i++)
	{
	Object objMessage = descriptions.get(i);
	String message = "";
	if(objMessage != null)
	{
	message = objMessage.toString();
	}

	buffer.append(message);

	if(i < descriptions.size() - 1)
	{
	buffer.append("\r\n");
	}
	}

	return buffer.toString();
	}

	/**
	* @param unprotected
	* @return attribute value protected.
	* @throws IOException
	*/
	public String protectAttr(String unprotected) throws IOException
	{
	return org.apache.etch.util.core.xml.XmlParser.ProtectAttrValue.toString(unprotected);
	}

	/**
	* @param unprotected
	* @return cdata value protected.
	* @throws IOException
	*/
	public String protectCData(String unprotected) throws IOException
	{
	return org.apache.etch.util.core.xml.XmlParser.ProtectCData.toString(unprotected);
	}

	@Override
	public void addDefaults( Service service ) throws ParseException
	{
	addBuiltin( service, newName( "List" ), "List", true );
	addBuiltin( service, newName( "Map" ), "Map", true );
	addBuiltin( service, newName( "Set" ), "Set", true );
	addBuiltin( service, newName( "Datetime" ), "Datetime", false );
	}

	/**
	* @param n
	* @return the id of the named item.
	*/
	public int id( Named<?> n )
	{
	if (n instanceof Item \|\| n instanceof Parameter)
	return Hash.hash( n.name().name() );

	return Hash.hash( n.fqname() );
	}
	}