Merge pull request #587 from winterheart/module-fixes

Update module, add logger module

2dlib/CMakeLists.txt

@@ -15,9 +15,9 @@ set(CPPS
 add_library(2dlib STATIC ${HEADERS} ${CPPS})
 target_link_libraries(2dlib PRIVATE
   cfile
+  logger
   mem
   misc
-  plog::plog
 )
 target_include_directories(2dlib PUBLIC
   $<BUILD_INTERFACE:

AudioEncode/CMakeLists.txt

@@ -11,7 +11,7 @@ set(CPPS
 add_library(AudioEncode STATIC ${HEADERS} ${CPPS})
 target_link_libraries(AudioEncode PRIVATE
   libacm
-  plog::plog
+  logger
 )
 target_include_directories(AudioEncode PUBLIC
   $<BUILD_INTERFACE:

CMakeLists.txt

@@ -234,6 +234,7 @@ add_subdirectory(linux)
 add_subdirectory(ddio)
 add_subdirectory(dd_video)
 add_subdirectory(fix)
+add_subdirectory(logger)
 add_subdirectory(manage)
 add_subdirectory(grtext)
 add_subdirectory(mem)

Descent3/CMakeLists.txt

@@ -314,9 +314,36 @@ file(GLOB_RECURSE INCS "../lib/*.h")
 
 add_executable(Descent3 WIN32 MACOSX_BUNDLE ${D3Icon} ${HEADERS} ${CPPS} ${INCS} ${MANIFEST} ${RC_FILE})
 target_link_libraries(Descent3 PRIVATE
-  2dlib AudioEncode bitmap cfile dd_video ddebug ddio libmve libacm
-  fix grtext manage mem misc model module stream_audio linux SDL2::SDL2 plog::plog
-  music networking physics renderer rtperformance sndlib ui unzip vecmat md5
+  SDL2::SDL2
+  2dlib
+  AudioEncode
+  bitmap
+  cfile
+  dd_video
+  ddebug
+  ddio
+  fix
+  grtext
+  libmve
+  libacm
+  linux
+  logger
+  manage
+  mem
+  md5
+  misc
+  model
+  module
+  music
+  networking
+  physics
+  renderer
+  rtperformance
+  sndlib
+  stream_audio
+  ui
+  unzip
+  vecmat
   ${PLATFORM_LIBS})
 target_include_directories(Descent3 PRIVATE ${PROJECT_BINARY_DIR}/lib)
 target_link_options(Descent3 PRIVATE $<$<PLATFORM_ID:Windows>:/DEBUG:FULL>)

Descent3/osiris_dll.h

@@ -112,11 +112,10 @@
 #ifndef __OSIRIS_H_
 #define __OSIRIS_H_
 
-#include "pstypes.h"
+#include "cfile.h"
+#include "module.h"
 #include "object_external_struct.h"
 #include "osiris_share.h"
-#include "module.h"
-#include "cfile.h"
 
 extern uint32_t Osiris_game_checksum;
 extern tOSIRISModuleInit Osiris_module_init;

Descent3/sdlmain.cpp

@@ -33,20 +33,9 @@
 #include <csignal>
 #endif
 
-#ifdef WIN32
-#include <cstdio>
-#include <windows.h>
-#include "debug.h"
-#endif
-
 #include <SDL.h>
-// We use direct plog includes instead of log.h for logger instance initialization
-#include <plog/Log.h>
-#include <plog/Appenders/ColorConsoleAppender.h>
-#include <plog/Initializers/RollingFileInitializer.h>
 
 #include "appdatabase.h"
-#include "ddio.h"
 #include "application.h"
 #include "args.h"
 #include "d3_version.h"
@@ -54,6 +43,11 @@
 #include "descent.h"
 #include "dedicated_server.h"
 #include "init.h"
+#include "log.h"
+
+#ifdef WIN32
+#include "debug.h"
+#endif
 
 std::filesystem::path orig_pwd;
 
@@ -212,38 +206,6 @@ int SDLCALL d3SDLEventFilter(void *userdata, SDL_Event *event) {
   return (1);
 }
 
-/**
- * Initialize logger facility.
- * @param log_level desired log level (for example, plog::debug)
- * @param enable_filelog enable logging into Descent.log
- * @param enable_win_console enable console windows for WIN32 (no-op for POSIX systems)
- */
-void InitLog(plog::Severity log_level, bool enable_filelog, bool enable_win_console) {
-  std::filesystem::path log_file = "Descent3.log";
-  static plog::ColorConsoleAppender<plog::TxtFormatter> consoleAppender;
-  static plog::RollingFileAppender<plog::TxtFormatter> fileAppender(log_file.u8string().c_str());
-
-#ifdef WIN32
-  if (enable_win_console) {
-    // Open console window
-    AllocConsole();
-    freopen("CONIN$", "r", stdin);
-    freopen("CONOUT$", "w", stdout);
-    freopen("CONOUT$", "w", stderr);
-  }
-#endif
-
-  plog::init(log_level, &consoleAppender);
-  if (enable_filelog) {
-    if (std::filesystem::is_regular_file(log_file)) {
-      // Delete old log
-      std::error_code ec;
-      std::filesystem::remove(log_file, ec);
-      plog::get()->addAppender(&fileAppender);
-    }
-  }
-}
-
 //	---------------------------------------------------------------------------
 //	Main
 //		creates all the OS objects and then runs Descent 3.

Descent3/tests/CMakeLists.txt

@@ -7,6 +7,7 @@ add_executable(
 
 target_link_libraries(
   porting-tests
+  module
   GTest::gtest_main
 )
 

bitmap/CMakeLists.txt

@@ -15,9 +15,9 @@ target_link_libraries(bitmap PRIVATE
   cfile
   ddebug
   ddio
+  logger
   mem
   misc
-  plog::plog
   stb
 )
 target_include_directories(bitmap PUBLIC

cfile/CMakeLists.txt

@@ -11,9 +11,9 @@ set(CPPS
 add_library(cfile STATIC ${HEADERS} ${CPPS})
 target_link_libraries(cfile PRIVATE
   ddio
+  logger
   mem
   misc
-  plog::plog
 )
 target_include_directories(cfile PUBLIC
   $<BUILD_INTERFACE:

dd_grwin32/CMakeLists.txt

@@ -11,8 +11,8 @@ set(CPPS
 add_library(dd_grwin32 STATIC ${HEADERS} ${CPPS})
 target_link_libraries(dd_grwin32 PRIVATE
   2dlib
+  logger
   misc
-  plog::plog
 )
 target_compile_definitions(dd_grwin32 PRIVATE DX_APP)
 target_link_libraries(dd_grwin32 PRIVATE ${DDRAW_LIBRARY})

ddio/CMakeLists.txt

@@ -29,8 +29,8 @@ set(CPPS
 add_library(ddio STATIC ${HEADERS} ${CPPS})
 target_link_libraries(ddio PRIVATE
   SDL2::SDL2
-  plog::plog
   ddebug
+  logger
   mem
   misc
 )

grtext/CMakeLists.txt

@@ -10,9 +10,9 @@ set(CPPS
 add_library(grtext STATIC ${HEADERS} ${CPPS})
 target_link_libraries(grtext PRIVATE
   ddio
+  logger
   mem
   misc
-  plog::plog
 )
 target_include_directories(grtext PUBLIC
   $<BUILD_INTERFACE:

lib/directplay.h

@@ -44,8 +44,11 @@
 #ifndef _OUTRAGE_DIRECTPLAY_HEADER
 #define _OUTRAGE_DIRECTPLAY_HEADER
 
+#include <cstdint>
+
 #include "dplay.h"
 #include "dplobby.h"
+#include "networking.h"
 
 struct modem_list {
   char name[200];
@@ -80,7 +83,7 @@ int dp_DirectPlaySend(network_address *who_to, uint8_t *data, int len, bool reli
 void dp_DirectPlayDispatch();
 
 // Initialize stuff
-int dp_InitDirectPlay(char *conn_name, void *parms = NULL, int num_elements = 0);
+int dp_InitDirectPlay(char *conn_name, void *parms = nullptr, int num_elements = 0);
 
 // Shutdown things
 void dp_ShutdownDirectPlay();

linux/CMakeLists.txt

@@ -13,7 +13,7 @@ set(CPPS
 add_library(linux STATIC ${HEADERS} ${CPPS})
 target_link_libraries(linux PRIVATE
   cfile
-  plog::plog
+  logger
 )
 target_include_directories(linux PUBLIC
   $<BUILD_INTERFACE:

logger/CMakeLists.txt

@@ -0,0 +1,16 @@
+set(HEADERS
+  log.h
+)
+set(CPPS
+  log.cpp
+)
+
+add_library(logger STATIC ${HEADERS} ${CPPS})
+target_link_libraries(logger PUBLIC
+  plog::plog
+)
+target_include_directories(logger PUBLIC
+  $<BUILD_INTERFACE:
+    ${PROJECT_SOURCE_DIR}/logger
+  >
+)

logger/log.cpp

@@ -0,0 +1,56 @@
+/*
+ * Descent 3
+ * Copyright (C) 2024 Descent Developers
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <filesystem>
+#include <plog/Log.h>
+#include <plog/Appenders/ColorConsoleAppender.h>
+#include <plog/Initializers/RollingFileInitializer.h>
+
+#ifdef WIN32
+#include <cstdio>
+#include <windows.h>
+#include "debug.h"
+#endif
+
+#include "log.h"
+
+void InitLog(plog::Severity log_level, bool enable_filelog, bool enable_win_console) {
+  std::filesystem::path log_file = "Descent3.log";
+  static plog::ColorConsoleAppender<plog::TxtFormatter> consoleAppender;
+  static plog::RollingFileAppender<plog::TxtFormatter> fileAppender(log_file.u8string().c_str());
+
+#ifdef WIN32
+  if (enable_win_console) {
+    // Open console window
+    AllocConsole();
+    freopen("CONIN$", "r", stdin);
+    freopen("CONOUT$", "w", stdout);
+    freopen("CONOUT$", "w", stderr);
+  }
+#endif
+
+  plog::init(log_level, &consoleAppender);
+  if (enable_filelog) {
+    if (std::filesystem::is_regular_file(log_file)) {
+      // Delete old log
+      std::error_code ec;
+      std::filesystem::remove(log_file, ec);
+    }
+    plog::get()->addAppender(&fileAppender);
+  }
+}

logger/log.h

@@ -32,3 +32,11 @@ In case of swapping to another solution here should be redefined following macro
 #define LOG_FATAL                       PLOG(plog::fatal)
 
 */
+
+/**
+ * Initialize logger facility.
+ * @param log_level desired log level (for example, plog::debug)
+ * @param enable_filelog enable logging into Descent.log
+ * @param enable_win_console enable console windows for WIN32 (no-op for POSIX systems)
+ */
+void InitLog(plog::Severity log_level, bool enable_filelog, bool enable_win_console);

manage/CMakeLists.txt

@@ -25,10 +25,10 @@ add_library(manage STATIC ${HEADERS} ${CPPS})
 target_link_libraries(manage PRIVATE
   cfile
   ddio
+  logger
   mem
   misc
   model
   sndlib
   stream_audio
-  plog::plog
 )

mem/CMakeLists.txt

@@ -6,8 +6,8 @@ target_compile_definitions(mem PUBLIC
   $<$<BOOL:${ENABLE_MEM_RTL}>:MEM_USE_RTL>
 )
 target_link_libraries(mem PRIVATE
+  logger
   misc
-  plog::plog
 )
 target_include_directories(mem PUBLIC
   $<BUILD_INTERFACE:

model/CMakeLists.txt

@@ -8,10 +8,10 @@ set(CPPS
 add_library(model STATIC ${HEADERS} ${CPPS})
 target_link_libraries(model PRIVATE
   cfile
+  logger
   mem
   misc
   physics
-  plog::plog
 )
 target_include_directories(model PUBLIC
   $<BUILD_INTERFACE:

module/CMakeLists.txt

@@ -1,8 +1,18 @@
-set(HEADERS)
+set(HEADERS
+  module.h
+)
 set(CPPS
-  module.cpp)
+  module.cpp
+)
 
 add_library(module STATIC ${HEADERS} ${CPPS})
 target_link_libraries(module PRIVATE
+  cfile
   ddebug
+  logger
+)
+target_include_directories(module PUBLIC
+  $<BUILD_INTERFACE:
+  ${PROJECT_SOURCE_DIR}/module
+  >
 )

module/module.cpp

@@ -101,54 +101,10 @@
 #include <dlfcn.h>
 #endif
 
+#include "cfile.h"
 #include "crossplat.h"
+#include "log.h"
 #include "module.h"
-#include "mono.h"
-
-/**
- * Returns fixed case file name to actual case on disk for case-sensitive filesystems (Linux).
- * This is actually copy of cf_FindRealFileNameCaseInsensitive() from CFILE.
- * @param fname the fixed case name to map to reality
- * @param directory optional directory to search within (default - current path)
- * @return filename with actual case name or empty path if there no mapping in filesystem
- * @note This function returns only filename without directory part, i.e.
- * mod_FindRealFileNameCaseInsensitive("test/test.txt") will return only "test.txt" on success.
- */
-std::filesystem::path mod_FindRealFileNameCaseInsensitive(const std::filesystem::path &fname,
-                                                          const std::filesystem::path &directory = ".") {
-  // Dumb check, maybe there already all ok?
-  if (std::filesystem::exists((directory / fname))) {
-    return fname.filename();
-  }
-
-  std::filesystem::path result, search_path, search_file;
-
-  search_path = directory / fname.parent_path();
-  search_file = fname.filename();
-
-  // If directory does not exist, nothing to search.
-  if (!std::filesystem::is_directory(search_path) || search_file.empty()) {
-    return {};
-  }
-
-  // Search component in search_path
-  auto const &it = std::filesystem::directory_iterator(search_path);
-
-  auto found = std::find_if(it, end(it), [&search_file, &search_path, &result](const auto &dir_entry) {
-    return stricmp(dir_entry.path().filename().u8string().c_str(), search_file.u8string().c_str()) == 0;
-  });
-
-  if (found != end(it)) {
-    // Match, append to result
-    result = found->path();
-    search_path = result;
-  } else {
-    // Component not found, mission failed
-    return {};
-  }
-
-  return result.filename();
-}
 
 int ModLastError = MODERR_NOERROR;
 
@@ -228,21 +184,21 @@ bool mod_LoadModule(module *handle, const std::filesystem::path &imodfilename, i
   if (!handle->handle) {
     // ok we couldn't find the given name...try other ways
     std::filesystem::path parent_path = modfilename.parent_path();
-    std::filesystem::path new_filename = mod_FindRealFileNameCaseInsensitive(parent_path, modfilename.filename());
+    std::filesystem::path new_filename = cf_FindRealFileNameCaseInsensitive(modfilename.filename(), parent_path);
 
     if (new_filename.empty()) {
-      mprintf(0, "Module Load Err: %s\n", dlerror());
+      LOG_ERROR.printf("Module Load Err: %s", dlerror());
       ModLastError = MODERR_MODNOTFOUND;
       return false;
     }
 
     // ok we have a different filename
-    mprintf(0, "MOD: Attempting to open %s instead of %s\n", new_filename.u8string().c_str(),
+    LOG_DEBUG.printf("MOD: Attempting to open %s instead of %s", new_filename.u8string().c_str(),
                      modfilename.u8string().c_str());
     modfilename = parent_path / new_filename;
     handle->handle = dlopen(modfilename.u8string().c_str(), f);
     if (!handle->handle) {
-      mprintf(0, "Module Load Err: %s\n", dlerror());
+      LOG_ERROR.printf("Module Load Err: %s", dlerror());
       ModLastError = MODERR_MODNOTFOUND;
       return false;
     }

music/CMakeLists.txt

@@ -12,11 +12,11 @@ target_link_libraries(music
   AudioEncode
   cfile
   ddio
+  logger
   mem
   misc
   sndlib
   stream_audio
-  plog::plog
 )
 target_include_directories(music PUBLIC
   $<BUILD_INTERFACE:

netcon/descent3onlineclient/CMakeLists.txt

@@ -18,6 +18,7 @@ target_link_libraries(Descent3_Online_TCP_IP PRIVATE
   ddio
   inetfile
   misc
+  module
   ui
   $<$<PLATFORM_ID:Windows>:ws2_32>
 )

netcon/lanclient/CMakeLists.txt

@@ -11,6 +11,7 @@ target_link_libraries(Direct_TCP_IP PRIVATE
   ddio
   inetfile
   misc
+  module
   ui
   $<$<PLATFORM_ID:Windows>:ws2_32>
 )

netcon/mtclient/CMakeLists.txt

@@ -21,6 +21,7 @@ target_link_libraries(Parallax_Online PRIVATE
   ddio
   inetfile
   misc
+  module
   ui
   $<$<PLATFORM_ID:Windows>:ws2_32>
 )

netgames/dmfc/CMakeLists.txt

@@ -30,6 +30,7 @@ add_library(dmfc STATIC ${HEADERS} ${CPPS})
 target_link_libraries(dmfc PUBLIC
   grtext
   misc
+  module
   physics
   ddio
 )

networking/CMakeLists.txt

@@ -13,8 +13,9 @@ endif()
 add_library(networking STATIC ${HEADERS} ${CPPS})
 target_link_libraries(networking PRIVATE
   ddio
+  logger
   mem
   misc
+  module
   ${PLATFORM_LIBS}
-  plog::plog
 )

networking/networking.cpp

@@ -290,6 +290,11 @@
 #include <process.h>
 #include <wsipx.h>
 #include <ras.h>
+
+#include "directplay.h"
+#include "dplay.h"
+#include "dplobby.h"
+
 typedef int socklen_t;
 #endif
 #include <stdlib.h>
@@ -311,36 +316,23 @@ typedef int socklen_t;
 #define LPSTR char *
 #endif
 
-#ifdef WIN32
-#include "dplay.h"
-#include "dplobby.h"
-#endif
-
 #include "descent.h"
 #include "appdatabase.h"
-
-#include "pstypes.h"
 #include "pserror.h"
 #include "log.h"
 #include "networking.h"
 #include "ddio.h"
 #include "mem.h"
+#include "module.h"
 #include "game.h"
 #include "args.h"
 #include "byteswap.h"
-
-#ifdef WIN32
-#include "directplay.h"
-#endif
-
 #include "pstring.h"
 
 #ifndef WIN32
 bool Use_DirectPlay = false;
 #endif
 
-#include "module.h" //for some nice defines to use below
-
 #define MAX_CONNECT_TRIES 50
 #define MAX_RECEIVE_BUFSIZE 32768
 //(1<<16)			// 16 K, eh?

physics/CMakeLists.txt

@@ -12,12 +12,13 @@ set(CPPS
 add_library(physics STATIC ${HEADERS} ${CPPS})
 target_link_libraries(physics PRIVATE
   ddio
+  logger
   mem
   misc
   model
+  module
   rtperformance
   sndlib
-  plog::plog
 )
 target_include_directories(physics PUBLIC
   $<BUILD_INTERFACE:

renderer/CMakeLists.txt

@@ -35,10 +35,11 @@ target_include_directories(renderer PRIVATE ${GENERATED_HEADERS})
 target_link_libraries(renderer PRIVATE
   glm::glm
   SDL2::SDL2
-  plog::plog
   bitmap
   ddio
+  logger
   mem
   misc
+  module
   rtperformance
 )

rtperformance/CMakeLists.txt

@@ -6,7 +6,7 @@ set(CPPS
 add_library(rtperformance STATIC ${HEADERS} ${CPPS})
 target_link_libraries(rtperformance PRIVATE
   ddio
-  plog::plog
+  logger
 )
 target_include_directories(rtperformance PUBLIC
   $<BUILD_INTERFACE:

scripts/CMakeLists.txt

@@ -85,6 +85,7 @@ foreach(SCRIPT ${SCRIPTS})
     dallas
     fix
     misc
+    module
   )
   set_target_properties(${SCRIPT} PROPERTIES PREFIX "")
   set_target_properties(${SCRIPT} PROPERTIES CXX_VISIBILITY_PRESET "hidden")

sndlib/CMakeLists.txt

@@ -21,12 +21,12 @@ add_library(sndlib STATIC ${HEADERS} ${CPPS})
 target_link_libraries(sndlib PRIVATE
   cfile
   ddio
+  logger
   mem
   misc
   stream_audio
   physics
   SDL2::SDL2
-  plog::plog
 )
 target_include_directories(sndlib PUBLIC
   $<BUILD_INTERFACE:

stream_audio/CMakeLists.txt

@@ -8,10 +8,10 @@ set(CPPS
 add_library(stream_audio STATIC ${HEADERS} ${CPPS})
 target_link_libraries(stream_audio PRIVATE
   ddio
+  logger
   mem
   misc
   sndlib
-  plog::plog
 )
 target_link_libraries(stream_audio PUBLIC
   AudioEncode

ui/CMakeLists.txt

@@ -26,9 +26,9 @@ add_library(ui STATIC ${HEADERS} ${CPPS})
 target_link_libraries(ui PRIVATE
   ddio
   grtext
+  logger
   mem
   misc
-  plog::plog
 )
 target_include_directories(ui PUBLIC
   $<BUILD_INTERFACE:

win32/CMakeLists.txt

@@ -11,6 +11,6 @@ target_compile_definitions(win32 PRIVATE DX_APP)
 target_link_libraries(win32 PRIVATE
   ddebug
   ddio
+  logger
   misc
-  plog::plog
 )