Further work on Steam compatibility

1. Adopt changes to dfhooks
2. Install dfhooks_dfhack the `hack` folder, and generate and install an appropriate `dfhooks_dfhack.ini` into the DF folder
3. Adjust RPATH (on Linux) so dfhooks_dfhack.dll can find dfhack.dll
4. Use dfhooks preinit to get the hack base path. Use this path when initializing Core
5. in `getHackPath()`, use the collected hack base path instead of hardcoding `./hack`.
6. Fix at one instance where `hack` was hardcoded outside of `getHackPath` (note: there are others this commit does not fix)
7. Update VersionInfoFactory to use a fs `path` instead of a `string` as its argument

Author: ab9rf

CMakeLists.txt

@@ -226,13 +226,10 @@ set(DFHACK_DATA_DESTINATION hack)
 
 ## where to install things (after the build is done, classic 'make install' or package structure)
 # the dfhack libraries will be installed here:
-if(UNIX)
-    # put the lib into DF/hack
-    set(DFHACK_LIBRARY_DESTINATION ${DFHACK_DATA_DESTINATION})
-else()
-    # windows is crap, therefore we can't do nice things with it. leave the libs on a nasty pile...
-    set(DFHACK_LIBRARY_DESTINATION .)
-endif()
+
+# put the lib into DF/hack
+# windows will find it because dfhooks will `AddDllDirectory` the hack folder at runtime
+set(DFHACK_LIBRARY_DESTINATION ${DFHACK_DATA_DESTINATION})
 
 # external tools will be installed here:
 set(DFHACK_BINARY_DESTINATION .)
@@ -267,7 +264,7 @@ if(UNIX)
         set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -m32 -march=i686")
     endif()
     string(REPLACE "-DNDEBUG" "" CMAKE_CXX_FLAGS_RELWITHDEBINFO "${CMAKE_CXX_FLAGS_RELWITHDEBINFO}")
-    set(CMAKE_INSTALL_RPATH ${DFHACK_LIBRARY_DESTINATION})
+    set(CMAKE_INSTALL_RPATH "$ORIGIN/${DFHACK_LIBRARY_DESTINATION}")
 elseif(MSVC)
     # for msvc, tell it to always use 8-byte pointers to member functions to avoid confusion
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /vmg /vmm /MP")

depends/dfhooks

@@ -131,7 +131,6 @@ endif()
 
 set(MAIN_SOURCES_WINDOWS
     ${CONSOLE_SOURCES}
-    Hooks.cpp
 )
 
 if(WIN32)
@@ -453,8 +452,9 @@ if(UNIX)
 endif()
 
 install(TARGETS dfhooks_dfhack
-        LIBRARY DESTINATION .
-        RUNTIME DESTINATION .)
+        LIBRARY DESTINATION ${DFHACK_LIBRARY_DESTINATION}
+        RUNTIME DESTINATION ${DFHACK_LIBRARY_DESTINATION})
+
 
 # install the main lib
 install(TARGETS dfhack
@@ -465,6 +465,12 @@ install(TARGETS dfhack-run dfhack-client binpatch
     LIBRARY DESTINATION ${DFHACK_LIBRARY_DESTINATION}
     RUNTIME DESTINATION ${DFHACK_LIBRARY_DESTINATION})
 
+file(GENERATE OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/dfhooks_dfhack.ini
+    CONTENT "${DFHACK_DATA_DESTINATION}/$<TARGET_FILE_NAME:dfhooks_dfhack>")
+
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/dfhooks_dfhack.ini
+    DESTINATION .)
+
 endif(BUILD_LIBRARY)
 
 # install the offset file

library/CMakeLists.txt

