com.github.gumtreediff.gen.TreeGenerators 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.gen;

import com.github.gumtreediff.io.TreeIoUtils;
import com.github.gumtreediff.tree.TreeContext;
import com.github.gumtreediff.utils.Registry;

import java.io.IOException;
import java.io.Reader;
import java.util.Arrays;
import java.util.regex.Pattern;

/**
 * Registry of tree generators, using a singleton pattern.
 */
public class TreeGenerators extends Registry {

    private static TreeGenerators registry;

    /**
     * Return the tree generators registry instance (singleton pattern).
     */
    public static TreeGenerators getInstance() {
        if (registry == null)
            registry = new TreeGenerators();
        return registry;
    }

    /**
     * Search a tree generator for the provided file path (based on the file extension), and use it
     * to produce a TreeContext containing the AST.
     *
     * @throws UnsupportedOperationException if no suitable generator is found
     */
    public TreeContext getTree(String file) throws UnsupportedOperationException, IOException {
        TreeGenerator p = get(file);
        if (p == null)
            throw new UnsupportedOperationException("No generator found for file: " + file);
        return p.generateFrom().file(file);
    }

    /**
     * Search the tree generator with the provided name , and use it
     * to produce a TreeContext containing the AST.
     *
     * @param generator the tree generator's name. if null, fallbacks to @see getTree(String)
     * @throws UnsupportedOperationException if no suitable generator is found
     */
    public TreeContext getTree(String file, String generator) throws UnsupportedOperationException, IOException {
        if (generator == null)
            return getTree(file);

        for (Entry e : entries)
            if (e.id.equals(generator))
                return e.instantiate(null).generateFrom().file(file);

        throw new UnsupportedOperationException("No generator \"" + generator + "\" found.");
    }

    /**
     * Search the tree generator with the provided name , and use it
     * to produce a TreeContext containing the AST.
     *
     * @param generator the tree generator's name. It can't be null
     * @throws UnsupportedOperationException if no suitable generator is found
     */
    public TreeContext getTree(Reader stream, String generator) throws UnsupportedOperationException, IOException {
        for (Entry e : entries)
            if (e.id.equals(generator))
                return e.instantiate(null).generateFrom().reader(stream);

        throw new UnsupportedOperationException("No generator \"" + generator + "\" found.");
    }

    public TreeContext getTreeFromCommand(String file, String command) throws IOException {
        TreeGenerator g = new ExternalProcessTreeGenerator() {
            @Override
            protected String[] getCommandLine(String file) {
                return command.replace("$FILE", file).split(" ");
            }

            @Override
            protected TreeContext generate(Reader r) throws IOException {
                String output = readStandardOutput(r);
                TreeContext ctx = TreeIoUtils.fromXml().generateFrom().string(output);
                return ctx;
            }
        };
        return g.generateFrom().file(file);
    }

    /**
     * Return whether or not a generator with the provided name exists.
     */
    public boolean has(String generator) {
        return this.findById(generator) != null;
    }

    /**
     * Indicate whether or not the provided file path has a related tree generator
     */
    public boolean hasGeneratorForFile(String file) {
        return get(file) != null;
    }

    @Override
    protected Entry newEntry(Class clazz, Register annotation) {
        return new Entry(annotation.id(), clazz, defaultFactory(clazz), annotation.priority()) {
            final Pattern[] accept;

            {
                String[] accept = annotation.accept();
                this.accept = new Pattern[accept.length];
                for (int i = 0; i < accept.length; i++)
                    this.accept[i] = Pattern.compile(accept[i]);
            }

            @Override
            protected boolean handle(String key) {
                for (Pattern pattern : accept)
                    if (pattern.matcher(key).find())
                        return true;
                return false;
            }

            @Override
            public String toString() {
                return String.format("%d\t%s\t%s: %s", priority, id, Arrays.toString(accept), clazz.getCanonicalName());
            }
        };
    }
}