//
// ImageJPluginFinder.java
//

/*
ImageJ software for multidimensional image processing and analysis.

Copyright (c) 2010, ImageJDev.org.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    * Neither the names of the ImageJDev.org developers nor the
      names of its contributors may be used to endorse or promote products
      derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
*/

package imagej.ext.plugin.finder;

import imagej.ext.plugin.IPlugin;
import imagej.ext.plugin.Plugin;
import imagej.ext.plugin.PluginInfo;
import imagej.ext.plugin.PluginModuleInfo;
import imagej.ext.plugin.RunnablePlugin;
import imagej.util.Log;

import java.util.List;

import net.java.sezpoz.Index;
import net.java.sezpoz.IndexItem;

/**
 * Discovers ImageJ plugins.
 * <p>
 * To accomplish this, SezPoz scans the classpath for {@link Plugin}
 * annotations.
 * </p>
 * 
 * @author Curtis Rueden
 */
@PluginFinder
public class ImageJPluginFinder implements IPluginFinder {

	/** Default class loader to use when querying SezPoz. */
	private static ClassLoader defaultClassLoader;

	/** Class loader to use when querying SezPoz. */
	private final ClassLoader classLoader;

	// -- Static utility methods --

	/** Sets the default class loader to use when querying SezPoz. */
	public static void setDefaultClassLoader(final ClassLoader cl) {
		defaultClassLoader = cl;
	}

	// -- Constructors --

	public ImageJPluginFinder() {
		this(defaultClassLoader);
	}

	public ImageJPluginFinder(final ClassLoader classLoader) {
		this.classLoader = classLoader;
	}

	// -- IPluginFinder methods --

	@Override
	public void findPlugins(final List<PluginInfo<?>> plugins) {
		final Index<Plugin, IPlugin> pluginIndex;
		if (classLoader == null) {
			pluginIndex = Index.load(Plugin.class, IPlugin.class);
		}
		else {
			pluginIndex = Index.load(Plugin.class, IPlugin.class, classLoader);
		}

		final int oldSize = plugins.size();
		for (final IndexItem<Plugin, IPlugin> item : pluginIndex) {
			final PluginInfo<?> entry = createInfo(item);
			plugins.add(entry);
		}
		final int newSize = plugins.size();

		Log.info("Found " + (newSize - oldSize) + " plugins.");
		if (Log.isDebug()) {
			for (int i = oldSize; i < newSize; i++) {
				Log.debug("- " + plugins.get(i));
			}
		}
	}

	// -- Helper methods --

	private <P extends IPlugin> PluginInfo<P> createInfo(
		final IndexItem<Plugin, IPlugin> item)
	{
		final String className = item.className();
		final Plugin plugin = item.annotation();

		@SuppressWarnings("unchecked")
		final Class<P> pluginType = (Class<P>) plugin.type();

		if (RunnablePlugin.class.isAssignableFrom(pluginType)) {
			// TODO - Investigate a simpler way to handle this.
			final PluginModuleInfo<? extends RunnablePlugin> moduleInfo =
				createModuleInfo(className, plugin);
			@SuppressWarnings("unchecked")
			final PluginInfo<P> result = (PluginInfo<P>) moduleInfo;
			return result;
		}
		return new PluginInfo<P>(className, pluginType, plugin);
	}

	private <R extends RunnablePlugin> PluginModuleInfo<R> createModuleInfo(
		final String className, final Plugin plugin)
	{
		@SuppressWarnings("unchecked")
		final Class<R> pluginType = (Class<R>) plugin.type();

		return new PluginModuleInfo<R>(className, pluginType, plugin);
	}

}

@@ -1669,16 +1669,45 @@
 inder;%0A%0A
+import imagej.ext.MenuEntry;%0A
 import i
@@ -3296,16 +3296,320 @@
 (item);%0A
+%0A%09%09%09// CTR TEMP - add %22IJ2%22 suffix to all modern plugins, for debugging%0A%09%09%09final List%3CMenuEntry%3E menuPath = entry.getMenuPath();%0A%09%09%09if (menuPath != null && menuPath.size() %3E 0) %7B%0A%09%09%09%09final MenuEntry menuLeaf = menuPath.get(menuPath.size() - 1);%0A%09%09%09%09menuLeaf.setName(menuLeaf.getName() + %22 %5BIJ2%5D%22);%0A%09%09%09%7D%0A%0A
 %09%09%09plugi

Add IJ2 suffix to all IJ2 plugins, for debugging.