Improve workspace open speeds by caching 'getAllResources' result and using identity indexOf in resource path comparison

Author: Col-E

recaf-core/src/main/java/software/coley/recaf/path/ResourcePathNode.java

@@ -5,6 +5,7 @@
 import software.coley.collections.Maps;
 import software.coley.collections.Unchecked;
 import software.coley.recaf.info.Named;
+import software.coley.recaf.util.CollectionUtils;
 import software.coley.recaf.workspace.model.Workspace;
 import software.coley.recaf.workspace.model.bundle.Bundle;
 import software.coley.recaf.workspace.model.resource.WorkspaceFileResource;
@@ -142,7 +143,7 @@ public int localCompare(PathNode<?> o) {
 
 					// Show in order as in the workspace.
 					List<WorkspaceResource> resources = workspace.getAllResources(false);
-					return Integer.compare(resources.indexOf(resource), resources.indexOf(otherResource));
+					return Integer.compare(CollectionUtils.identityIndexOf(resources, resource), CollectionUtils.identityIndexOf(resources, otherResource));
 				} else {
 					// Enforce some ordering. Not ideal but works.
 					return Named.STRING_COMPARATOR.compare(

recaf-core/src/main/java/software/coley/recaf/util/CollectionUtils.java

@@ -0,0 +1,30 @@
+package software.coley.recaf.util;
+
+import jakarta.annotation.Nonnull;
+
+import java.util.List;
+
+/**
+ * Collection utilities that don't fit anywhere else.
+ * These should ideally get migrated to <a href="https://github.com/Col-E/ExtraCollections">Extra-Collections</a>.
+ *
+ * @author Matt Coley
+ */
+public class CollectionUtils {
+	/**
+	 * @param list
+	 * 		List to search through.
+	 * @param element
+	 * 		Element to search for.
+	 * @param <T>
+	 * 		Inferred element type.
+	 *
+	 * @return The index of the first occurrence of {@code element} in {@code list}, or -1 if not found.
+	 */
+	public static <T> int identityIndexOf(@Nonnull List<? extends T> list, T element) {
+		for (int i = list.size(); i != 0; )
+			if (element == list.get(--i))
+				return i;
+		return -1;
+	}
+}

recaf-core/src/main/java/software/coley/recaf/workspace/model/BasicWorkspace.java

@@ -28,6 +28,8 @@ public class BasicWorkspace implements Workspace {
 	private final WorkspaceResource primary;
 	private final List<WorkspaceResource> supporting = new ArrayList<>();
 	private final List<WorkspaceResource> internal;
+	private List<WorkspaceResource> cachedAllResourcesNoInternal;
+	private List<WorkspaceResource> cachedAllResources;
 
 	/**
 	 * @param primary
@@ -92,6 +94,7 @@ public List<WorkspaceResource> getInternalSupportingResources() {
 
 	@Override
 	public void addSupportingResource(@Nonnull WorkspaceResource resource) {
+		cachedAllResources = null;
 		supporting.add(resource);
 		Unchecked.checkedForEach(modificationListeners, listener -> listener.onAddLibrary(this, resource),
 				(listener, t) -> logger.error("Exception thrown when adding supporting resource", t));
@@ -101,6 +104,7 @@ public void addSupportingResource(@Nonnull WorkspaceResource resource) {
 	public boolean removeSupportingResource(@Nonnull WorkspaceResource resource) {
 		boolean remove = supporting.remove(resource);
 		if (remove) {
+			cachedAllResources = null;
 			Unchecked.checkedForEach(modificationListeners, listener -> listener.onRemoveLibrary(this, resource),
 					(listener, t) -> logger.error("Exception thrown when removing supporting resource", t));
 		}
@@ -123,6 +127,24 @@ public void removeWorkspaceModificationListener(@Nonnull WorkspaceModificationLi
 		modificationListeners.remove(listener);
 	}
 
+	@Nonnull
+	@Override
+	public List<WorkspaceResource> getAllResources(boolean includeInternal) {
+		// Cache the list of all resources since it is commonly used and the underlying stream
+		// collection in the base implementation is expensive to compute.
+		if (includeInternal) {
+			List<WorkspaceResource> cached = this.cachedAllResources;
+			if (cached != null)
+				return cached;
+			return this.cachedAllResources = Workspace.super.getAllResources(false);
+		} else {
+			List<WorkspaceResource> cached = this.cachedAllResourcesNoInternal;
+			if (cached != null)
+				return cached;
+			return this.cachedAllResourcesNoInternal = Workspace.super.getAllResources(false);
+		}
+	}
+
 	/**
 	 * Called by {@link WorkspaceManager} when the workspace is closed.
 	 */