|
Ant example source code file (ProjectHelper2.java)
The ProjectHelper2.java source code
/*
* 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.tools.ant.helper;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Location;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.ProjectHelper;
import org.apache.tools.ant.RuntimeConfigurable;
import org.apache.tools.ant.Target;
import org.apache.tools.ant.Task;
import org.apache.tools.ant.UnknownElement;
import org.apache.tools.ant.util.FileUtils;
import org.apache.tools.ant.util.JAXPUtils;
import org.xml.sax.Attributes;
import org.xml.sax.InputSource;
import org.xml.sax.Locator;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;
import org.xml.sax.XMLReader;
import org.xml.sax.helpers.DefaultHandler;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.net.URL;
import java.util.HashMap;
import java.util.Hashtable;
import java.util.Map;
import java.util.Stack;
/**
* Sax2 based project reader
*
*/
public class ProjectHelper2 extends ProjectHelper {
/* Stateless */
// singletons - since all state is in the context
private static AntHandler elementHandler = new ElementHandler();
private static AntHandler targetHandler = new TargetHandler();
private static AntHandler mainHandler = new MainHandler();
private static AntHandler projectHandler = new ProjectHandler();
/**
* helper for path -> URI and URI -> path conversions.
*/
private static final FileUtils FILE_UTILS = FileUtils.getFileUtils();
/**
* Parse an unknown element from a url
*
* @param project the current project
* @param source the url containing the task
* @return a configured task
* @exception BuildException if an error occurs
*/
public UnknownElement parseUnknownElement(Project project, URL source)
throws BuildException {
Target dummyTarget = new Target();
dummyTarget.setProject(project);
AntXMLContext context = new AntXMLContext(project);
context.addTarget(dummyTarget);
context.setImplicitTarget(dummyTarget);
parse(context.getProject(), source,
new RootHandler(context, elementHandler));
Task[] tasks = dummyTarget.getTasks();
if (tasks.length != 1) {
throw new BuildException("No tasks defined");
}
return (UnknownElement) tasks[0];
}
/**
* Parse a source xml input.
*
* @param project the current project
* @param source the xml source
* @exception BuildException if an error occurs
*/
public void parse(Project project, Object source)
throws BuildException {
getImportStack().addElement(source);
//System.out.println("Adding " + source);
AntXMLContext context = null;
context = (AntXMLContext) project.getReference("ant.parsing.context");
// System.out.println("Parsing " + getImportStack().size() + " " +
// context+ " " + getImportStack() );
if (context == null) {
context = new AntXMLContext(project);
project.addReference("ant.parsing.context", context);
project.addReference("ant.targets", context.getTargets());
}
if (getImportStack().size() > 1) {
// we are in an imported file.
context.setIgnoreProjectTag(true);
Target currentTarget = context.getCurrentTarget();
Target currentImplicit = context.getImplicitTarget();
Map currentTargets = context.getCurrentTargets();
try {
Target newCurrent = new Target();
newCurrent.setProject(project);
newCurrent.setName("");
context.setCurrentTarget(newCurrent);
context.setCurrentTargets(new HashMap());
context.setImplicitTarget(newCurrent);
parse(project, source, new RootHandler(context, mainHandler));
newCurrent.execute();
} finally {
context.setCurrentTarget(currentTarget);
context.setImplicitTarget(currentImplicit);
context.setCurrentTargets(currentTargets);
}
} else {
// top level file
context.setCurrentTargets(new HashMap());
parse(project, source, new RootHandler(context, mainHandler));
// Execute the top-level target
context.getImplicitTarget().execute();
}
}
/**
* Parses the project file, configuring the project as it goes.
*
* @param project the current project
* @param source the xml source
* @param handler the root handler to use (contains the current context)
* @exception BuildException if the configuration is invalid or cannot
* be read
*/
public void parse(Project project, Object source, RootHandler handler)
throws BuildException {
AntXMLContext context = handler.context;
File buildFile = null;
URL url = null;
String buildFileName = null;
if (source instanceof File) {
buildFile = (File) source;
buildFile = FILE_UTILS.normalize(buildFile.getAbsolutePath());
context.setBuildFile(buildFile);
buildFileName = buildFile.toString();
// } else if (source instanceof InputStream ) {
} else if (source instanceof URL) {
url = (URL) source;
buildFileName = url.toString();
// } else if (source instanceof InputSource ) {
} else {
throw new BuildException("Source " + source.getClass().getName()
+ " not supported by this plugin");
}
InputStream inputStream = null;
InputSource inputSource = null;
try {
/**
* SAX 2 style parser used to parse the given file.
*/
XMLReader parser = JAXPUtils.getNamespaceXMLReader();
String uri = null;
if (buildFile != null) {
uri = FILE_UTILS.toURI(buildFile.getAbsolutePath());
inputStream = new FileInputStream(buildFile);
} else {
inputStream = url.openStream();
uri = url.toString(); // ?? OK ??
}
inputSource = new InputSource(inputStream);
if (uri != null) {
inputSource.setSystemId(uri);
}
project.log("parsing buildfile " + buildFileName
+ " with URI = " + uri, Project.MSG_VERBOSE);
DefaultHandler hb = handler;
parser.setContentHandler(hb);
parser.setEntityResolver(hb);
parser.setErrorHandler(hb);
parser.setDTDHandler(hb);
parser.parse(inputSource);
} catch (SAXParseException exc) {
Location location = new Location(exc.getSystemId(),
exc.getLineNumber(), exc.getColumnNumber());
Throwable t = exc.getException();
if (t instanceof BuildException) {
BuildException be = (BuildException) t;
if (be.getLocation() == Location.UNKNOWN_LOCATION) {
be.setLocation(location);
}
throw be;
} else if (t == null) {
t = exc;
}
throw new BuildException(exc.getMessage(), t, location);
} catch (SAXException exc) {
Throwable t = exc.getException();
if (t instanceof BuildException) {
throw (BuildException) t;
} else if (t == null) {
t = exc;
}
throw new BuildException(exc.getMessage(), t);
} catch (FileNotFoundException exc) {
throw new BuildException(exc);
} catch (UnsupportedEncodingException exc) {
throw new BuildException("Encoding of project file "
+ buildFileName + " is invalid.",
exc);
} catch (IOException exc) {
throw new BuildException("Error reading project file "
+ buildFileName + ": " + exc.getMessage(),
exc);
} finally {
FileUtils.close(inputStream);
}
}
/**
* Returns main handler
* @return main handler
*/
protected static AntHandler getMainHandler() {
return mainHandler;
}
/**
* Sets main handler
* @param handler new main handler
*/
protected static void setMainHandler(AntHandler handler) {
mainHandler = handler;
}
/**
* Returns project handler
* @return project handler
*/
protected static AntHandler getProjectHandler() {
return projectHandler;
}
/**
* Sets project handler
* @param handler new project handler
*/
protected static void setProjectHandler(AntHandler handler) {
projectHandler = handler;
}
/**
* Returns target handler
* @return target handler
*/
protected static AntHandler getTargetHandler() {
return targetHandler;
}
/**
* Sets target handler
* @param handler new target handler
*/
protected static void setTargetHandler(AntHandler handler) {
targetHandler = handler;
}
/**
* Returns element handler
* @return element handler
*/
protected static AntHandler getElementHandler() {
return elementHandler;
}
/**
* Sets element handler
* @param handler new element handler
*/
protected static void setElementHandler(AntHandler handler) {
elementHandler = handler;
}
/**
* The common superclass for all SAX event handlers used to parse
* the configuration file.
*
* The context will hold all state information. At each time
* there is one active handler for the current element. It can
* use onStartChild() to set an alternate handler for the child.
*/
public static class AntHandler {
/**
* Handles the start of an element. This base implementation does
* nothing.
*
* @param uri the namespace URI for the tag
* @param tag The name of the element being started.
* Will not be <code>null.
* @param qname The qualified name of the element.
* @param attrs Attributes of the element being started.
* Will not be <code>null.
* @param context The context that this element is in.
*
* @exception SAXParseException if this method is not overridden, or in
* case of error in an overridden version
*/
public void onStartElement(String uri, String tag, String qname,
Attributes attrs,
AntXMLContext context)
throws SAXParseException {
}
/**
* Handles the start of an element. This base implementation just
* throws an exception - you must override this method if you expect
* child elements.
*
* @param uri The namespace uri for this element.
* @param tag The name of the element being started.
* Will not be <code>null.
* @param qname The qualified name for this element.
* @param attrs Attributes of the element being started.
* Will not be <code>null.
* @param context The current context.
* @return a handler (in the derived classes)
*
* @exception SAXParseException if this method is not overridden, or in
* case of error in an overridden version
*/
public AntHandler onStartChild(String uri, String tag, String qname,
Attributes attrs,
AntXMLContext context)
throws SAXParseException {
throw new SAXParseException("Unexpected element \"" + qname
+ " \"", context.getLocator());
}
/**
* Handle the end of a element.
*
* @param uri the namespace uri of the element
* @param tag the tag of the element
* @param qname the qualified name of the element
* @param context the current context
* @exception SAXParseException if an error occurs
*/
public void onEndChild(String uri, String tag, String qname,
AntXMLContext context)
throws SAXParseException {
}
/**
* This method is called when this element and all elements nested into it have been
* handled. I.e., this happens at the </end_tag_of_the_element>.
* @param uri the namespace uri for this element
* @param tag the element name
* @param context the current context
*/
public void onEndElement(String uri, String tag,
AntXMLContext context) {
}
/**
* Handles text within an element. This base implementation just
* throws an exception, you must override it if you expect content.
*
* @param buf A character array of the text within the element.
* Will not be <code>null.
* @param start The start element in the array.
* @param count The number of characters to read from the array.
* @param context The current context.
*
* @exception SAXParseException if this method is not overridden, or in
* case of error in an overridden version
*/
public void characters(char[] buf, int start, int count, AntXMLContext context)
throws SAXParseException {
String s = new String(buf, start, count).trim();
if (s.length() > 0) {
throw new SAXParseException("Unexpected text \"" + s
+ "\"", context.getLocator());
}
}
/**
* Will be called every time a namespace is reached.
* It'll verify if the ns was processed, and if not load the task
* definitions.
* @param uri The namespace uri.
*/
protected void checkNamespace(String uri) {
}
}
/**
* Handler for ant processing. Uses a stack of AntHandlers to
* implement each element ( the original parser used a recursive behavior,
* with the implicit execution stack )
*/
public static class RootHandler extends DefaultHandler {
private Stack antHandlers = new Stack();
private AntHandler currentHandler = null;
private AntXMLContext context;
/**
* Creates a new RootHandler instance.
*
* @param context The context for the handler.
* @param rootHandler The handler for the root element.
*/
public RootHandler(AntXMLContext context, AntHandler rootHandler) {
currentHandler = rootHandler;
antHandlers.push(currentHandler);
this.context = context;
}
/**
* Returns the current ant handler object.
* @return the current ant handler.
*/
public AntHandler getCurrentAntHandler() {
return currentHandler;
}
/**
* Resolves file: URIs relative to the build file.
*
* @param publicId The public identifier, or <code>null
* if none is available. Ignored in this
* implementation.
* @param systemId The system identifier provided in the XML
* document. Will not be <code>null.
* @return an inputsource for this identifier
*/
public InputSource resolveEntity(String publicId,
String systemId) {
context.getProject().log("resolving systemId: "
+ systemId, Project.MSG_VERBOSE);
if (systemId.startsWith("file:")) {
String path = FILE_UTILS.fromURI(systemId);
File file = new File(path);
if (!file.isAbsolute()) {
file = FILE_UTILS.resolveFile(context.getBuildFileParent(), path);
context.getProject().log(
"Warning: '" + systemId + "' in " + context.getBuildFile()
+ " should be expressed simply as '" + path.replace('\\', '/')
+ "' for compliance with other XML tools",
Project.MSG_WARN);
}
context.getProject().log("file=" + file, Project.MSG_DEBUG);
try {
InputSource inputSource =
new InputSource(new FileInputStream(file));
inputSource.setSystemId(FILE_UTILS.toURI(file.getAbsolutePath()));
return inputSource;
} catch (FileNotFoundException fne) {
context.getProject().log(file.getAbsolutePath()
+ " could not be found", Project.MSG_WARN);
}
}
// use default if not file or file not found
context.getProject().log(
"could not resolve systemId", Project.MSG_DEBUG);
return null;
}
/**
* Handles the start of a project element. A project handler is created
* and initialised with the element name and attributes.
*
* @param uri The namespace uri for this element.
* @param tag The name of the element being started.
* Will not be <code>null.
* @param qname The qualified name for this element.
* @param attrs Attributes of the element being started.
* Will not be <code>null.
*
* @exception org.xml.sax.SAXParseException if the tag given is not
* <code>"project"
*/
public void startElement(String uri, String tag, String qname, Attributes attrs)
throws SAXParseException {
AntHandler next
= currentHandler.onStartChild(uri, tag, qname, attrs, context);
antHandlers.push(currentHandler);
currentHandler = next;
currentHandler.onStartElement(uri, tag, qname, attrs, context);
}
/**
* Sets the locator in the project helper for future reference.
*
* @param locator The locator used by the parser.
* Will not be <code>null.
*/
public void setDocumentLocator(Locator locator) {
context.setLocator(locator);
}
/**
* Handles the end of an element. Any required clean-up is performed
* by the onEndElement() method and then the original handler
* is restored to the parser.
*
* @param uri The namespace URI for this element.
* @param name The name of the element which is ending.
* Will not be <code>null.
* @param qName The qualified name for this element.
*
* @exception SAXException in case of error (not thrown in
* this implementation)
*
*/
public void endElement(String uri, String name, String qName) throws SAXException {
currentHandler.onEndElement(uri, name, context);
AntHandler prev = (AntHandler) antHandlers.pop();
currentHandler = prev;
if (currentHandler != null) {
currentHandler.onEndChild(uri, name, qName, context);
}
}
/**
* Handle text within an element, calls currentHandler.characters.
*
* @param buf A character array of the test.
* @param start The start offset in the array.
* @param count The number of characters to read.
* @exception SAXParseException if an error occurs
*/
public void characters(char[] buf, int start, int count)
throws SAXParseException {
currentHandler.characters(buf, start, count, context);
}
/**
* Start a namespace prefix to uri mapping
*
* @param prefix the namespace prefix
* @param uri the namespace uri
*/
public void startPrefixMapping(String prefix, String uri) {
context.startPrefixMapping(prefix, uri);
}
/**
* End a namepace prefix to uri mapping
*
* @param prefix the prefix that is not mapped anymore
*/
public void endPrefixMapping(String prefix) {
context.endPrefixMapping(prefix);
}
}
/**
* The main handler - it handles the <project> tag.
*
* @see org.apache.tools.ant.helper.ProjectHelper2.AntHandler
*/
public static class MainHandler extends AntHandler {
/**
* Handle the project tag
*
* @param uri The namespace uri.
* @param name The element tag.
* @param qname The element qualified name.
* @param attrs The attributes of the element.
* @param context The current context.
* @return The project handler that handles subelements of project
* @exception SAXParseException if the qualified name is not "project".
*/
public AntHandler onStartChild(String uri, String name, String qname,
Attributes attrs,
AntXMLContext context)
throws SAXParseException {
if (name.equals("project")
&& (uri.equals("") || uri.equals(ANT_CORE_URI))) {
return ProjectHelper2.projectHandler;
} else {
// if (context.importlevel > 0) {
// // we are in an imported file. Allow top-level <target>.
// if (qname.equals( "target" ) )
// return ProjectHelper2.targetHandler;
// }
if (name.equals(qname)) {
throw new SAXParseException("Unexpected element \"{" + uri
+ "}" + name + "\" {" + ANT_CORE_URI + "}" + name,
context.getLocator());
} else {
throw new SAXParseException("Unexpected element \"" + qname
+ "\" " + name, context.getLocator());
}
}
}
}
/**
* Handler for the top level "project" element.
*/
public static class ProjectHandler extends AntHandler {
/**
* Initialisation routine called after handler creation
* with the element name and attributes. The attributes which
* this handler can deal with are: <code>"default",
* <code>"name",
Other Ant examples (source code examples)Here is a short list of links related to this Ant ProjectHelper2.java source code file: |
| ... this post is sponsored by my books ... | |
#1 New Release! |
FP Best Seller |
Copyright 1998-2024 Alvin Alexander, alvinalexander.com
All Rights Reserved.
A percentage of advertising revenue from
pages under the /java/jwarehouse
URI on this website is
paid back to open source projects.