Fix breaking changes from libtcod.

Private types in libtcod heaps and random were changed.

Author: HexDecimal

build_libtcod.py

@@ -38,10 +38,10 @@
 RE_PREPROCESSOR = re.compile(r"(?!#define\s+\w+\s+\d+$)#.*?(?<!\\)$", re.DOTALL | re.MULTILINE)
 RE_INCLUDE = re.compile(r'#include "([^"]*)"')
 RE_TAGS = re.compile(
-    r"TCODLIB_C?API|TCOD_PUBLIC|TCOD_NODISCARD|TCOD_DEPRECATED_NOMESSAGE"
+    r"TCODLIB_C?API|TCOD_PUBLIC|TCOD_NODISCARD|TCOD_DEPRECATED_NOMESSAGE|TCOD_DEPRECATED_ENUM"
     r"|(TCOD_DEPRECATED|TCODLIB_FORMAT)\([^)]*\)|__restrict"
 )
-RE_VAFUNC = re.compile(r".*\(.*va_list.*\);")
+RE_VAFUNC = re.compile(r"^[^;]*\([^;]*va_list.*\);", re.MULTILINE)
 RE_INLINE = re.compile(r"(^.*?inline.*?\(.*?\))\s*\{.*?\}$", re.DOTALL | re.MULTILINE)
 
 

libtcod

@@ -2,6 +2,7 @@
    Anything included here will be accessible from tcod.loader.lib */
 #include "../libtcod/src/libtcod/libtcod.h"
 #include "../libtcod/src/libtcod/libtcod_int.h"
+#include "../libtcod/src/libtcod/renderer_xterm.h"
 #include "../libtcod/src/libtcod/tileset_truetype.h"
 #include "../libtcod/src/libtcod/wrappers.h"
 #include "noise.h"

tcod/cffi.h

@@ -3663,7 +3663,7 @@ def random_get_instance() -> tcod.random.Random:
     Returns:
         Random: A Random instance using the default random number generator.
     """
-    return tcod.random.Random._new_from_cdata(ffi.cast("mersenne_data_t*", lib.TCOD_random_get_instance()))
+    return tcod.random.Random._new_from_cdata(lib.TCOD_random_get_instance())
 
 
 @pending_deprecate()
@@ -3809,10 +3809,7 @@ def random_save(rnd: Optional[tcod.random.Random]) -> tcod.random.Random:
     """
     return tcod.random.Random._new_from_cdata(
         ffi.gc(
-            ffi.cast(
-                "mersenne_data_t*",
-                lib.TCOD_random_save(rnd.random_c if rnd else ffi.NULL),
-            ),
+            lib.TCOD_random_save(rnd.random_c if rnd else ffi.NULL),
             lib.TCOD_random_delete,
         )
     )

tcod/libtcodpy.py

@@ -440,9 +440,9 @@ int update_frontier_heuristic(
   for (int i = 0; i < frontier->heap.size; ++i) {
     unsigned char* heap_ptr = (unsigned char*)frontier->heap.heap;
     heap_ptr += frontier->heap.node_size * i;
-    struct TCOD_HeapNode* heap_node = (void*)heap_ptr;
-    struct FrontierNode* f_node = (struct FrontierNode*)heap_node->data;
-    heap_node->priority = (f_node->distance + compute_heuristic(heuristic, frontier->ndim, f_node->index));
+    int* priority = (int*)heap_ptr;
+    struct FrontierNode* f_node = (struct FrontierNode*)(heap_ptr + frontier->heap.data_offset);
+    *priority = (f_node->distance + compute_heuristic(heuristic, frontier->ndim, f_node->index));
   }
   TCOD_minheap_heapify(&frontier->heap);
   return 0;
@@ -478,8 +478,7 @@ int frontier_has_index(
   for (int i = 0; i < frontier->heap.size; ++i) {
     const unsigned char* heap_ptr = (const unsigned char*)frontier->heap.heap;
     heap_ptr += frontier->heap.node_size * i;
-    const struct TCOD_HeapNode* heap_node = (const void*)heap_ptr;
-    const struct FrontierNode* f_node = (const void*)heap_node->data;
+    const struct FrontierNode* f_node = (const void*)(heap_ptr + frontier->heap.data_offset);
     bool found = 1;
     for (int j = 0; j < frontier->ndim; ++j) {
       if (index[j] != f_node->index[j]) {

tcod/path.c

@@ -75,10 +75,7 @@ def __init__(
             seed = hash(seed)
 
         self.random_c = ffi.gc(
-            ffi.cast(
-                "mersenne_data_t*",
-                lib.TCOD_random_new_from_seed(algorithm, seed & 0xFFFFFFFF),
-            ),
+            lib.TCOD_random_new_from_seed(algorithm, seed & 0xFFFFFFFF),
             lib.TCOD_random_delete,
         )
 
@@ -141,22 +138,24 @@ def __getstate__(self) -> Any:
         """Pack the self.random_c attribute into a portable state."""
         state = self.__dict__.copy()
         state["random_c"] = {
-            "algo": self.random_c.algo,
-            "distribution": self.random_c.distribution,
-            "mt": list(self.random_c.mt),
-            "cur_mt": self.random_c.cur_mt,
-            "Q": list(self.random_c.Q),
-            "c": self.random_c.c,
-            "cur": self.random_c.cur,
+            "mt_cmwc": {
+                "algorithm": self.random_c.mt_cmwc.algorithm,
+                "distribution": self.random_c.mt_cmwc.distribution,
+                "mt": list(self.random_c.mt_cmwc.mt),
+                "cur_mt": self.random_c.mt_cmwc.cur_mt,
+                "Q": list(self.random_c.mt_cmwc.Q),
+                "c": self.random_c.mt_cmwc.c,
+                "cur": self.random_c.mt_cmwc.cur,
+            }
         }
         return state
 
     def __setstate__(self, state: Any) -> None:
         """Create a new cdata object with the stored paramaters."""
-        try:
-            cdata = state["random_c"]
-        except KeyError:  # old/deprecated format
-            cdata = state["cdata"]
-            del state["cdata"]
-        state["random_c"] = ffi.new("mersenne_data_t*", cdata)
+        if "algo" in state["random_c"]:
+            # Handle old/deprecated format.  Covert to libtcod's new union type.
+            state["random_c"]["algorithm"] = state["random_c"]["algo"]
+            del state["random_c"]["algo"]
+            state["random_c"] = {"mt_cmwc": state["random_c"]}
+        state["random_c"] = ffi.new("TCOD_Random*", state["random_c"])
         self.__dict__.update(state)

tcod/random.py

@@ -29,7 +29,7 @@ def test_tcod_random_pickle() -> None:
     assert rand.uniform(0, 1) == rand2.uniform(0, 1)
 
 
-def test_load_rng_v13() -> None:
+def test_load_rng_v13_1() -> None:
     with open(pathlib.Path(__file__).parent / "data/random_v13.pkl", "rb") as f:
         rand: tcod.random.Random = pickle.load(f)
     assert rand.randint(0, 0xFFFF) == 56422