package votorola.g.web.gwt; // Copyright 2012, Michael Allan.  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Votorola Software"), to deal in the Votorola Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicence, and/or sell copies of the Votorola Software, and to permit persons to whom the Votorola Software is furnished to do so, subject to the following conditions: The preceding copyright notice and this permission notice shall be included in all copies or substantial portions of the Votorola Software. THE VOTOROLA SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE VOTOROLA SOFTWARE OR THE USE OR OTHER DEALINGS IN THE VOTOROLA SOFTWARE.

import com.google.gwt.dom.client.*;


/** {@linkplain Node Node} utilities.
  */
public final class NodeX
{


    private NodeX() {}



    /** Returns the next ancestor that is an element, or null if there is none.
      */
    public static Element nextAncestorElement( Node node )
    {
        for( ;; )
        {
            node = node.getParentNode();
            if( node == null ) return null;

            if( Element.is( node )) return node.cast();
        }
    }



    /** Returns the next element in document order; or null if n is null, or the document
      * has no more elements.
      *
      *     @param n the reference node, which may be null.
      *     @param name the tag name to restrict the search to, or null to search for
      *       elements of any tag name.
      *     @param deeply whether to recurse into child nodes, if any.
      */
    public static Element nextElement( Node n, final String name, final boolean deeply )
    {
        for( ;; )
        {
            n = nextNode( n, deeply );
            if( n == null ) break;

            if( !Element.is( n )) continue;

            if( name == null || name.equals(n.getNodeName()) ) return n.cast();
        }
        return null;
    }



    /** Returns the next node in document order; or null if n is null, or the document has
      * no more nodes.
      *
      *     @param n the reference node, which may be null.
      *     @param deeply whether to recurse into child nodes, if any.  Calling
      *       <code>nextNode(n,true)</code> is equivalent to
      *       org.w3c.dom.traversal.TreeWalker.nextNode.
      */
    public static Node nextNode( final Node n, final boolean deeply )
    {
        Node o = null; // next node
        walk: if( n != null )
        {
            if( deeply )
            {
                o = n.getFirstChild();
                if( o != null ) break walk;
            }

            o = n.getNextSibling();
            if( o != null ) break walk;

            o = nextNode( n.getParentNode(), /*deeply*/false );
        }
        return o;
    }



}