@@ -124,7 +124,7 @@ namespace DFHack {
 
     static const std::filesystem::path getConfigDefaultsPath()
     {
-        return Filesystem::getInstallDir() / "hack" / "data" / "dfhack-config-defaults";
+        return Core::getInstance().getHackPath() / "data" / "dfhack-config-defaults";
     };
 
 class MainThread {
@@ -492,7 +492,7 @@ void Core::getScriptPaths(std::vector<std::filesystem::path> *dest)
         if (save.size())
             dest->emplace_back(df_pref_path / "save" / save / "scripts");
     }
-    dest->emplace_back(df_install_path / "hack" / "scripts");
+    dest->emplace_back(getHackPath() / "scripts");
     for (auto & path : script_paths[2])
         dest->emplace_back(path);
     for (auto & path : script_paths[1])
@@ -1054,16 +1054,17 @@ void Core::fatal (std::string output, const char * title)
 
 std::filesystem::path Core::getHackPath()
 {
-    return p->getPath() / "hack";
+    return hack_path;
 }
 
 df::viewscreen * Core::getTopViewscreen() {
     return getInstance().top_viewscreen;
 }
 
-bool Core::InitMainThread() {
+bool Core::InitMainThread(std::filesystem::path path) {
     // this hook is always called from DF's main (render) thread, so capture this thread id
     df_render_thread = std::this_thread::get_id();
+    hack_path = path;
 
     Filesystem::init();
 
@@ -1099,16 +1100,12 @@ bool Core::InitMainThread() {
     }
 
     // find out what we are...
-    #ifdef LINUX_BUILD
-        const char * path = "hack/symbols.xml";
-    #else
-        const char * path = "hack\\symbols.xml";
-    #endif
+    std::filesystem::path symbols_path = getHackPath() / "symbols.xml";
     auto local_vif = std::make_unique<DFHack::VersionInfoFactory>();
     std::cerr << "Identifying DF version.\n";
     try
     {
-        local_vif->loadFile(path);
+        local_vif->loadFile(symbols_path);
     }
     catch(Error::All & err)
     {

library/Core.cpp

@@ -7,6 +7,14 @@ static bool disabled = false;
 
 DFhackCExport const int32_t dfhooks_priority = 100;
 
+static std::filesystem::path basepath{"./hack"};
+
+// called by the chainloader before the main thread is initialized and before any other hooks are called.
+DFhackCExport void dfhooks_preinit(std::filesystem::path dllpath)
+{
+    basepath = dllpath.parent_path();
+}
+
 // called from the main thread before the simulation thread is started
 // and the main event loop is initiated
 DFhackCExport void dfhooks_init() {
@@ -17,7 +25,7 @@ DFhackCExport void dfhooks_init() {
     }
 
     // we need to init DF globals before we can check the commandline
-    if (!DFHack::Core::getInstance().InitMainThread() || !df::global::game) {
+    if (!DFHack::Core::getInstance().InitMainThread(basepath) || !df::global::game) {
         // we don't set disabled to true here so symbol generation can work
         return;
     }

library/Hooks.cpp

@@ -226,9 +226,9 @@ void VersionInfoFactory::ParseVersion (TiXmlElement* entry, VersionInfo* mem)
 } // method
 
 // load the XML file with offsets
-bool VersionInfoFactory::loadFile(string path_to_xml)
+bool VersionInfoFactory::loadFile(std::filesystem::path path_to_xml)
 {
-    TiXmlDocument doc( path_to_xml.c_str() );
+    TiXmlDocument doc( path_to_xml.string().c_str() );
     std::cerr << "Loading " << path_to_xml << " ... ";
     //bool loadOkay = doc.LoadFile();
     if (!doc.LoadFile())

library/VersionInfoFactory.cpp

@@ -268,7 +268,7 @@ namespace DFHack
         struct Private;
         std::unique_ptr<Private> d;
 
-        bool InitMainThread();
+        bool InitMainThread(std::filesystem::path path);
         bool InitSimulationThread();
         int Update (void);
         int Shutdown (void);
@@ -353,6 +353,8 @@ namespace DFHack
 
         uint32_t unpaused_ms; // reset to 0 on map load
 
+        std::filesystem::path hack_path;
+
         friend class CoreService;
         friend class ServerConnection;
         friend class CoreSuspender;

library/include/Core.h

@@ -26,6 +26,7 @@ distribution.
 #pragma once
 
 #include <memory>
+#include <filesystem>
 
 #include "Export.h"
 
@@ -38,7 +39,7 @@ namespace DFHack
         public:
             VersionInfoFactory();
             ~VersionInfoFactory();
-            bool loadFile( std::string path_to_xml);
+            bool loadFile( std::filesystem::path path_to_xml);
             bool isInErrorState() const {return error;};
             std::shared_ptr<const VersionInfo> getVersionInfoByMD5(std::string md5string) const;
             std::shared_ptr<const VersionInfo> getVersionInfoByPETimestamp(uintptr_t timestamp) const;