Merge branch 'mega-split'

This branch migrates many non-image-specific services from the ImageJ
core component.

This includes the module and command frameworks, including widgets
(module preprocessing that handles inputs) and displays (module
postprocessing that handles outputs).

It also includes the menu, options, platform, script and tool services.

Migrated from:
https://github.com/imagej/imagej/tree/imagej-2.0.0-beta-7.9/core/core/src/main/java/imagej

Author: ctrueden

src/main/java/org/scijava/AbstractGateway.java

@@ -35,14 +35,29 @@
 import org.scijava.app.AppService;
 import org.scijava.app.SciJavaApp;
 import org.scijava.app.StatusService;
+import org.scijava.command.CommandService;
+import org.scijava.console.ConsoleService;
+import org.scijava.display.DisplayService;
 import org.scijava.event.EventHistory;
 import org.scijava.event.EventService;
+import org.scijava.io.IOService;
+import org.scijava.io.RecentFileService;
 import org.scijava.log.LogService;
+import org.scijava.menu.MenuService;
+import org.scijava.module.ModuleService;
 import org.scijava.object.ObjectService;
+import org.scijava.options.OptionsService;
+import org.scijava.platform.AppEventService;
+import org.scijava.platform.PlatformService;
 import org.scijava.plugin.AbstractRichPlugin;
 import org.scijava.plugin.PluginService;
+import org.scijava.script.ScriptService;
 import org.scijava.service.Service;
+import org.scijava.text.TextService;
 import org.scijava.thread.ThreadService;
+import org.scijava.tool.IconService;
+import org.scijava.tool.ToolService;
+import org.scijava.widget.WidgetService;
 
 /**
  * Abstract superclass for {@link Gateway} implementations.
@@ -81,11 +96,31 @@ public Service get(final String serviceClassName) {
 
 	// -- Gateway methods - services --
 
+	@Override
+	public AppEventService appEvent() {
+		return get(AppEventService.class);
+	}
+
 	@Override
 	public AppService app() {
 		return get(AppService.class);
 	}
 
+	@Override
+	public CommandService command() {
+		return get(CommandService.class);
+	}
+
+	@Override
+	public ConsoleService console() {
+		return get(ConsoleService.class);
+	}
+
+	@Override
+	public DisplayService display() {
+		return get(DisplayService.class);
+	}
+
 	@Override
 	public EventHistory eventHistory() {
 		return get(EventHistory.class);
@@ -96,31 +131,86 @@ public EventService event() {
 		return get(EventService.class);
 	}
 
+	@Override
+	public IconService icon() {
+		return get(IconService.class);
+	}
+
+	@Override
+	public IOService io() {
+		return get(IOService.class);
+	}
+
 	@Override
 	public LogService log() {
 		return get(LogService.class);
 	}
 
+	@Override
+	public MenuService menu() {
+		return get(MenuService.class);
+	}
+
+	@Override
+	public ModuleService module() {
+		return get(ModuleService.class);
+	}
+
 	@Override
 	public ObjectService object() {
 		return get(ObjectService.class);
 	}
 
+	@Override
+	public OptionsService options() {
+		return get(OptionsService.class);
+	}
+
+	@Override
+	public PlatformService platform() {
+		return get(PlatformService.class);
+	}
+
 	@Override
 	public PluginService plugin() {
 		return get(PluginService.class);
 	}
 
+	@Override
+	public RecentFileService recentFile() {
+		return get(RecentFileService.class);
+	}
+
+	@Override
+	public ScriptService script() {
+		return get(ScriptService.class);
+	}
+
 	@Override
 	public StatusService status() {
 		return get(StatusService.class);
 	}
 
+	@Override
+	public TextService text() {
+		return get(TextService.class);
+	}
+
 	@Override
 	public ThreadService thread() {
 		return get(ThreadService.class);
 	}
 
+	@Override
+	public ToolService tool() {
+		return get(ToolService.class);
+	}
+
+	@Override
+	public WidgetService widget() {
+		return get(WidgetService.class);
+	}
+
 	// -- Gateway methods - application --
 
 	@Override

src/main/java/org/scijava/Cancelable.java

@@ -0,0 +1,66 @@
+/*
+ * #%L
+ * SciJava Common shared library for SciJava software.
+ * %%
+ * Copyright (C) 2009 - 2014 Board of Regents of the University of
+ * Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
+ * Institute of Molecular Cell Biology and Genetics.
+ * %%
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. 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.
+ * 
+ * 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.
+ * #L%
+ */
+
+package org.scijava;
+
+/**
+ * An operation that can be canceled.
+ * 
+ * @author Curtis Rueden
+ */
+public interface Cancelable {
+
+	/** Gets whether the operation has been canceled. */
+	boolean isCanceled();
+
+	/**
+	 * Cancels the operation execution, with the given reason for doing so.
+	 * <p>
+	 * This method merely sets the operation status to canceled; it cannot
+	 * necessarily stop the operation itself. That is, it is the responsibility of
+	 * each individual operation to check {@link #isCanceled()} in a timely manner
+	 * during execution, and stop doing whatever it is doing if the flag has been
+	 * tripped.
+	 * </p>
+	 * 
+	 * @param reason A message describing why the operation is being canceled.
+	 */
+	void cancel(String reason);
+
+	/**
+	 * Gets a message describing why the operation was canceled.
+	 * 
+	 * @return The reason for cancelation, which may be null if no reason was
+	 *         given, or if the operation was not in fact canceled.
+	 */
+	String getCancelReason();
+
+}

