com.sun.electric.util.config.XmlInitSax Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of electric-core Show documentation
There is a newer version: 9.02-e
/* -*- tab-width: 4 -*-
 *
 * Electric(tm) VLSI Design System
 *
 * File: XmlInit.java
 *
 * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
 *
 * Electric(tm) is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * Electric(tm) 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Electric(tm); see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, Mass 02111-1307, USA.
 */
package com.sun.electric.util.config;

import java.io.File;
import java.net.URL;
import java.util.List;
import java.util.Map;
import java.util.Set;

import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;
import org.xml.sax.helpers.DefaultHandler;


import com.sun.electric.util.CollectionFactory;
import com.sun.electric.util.config.XmlConfigVerification.LoopExistsException;
import com.sun.electric.util.config.model.ConfigEntries;
import com.sun.electric.util.config.model.ConfigEntry;
import com.sun.electric.util.config.model.Include;
import com.sun.electric.util.config.model.Injection;
import com.sun.electric.util.config.model.Parameter;

/**
 * @author Felix Schmidt
 * 
 */
public class XmlInitSax extends InitStrategy {

	private static Logger logger = LoggerFactory.getLogger(XmlInitSax.class);

	private String xmlFile;
	private static final String SCHEMA_LANGUAGE = "http://java.sun.com/xml/jaxp/properties/schemaLanguage";
	private static final String XML_SCHEMA = "http://www.w3.org/2001/XMLSchema";

	public XmlInitSax(String xmlFile) {
		this.xmlFile = xmlFile;// new File(xmlFile);
	}

	public XmlInitSax(URL xmlUrl) {

		this.xmlFile = xmlUrl.toString();

	}

	@Override
	public void init(EConfigContainer config) {
		ConfigEntries.refresh();
		Map injections = CollectionFactory.createHashMap();
		List includes = CollectionFactory.createArrayList();
		SAXParser saxParser = null;
		Set visitedIncludes = CollectionFactory.createHashSet();
		try {
			SAXParserFactory factory = SAXParserFactory.newInstance();
			factory.setNamespaceAware(true);
			factory.setValidating(true);

			saxParser = factory.newSAXParser();
			saxParser.setProperty(SCHEMA_LANGUAGE, XML_SCHEMA);
			saxParser.parse(xmlFile, new ParserHandler(injections, includes));

			Include mainInclude = new Include(xmlFile, null);
			visitedIncludes.add(mainInclude);
		} catch (Exception e) {
			e.printStackTrace();
			return;
		}

		try {
			this.parseIncludes(saxParser, includes, visitedIncludes, injections);
		} catch (Exception ex) {
			ex.printStackTrace();
			return;
		}

		try {
			if (XmlConfigVerification.runVerification(injections)) {

				for (Injection in : injections.values()) {
					try {
						logger.debug("bind injection: {} to {}", in.getName(), in.getImplementation());
						ConfigEntry entry;
						if (ConfigEntries.getEntries().containsKey(in.getName())) {
							entry = ConfigEntries.getEntries().get(in.getName());
						} else {
							entry = in.createConfigEntry(injections);
						}
						config.addConfigEntry(in.getName(), entry);
					} catch (ClassNotFoundException e) {
						logger.debug("unable to bind injection: {}", in.getName());
					} catch (LinkageError e) {
						logger.debug("unable to bind injection dependencies: {}", in.getName());
					}

				}
			}
		} catch (LoopExistsException e) {
			logger.error("A loop exists in the configuration");
		}

	}

	private void parseIncludes(SAXParser parser, List includes, Set visitedIncludes,
			Map injections) throws Exception {
		for (Include include : includes) {
			if (!visitedIncludes.contains(include)) {
				List newIncludes = CollectionFactory.createArrayList();
				parser.parse(this.getFileObject(include.getFile()),
						new ParserHandler(injections, newIncludes));

				this.parseIncludes(parser, newIncludes, visitedIncludes, injections);
			}
		}
	}

	private File getFileObject(String name) throws Exception {
		File result = new File(name);

		if (!result.exists()) {
			result = new File(ClassLoader.getSystemResource(name).toURI());
		}

		return result;
	}

	private static class ParserHandler extends DefaultHandler {

		private enum XmlTags {
			configuration, injection, parameters, parameter, include, initRuntimeParameter
		}

		private Injection currentInjection = null;
		private List currentParameters = null;
		private Parameter currentParameter = null;
		private Map injections = null;
		private Include currentInclude = null;
		private List includes;

		public ParserHandler(Map injections, List includes) {
			this.injections = injections;
			this.includes = includes;
		}

