org.netbeans.modules.css.parser.SimpleNodeUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of css-parser Show documentation
A CSS Parser extract from the NetBeans CSS modules
The newest version!
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 1997-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
 * Other names may be trademarks of their respective owners.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common
 * Development and Distribution License("CDDL") (collectively, the
 * "License"). You may not use this file except in compliance with the
 * License. You can obtain a copy of the License at
 * http://www.netbeans.org/cddl-gplv2.html
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 * specific language governing permissions and limitations under the
 * License.  When distributing the software, include this License Header
 * Notice in each file and include the License file at
 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the GPL Version 2 section of the License file that
 * accompanied this code. If applicable, add the following below the
 * License Header, with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 * 
 * If you wish your version of this file to be governed by only the CDDL
 * or only the GPL Version 2, indicate your decision by adding
 * "[Contributor] elects to include this software in this distribution
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 * single choice of license, a recipient has the option to distribute
 * your version of this file under either the CDDL, the GPL Version 2 or
 * to extend the choice of license to its licensees as provided above.
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 * Version 2 license, then the option applies only if the new code is
 * made subject to such option by the copyright holder.
 * 
 * Contributor(s):
 * 
 * Portions Copyrighted 2008 Sun Microsystems, Inc.
 */
package org.netbeans.modules.css.parser;

import java.util.ArrayList;
import java.util.StringTokenizer;
import java.util.concurrent.atomic.AtomicReference;
import org.netbeans.modules.csl.api.OffsetRange;

/**
 *
 * @author marek
 */
public class SimpleNodeUtil {

    public static OffsetRange getTrimmedNodeRange(SimpleNode node) {
        CharSequence text = node.image();
        int from_diff;
        int to_diff;
        for(from_diff = 0; from_diff < text.length(); from_diff++) {
            if(!Character.isWhitespace(text.charAt(from_diff))) {
                break;
            }
        }

        for(to_diff = 0; to_diff < text.length() - from_diff; to_diff++) {
            if(!Character.isWhitespace(text.charAt(text.length() - 1 - to_diff))) {
                break;
            }
        }

        return new OffsetRange(node.startOffset() + from_diff, node.endOffset() - to_diff);
    }

    public static Token getNodeToken(SimpleNode node, int tokenKind) {
        Token t = node.jjtGetFirstToken();
        if (t == null) {
            return null;
        }
        do {
            if(t.kind == tokenKind) {
                return t;
            }
            t = t.next;
        } while (t != node.jjtGetLastToken());
        return null;
    }

    public static SimpleNode findDescendant(SimpleNode node, int astOffset) {
        int so = node.startOffset();
        int eo = node.endOffset();
       
        
        if (astOffset < so || astOffset > eo) {
            //we are out of the scope - may happen just with the first client call
            return null;
        }

        if (astOffset >= so && astOffset <= eo && node.jjtGetNumChildren() == 0) {
            //if the node matches and has no children we found it
            return node;
        }

        for (int i = 0; i < node.jjtGetNumChildren(); i++) {
            SimpleNode child = (SimpleNode) node.jjtGetChild(i);

            int ch_so = child.startOffset();
            int ch_eo = child.endOffset();
            if (astOffset >= ch_so && astOffset <= ch_eo) {
                //the child is or contains the searched node
                return findDescendant(child, astOffset);
            }

        }

        return node;
    }

    
    /** @return first child of the node with the specified kind. */
    public static SimpleNode getChildByType(SimpleNode node, int kind) {
        SimpleNode[] children = getChildrenByType(node, kind);
        return children.length == 0 ? null : children[0];
    }

    public static SimpleNode getAncestorByType(SimpleNode node, final int kind) {
	final AtomicReference found = new AtomicReference();
	visitAncestors(node, new NodeVisitor() {
	    public void visit(SimpleNode node) {
		if(found.get() == null && node.kind() == kind) {
		    found.set(node);
		}
	    }
	});
	return found.get();
    }
    
