Merge pull request #5119 from NREL/4847_LoggerSingleton_3.1

4847 logger singleton 3.1
NREL · Mar 27, 2024 · f6310d8 · f6310d8
2 parents 1b653ae + db83481
commit f6310d8
Show file tree

Hide file tree

Showing 36 changed files with 105 additions and 109 deletions.
diff --git a/ProjectMacros.cmake b/ProjectMacros.cmake
@@ -281,6 +281,7 @@ macro(MAKE_SWIG_TARGET NAME SIMPLENAME KEY_I_FILE I_FILES PARENT_TARGET PARENT_S
     set_target_properties(${swig_target} PROPERTIES RUNTIME_OUTPUT_DIRECTORY "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/ruby/")
     target_link_libraries(${swig_target} ${${PARENT_TARGET}_depends})
     target_include_directories(${swig_target} SYSTEM PRIVATE ${RUBY_INCLUDE_DIRS})
+    target_compile_definitions(${swig_target} PRIVATE SHARED_OS_LIBS)
     add_dependencies(${swig_target} ${PARENT_TARGET})
 
     execute_process(COMMAND \"${CMAKE_COMMAND}\" -E copy \"\${resolved_item_var}\" \"\${CMAKE_INSTALL_PREFIX}/Ruby/openstudio/\")
@@ -355,6 +356,7 @@ macro(MAKE_SWIG_TARGET NAME SIMPLENAME KEY_I_FILE I_FILES PARENT_TARGET PARENT_S
       ${SWIG_WRAPPER}
     )
 
+    target_compile_definitions(${swig_target} PRIVATE SHARED_OS_LIBS)
     set_target_properties(${swig_target} PROPERTIES OUTPUT_NAME _${LOWER_NAME})
     set_target_properties(${swig_target} PROPERTIES PREFIX "")
     set_target_properties(${swig_target} PROPERTIES ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_ARCHIVE_OUTPUT_DIRECTORY}/python/")

diff --git a/python/engine/CMakeLists.txt b/python/engine/CMakeLists.txt
@@ -30,8 +30,8 @@ target_include_directories(pythonengine
 target_link_libraries(
   pythonengine
   PRIVATE
+  openstudiolib
   openstudio_scriptengine
-  openstudio_utilities_minimal
   CONAN_PKG::fmt
   Python::Python
 )

diff --git a/src/airflow/Airflow.i b/src/airflow/Airflow.i
@@ -5,7 +5,7 @@
 %module openstudioairflow
 #endif
 
-#define UTILITIES_API
+%include <utilities/UtilitiesAPI.hpp>
 #define AIRFLOW_API
 
 %include <utilities/core/CommonInclude.i>

diff --git a/src/cli/CMakeLists.txt b/src/cli/CMakeLists.txt
@@ -82,6 +82,15 @@ endif()
 ###############################################################################
 
 if(BUILD_TESTING)
+  # openstudio_tests is a test target for C++ based tests that extend across multiple
+  # compiled units such as the case for openstudio cli. 
+  # For example, here is a good place to test issues that are concerned with
+  # the complexities of sharing data between the Python and Ruby script engines.
+  set(openstudio_tests_src
+    "test/Logger_GTest.cpp"
+  )
+  CREATE_TEST_TARGETS(openstudio "${openstudio_tests_src}" openstudiolib openstudio_workflow)
+  add_dependencies(openstudio_tests openstudio)
 
   # Just for convenience: having to VT the seb model which is at 1.11.5 can be very time consuming, especially on debug builds
   add_custom_target(update_seb_osm_in_build_dir

diff --git a/src/cli/main.cpp b/src/cli/main.cpp
@@ -80,14 +80,6 @@ int main(int argc, char* argv[]) {
                "└{0:─^{2}}┘",
                "", "The `classic` command is deprecated and will be removed in a future release", 80);
     fmt::print("\n");
-#if defined _WIN32
-    // Poor man's hack #4847
-    // Disable this logger, we have a duplicate in the ruby shared lib
-    openstudio::Logger::instance().standardOutLogger().disable();
-    openstudio::Logger::instance().standardErrLogger().disable();
-    // Avoid getting some messages during getOpenStudioModule() when we locate the DLL
-    openstudio::StringStreamLogSink sink;
-#endif
     result = openstudio::rubyCLI(rubyEngine);
   } else {
     CLI::App app{"openstudio"};

diff --git a/src/cli/test/Logger_GTest.cpp b/src/cli/test/Logger_GTest.cpp
@@ -0,0 +1,24 @@
+#include "../../scriptengine/ScriptEngine.hpp"
+#include "../../utilities/core/Logger.hpp"
+
+#include <gtest/gtest.h>
+
+// cppcheck-suppress syntaxError
+TEST(OpenStudioTest, LoggerGlobal) {
+  auto isEnabled = openstudio::Logger::instance().standardOutLogger().isEnabled();
+  EXPECT_TRUE(isEnabled);
+
+  openstudio::ScriptEngineInstance pythonEngine("pythonengine", {});
+  openstudio::ScriptEngineInstance rubyEngine("rubyengine", {});
+
+  pythonEngine->exec("openstudio.Logger.instance().standardOutLogger().disable()");
+  isEnabled = openstudio::Logger::instance().standardOutLogger().isEnabled();
+  EXPECT_FALSE(isEnabled);
+
+  rubyEngine->exec("OpenStudio::Logger::instance().standardOutLogger().enable()");
+  isEnabled = openstudio::Logger::instance().standardOutLogger().isEnabled();
+  EXPECT_TRUE(isEnabled);
+
+  pythonEngine.reset();
+  rubyEngine.reset();
+}
diff --git a/src/energyplus/EnergyPlus.i b/src/energyplus/EnergyPlus.i
@@ -6,7 +6,7 @@
 #endif
 
 
-#define UTILITIES_API
+%include <utilities/UtilitiesAPI.hpp>
 #define MODEL_API
 #define ENERGYPLUS_API
 

diff --git a/src/epjson/epJSON.i b/src/epjson/epJSON.i
@@ -6,7 +6,7 @@
 #endif
 
 
-#define UTILITIES_API
+%include <utilities/UtilitiesAPI.hpp>
 #define EPJSON_API
 
 // You're better off just loading the json directly in the target language, so ignore

diff --git a/src/gbxml/gbXML.i b/src/gbxml/gbXML.i
@@ -6,7 +6,7 @@
 #endif
 
 
-#define UTILITIES_API
+%include <utilities/UtilitiesAPI.hpp>
 #define GBXML_API
 
 %include <utilities/core/CommonInclude.i>

diff --git a/src/gltf/Gltf.i b/src/gltf/Gltf.i
@@ -5,7 +5,7 @@
 %module openstudiogltf
 #endif
 
-#define UTILITIES_API
+%include <utilities/UtilitiesAPI.hpp>
 #define MODEL_API
 #define GLTF_API
 

diff --git a/src/isomodel/ISOModel.i b/src/isomodel/ISOModel.i
@@ -5,7 +5,7 @@
 %module openstudioisomodel
 #endif
 
-#define UTILITIES_API
+%include <utilities/UtilitiesAPI.hpp>
 #define ISOMODEL_API
 
 %include <utilities/core/CommonInclude.i>

diff --git a/src/measure/Measure.i b/src/measure/Measure.i
@@ -6,7 +6,7 @@
 #endif
 
 
-#define UTILITIES_API
+%include <utilities/UtilitiesAPI.hpp>
 #define MODEL_API
 #define STANDARDSINTERFACE_API
 #define MEASURE_API

diff --git a/src/model/ModelGeometry.i b/src/model/ModelGeometry.i
@@ -6,6 +6,7 @@
 #endif
 
 
+%include <utilities/UtilitiesAPI.hpp>
 %include <model/Model_Common_Include.i>
 %import <model/ModelCore.i>
 %import <model/ModelSimulation.i>

diff --git a/src/model/Model_Common_Include.i b/src/model/Model_Common_Include.i
@@ -1,7 +1,7 @@
 #ifndef MODEL_COMMON_INCLUDE_I
 #define MODEL_COMMON_INCLUDE_I
 
-#define UTILITIES_API
+%include <utilities/UtilitiesAPI.hpp>
 #define MODEL_API
 
 %include <utilities/core/CommonInclude.i>

diff --git a/src/osversion/OSVersion.i b/src/osversion/OSVersion.i
@@ -6,7 +6,7 @@
 #endif
 
 
-#define UTILITIES_API
+%include <utilities/UtilitiesAPI.hpp>
 #define MODEL_API
 #define OSVERSION_API
 

diff --git a/src/radiance/AnnualIlluminanceMap.i b/src/radiance/AnnualIlluminanceMap.i
@@ -1,7 +1,7 @@
 #ifndef RADIANCE_ANNUALILLUMINANCEMAP_I
 #define RADIANCE_ANNUALILLUMINANCEMAP_I
 
-#define UTILITIES_API
+%include <utilities/UtilitiesAPI.hpp>
 #define RADIANCE_API
 
 %include <utilities/core/CommonInclude.i>

diff --git a/src/radiance/HeaderInfo.i b/src/radiance/HeaderInfo.i
@@ -1,7 +1,7 @@
 #ifndef RADIANCE_HEADERINFO_I
 #define RADIANCE_HEADERINFO_I
 
-#define UTILITIES_API
+%include <utilities/UtilitiesAPI.hpp>
 #define RADIANCE_API
 
 %include <utilities/core/CommonInclude.i>

diff --git a/src/radiance/Radiance.i b/src/radiance/Radiance.i
@@ -6,7 +6,7 @@
 #endif
 
 
-#define UTILITIES_API
+%include <utilities/UtilitiesAPI.hpp>
 #define RADIANCE_API
 
 %include <utilities/core/CommonInclude.i>

diff --git a/src/sdd/SDD.i b/src/sdd/SDD.i
@@ -6,7 +6,7 @@
 #endif
 
 
-#define UTILITIES_API
+%include <utilities/UtilitiesAPI.hpp>
 #define SDD_API
 
 %include <utilities/core/CommonInclude.i>

diff --git a/src/utilities/Utilities.i b/src/utilities/Utilities.i
@@ -6,7 +6,7 @@
 #endif
 
 
-#define UTILITIES_API
+%include <utilities/UtilitiesAPI.hpp>
 #define UTILITIES_TEMPLATE_EXT
 
 %include <utilities/core/CommonInclude.i>

diff --git a/src/utilities/UtilitiesBCL.i b/src/utilities/UtilitiesBCL.i
@@ -7,8 +7,7 @@
 #endif
 
 
-#define UTILITIES_API
-#define UTILITIES_TEMPLATE_EXT
+%include <utilities/UtilitiesAPI.hpp>
 
 %include <utilities/core/CommonInclude.i>
 %import <utilities/core/CommonImport.i>

diff --git a/src/utilities/UtilitiesCore.i b/src/utilities/UtilitiesCore.i
@@ -5,9 +5,7 @@
 %module openstudioutilitiescore
 #endif
 
-
-#define UTILITIES_API
-#define UTILITIES_TEMPLATE_EXT
+%include <utilities/UtilitiesAPI.hpp>
 
 %include <utilities/core/CommonInclude.i>
 %include <utilities/core/CommonImport.i> // CommonImport is included in this module

diff --git a/src/utilities/UtilitiesData.i b/src/utilities/UtilitiesData.i
@@ -6,9 +6,7 @@
 #endif
 
 
-#define UTILITIES_API
-#define UTILITIES_TEMPLATE_EXT
-
+%include <utilities/UtilitiesAPI.hpp>
 %include <utilities/core/CommonInclude.i>
 %import <utilities/core/CommonImport.i>
 %import <utilities/UtilitiesTime.i>

diff --git a/src/utilities/UtilitiesFileTypes.i b/src/utilities/UtilitiesFileTypes.i
@@ -5,9 +5,7 @@
 %module openstudioutilitiesfiletypes
 #endif
 
-#define UTILITIES_API
-#define UTILITIES_TEMPLATE_EXT
-
+%include <utilities/UtilitiesAPI.hpp>
 %include <utilities/core/CommonInclude.i>
 %import <utilities/core/CommonImport.i>
 %import <utilities/UtilitiesCore.i>

diff --git a/src/utilities/UtilitiesGeometry.i b/src/utilities/UtilitiesGeometry.i
@@ -6,9 +6,7 @@
 #endif
 
 
-#define UTILITIES_API
-#define UTILITIES_TEMPLATE_EXT
-
+%include <utilities/UtilitiesAPI.hpp>
 %include <utilities/core/CommonInclude.i>
 %import <utilities/core/CommonImport.i>
 %import <utilities/UtilitiesPlot.i>

diff --git a/src/utilities/UtilitiesIdd.i b/src/utilities/UtilitiesIdd.i
@@ -6,9 +6,7 @@
 #endif
 
 
-#define UTILITIES_API
-#define UTILITIES_TEMPLATE_EXT
-
+%include <utilities/UtilitiesAPI.hpp>
 %include <utilities/core/CommonInclude.i>
 %import <utilities/core/CommonImport.i>
 %import <utilities/UtilitiesCore.i>

diff --git a/src/utilities/UtilitiesIdf.i b/src/utilities/UtilitiesIdf.i
@@ -6,9 +6,7 @@
 #endif
 
 
-#define UTILITIES_API
-#define UTILITIES_TEMPLATE_EXT
-
+%include <utilities/UtilitiesAPI.hpp>
 %include <utilities/core/CommonInclude.i>
 %import <utilities/core/CommonImport.i>
 %import <utilities/UtilitiesCore.i>

diff --git a/src/utilities/UtilitiesPlot.i b/src/utilities/UtilitiesPlot.i
@@ -6,9 +6,7 @@
 #endif
 
 
-#define UTILITIES_API
-#define UTILITIES_TEMPLATE_EXT
-
+%include <utilities/UtilitiesAPI.hpp>
 %include <utilities/core/CommonInclude.i>
 %import <utilities/core/CommonImport.i>
 %import <utilities/UtilitiesData.i>

diff --git a/src/utilities/UtilitiesSql.i b/src/utilities/UtilitiesSql.i
@@ -6,9 +6,7 @@
 #endif
 
 
-#define UTILITIES_API
-#define UTILITIES_TEMPLATE_EXT
-
+%include <utilities/UtilitiesAPI.hpp>
 %include <utilities/core/CommonInclude.i>
 %import <utilities/core/CommonImport.i>
 %import <utilities/UtilitiesGeometry.i>

diff --git a/src/utilities/UtilitiesTime.i b/src/utilities/UtilitiesTime.i
@@ -6,9 +6,7 @@
 #endif
 
 
-#define UTILITIES_API
-#define UTILITIES_TEMPLATE_EXT
-
+%include <utilities/UtilitiesAPI.hpp>
 %include <utilities/core/CommonInclude.i>
 %import <utilities/core/CommonImport.i>
 %import <utilities/UtilitiesCore.i>

diff --git a/src/utilities/UtilitiesUnits.i b/src/utilities/UtilitiesUnits.i
@@ -6,9 +6,7 @@
 #endif
 
 
-#define UTILITIES_API
-#define UTILITIES_TEMPLATE_EXT
-
+%include <utilities/UtilitiesAPI.hpp>
 %include <utilities/core/CommonInclude.i>
 %import <utilities/core/CommonImport.i>
 %import <utilities/UtilitiesCore.i>

diff --git a/src/utilities/UtilitiesXML.i b/src/utilities/UtilitiesXML.i
@@ -6,9 +6,7 @@
 #endif
 
 
-#define UTILITIES_API
-#define UTILITIES_TEMPLATE_EXT
-
+%include <utilities/UtilitiesAPI.hpp>
 %include <utilities/core/CommonInclude.i>
 %import <utilities/core/CommonImport.i>
 %import <utilities/UtilitiesCore.i>

diff --git a/src/utilities/core/LogSink.hpp b/src/utilities/core/LogSink.hpp
@@ -18,9 +18,11 @@
 
 namespace openstudio {
 
+class Logger;
+
 namespace detail {
   class LogSink_Impl;
-}
+}  // namespace detail
 
 /// LogSink is a class for managing sinks for log messages, e.g. files, streams, etc.
 class UTILITIES_API LogSink
@@ -76,7 +78,7 @@ class UTILITIES_API LogSink
   void setFormatter(const boost::log::formatter& fmter);
 
  protected:
-  friend class LoggerSingleton;
+  friend class Logger;
 
   // does not register in the global logger
   LogSink();