src/main/java/org/scijava/Gateway.java

@@ -34,15 +34,30 @@
 import org.scijava.app.App;
 import org.scijava.app.AppService;
 import org.scijava.app.StatusService;
+import org.scijava.command.CommandService;
+import org.scijava.console.ConsoleService;
+import org.scijava.display.DisplayService;
 import org.scijava.event.EventHistory;
 import org.scijava.event.EventService;
+import org.scijava.io.IOService;
+import org.scijava.io.RecentFileService;
 import org.scijava.log.LogService;
+import org.scijava.menu.MenuService;
+import org.scijava.module.ModuleService;
 import org.scijava.object.ObjectService;
+import org.scijava.options.OptionsService;
+import org.scijava.platform.AppEventService;
+import org.scijava.platform.PlatformService;
 import org.scijava.plugin.Plugin;
 import org.scijava.plugin.PluginService;
 import org.scijava.plugin.RichPlugin;
+import org.scijava.script.ScriptService;
 import org.scijava.service.Service;
+import org.scijava.text.TextService;
 import org.scijava.thread.ThreadService;
+import org.scijava.tool.IconService;
+import org.scijava.tool.ToolService;
+import org.scijava.widget.WidgetService;
 
 /**
  * Interface for convenience classes that wrap a {@link Context} to provide
@@ -127,22 +142,52 @@ public interface Gateway extends RichPlugin {
 
 	// -- Gateway methods - services --
 
+	AppEventService appEvent();
+
 	AppService app();
 
+	CommandService command();
+
+	ConsoleService console();
+
+	DisplayService display();
+
 	EventHistory eventHistory();
 
 	EventService event();
 
+	IconService icon();
+
+	IOService io();
+
 	LogService log();
 
+	MenuService menu();
+
+	ModuleService module();
+
 	ObjectService object();
 
+	OptionsService options();
+
+	PlatformService platform();
+
 	PluginService plugin();
 
+	RecentFileService recentFile();
+
+	ScriptService script();
+
 	StatusService status();
 
+	TextService text();
+
 	ThreadService thread();
 
+	ToolService tool();
+
+	WidgetService widget();
+
 	// -- Gateway methods - application --
 
 	/** @see org.scijava.app.AppService */

src/main/java/org/scijava/Identifiable.java

@@ -0,0 +1,62 @@
+/*
+ * #%L
+ * SciJava Common shared library for SciJava software.
+ * %%
+ * Copyright (C) 2009 - 2014 Board of Regents of the University of
+ * Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
+ * Institute of Molecular Cell Biology and Genetics.
+ * %%
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. 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.
+ * 
+ * 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.
+ * #L%
+ */
+
+package org.scijava;
+
+import java.io.Serializable;
+
+/**
+ * An object which can express itself by some unique string.
+ * <p>
+ * Two objects that produce the same identifier string can be considered
+ * equivalent by some metric. The main use case for these identifiers is as a
+ * weak form of long-term serialization:
+ * </p>
+ * <ol>
+ * <li>An object's identifier is saved to long-term storage such as disk.</li>
+ * <li>Later, in a new JVM, the identifier is retrieved from disk.</li>
+ * <li>An existing index of objects is queried to find the object (if any) whose
+ * identifier matches the retrieved one.</li>
+ * </ol>
+ * <p>
+ * In this way, objects themselves do not need to be {@link Serializable}, nor
+ * do multiple potentially equivalent objects need to be synthesized and then
+ * compared using {@link #equals}.
+ * </p>
+ * 
+ * @author Curtis Rueden
+ */
+public interface Identifiable {
+
+	/** Gets a string intended to function as an identifier for the object. */
+	String getIdentifier();
+
+}