Added door popups that report requirements

1 files changed, 230 insertions, 84 deletions

@@ -12,10 +12,138 @@
 
 namespace {
 
+struct Requirements {
+  bool disabled = false;
+
+  std::set<int> doors; // non-grouped, handles progressive
+  std::set<int> items; // all other items
+  std::set<int> rooms; // maybe
+  bool mastery = false; // maybe
+  bool panel_hunt = false; // maybe
+
+  void Merge(const Requirements& rhs) {
+    if (rhs.disabled) {
+      return;
+    }
+
+    for (int id : rhs.doors) {
+      doors.insert(id);
+    }
+    for (int id : rhs.items) {
+      items.insert(id);
+    }
+    for (int id : rhs.rooms) {
+      rooms.insert(id);
+    }
+    mastery = mastery || rhs.mastery;
+    panel_hunt = panel_hunt || rhs.panel_hunt;
+  }
+};
+
+class RequirementCalculator {
+ public:
+  void Reset() {
+    doors_.clear();
+    panels_.clear();
+  }
+
+  const Requirements& GetDoor(int door_id) {
+    if (!doors_.count(door_id)) {
+      Requirements requirements;
+      const Door& door_obj = GD_GetDoor(door_id);
+
+      if (!AP_IsPilgrimageEnabled() &&
+          door_obj.type == DoorType::kSunPainting) {
+        requirements.items.insert(door_obj.ap_item_id);
+      } else if (door_obj.type == DoorType::kSunwarp) {
+        switch (AP_GetSunwarpAccess()) {
+          case kSUNWARP_ACCESS_NORMAL:
+            // Do nothing.
+            break;
+          case kSUNWARP_ACCESS_DISABLED:
+            requirements.disabled = true;
+            break;
+          case kSUNWARP_ACCESS_UNLOCK:
+            requirements.items.insert(door_obj.group_ap_item_id);
+            break;
+          case kSUNWARP_ACCESS_INDIVIDUAL:
+          case kSUNWARP_ACCESS_PROGRESSIVE:
+            requirements.doors.insert(door_obj.id);
+            break;
+        }
+      } else if (AP_GetDoorShuffleMode() == kNO_DOORS || door_obj.skip_item) {
+        requirements.rooms.insert(door_obj.room);
+
+        for (int panel_id : door_obj.panels) {
+          const Requirements& panel_reqs = GetPanel(panel_id);
+          requirements.Merge(panel_reqs);
+        }
+      } else if (AP_GetDoorShuffleMode() == kSIMPLE_DOORS &&
+                 !door_obj.group_name.empty()) {
+        requirements.items.insert(door_obj.group_ap_item_id);
+      } else {
+        requirements.doors.insert(door_obj.id);
+      }
+
+      doors_[door_id] = requirements;
+    }
+
+    return doors_[door_id];
+  }
+
+  const Requirements& GetPanel(int panel_id) {
+    if (!panels_.count(panel_id)) {
+      Requirements requirements;
+      const Panel& panel_obj = GD_GetPanel(panel_id);
+
+      requirements.rooms.insert(panel_obj.room);
+
+      if (panel_obj.name == "THE MASTER") {
+        requirements.mastery = true;
+      }
+
+      if ((panel_obj.name == "ANOTHER TRY" || panel_obj.name == "LEVEL 2") &&
+          AP_GetLevel2Requirement() > 1) {
+        requirements.panel_hunt = true;
+      }
+
+      for (int room_id : panel_obj.required_rooms) {
+        requirements.rooms.insert(room_id);
+      }
+
+      for (int door_id : panel_obj.required_doors) {
+        const Requirements& door_reqs = GetDoor(door_id);
+        requirements.Merge(door_reqs);
+      }
+
+      for (int panel_id : panel_obj.required_panels) {
+        const Requirements& panel_reqs = GetPanel(panel_id);
+        requirements.Merge(panel_reqs);
+      }
+
+      if (AP_IsColorShuffle()) {
+        for (LingoColor color : panel_obj.colors) {
+          requirements.items.insert(GD_GetItemIdForColor(color));
+        }
+      }
+
+      panels_[panel_id] = requirements;
+    }
+
+    return panels_[panel_id];
+  }
+
+ private:
+  std::map<int, Requirements> doors_;
+  std::map<int, Requirements> panels_;
+};
+
 struct TrackerState {
   std::map<int, bool> reachability;
   std::set<int> reachable_doors;
   std::mutex reachability_mutex;
+  RequirementCalculator requirements;
+  std::map<int, std::map<std::string, bool>> door_reports;
 };
 
 enum Decision { kYes, kNo, kMaybe };
@@ -172,6 +300,10 @@ class StateCalculator {
 
   const std::set<int>& GetSolveablePanels() const { return solveable_panels_; }
 
+  const std::map<int, std::map<std::string, bool>>& GetDoorReports() const {
+    return door_report_;
+  }
+
  private:
   Decision IsNonGroupedDoorReachable(const Door& door_obj) {
     bool has_item = AP_HasItem(door_obj.ap_item_id);
@@ -188,68 +320,52 @@ class StateCalculator {
     return has_item ? kYes : kNo;
   }
 
-  Decision IsDoorReachable_Helper(int door_id) {
-    const Door& door_obj = GD_GetDoor(door_id);
-
-    if (!AP_IsPilgrimageEnabled() && door_obj.type == DoorType::kSunPainting) {
-      return AP_HasItem(door_obj.ap_item_id) ? kYes : kNo;
-    } else if (door_obj.type == DoorType::kSunwarp) {
-      switch (AP_GetSunwarpAccess()) {
-        case kSUNWARP_ACCESS_NORMAL:
-          return kYes;
-        case kSUNWARP_ACCESS_DISABLED:
-          return kNo;
-        case kSUNWARP_ACCESS_UNLOCK:
-          return AP_HasItem(door_obj.group_ap_item_id) ? kYes : kNo;
-        case kSUNWARP_ACCESS_INDIVIDUAL:
-        case kSUNWARP_ACCESS_PROGRESSIVE:
-          return IsNonGroupedDoorReachable(door_obj);
-      }
-    } else if (AP_GetDoorShuffleMode() == kNO_DOORS || door_obj.skip_item) {
-      if (!reachable_rooms_.count(door_obj.room)) {
-        return kMaybe;
-      }
+  Decision AreRequirementsSatisfied(const Requirements& reqs, std::map<std::string, bool>* report = nullptr) {
+    if (reqs.disabled) {
+      return kNo;
+    }
 
-      for (int panel_id : door_obj.panels) {
-        if (!solveable_panels_.count(panel_id)) {
-          return kMaybe;
-        }
-      }
+    Decision final_decision = kYes;
 
-      return kYes;
-    } else if (AP_GetDoorShuffleMode() == kSIMPLE_DOORS &&
-               !door_obj.group_name.empty()) {
-      return AP_HasItem(door_obj.group_ap_item_id) ? kYes : kNo;
-    } else {
-      return IsNonGroupedDoorReachable(door_obj);
-    }
-  }
+    for (int door_id : reqs.doors) {
+      const Door& door_obj = GD_GetDoor(door_id);
+      Decision decision = IsNonGroupedDoorReachable(door_obj);
 
-  Decision IsDoorReachable(int door_id) {
-    if (options_.parent) {
-      return options_.parent->IsDoorReachable(door_id);
-    }
+      if (report) {
+        (*report)[door_obj.item_name] = (decision == kYes);
+      }
 
-    if (door_decisions_.count(door_id)) {
-      return door_decisions_.at(door_id);
+      if (decision != kYes) {
+        final_decision = decision;
+      }
     }
+    
+    for (int item_id : reqs.items) {
+      bool has_item = AP_HasItem(item_id);
+      if (report) {
+        (*report)[AP_GetItemName(item_id)] = has_item;
+      }
 
-    Decision result = IsDoorReachable_Helper(door_id);
-    if (result != kMaybe) {
-      door_decisions_[door_id] = result;
+      if (!has_item) {
+        final_decision = kNo;
+      }
     }
 
-    return result;
-  }
-
-  Decision IsPanelReachable(int panel_id) {
-    const Panel& panel_obj = GD_GetPanel(panel_id);
+    for (int room_id : reqs.rooms) {
+      bool reachable = reachable_rooms_.count(room_id);
+      
+      if (report) {
+        std::string report_name =
+            "Reach \"" + GD_GetRoom(room_id).name + "\"";
+        (*report)[report_name] = reachable;
+      }
 
-    if (!reachable_rooms_.count(panel_obj.room)) {
-      return kMaybe;
+      if (!reachable && final_decision != kNo) {
+        final_decision = kMaybe;
+      }
     }
-
-    if (panel_obj.name == "THE MASTER") {
+    
+    if (reqs.mastery) {
       int achievements_accessible = 0;
 
       for (int achieve_id : GD_GetAchievementPanels()) {
@@ -262,12 +378,18 @@ class StateCalculator {
         }
       }
 
-      return (achievements_accessible >= AP_GetMasteryRequirement()) ? kYes
-                                                                     : kMaybe;
+      bool can_mastery =
+          (achievements_accessible >= AP_GetMasteryRequirement());
+      if (report) {
+        (*report)["Mastery"] = can_mastery;
+      }
+
+      if (can_mastery && final_decision != kNo) {
+        final_decision = kMaybe;
+      }
     }
 
-    if ((panel_obj.name == "ANOTHER TRY" || panel_obj.name == "LEVEL 2") &&
-        AP_GetLevel2Requirement() > 1) {
+    if (reqs.panel_hunt) {
       int counting_panels_accessible = 0;
 
       for (int solved_panel_id : solveable_panels_) {
@@ -278,44 +400,52 @@ class StateCalculator {
         }
       }
 
-      return (counting_panels_accessible >= AP_GetLevel2Requirement() - 1)
-                 ? kYes
-                 : kMaybe;
+      bool can_level2 =
+          (counting_panels_accessible >= AP_GetLevel2Requirement() - 1);
+      if (report) {
+        std::string report_name =
+            std::to_string(AP_GetLevel2Requirement()) + " Panels";
+        (*report)[report_name] = can_level2;
+      }
+      
+      if (can_level2 && final_decision != kNo) {
+        final_decision = kMaybe;
+      }
     }
 
-    for (int room_id : panel_obj.required_rooms) {
-      if (!reachable_rooms_.count(room_id)) {
-        return kMaybe;
-      }
+    return final_decision;
+  }
+
+  Decision IsDoorReachable_Helper(int door_id) {
+    if (door_report_.count(door_id)) {
+      door_report_[door_id].clear();
+    } else {
+      door_report_[door_id] = {};
     }
+    
+    return AreRequirementsSatisfied(GetState().requirements.GetDoor(door_id),
+                                    &door_report_[door_id]);
+  }
 
-    for (int door_id : panel_obj.required_doors) {
-      Decision door_reachable = IsDoorReachable(door_id);
-      if (door_reachable == kNo) {
-        const Door& door_obj = GD_GetDoor(door_id);
-        return (door_obj.is_event || AP_GetDoorShuffleMode() == kNO_DOORS)
-                   ? kMaybe
-                   : kNo;
-      } else if (door_reachable == kMaybe) {
-        return kMaybe;
-      }
+  Decision IsDoorReachable(int door_id) {
+    if (options_.parent) {
+      return options_.parent->IsDoorReachable(door_id);
     }
 
-    for (int panel_id : panel_obj.required_panels) {
-      if (!solveable_panels_.count(panel_id)) {
-        return kMaybe;
-      }
+    if (door_decisions_.count(door_id)) {
+      return door_decisions_.at(door_id);
     }
 
-    if (AP_IsColorShuffle()) {
-      for (LingoColor color : panel_obj.colors) {
-        if (!AP_HasItem(GD_GetItemIdForColor(color))) {
-          return kNo;
-        }
-      }
+    Decision result = IsDoorReachable_Helper(door_id);
+    if (result != kMaybe) {
+      door_decisions_[door_id] = result;
     }
 
-    return kYes;
+    return result;
+  }
+
+  Decision IsPanelReachable(int panel_id) {
+    return AreRequirementsSatisfied(GetState().requirements.GetPanel(panel_id));
   }
 
   Decision IsExitUsable(const Exit& room_exit) {
@@ -401,10 +531,16 @@ class StateCalculator {
   std::set<int> reachable_rooms_;
   std::map<int, Decision> door_decisions_;
   std::set<int> solveable_panels_;
+  std::map<int, std::map<std::string, bool>> door_report_;
 };
 
 }  // namespace
 
+void ResetReachabilityRequirements() {
+  std::lock_guard reachability_guard(GetState().reachability_mutex);
+  GetState().requirements.Reset();
+}
+
 void RecalculateReachability() {
   StateCalculator state_calculator({.start = GD_GetRoomByName("Menu")});
   state_calculator.Calculate();
@@ -435,10 +571,14 @@ void RecalculateReachability() {
     }
   }
 
+  std::map<int, std::map<std::string, bool>> door_reports =
+      state_calculator.GetDoorReports();
+
   {
     std::lock_guard reachability_guard(GetState().reachability_mutex);
     std::swap(GetState().reachability, new_reachability);
     std::swap(GetState().reachable_doors, new_reachable_doors);
+    std::swap(GetState().door_reports, door_reports);
   }
 }
 
@@ -457,3 +597,9 @@ bool IsDoorOpen(int door_id) {
 
   return GetState().reachable_doors.count(door_id);
 }
+
+const std::map<std::string, bool>& GetDoorRequirements(int door_id) {
+  std::lock_guard reachability_guard(GetState().reachability_mutex);
+
+  return GetState().door_reports.at(door_id);
+}