Merge branch 'DFHack:master' into squid-keybinds-update

Author: realSquidCoder

.gitignore

@@ -11,3 +11,5 @@ allegro_deps-msvc2015-x64-1.2.0.zip
 allegro_deps
 allegro_deps-msvc2015-x86-1.2.0.zip
 allegro-msvc2015-x86-5.1.12.zip
+win64/allegro-msvc-x64-5.2.10.7z
+win64/allegro_deps-msvc-x64-1.15.0.7z

.pre-commit-config.yaml

@@ -19,7 +19,7 @@ repos:
       args: ['--fix=lf']
     - id: trailing-whitespace
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.30.0
+  rev: 0.31.0
   hooks:
     - id: check-github-workflows
 - repo: https://github.com/Lucas-C/pre-commit-hooks

CMakeLists.txt

@@ -36,7 +36,6 @@ SET(PROJECT_SRCS
     WorldSegment.cpp
     VegetationConfiguration.cpp
     Keybinds.cpp
-    EnumToString.cpp
     MaterialMatcher.cpp
     main.cpp
 )
@@ -55,7 +54,6 @@ SET(PROJECT_HDRS
     CreatureConfiguration.h
     Creatures.h
     DumpInfo.h
-    EnumToString.h
     FluidConfiguration.h
     GameBuildings.h
     GroundMaterialConfiguration.h
@@ -148,7 +146,7 @@ IF(UNIX)
                 set(ALLEGRO_DOWNLOAD_FILE "linux64-allegro5210.tbz2")
                 download_file("https://github.com/DFHack/dfhack-bin/releases/download/50.15/linux64-allegro5210.tbz2"
                     "${ALLEGRO_DOWNLOAD_DIR}/${ALLEGRO_DOWNLOAD_FILE}"
-                    "17d5f7dd89eb624b005b7b9202b94aff")
+                    "14c4237fbe6f2abf26edc0ba4d6c4424")
             else()
                 MESSAGE(FATAL_ERROR "32 bit build not supported for stonesense")
             endif()

Config.cpp

@@ -1,6 +1,7 @@
 #include <iostream>
 #include <fstream>
 #include <string>
+#include <filesystem>
 #include "common.h"
 #include "commonTypes.h"
 #include "Config.h"
