Move error codes for Goap into constants

cvra · Aug 21, 2023 · 1597ec1 · 1597ec1
1 parent f86a78f
commit 1597ec1
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 6 deletions.
diff --git a/lib/goap/example.cpp b/lib/goap/example.cpp
@@ -75,11 +75,16 @@ int main()
 
     auto len = planner.plan(state, goal, actions.data(), actions.size(), path, max_path_len);
 
-    if (len <= 0) {
+    if (len == goap::kErrorNoPathFound) {
         std::cout << "Could not find a plan!" << std::endl;
         return 1;
     }
 
+    if (len == goap::kErrorNotEnoughMemory) {
+        std::cout << "Not enough memory reserved to explore all options!" << std::endl;
+        return 1;
+    }
+
     // Execute all the steps in the plan
     for (int i = 0; i < len; i++) {
         path[i]->execute(state);

diff --git a/lib/goap/include/goap/goap.hpp b/lib/goap/include/goap/goap.hpp
@@ -13,6 +13,9 @@
 
 namespace goap {
 
+const int kErrorNoPathFound = -1;
+const int kErrorNotEnoughMemory = -2;
+
 template <typename State>
 class Action {
 public:
@@ -105,7 +108,7 @@ class Planner {
                         }
 
                         if (!gc) {
-                            return -2;
+                            return kErrorNotEnoughMemory;
                         }
 
                         if (gc_prev) {
@@ -152,8 +155,8 @@ class Planner {
             }
         }
 
-        // No path was found
-        return -1;
+        // Reaching here means we did not find a path
+        return kErrorNoPathFound;
     }
 };
 

diff --git a/lib/goap/tests/goap_test.cpp b/lib/goap/tests/goap_test.cpp
@@ -181,7 +181,7 @@ TEST(SimpleScenario, WhatHappensIfThereIsNoPath)
     goap::Action<TestState>* path[max_path_len] = {nullptr};
 
     auto cost = planner.plan(state, goal, actions, action_count, path, max_path_len);
-    CHECK_EQUAL(-1, cost);
+    CHECK_EQUAL(goap::kErrorNoPathFound, cost);
 }
 
 struct FarAwayState {
@@ -236,7 +236,7 @@ TEST(TooLongPathTestGroup, DoNotFindFarAwayPlan)
 
     // Of course it will fail
     auto cost = planner.plan(state, goal, actions, 1);
-    CHECK_EQUAL(-2, cost);
+    CHECK_EQUAL(goap::kErrorNotEnoughMemory, cost);
 }
 
 TEST(TooLongPathTestGroup, RespectsMaxOutputLength)