Skip to content

Rewrite getModsInLoadOrder to handle circular dependencies between mods. #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Rewrite getModsInLoadOrder to handle circular dependencies between mods. #42

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 47 additions & 34 deletions FactorioDataWrapper/src/com/demod/factorio/ModLoader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,9 @@
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.Comparator;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Objects;
Expand Down Expand Up @@ -115,39 +114,53 @@ public Optional<Mod> getMod(String name) {
return Optional.ofNullable(mods.get(name));
}

public List<Mod> getModsInLoadOrder() {
LinkedList<Mod> work = new LinkedList<>();
mods.values().stream().sorted((m1, m2) -> m1.getInfo().getName().compareTo(m2.getInfo().getName()))
.forEach(n -> work.add(n));
List<String> order = new ArrayList<>();
while (!work.isEmpty()) {
Iterator<Mod> iter = work.iterator();
while (iter.hasNext()) {
Mod mod = iter.next();
boolean missingDep = false;
for (Dependency dependency : mod.getInfo().getDependencies()) {
String depName = dependency.getName();
if (getMod(depName).isPresent()) {
if (!order.contains(depName)) {
missingDep = true;
break;
}
} else if (!dependency.isOptional()) {
throw new InternalError("MISSING DEPENDENCY FOR " + mod.getInfo().getName() + " : " + depName);
}
}
if (!missingDep) {
order.add(mod.getInfo().getName());
iter.remove();
}
}
private Map<String, Integer> getDepths() {
Map<String, Integer> depths = new LinkedHashMap<>();
Set<String> visited = new HashSet<>();

for (Mod mod : this.mods.values()) {
populateDepth(mod, depths, visited);
}
// Make sure core loads first
if (order.contains("core") && order.indexOf("core") != 0) {
order.remove("core");
order.add(0, "core");

return depths;
}

private void populateDepth(Mod mod, Map<String, Integer> depths, Set<String> visited) {
ModInfo modInfo = mod.getInfo();
String modName = modInfo.getName();
if (depths.containsKey(modName)) {
return;
}
return order.stream().map(this::getMod).map(Optional::get).collect(Collectors.toList());
if (visited.contains(modName)) {
return;
}
visited.add(modName);

int depth = 0;
for (Dependency dependency : modInfo.getDependencies()) {
String dependencyName = dependency.getName();
Optional<Mod> maybeDependencyMod = getMod(dependencyName);
if (maybeDependencyMod.isPresent()) {
Mod dependencyMod = maybeDependencyMod.get();
populateDepth(dependencyMod, depths, visited);
Integer dependencyDepth = depths.getOrDefault(dependencyMod.getInfo().getName(), 0);
depth = Math.max(depth, dependencyDepth + 1);
}
}

depths.put(modName, depth);
visited.remove(modName);
}

public List<Mod> getModsInLoadOrder() {
Map<String, Integer> depths = getDepths();
Comparator<Mod> comparator = Comparator.comparing((Mod mod) -> depths.get(mod.getInfo().getName()));
List<Mod> result = mods.values().stream().sorted(comparator).collect(Collectors.toList());
result.remove(mods.get("core"));
result.remove(mods.get("base"));
result.add(0, mods.get("core"));
result.add(1, mods.get("base"));
return result;
}

public void loadFolder(File folder) throws IOException {
Expand Down