325N/A/*
325N/A * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
325N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
325N/A *
325N/A * This code is free software; you can redistribute it and/or modify it
325N/A * under the terms of the GNU General Public License version 2 only, as
325N/A * published by the Free Software Foundation. Oracle designates this
325N/A * particular file as subject to the "Classpath" exception as provided
325N/A * by Oracle in the LICENSE file that accompanied this code.
325N/A *
325N/A * This code is distributed in the hope that it will be useful, but WITHOUT
325N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
325N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
325N/A * version 2 for more details (a copy is included in the LICENSE file that
325N/A * accompanied this code).
325N/A *
325N/A * You should have received a copy of the GNU General Public License version
325N/A * 2 along with this work; if not, write to the Free Software Foundation,
325N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
325N/A *
325N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
325N/A * or visit www.oracle.com if you need additional information or have any
325N/A * questions.
325N/A */
325N/A
325N/Apackage com.sun.tools.internal.xjc.reader.dtd.bindinfo;
325N/A
325N/Aimport java.io.IOException;
325N/Aimport java.util.Collection;
325N/Aimport java.util.HashMap;
325N/Aimport java.util.Map;
325N/A
325N/Aimport javax.xml.parsers.ParserConfigurationException;
325N/Aimport javax.xml.parsers.SAXParserFactory;
325N/Aimport javax.xml.validation.ValidatorHandler;
325N/A
325N/Aimport com.sun.codemodel.internal.ClassType;
325N/Aimport com.sun.codemodel.internal.JClass;
325N/Aimport com.sun.codemodel.internal.JClassAlreadyExistsException;
325N/Aimport com.sun.codemodel.internal.JCodeModel;
325N/Aimport com.sun.codemodel.internal.JDefinedClass;
325N/Aimport com.sun.codemodel.internal.JPackage;
325N/Aimport com.sun.istack.internal.SAXParseException2;
325N/Aimport com.sun.tools.internal.xjc.AbortException;
325N/Aimport com.sun.tools.internal.xjc.ErrorReceiver;
325N/Aimport com.sun.tools.internal.xjc.SchemaCache;
325N/Aimport com.sun.tools.internal.xjc.model.CCustomizations;
325N/Aimport com.sun.tools.internal.xjc.model.CPluginCustomization;
325N/Aimport com.sun.tools.internal.xjc.model.Model;
325N/Aimport com.sun.tools.internal.xjc.reader.Const;
325N/Aimport com.sun.tools.internal.xjc.util.CodeModelClassFactory;
325N/Aimport com.sun.tools.internal.xjc.util.ErrorReceiverFilter;
325N/Aimport com.sun.tools.internal.xjc.util.ForkContentHandler;
325N/A
325N/Aimport org.w3c.dom.Document;
325N/Aimport org.w3c.dom.Element;
325N/Aimport org.xml.sax.InputSource;
325N/Aimport org.xml.sax.SAXException;
325N/Aimport org.xml.sax.XMLReader;
325N/A
325N/A/**
325N/A * Root of the binding information.
325N/A */
325N/Apublic class BindInfo
325N/A{
325N/A /** Controller object that can be used to report errors. */
325N/A protected final ErrorReceiver errorReceiver;
325N/A
325N/A /*package*/ final Model model;
325N/A
325N/A /**
325N/A * The -p option that should control the default Java package that
325N/A * will contain the generated code. Null if unspecified. This takes
325N/A * precedence over the value specified in the binding file.
325N/A */
325N/A private final String defaultPackage;
325N/A
325N/A public BindInfo(Model model, InputSource source, ErrorReceiver _errorReceiver) throws AbortException {
325N/A this( model, parse(model,source,_errorReceiver), _errorReceiver);
325N/A }
325N/A
325N/A public BindInfo(Model model, Document _dom, ErrorReceiver _errorReceiver) {
325N/A this.model = model;
325N/A this.dom = _dom.getDocumentElement();
325N/A this.codeModel = model.codeModel;
325N/A this.errorReceiver = _errorReceiver;
325N/A this.classFactory = new CodeModelClassFactory(_errorReceiver);
325N/A // TODO: decide name converter from the binding file
325N/A
325N/A this.defaultPackage = model.options.defaultPackage;
325N/A
325N/A // copy global customizations to the model
325N/A model.getCustomizations().addAll(getGlobalCustomizations());
325N/A
325N/A // process element declarations
325N/A for( Element ele : DOMUtil.getChildElements(dom,"element")) {
325N/A BIElement e = new BIElement(this,ele);
325N/A elements.put(e.name(),e);
325N/A }
325N/A
325N/A // add built-in conversions
325N/A BIUserConversion.addBuiltinConversions(this,conversions);
325N/A
325N/A // process conversion declarations
325N/A for( Element cnv : DOMUtil.getChildElements(dom,"conversion")) {
325N/A BIConversion c = new BIUserConversion(this,cnv);
325N/A conversions.put(c.name(),c);
325N/A }
325N/A for( Element en : DOMUtil.getChildElements(dom,"enumeration")) {
325N/A BIConversion c = BIEnumeration.create( en, this );
325N/A conversions.put(c.name(),c);
325N/A }
325N/A // TODO: check the uniquness of conversion name
325N/A
325N/A
325N/A // process interface definitions
325N/A for( Element itf : DOMUtil.getChildElements(dom,"interface")) {
325N/A BIInterface c = new BIInterface(itf);
325N/A interfaces.put(c.name(),c);
325N/A }
325N/A }
325N/A
325N/A
325N/A /** CodeModel object that is used by this binding file. */
325N/A final JCodeModel codeModel;
325N/A
325N/A /** Wrap the codeModel object and automate error reporting. */
325N/A final CodeModelClassFactory classFactory;
325N/A
325N/A /** DOM tree that represents binding info. */
325N/A private final Element dom;
325N/A
325N/A /** Conversion declarations. */
325N/A private final Map<String,BIConversion> conversions = new HashMap<String,BIConversion>();
325N/A
325N/A /** Element declarations keyed by names. */
325N/A private final Map<String,BIElement> elements = new HashMap<String,BIElement>();
325N/A
325N/A /** interface declarations keyed by names. */
325N/A private final Map<String,BIInterface> interfaces = new HashMap<String,BIInterface>();
325N/A
325N/A
325N/A /** XJC extension namespace. */
325N/A private static final String XJC_NS = Const.XJC_EXTENSION_URI;
325N/A
325N/A//
325N/A//
325N/A// Exposed public methods
325N/A//
325N/A//
325N/A /** Gets the serialVersionUID if it's turned on. */
325N/A public Long getSerialVersionUID() {
325N/A Element serial = DOMUtil.getElement(dom,XJC_NS,"serializable");
325N/A if(serial==null) return null;
325N/A
325N/A String v = DOMUtil.getAttribute(serial,"uid");
325N/A if(v==null) v="1";
325N/A return new Long(v);
325N/A }
325N/A
325N/A /** Gets the xjc:superClass customization if it's turned on. */
325N/A public JClass getSuperClass() {
325N/A Element sc = DOMUtil.getElement(dom,XJC_NS,"superClass");
325N/A if (sc == null) return null;
325N/A
325N/A JDefinedClass c;
325N/A
325N/A try {
325N/A String v = DOMUtil.getAttribute(sc,"name");
325N/A if(v==null) return null;
325N/A c = codeModel._class(v);
325N/A c.hide();
325N/A } catch (JClassAlreadyExistsException e) {
325N/A c = e.getExistingClass();
325N/A }
325N/A
325N/A return c;
325N/A }
325N/A
325N/A /** Gets the xjc:superInterface customization if it's turned on. */
325N/A public JClass getSuperInterface() {
325N/A Element sc = DOMUtil.getElement(dom,XJC_NS,"superInterface");
325N/A if (sc == null) return null;
325N/A
325N/A String name = DOMUtil.getAttribute(sc,"name");
325N/A if (name == null) return null;
325N/A
325N/A JDefinedClass c;
325N/A
325N/A try {
325N/A c = codeModel._class(name, ClassType.INTERFACE);
325N/A c.hide();
325N/A } catch (JClassAlreadyExistsException e) {
325N/A c = e.getExistingClass();
325N/A }
325N/A
325N/A return c;
325N/A }
325N/A
325N/A /**
325N/A * Gets the specified package name (options/@package).
325N/A */
325N/A public JPackage getTargetPackage() {
325N/A if(model.options.defaultPackage!=null)
325N/A // "-p" takes precedence over everything else
325N/A return codeModel._package(model.options.defaultPackage);
325N/A
325N/A String p;
325N/A if( defaultPackage!=null )
325N/A p = defaultPackage;
325N/A else
325N/A p = getOption("package", "");
325N/A return codeModel._package(p);
325N/A }
325N/A
325N/A /**
325N/A * Gets the conversion declaration from the binding info.
325N/A *
325N/A * @return
325N/A * A non-null valid BIConversion object.
325N/A */
325N/A public BIConversion conversion(String name) {
325N/A BIConversion r = conversions.get(name);
325N/A if (r == null)
325N/A throw new AssertionError("undefined conversion name: this should be checked by the validator before we read it");
325N/A return r;
325N/A }
325N/A
325N/A /**
325N/A * Gets the element declaration from the binding info.
325N/A *
325N/A * @return
325N/A * If there is no declaration with a given name,
325N/A * this method returns null.
325N/A */
325N/A public BIElement element( String name ) {
325N/A return elements.get(name);
325N/A }
325N/A /** Iterates all {@link BIElement}s in a read-only set. */
325N/A public Collection<BIElement> elements() {
325N/A return elements.values();
325N/A }
325N/A
325N/A /** Returns all {@link BIInterface}s in a read-only set. */
325N/A public Collection<BIInterface> interfaces() {
325N/A return interfaces.values();
325N/A }
325N/A
325N/A /**
325N/A * Gets the list of top-level {@link CPluginCustomization}s.
325N/A */
325N/A private CCustomizations getGlobalCustomizations() {
325N/A CCustomizations r=null;
325N/A for( Element e : DOMUtil.getChildElements(dom) ) {
325N/A if(!model.options.pluginURIs.contains(e.getNamespaceURI()))
325N/A continue; // this isn't a plugin customization
325N/A if(r==null)
325N/A r = new CCustomizations();
325N/A r.add(new CPluginCustomization(e, DOMLocator.getLocationInfo(e)));
325N/A }
325N/A
325N/A if(r==null) r = CCustomizations.EMPTY;
325N/A return new CCustomizations(r);
325N/A }
325N/A
325N/A
325N/A
325N/A
325N/A//
325N/A//
325N/A// Internal utility methods
325N/A//
325N/A//
325N/A
325N/A
325N/A /** Gets the value from the option element. */
325N/A private String getOption(String attName, String defaultValue) {
325N/A Element opt = DOMUtil.getElement(dom,"options");
325N/A if (opt != null) {
325N/A String s = DOMUtil.getAttribute(opt,attName);
325N/A if (s != null)
325N/A return s;
325N/A }
325N/A return defaultValue;
325N/A }
325N/A
325N/A /**
325N/A * Lazily parsed schema for the binding file.
325N/A */
325N/A private static SchemaCache bindingFileSchema = new SchemaCache(BindInfo.class.getResource("bindingfile.xsd"));
325N/A
325N/A /**
325N/A * Parses an InputSource into dom4j Document.
325N/A * Returns null in case of an exception.
325N/A */
325N/A private static Document parse( Model model, InputSource is, ErrorReceiver receiver ) throws AbortException {
325N/A try {
325N/A ValidatorHandler validator = bindingFileSchema.newValidator();
325N/A
325N/A // set up the pipe line as :
325N/A // /-> extensionChecker -> validator
325N/A // parser-> -<
325N/A // \-> DOM builder
325N/A SAXParserFactory pf = SAXParserFactory.newInstance();
325N/A pf.setNamespaceAware(true);
325N/A DOMBuilder builder = new DOMBuilder();
325N/A
325N/A ErrorReceiverFilter controller = new ErrorReceiverFilter(receiver);
325N/A validator.setErrorHandler(controller);
325N/A XMLReader reader = pf.newSAXParser().getXMLReader();
325N/A reader.setErrorHandler(controller);
325N/A
325N/A DTDExtensionBindingChecker checker = new DTDExtensionBindingChecker("", model.options, controller);
325N/A checker.setContentHandler(validator);
325N/A
325N/A reader.setContentHandler(new ForkContentHandler(checker,builder));
325N/A
325N/A reader.parse(is);
325N/A
325N/A if(controller.hadError()) throw new AbortException();
325N/A return (Document)builder.getDOM();
325N/A } catch( IOException e ) {
325N/A receiver.error( new SAXParseException2(e.getMessage(),null,e) );
325N/A } catch( SAXException e ) {
325N/A receiver.error( new SAXParseException2(e.getMessage(),null,e) );
325N/A } catch( ParserConfigurationException e ) {
325N/A receiver.error( new SAXParseException2(e.getMessage(),null,e) );
325N/A }
325N/A
325N/A throw new AbortException();
325N/A }
325N/A}