    /** @return list of children of the node with the specified kind. */
    public static SimpleNode[] getChildrenByType(SimpleNode node, int kind) {
        int childrenCount = node.jjtGetNumChildren();
        if(childrenCount == 0) {
            return new SimpleNode[0];
        }
        ArrayList list = new ArrayList(childrenCount / 4);
        for(int i = 0; i < childrenCount ; i++) {
            SimpleNode child = (SimpleNode)node.children[i];
            if(child.kind() == kind) {
                list.add(child);
            }
        }
        return list.toArray(new SimpleNode[]{});
    }
    
    public static void visitChildren(SimpleNode node, NodeVisitor visitor) {
        Node[] children = node.children;
        if (children != null) {
            for (int i = 0; i < children.length; ++i) {
                SimpleNode n = (SimpleNode) children[i];
                if (n != null) {
                    visitor.visit(n);
                    n.visitChildren(visitor);
                }
            }
        }
    }

    public static void visitAncestors(SimpleNode node, NodeVisitor visitor) {
        SimpleNode parent = (SimpleNode)node.parent;
        if (parent != null) {
            visitor.visit(parent);
            visitAncestors(parent, visitor);
        }
    }
    
        /** @return A sibling node before or after the given node. */
    public static SimpleNode getSibling(SimpleNode node, boolean before) {
        SimpleNode parent = (SimpleNode)node.jjtGetParent();
        if(parent == null) {
            return null;
        }
        if(parent.children == null) {
            return null;
        }
        
        SimpleNode sibling = null;
        for(int i = 0; i < parent.children.length ; i++) {
            SimpleNode child = (SimpleNode)parent.children[i];
            if(child == node) {
                //we found myself
                if(before) {
                    if(i == 0) {
                        //we are first node, no sibling before
                        return null;
                    } else {
                        return (SimpleNode)parent.children[i - 1];
                    }
                } else {
                    //after
                    if(i == parent.children.length - 1) {
                        //we are last node, no sibling after
                        return null;
                    } else {
                        return (SimpleNode)parent.children[i + 1];
                    }
                }
            }
        }
        return sibling;
    }

     /** find an SimpleNode according to the path
     * example of path: html/body/table|2/tr -- find a second table tag in body tag
     *
     */
    public static SimpleNode query(SimpleNode base, String path) {
        StringTokenizer st = new StringTokenizer(path, "/");
        SimpleNode found = base;
        while(st.hasMoreTokens()) {
            String token = st.nextToken();
            int indexDelim = token.indexOf('|');

            String nodeName = indexDelim >= 0 ? token.substring(0, indexDelim) : token;
            String sindex = indexDelim >= 0 ? token.substring(indexDelim + 1, token.length()) : "0";
            int index = Integer.parseInt(sindex);

            int count = 0;
            SimpleNode foundLocal = null;
            if(found.children != null) {
                for(Node _child : found.children) {
                    SimpleNode child = (SimpleNode)_child;

                    if(CssParserTreeConstants.jjtNodeName[child.kind()].equals(nodeName) && count++ == index) {
                        foundLocal = child;
                        break;
                    }
                }
            }
            if(foundLocal != null) {
                found = foundLocal;

                if(!st.hasMoreTokens()) {
                    //last token, we may return
                    assert CssParserTreeConstants.jjtNodeName[found.kind()].equals(nodeName);
                    return found;
                }

            } else {
                return null; //no found
            }
        }

        return null;
    }

    public static String getNodeImage(SimpleNode node) {
        String image;
        switch(node.kind()) {
            case CssParserTreeConstants.JJTHEXCOLOR:
                //filter out comments and whitespaces since the node
                //can also contain them: ( ( (  |  ) )*)
                image = node.image(CssParserConstants.COMMENT, CssParserConstants.S);
                break;
            default:
                image = node.image();
        }

        return image;
    }

}