com.github.gumtreediff.matchers.MappingStore Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
GumTree core module.
The newest version!
/*
 * This file is part of GumTree.
 *
 * GumTree is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * GumTree 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with GumTree.  If not, see .
 *
 * Copyright 2011-2015 Jean-Rémy Falleri 
 * Copyright 2011-2015 Floréal Morandat 
 */

package com.github.gumtreediff.matchers;

import java.util.*;

import com.github.gumtreediff.tree.Tree;

/**
 * Class dedicated to store mappings between two ASTs.
 * Internally, the mappings are stored via two hashmaps.
 *
 * @see Tree
 */
public class MappingStore implements Iterable {
    /**
     * The immutable root of the source AST
     */
    public final Tree src;

    /**
     * The immutable root of the destination AST
     */
    public final Tree dst;

    private Map srcToDst;
    private Map dstToSrc;

    /**
     * Instantiate a mapping store using the mappings of the provided
     * mapping store.
     * The references to the source and destination AST are also copied
     * from the provided mapping store.
     */
    public MappingStore(MappingStore ms) {
        this(ms.src, ms.dst);
        for (Mapping m : ms)
            addMapping(m.first, m.second);
    }

    /**
     * Instantiate a new empty mapping store between the provided
     * source and destination AST.
     */
    public MappingStore(Tree src, Tree dst) {
        this.src = src;
        this.dst = dst;
        srcToDst = new HashMap<>();
        dstToSrc = new HashMap<>();
    }

    /**
     * Return the number of mappings.
     */
    public int size() {
        return srcToDst.size();
    }

    /**
     * Converts the mapping store to a set of mappings.
     */
    public Set asSet() {
        return new AbstractSet<>() {
            @Override
            public Iterator iterator() {
                Iterator it = srcToDst.keySet().iterator();
                return new Iterator<>() {
                    @Override
                    public boolean hasNext() {
                        return it.hasNext();
                    }

                    @Override
                    public Mapping next() {
                        Tree src = it.next();
                        if (src == null) return null;
                        return new Mapping(src, srcToDst.get(src));
                    }
                };
            }

            @Override
            public int size() {
                return srcToDst.keySet().size();
            }
        };
    }

    /**
     * Add a mapping between the two provided nodes inside the mapping store.
     */
    public void addMapping(Tree src, Tree dst) {
        srcToDst.put(src, dst);
        dstToSrc.put(dst, src);
    }

    /**
     * Add a mapping between the two provided nodes inside the mapping store.
     * Mappings between all descendants of the two nodes are added as well.
     * The trees rooted at the source and destination nodes are expected to be at
     * least iso structural.
     * 
     * @see Tree#isIsoStructuralTo(Tree)
     */
    public void addMappingRecursively(Tree src, Tree dst) {
        addMapping(src, dst);
        for (int i = 0; i < src.getChildren().size(); i++)
            addMappingRecursively(src.getChild(i), dst.getChild(i));
    }

    /**
     * Remove the mapping between the provided source and destination nodes.
     */
    public void removeMapping(Tree src, Tree dst) {
        srcToDst.remove(src);
        dstToSrc.remove(dst);
    }

    /**
     * Return the destination source node mapped to the given source node.
     * If there is no mapping involving the source node, null is returned.
     */
    public Tree getDstForSrc(Tree src) {
        return srcToDst.get(src);
    }

    /**
     * Return the source node mapped to the given destination node.
     * If there is no mapping involving the destination node, null is returned.
     */
    public Tree getSrcForDst(Tree dst) {
        return dstToSrc.get(dst);
    }

    /**
     * Return whether or not there is a mapping for the given source node.
     */
    public boolean isSrcMapped(Tree src) {
        return srcToDst.containsKey(src);
    }

    /**
     * Return whether or not there is a mapping for the given destination node.
     */
    public boolean isDstMapped(Tree dst) {
        return dstToSrc.containsKey(dst);
    }

    /**
     * Return whether or not the given source and destination nodes are unmapped.
     */
    public boolean areBothUnmapped(Tree src, Tree dst) {
        return !(isSrcMapped(src) || isDstMapped(dst));
    }

    /**
     * Return whether or not all the given source nodes are unmapped.
     */
    public boolean areSrcsUnmapped(Collection srcs) {
        for (Tree src : srcs)
            if (isSrcMapped(src))
                return false;

        return true;
    }

    /**
     * Return whether or not all the given destination nodes are unmapped.
     */
    public boolean areDstsUnmapped(Collection dsts) {
        for (Tree dst : dsts)
            if (isDstMapped(dst))
                return false;

        return true;
    }

    /**
     * Return whether or not the given source node has unmapped descendants.
     */
    public boolean hasUnmappedSrcChildren(Tree t) {
        for (Tree c : t.getDescendants())
            if (!isSrcMapped(c))
                return true;

        return false;
    }

    /**
     * Return whether or not the given destination node has unmapped descendants.
     */
    public boolean hasUnmappedDstChildren(Tree t) {
        for (Tree c : t.getDescendants())
            if (!isDstMapped(c))
                return true;

        return false;
    }

    /**
     * Returns whether or not there is a mapping between the given source and
     * destination nodes.
     */
    public boolean has(Tree src, Tree dst) {
        return srcToDst.get(src) == dst;
    }

    @Override
    public Iterator iterator() {
        return asSet().iterator();
    }

    @Override
    public String toString() {
        StringBuilder b = new StringBuilder();
        for (Mapping m : this)
            b.append(m.toString()).append('\n');
        return b.toString();
    }

    /**
     * Return whether or not a mapping is possible between the provided source and
     * destination nodes.
     */
    public boolean isMappingAllowed(Tree src, Tree dst) {
        return src.hasSameType(dst) && areBothUnmapped(src, dst);
    }
}