@@ -299,7 +300,7 @@ namespace {
         }
         if (line.find("[FONT") != string::npos) {
             string result = parseStrFromLine("FONT", line);
-            ssConfig.font = al_create_path(result.c_str());
+            ssConfig.font = std::filesystem::path{ result }.make_preferred();
         }
         if (line.find("[USE_DF_COLORS") != string::npos) {
             string result = parseStrFromLine("USE_DF_COLORS", line);
@@ -806,12 +807,10 @@ namespace {
 bool loadConfigFile()
 {
     string line;
-    ALLEGRO_PATH * p =al_create_path("dfhack-config/stonesense/init.txt");
-    const char * path = al_path_cstr(p,ALLEGRO_NATIVE_PATH_SEP);
+    auto path = std::filesystem::path{} / "dfhack-config" / "stonesense" / "init.txt";
     std::ifstream myfile(path);
     if (myfile.is_open() == false) {
         LogError( "cannot find init file\n" );
-        al_destroy_path(p);
         return false;
     }
 
@@ -823,6 +822,5 @@ bool loadConfigFile()
     ssConfig.colors.update();
     //close file, etc.
     myfile.close();
-    al_destroy_path(p);
     return true;
 }

Constructions.cpp

@@ -33,7 +33,7 @@ void changeConstructionMaterials(WorldSegment* segment, vector<df::construction>
  * Reads an unbuilt construction's tle type to the given block and converts the
  * material to "CONSTRUCTION".
  */
-bool readConstructionsToTile( Tile* b, const Buildings::t_building* building )
+bool readConstructionsToTile( Tile* b, const Stonesense_Building* building )
 {
     if(building->type == df::building_type::Construction) {
         df::tiletype constructedTiletype = df::tiletype::Void;

Constructions.h

@@ -3,4 +3,4 @@
 #include "df/construction.h"
 
 void changeConstructionMaterials(WorldSegment* segment, std::vector<df::construction>* allConstructions);
-bool readConstructionsToTile( Tile* b, const DFHack::Buildings::t_building* building );
+bool readConstructionsToTile( Tile* b, const Stonesense_Building* building );

ContentBuildingReader.cpp

@@ -208,17 +208,15 @@ bool includeFile(SpriteNode* node, TiXmlElement* includeNode, SpriteTile* &oldSi
     std::filesystem::path documentRef = getDocument(includeNode);
 
     std::filesystem::path configfilepath = getLocalFilename(includeNode->Attribute("file"), documentRef);
-    ALLEGRO_PATH * incpath = al_create_path(configfilepath.string().c_str());
-    al_append_path_component(incpath, "include");
-    TiXmlDocument doc( al_path_cstr(incpath, ALLEGRO_NATIVE_PATH_SEP) );
-    al_destroy_path(incpath);
+    std::filesystem::path incpath = configfilepath.remove_filename() / "include" / configfilepath.filename();
+    TiXmlDocument doc( incpath.string().c_str() );
     bool loadOkay = doc.LoadFile();
     TiXmlHandle hDoc(&doc);
     TiXmlElement* elemParent;
     if(!loadOkay) {
         contentError("Include failed",includeNode);
-        LogError("File load failed: %s\n", configfilepath.string().c_str());
-        LogError("Line %d: %s\n",doc.ErrorRow(),doc.ErrorDesc());
+        LogError("File load failed: %s\n", incpath.string().c_str());
+        LogError("Line %d: %s\n",doc.ErrorRow(),doc.ErrorDesc() ? doc.ErrorDesc() : "(null)");
         return false;
     }
     elemParent = hDoc.FirstChildElement("include").Element();

ContentLoader.cpp

@@ -30,8 +30,6 @@
 #include "df/world.h"
 #include "df/world_raws.h"
 
-#include "EnumToString.h"
-
 using namespace DFHack;
 using namespace df::enums;
 
@@ -210,9 +208,8 @@ bool ContentLoader::Load()
     contentLoader->obsidian = lookupMaterialIndex(INORGANIC, "OBSIDIAN");
 
     loadGraphicsFromDisk(); //these get destroyed when flushImgFiles is called.
-    ALLEGRO_PATH * p = al_create_path("stonesense/index.txt");
-    bool overallResult = parseContentIndexFile( al_path_cstr(p, ALLEGRO_NATIVE_PATH_SEP) );
-    al_destroy_path(p);
+    std::filesystem::path p{ "stonesense" };
+    bool overallResult = parseContentIndexFile( p / "index.txt");
     translationComplete = false;
 
     return overallResult;
@@ -235,33 +232,15 @@ bool ContentLoader::reload_configs()
     flushImgFiles();
 
     loadGraphicsFromDisk(); //these get destroyed when flushImgFiles is called.
-    ALLEGRO_PATH * p = al_create_path("stonesense/index.txt");
-    bool overallResult = parseContentIndexFile( al_path_cstr(p, ALLEGRO_NATIVE_PATH_SEP) );
-    al_destroy_path(p);
+    std::filesystem::path p = std::filesystem::path{} / "stonesense" / "index.txt";
+    bool overallResult = parseContentIndexFile( p );
 
     return overallResult;
 }
 
-// takes a filename and the file referring to it, and makes a combined filename in
-// HTML style: (ie "/something" is relative to the stonesense root, everything
-// else is relative to the referrer)
-// buffer must be FILENAME_BUFFERSIZE chars
-// returns true if it all works
-
-std::filesystem::path getLocalFilename(const char* filename, std::filesystem::path relativeto)
+std::filesystem::path getLocalFilename(std::filesystem::path filename, std::filesystem::path relativeto)
 {
-    // TODO verify that this does not leak
-    ALLEGRO_PATH* temppath;
-    if (filename[0] == '/' || filename[0] == '\\') {
-        temppath = al_create_path(filename);
-        al_make_path_canonical(temppath);
-    }
-    else {
-        temppath = al_create_path(relativeto.string().c_str());
-        al_join_paths(temppath, al_create_path(filename));
-        al_make_path_canonical(temppath);
-    }
-    return std::string{ al_path_cstr(temppath, ALLEGRO_NATIVE_PATH_SEP) };
+    return relativeto.remove_filename() / filename;
 }
 
 bool ContentLoader::parseContentIndexFile( std::filesystem::path filepath )
@@ -313,16 +292,14 @@ bool ContentLoader::parseContentIndexFile( std::filesystem::path filepath )
             continue;
         }
 
-        std::filesystem::path configfilepath = getLocalFilename(line.c_str(), filepath);
-        ALLEGRO_PATH * temppath = al_create_path(configfilepath.string().c_str());
-        const char* extension;
-        extension = al_get_path_extension(temppath);
-        if (strcmp(extension,".xml") == 0) {
+        std::filesystem::path configfilepath = filepath.remove_filename() / std::filesystem::path{ line }.make_preferred();
+        auto extension = configfilepath.extension();
+        if (extension == ".xml") {
             LogVerbose("Reading xml %s...\n", configfilepath.string().c_str());
             if (!parseContentXMLFile(configfilepath)) {
                 LogError("Failure in reading %s\n",configfilepath.string().c_str());
             }
-        } else if (strcmp(extension,".txt") == 0) {
+        } else if (extension == ".txt") {
             LogVerbose("Reading index %s...\n", configfilepath.string().c_str());
             if (!parseContentIndexFile(configfilepath)) {
                 LogError("Failure in reading %s\n",configfilepath.string().c_str());
@@ -468,13 +445,19 @@ const char* getDocument(TiXmlNode* element)
     return parent->Value();
 }
 
-void contentError(const char* message, TiXmlNode* element)
+void contentError(const string& message, TiXmlNode* element)
 {
-    LogError("%s: %s: %s (Line %d)\n",getDocument(element),message,element->Value(),element->Row());
+    auto safeStr = [](const char* s)->const char* {return s ? s : "(unknown)"; };
+
+    LogError("%s: %s: %s (Line %d)\n",
+        safeStr(getDocument(element)),
+        message.c_str(),
+        element ? safeStr(element->Value()) : "(no element)",
+        element ? element->Row() : -1);
 }
-void contentWarning(const char* message, TiXmlNode* element)
+void contentWarning(const string& message, TiXmlNode* element)
 {
-    LogVerbose("%s: %s: %s (Line %d)\n",getDocument(element),message,element->Value(),element->Row());
+    LogVerbose("%s: %s: %s (Line %d)\n",getDocument(element),message.c_str(),element->Value(),element->Row());
 }
 // converts list of characters 0-5 into bits, ignoring garbage
 // eg  "035" or "0  3 5" or "0xx3x5" are all good
@@ -697,11 +680,11 @@ uint8_t lookupMaterialBright(int matType,int matIndex)
     return 0;
 }
 
-int loadConfigImgFile(const char* filename, TiXmlElement* referrer)
+int loadConfigImgFile(std::filesystem::path filename, TiXmlElement* referrer)
 {
     std::filesystem::path documentRef = getDocument(referrer);
     std::filesystem::path configfilepath = getLocalFilename(filename, documentRef);
-    return loadImgFile(configfilepath.string().c_str());
+    return loadImgFile(configfilepath);
 }
 
 void ContentLoader::flushCreatureConfig()

ContentLoader.h

@@ -86,41 +86,31 @@ class ContentLoader
 extern ContentLoader * contentLoader;
 
 extern const char* getDocument(TiXmlNode* element);
-std::filesystem::path getLocalFilename(const char* filename, std::filesystem::path relativeto);
-extern void contentError(const char* message, TiXmlNode* element);
-extern void contentWarning(const char* message, TiXmlNode* element);
+std::filesystem::path getLocalFilename(std::filesystem::path filename, std::filesystem::path relativeto);
+extern void contentError(const std::string& message, TiXmlNode* element);
+extern void contentWarning(const std::string& message, TiXmlNode* element);
 extern char getAnimFrames(const char* framestring);
-extern int loadConfigImgFile(const char* filename, TiXmlElement* referrer);
+extern int loadConfigImgFile(std::filesystem::path filename, TiXmlElement* referrer);
 MAT_BASICS lookupMaterialType(const char* strValue);
 int lookupMaterialIndex(int matType, const char* strValue);
-template <typename T>
-int lookupIndexedType(const char* indexName, std::vector<T>& typeVector)
+
+template <typename T, typename Index = decltype(T::id)>
+int lookupIndexedType(const Index& indexName, const std::vector<T>& typeVector)
 {
-    if (indexName == NULL || indexName[0] == 0) {
-        return INVALID_INDEX;
-    }
-    uint32_t vsize = (uint32_t)typeVector.size();
-    for(uint32_t i=0; i < vsize; i++) {
-        if (typeVector[i].id == indexName) {
-            return i;
-        }
-    }
-    return INVALID_INDEX;
+    auto get_id = [](auto tv) {
+        if constexpr (std::is_pointer_v<T>) return tv->id;
+        else return tv.id;
+        };
+    auto it = std::find_if(typeVector.begin(), typeVector.end(),
+        [&](auto tv) -> bool { return get_id(tv) == indexName; });
+    return it != typeVector.end() ? it - typeVector.begin() : INVALID_INDEX;
 }
-template <typename T>
-int lookupIndexedPonterType(const char* indexName, std::vector<T*>& typeVector)
+template <typename T, typename Index = decltype(T::id)>
+int lookupIndexedPointerType(const Index& indexName, const std::vector<T*>& typeVector)
 {
-    if (indexName == NULL || indexName[0] == 0) {
-        return INVALID_INDEX;
-    }
-    uint32_t vsize = (uint32_t)typeVector.size();
-    for(uint32_t i=0; i < vsize; i++) {
-        if (typeVector[i]->id == indexName) {
-            return i;
-        }
-    }
-    return INVALID_INDEX;
+    return lookupIndexedType<T*, Index>(indexName, typeVector);
 }
+
 const char *lookupMaterialTypeName(int matType);
 const char *lookupMaterialName(int matType,int matIndex);
 const char *lookupBuildingSubtype(int main_type, int i);