spoon.support.QueueProcessingManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spoon-core Show documentation
Spoon is a tool for meta-programming, analysis and transformation of Java programs.
The newest version!
/* 
 * Spoon - http://spoon.gforge.inria.fr/
 * Copyright (C) 2006 INRIA Futurs 
 * 
 * This software is governed by the CeCILL-C License under French law and
 * abiding by the rules of distribution of free software. You can use, modify 
 * and/or redistribute the software under the terms of the CeCILL-C license as 
 * circulated by CEA, CNRS and INRIA at http://www.cecill.info. 
 * 
 * This program 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 CeCILL-C License for more details.
 *  
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-C license and that you accept its terms.
 */

package spoon.support;

import java.util.ArrayList;
import java.util.Collection;
import java.util.LinkedList;
import java.util.Queue;

import spoon.processing.AbstractProcessor;
import spoon.processing.ProcessingManager;
import spoon.processing.Processor;
import spoon.processing.Severity;
import spoon.reflect.declaration.CtElement;
import spoon.reflect.factory.Factory;
import spoon.support.util.Timer;
import spoon.support.visitor.ProcessingVisitor;

/**
 * This processing manager implements a blocking processing policy that consists
 * of applying the processors in a FIFO order until no processors remain to be
 * applied.
 */
public class QueueProcessingManager implements ProcessingManager {
	Processor current;

	Factory factory;

	Queue> processors;

	ProcessingVisitor visitor;

	/**
	 * Creates a new processing manager that maintains a queue of processors to
	 * be applied to a given factory.
	 * 
	 * @param factory
	 *            the factory on which the processing applies (contains the
	 *            meta-model)
	 */
	public QueueProcessingManager(Factory factory) {
		super();
		setFactory(factory);
	}

	public void addProcessor(Class> type) {
		try {
			Processor p = type.newInstance();
			addProcessor(p);
		} catch (Exception e) {
			factory.getEnvironment()
					.report(null,
							Severity.ERROR,
							"Unable to instantiate processor \""
									+ type.getName()
									+ "\" - Your processor should have a constructor with no arguments");
		}
	}

	public boolean addProcessor(Processor p) {
		p.setFactory(getFactory());
		return getProcessors().add(p);
	}

	@SuppressWarnings("unchecked")
	public void addProcessor(String qualifiedName) {
		try {
			addProcessor((Class>) Thread.currentThread()
					.getContextClassLoader().loadClass(qualifiedName));
		} catch (ClassNotFoundException e) {
			factory.getEnvironment()
					.report(null,
							Severity.ERROR,
							"Unable to load processor \""
									+ qualifiedName
									+ "\" - Check your classpath. Did you use the --precompile option?");
		}
	}

	public Processor getCurrentProcessor() {
		return current;
	}

	public Factory getFactory() {
		return factory;
	}

	public Queue> getProcessors() {
		if (processors == null) {
			processors = new LinkedList>();
		}
		return processors;
	}

	protected ProcessingVisitor getVisitor() {
		if (visitor == null)
			visitor = new ProcessingVisitor(getFactory());
		return visitor;
	}

	public boolean isToBeApplied(Class> type) {
		for (Processor p : getProcessors()) {
			if (p.getClass() == type) {
				return true;
			}
		}
		return false;
	}

	public void process() {
		Timer.start("process");
		process(getFactory().Package().getAllRoots());
		Timer.stop("process");
	}

	public void process(Collection elements) {
		Processor p;
		while ((p = getProcessors().poll()) != null) {
			if (getFactory().getEnvironment().isVerbose()) {
				getFactory().getEnvironment().reportProgressMessage(
						p.getClass().getName());
			}
			current = p;
			p.initProperties(AbstractProcessor.loadProperties(p));
			p.init();
			p.process();
			for (CtElement e : new ArrayList(elements))
				process(e, p);
			p.processingDone();
		}
	}

	public void process(CtElement element) {
		Processor p;
		while ((p = getProcessors().poll()) != null) {
			current = p;
			p.init();
			p.process();
			process(element, p);
			p.processingDone();
		}
	}

	protected void process(CtElement element, Processor processor) {
		getVisitor().setProcessor(processor);
		getVisitor().scan(element);
	}

	public void setFactory(Factory factory) {
		this.factory = factory;
		factory.getEnvironment().setManager(this);
	}

}