de.uka.ilkd.key.util.removegenerics.AbstractGenericRemover Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of key.removegenerics Show documentation
Helper to remove generics from Java source code
The newest version!
/* This file is part of KeY - https://key-project.org
 * KeY is licensed under the GNU General Public License Version 2
 * SPDX-License-Identifier: GPL-2.0-only */
package de.uka.ilkd.key.util.removegenerics;

import java.io.File;
import java.io.IOException;
import java.util.*;

import de.uka.ilkd.key.util.removegenerics.monitor.GenericRemoverMonitor;

import recoder.CrossReferenceServiceConfiguration;
import recoder.ParserException;
import recoder.io.PathList;
import recoder.java.CompilationUnit;

public abstract class AbstractGenericRemover {
    private final GenericRemoverMonitor monitor;

    private final CrossReferenceServiceConfiguration sc = new CrossReferenceServiceConfiguration();

    private final Map allUnits =
        new LinkedHashMap<>();

    private final List sourceFiles = new ArrayList<>();

    public AbstractGenericRemover(GenericRemoverMonitor monitor) {
        assert monitor != null;
        this.monitor = monitor;
    }

    public void addSearchPath(String path) {
        PathList searchPaths = sc.getProjectSettings().getSearchPathList();
        searchPaths.add(path);
    }

    public void addSourceFiles(Collection sourceFiles) {
        this.sourceFiles.addAll(sourceFiles);
    }

    public void addSourceFile(String file) {
        sourceFiles.add(file);
    }

    public PathList getSearchPath() {
        return sc.getProjectSettings().getSearchPathList();
    }

    public List getSourceFiles() {
        return sourceFiles;
    }

    public void removeGenerics() throws ParserException, IOException {
        for (String fileName : sourceFiles) {
            File file = new File(fileName);
            if (file.isDirectory()) {
                processDirectory(file);
            } else {
                processFile(file);
            }
        }

        List allTransformations = new ArrayList<>();

        monitor.taskStarted("Analysing ...");

        sc.getChangeHistory().updateModel();

        for (CompilationUnit cu : allUnits.keySet()) {
            ResolveGenerics transformation = new ResolveGenerics(sc, cu);

            // add also the empty transformation ... so that unchanged files are
            // copied
            transformation.analyze();
            allTransformations.add(transformation);
        }

        monitor.taskStarted("Transformation ...");
        for (ResolveGenerics transformation : allTransformations) {
            transformation.transform();
            CompilationUnit cu = transformation.getCU();

            // repair spacing around single line comments
            SingleLineCommentRepairer.repairSingleLineComments(cu);

            // save new content
            String filename = allUnits.get(cu);
            saveModifiedCompilationUnit(cu, filename);
        }

        monitor.taskStarted("Remove Generics completed.");
    }

    protected abstract void saveModifiedCompilationUnit(CompilationUnit cu, String filename)
            throws IOException;

    private void processDirectory(File dir) throws ParserException {

        for (File f : dir.listFiles()) {
            if (f.isDirectory()) {
                processDirectory(f);
            } else if (f.getName().toLowerCase().endsWith(".java")) {
                processFile(f);
            }
        }

    }

    private void processFile(File file) throws ParserException {
        monitor.taskStarted("Reading from " + file);
        if (!file.exists()) {
            monitor.warningOccurred(file + " does not exist");
            return;
        }

        if (!file.canRead()) {
            monitor.warningOccurred(file + " cannot be read");
            return;
        }

        CompilationUnit cu =
            sc.getSourceFileRepository().getCompilationUnitFromFile(file.getPath());
        String filename = file.getName();

        allUnits.put(cu, filename);
    }
}