aoqi@0: /*
aoqi@0:  * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: package com.sun.tools.doclets.internal.toolkit.builders;
aoqi@0: 
aoqi@0: import java.io.*;
aoqi@0: import java.util.*;
aoqi@0: 
aoqi@0: import javax.xml.parsers.*;
aoqi@0: 
aoqi@0: import org.xml.sax.*;
aoqi@0: import org.xml.sax.helpers.DefaultHandler;
aoqi@0: 
aoqi@0: import com.sun.tools.doclets.internal.toolkit.*;
aoqi@0: import com.sun.tools.doclets.internal.toolkit.util.*;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Parse the XML that specified the order of operation for the builders.  This
aoqi@0:  * Parser uses SAX parsing.
aoqi@0:  *
aoqi@0:  *  <p><b>This is NOT part of any supported API.
aoqi@0:  *  If you write code that depends on this, you do so at your own risk.
aoqi@0:  *  This code and its internal interfaces are subject to change or
aoqi@0:  *  deletion without notice.</b>
aoqi@0:  *
aoqi@0:  * @author Jamie Ho
aoqi@0:  * @since 1.5
aoqi@0:  * @see SAXParser
aoqi@0:  */
aoqi@0: public class LayoutParser extends DefaultHandler {
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * The map of XML elements that have been parsed.
aoqi@0:      */
aoqi@0:     private Map<String,XMLNode> xmlElementsMap;
aoqi@0:     private XMLNode currentNode;
aoqi@0:     private final Configuration configuration;
aoqi@0:     private String currentRoot;
aoqi@0:     private boolean isParsing;
aoqi@0: 
aoqi@0:     private LayoutParser(Configuration configuration) {
aoqi@0:         xmlElementsMap = new HashMap<String,XMLNode>();
aoqi@0:         this.configuration = configuration;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Return an instance of the BuilderXML.
aoqi@0:      *
aoqi@0:      * @param configuration the current configuration of the doclet.
aoqi@0:      * @return an instance of the BuilderXML.
aoqi@0:      */
aoqi@0:     public static LayoutParser getInstance(Configuration configuration) {
aoqi@0:         return new LayoutParser(configuration);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Parse the XML specifying the layout of the documentation.
aoqi@0:      *
aoqi@0:      * @return the list of XML elements parsed.
aoqi@0:      */
aoqi@0:     public XMLNode parseXML(String root) {
aoqi@0:         if (xmlElementsMap.containsKey(root)) {
aoqi@0:             return xmlElementsMap.get(root);
aoqi@0:         }
aoqi@0:         try {
aoqi@0:             currentRoot = root;
aoqi@0:             isParsing = false;
aoqi@0:             SAXParserFactory factory = SAXParserFactory.newInstance();
aoqi@0:             SAXParser saxParser = factory.newSAXParser();
aoqi@0:             InputStream in = configuration.getBuilderXML();
aoqi@0:             saxParser.parse(in, this);
aoqi@0:             return xmlElementsMap.get(root);
aoqi@0:         } catch (Throwable t) {
aoqi@0:             t.printStackTrace();
aoqi@0:             throw new DocletAbortException(t);
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     @Override
aoqi@0:     public void startElement(String namespaceURI, String sName, String qName,
aoqi@0:         Attributes attrs)
aoqi@0:     throws SAXException {
aoqi@0:         if (isParsing || qName.equals(currentRoot)) {
aoqi@0:             isParsing = true;
aoqi@0:             currentNode = new XMLNode(currentNode, qName);
aoqi@0:             for (int i = 0; i < attrs.getLength(); i++)
aoqi@0:                 currentNode.attrs.put(attrs.getLocalName(i), attrs.getValue(i));
aoqi@0:             if (qName.equals(currentRoot))
aoqi@0:                 xmlElementsMap.put(qName, currentNode);
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     @Override
aoqi@0:     public void endElement(String namespaceURI, String sName, String qName)
aoqi@0:     throws SAXException {
aoqi@0:         if (! isParsing) {
aoqi@0:             return;
aoqi@0:         }
aoqi@0:         currentNode = currentNode.parent;
aoqi@0:         isParsing = ! qName.equals(currentRoot);
aoqi@0:     }
aoqi@0: }