		/*
		 * (non-Javadoc)
		 * 
		 * @see
		 * org.xml.sax.helpers.DefaultHandler#startElement(java.lang.String,
		 * java.lang.String, java.lang.String, org.xml.sax.Attributes)
		 */
		@Override
		public void startElement(String uri, String localName, String qName, Attributes attributes)
				throws SAXException {

			if (localName.equals(XmlTags.configuration.toString())) {
			} else if (localName.equals(XmlTags.injection.toString())) {
				this.parseInjectionTag(attributes);
			} else if (localName.equals(XmlTags.parameters.toString())) {
				this.parseParametersTag(attributes);
			} else if (localName.equals(XmlTags.parameter.toString())) {
				this.parseParameterTag(attributes);
			} else if (localName.equals(XmlTags.include.toString())) {
				this.parseIncludeTag(attributes);
			} else if (localName.equals(XmlTags.initRuntimeParameter.toString())) {
				this.parseInitRuntimeParamterTag(attributes);
			} else {
				logger.error("unexpected opening tag: {}", localName);
			}
		}

		private void parseInitRuntimeParamterTag(Attributes attributes) throws SAXException {
			if (currentParameter != null) {
				throw new SAXException("error: closing tag expected");
			} else {
				String name = attributes.getValue(Parameter.Attributes.name.toString());
				String type = attributes.getValue(Parameter.Attributes.type.toString());

				Parameter.Type paramType = Parameter.Type.valueOf(type);

				currentParameter = new Parameter(name, null, null, paramType, false);
			}

		}

		private void parseInjectionTag(Attributes attributes) throws SAXException {
			if (currentInjection != null) {
				throw new SAXException("error: closing tag expected");
			} else {
				String name = attributes.getValue(Injection.Attributes.name.toString());
				String impl = attributes.getValue(Injection.Attributes.implementation.toString());
				String factoryMethod = attributes.getValue(Injection.Attributes.factoryMethod.toString());
				String singleton = attributes.getValue(Injection.Attributes.singleton.toString());

				boolean isSingleton = false;
				if (singleton != null)
					isSingleton = Boolean.parseBoolean(singleton);

				currentInjection = new Injection(name, impl, factoryMethod, isSingleton);
			}
		}

		private void parseParametersTag(Attributes attributes) throws SAXException {
			if (currentParameters != null) {
				throw new SAXException("error: closing tag expected");
			} else {
				currentParameters = CollectionFactory.createArrayList();
			}
		}

		private void parseParameterTag(Attributes attributes) throws SAXException {
			if (currentParameter != null) {
				throw new SAXException("error: closing tag expected");
			} else {
				String name = attributes.getValue(Parameter.Attributes.name.toString());
				String ref = attributes.getValue(Parameter.Attributes.ref.toString());
				String type = attributes.getValue(Parameter.Attributes.type.toString());
				String value = attributes.getValue(Parameter.Attributes.value.toString());

				Parameter.Type paramType;
				if (ref != null) {
					paramType = Parameter.Type.Reference;
				} else {
					paramType = Parameter.Type.valueOf(type);
				}

				currentParameter = new Parameter(name, ref, value, paramType, false);
			}
		}

		private void parseIncludeTag(Attributes attributes) throws SAXException {
			if (currentParameter != null) {
				throw new SAXException("error: closing tag expected");
			} else {
				String file = attributes.getValue(Include.Attributes.file.toString());
				String id = attributes.getValue(Include.Attributes.id.toString());

				currentInclude = new Include(file, id);
			}
		}

		/*
		 * (non-Javadoc)
		 * 
		 * @see org.xml.sax.helpers.DefaultHandler#endElement(java.lang.String,
		 * java.lang.String, java.lang.String)
		 */
		@Override
		public void endElement(String uri, String localName, String qName) throws SAXException {
			if (localName.equals(XmlTags.configuration.toString())) {
			} else if (localName.equals(XmlTags.injection.toString())) {
				injections.put(currentInjection.getName(), currentInjection);
				currentInjection = null;
			} else if (localName.equals(XmlTags.parameters.toString())) {
				currentInjection.setParameters(currentParameters);
				currentParameters = null;
			} else if (localName.equals(XmlTags.parameter.toString())) {
				currentParameters.add(currentParameter);
				currentParameter = null;
			} else if (localName.equals(XmlTags.include.toString())) {
				includes.add(currentInclude);
				currentInclude = null;
			} else if (localName.equals(XmlTags.initRuntimeParameter.toString())) {
				currentParameters.add(currentParameter);
				currentParameter = null;
			} else {
				logger.error("unexpected closing tag: {}");
			}
		}

		/*
		 * (non-Javadoc)
		 * 
		 * @see
		 * org.xml.sax.helpers.DefaultHandler#error(org.xml.sax.SAXParseException
		 * )
		 */
		@Override
		public void error(SAXParseException e) throws SAXException {
			throw new SAXException(e);
		}

		/*
		 * (non-Javadoc)
		 * 
		 * @see
		 * org.xml.sax.helpers.DefaultHandler#warning(org.xml.sax.SAXParseException
		 * )
		 */
		@Override
		public void warning(SAXParseException e) throws SAXException {
			throw new SAXException(e);
		}

	}

}