org.scijava.ops.engine.impl.DefaultOpDescriptionGenerator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scijava-ops-engine Show documentation
Java implementation of the SciJava Ops matching engine.
The newest version!
/*-
 * #%L
 * Java implementation of the SciJava Ops matching engine.
 * %%
 * Copyright (C) 2016 - 2024 SciJava developers.
 * %%
 * 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.ops.engine.impl;

import com.google.common.base.Strings;
import org.scijava.ops.api.*;
import org.scijava.ops.engine.BaseOpHints;
import org.scijava.ops.engine.OpDescriptionGenerator;
import org.scijava.ops.engine.matcher.convert.ConvertedOpInfo;
import org.scijava.ops.engine.matcher.reduce.ReducedOpInfo;
import org.scijava.ops.engine.util.Infos;
import org.scijava.priority.Priority;
import org.scijava.struct.ItemIO;
import org.scijava.types.Nil;
import org.scijava.common3.Types;

import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Optional;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;

import static org.scijava.struct.ItemIO.CONTAINER;
import static org.scijava.struct.ItemIO.MUTABLE;

/**
 * An {@link OpDescriptionGenerator} implementation which makes use of
 * {@link ConvertedOpInfo}s to provide "simple" descriptions.
 *
 * @author Gabriel Selzer
 */
public class DefaultOpDescriptionGenerator implements OpDescriptionGenerator {

	@Override
	public double priority() {
		return Priority.VERY_HIGH;
	}

	@Override
	public String simpleDescriptions(OpEnvironment env, OpRequest req) {
		return buildOpString(req, env, info -> describeUsingOps(info, env));
	}

	@Override
	public String verboseDescriptions(OpEnvironment env, OpRequest req) {
		return buildOpString(req, env, Infos::describe);
	}

	private static String buildOpString(OpRequest req, OpEnvironment env,
		Function descriptionFunction)
	{
		// handle namespaces queries
		String name = req.name();
		Optional nsString = getNonOpString(env, name);
		if (nsString.isPresent()) {
			return nsString.get();
		}

		// handle name queries
		Collection infos = env.infos(name);
		var filtered = filterInfos(infos, req);
		String opString = filtered.stream() //
			.map(descriptionFunction) //
			.map(s -> s.replaceAll("\n", "\n\t")) //
			.distinct() //
			.collect(Collectors.joining("\n\t- "));
		if (opString.isEmpty()) return NO_OP_MATCHES;
		return req.name() + ":\n\t- " + opString;
	}

	/**
	 * Helper method to build strings when the queried name is not an op
	 *
	 * @param env The op to query, or null
	 * @param name The potential op name
	 * @return If the {@code name} is empty/{@code null}, return a namespaces
	 *         string. Otherwise, if it doesn't match a particular op name, it is
	 *         assumed to be a namespace request and we return all ops in that
	 *         namespace. Returns {@code Optional.empty()} if this is a legitimate
	 *         op request.
	 */
	private static Optional getNonOpString(OpEnvironment env,
		String name)
	{
		String prefix = null;
		Stream nsStream = null;
		if (Strings.isNullOrEmpty(name)) {
			// Return all namespaces
			nsStream = publicOpStream(env);
			nsStream = nsStream.map(s -> s.substring(0, s.indexOf('.'))).distinct();
			prefix = "Namespaces:\n\t> ";
		}
		else if (env.infos(name).isEmpty()) {
			// Return all ops in the namespace
			nsStream = publicOpStream(env).filter(n -> n.startsWith(name));
			prefix = "Names:\n\t> ";
		}
		if (nsStream == null) return Optional.empty();
		String suffix = nsStream.collect(Collectors.joining("\n\t> "));

		if (Strings.isNullOrEmpty(suffix)) return Optional.of(
			"Not a valid Op name or namespace:\n\t> " + name);

		return Optional.of(prefix + suffix);
	}

	/**
	 * Helper method for getting publicly visible ops
	 *
	 * @return A stream of strings for each Op info not in a protected namespace
	 *         (e.g. 'engine')
	 */
	private static Stream publicOpStream(OpEnvironment env) {
		return env.infos().stream() //
			// Get all names from each Op
			.flatMap(info -> info.names().stream()) //
			// Deduplicate & sort
			.distinct() //
			.sorted() //
			// Filter out the engine namespace
			.filter(ns -> !ns.startsWith("engine"));
	}

	private static List filterInfos(Iterable infos,
		OpRequest req)
	{
		List filtered = new ArrayList<>();
		for (var info : infos) {
			if (info instanceof ReducedOpInfo) {
				continue;
			}
			if (info instanceof ConvertedOpInfo) {
				if (((ConvertedOpInfo) info).srcInfo() instanceof ReducedOpInfo)
					continue;
			}

			// Container types are matched as outputs in OpRequests
			var numPureInputs = info.inputs().stream() //
				.filter(m -> !ItemIO.CONTAINER.equals(m.getIOType())) //
				.count();

			Type[] args = req.argTypes();
			if (args == null || args.length == numPureInputs) {
				filtered.add(info);
			}

		}
		return filtered;
	}

	private static String describeUsingOps(final OpInfo info,
		final OpEnvironment env)
	{
		final StringBuilder sb = new StringBuilder("(");
		// describe inputs
		var memberItr = info.inputs().iterator();
		while (memberItr.hasNext()) {
			var m = memberItr.next();
			// MUTABLE annotation
			if (m.getIOType() == MUTABLE) {
				sb.append("@MUTABLE ");
			}
			// CONTAINER annotation
			else if (m.getIOType() == CONTAINER) {
				sb.append("@CONTAINER ");
			}
			// describe member type
			sb.append(describeType(env, Nil.of(m.type())));
			if (!m.isRequired()) {
				sb.append(" = null");
			}
			// describe member optionality
			if (memberItr.hasNext()) {
				sb.append(", ");
			}
		}
		sb.append(")");
		// describe output
		var output = info.output();
		sb.append(" -> ");
		if (output.isInput()) {
			sb.append("None");
		}
		else {
			sb.append(describeType(env, Nil.of(output.type())));
		}
		// return concatenation
		return sb.toString();
	}

	private static  String describeType(OpEnvironment env, Nil from) {
		Type specialType = Types.parameterize(Function.class, new Type[] { Types
			.parameterize(Nil.class, new Type[] { from.type() }), String.class });
		@SuppressWarnings("unchecked")
		Nil, String>> specialTypeNil =
			(Nil, String>>) Nil.of(specialType);
		try {
			Type nilFromType = Types.parameterize(Nil.class, new Type[] { from
				.type() });
			Hints h = new Hints( //
				BaseOpHints.Adaptation.FORBIDDEN, //
				BaseOpHints.Conversion.FORBIDDEN, //
				BaseOpHints.History.IGNORE //
			);
			Function, String> op = env.op("engine.describe", specialTypeNil,
				new Nil[] { Nil.of(nilFromType) }, Nil.of(String.class), h);
			return op.apply(from);
		}
		catch (OpMatchingException e) {
			return Types.raw(from.type()).getSimpleName();
		}
	}

}