package org.tinyjee.maven.dim.sources;
   
   import org.apache.velocity.app.VelocityEngine;
   import org.apache.velocity.context.Context;
   import org.apache.velocity.tools.config.EasyFactoryConfiguration;
   import org.tinyjee.maven.dim.spi.Globals;
   import org.tinyjee.maven.dim.spi.VelocityConfigurator;
   
   import java.util.Map;
  
  import static org.apache.velocity.runtime.RuntimeConstants.*;
  
  /**
   * Is the default implementation for {@link VelocityConfigurator} which sets various defaults.
   *
   * @author Juergen_Kellerer, 2011-10-14
   */
  public class DefaultVelocityConfigurator implements VelocityConfigurator {
  	public void configureEngine(VelocityEngine engine) {
  		// Register a custom resource loader that uses DIM's path / url resolve logic
  		engine.setProperty(RESOURCE_LOADER, "dim-resource");
  		engine.setProperty("dim-resource.resource.loader.class",
  				"org.tinyjee.maven.dim.sources.TemplateSource$UrlResourceLoader");
  
  		// Enable template-local macro definitions
  		if (engine.getProperty(VM_PERM_ALLOW_INLINE) == null) engine.setProperty(VM_PERM_ALLOW_INLINE, true);
  
  		// Setup macro libraries
  		String existingLibrary = (String) engine.getProperty(VM_LIBRARY);
  		engine.setProperty(VM_LIBRARY, "classpath:/templates/dim/macro-library.vm," + VM_LIBRARY_DEFAULT +
  				(existingLibrary == null ? "" : ',' + existingLibrary));
  	}
  
  	public void configureTools(EasyFactoryConfiguration toolsConfiguration) {
  		toolsConfiguration.toolbox("application").
  				tool("org.apache.velocity.tools.generic.AlternatorTool").
  				tool("org.apache.velocity.tools.generic.ClassTool").
  				tool("org.apache.velocity.tools.generic.ComparisonDateTool").
  				tool("org.apache.velocity.tools.generic.ConversionTool").
  				tool("org.apache.velocity.tools.generic.DateTool").
  				tool("org.apache.velocity.tools.generic.DisplayTool").
  				tool("org.apache.velocity.tools.generic.EscapeTool").
  				tool("org.apache.velocity.tools.generic.FieldTool").
  				tool("org.apache.velocity.tools.generic.MathTool").
  				tool("org.apache.velocity.tools.generic.NumberTool").
  				tool("org.apache.velocity.tools.generic.RenderTool").
  				tool("org.apache.velocity.tools.generic.SortTool").
  				tool("org.apache.velocity.tools.generic.ListTool").
  				tool("org.apache.velocity.tools.generic.ResourceTool").
  				tool("org.apache.velocity.tools.generic.MarkupTool").
  				tool(VelocityHighlightingTool.class).
  				tool(VelocitySourceClassInvocationTool.class);
  	}
  
  	public void configureContext(Map<String, Object> parameters, Context templateContext) {
  		// Note: The given parameters and tools configuration is already present, applying
  		//       additional customizations:
  		if (!templateContext.containsKey("globals")) templateContext.put("globals", Globals.getInstance());
  		if (!templateContext.containsKey("macroParameters")) templateContext.put("macroParameters", parameters);
  		if (!templateContext.containsKey("context")) templateContext.put("context", templateContext);
  
  		// 'sourceUrl' is set when the context is constructed and points to the actual template file,
  		// there's no need to construct and set it here.
  	}
  }