Resolving static lifetime problems

core/src/CMakeLists.txt

@@ -2,7 +2,6 @@
 
 set(BaseSources
     "Logged.cpp"
-    "Timer.cpp"
     "ModelConfig.cpp"
     "Model.cpp"
     "Iterator.cpp"
@@ -14,9 +13,9 @@ set(BaseSources
     "RectGridIO.cpp"
     "ParaGridIO.cpp"
     "FileCallbackCloser.cpp"
+    "Finalizer.cpp"
     "DevStep.cpp"
     "StructureFactory.cpp"
-    "MissingData.cpp"
     "ModelArray.cpp"
     "ModelComponent.cpp"
     "ModelMetadata.cpp"

core/src/CommonRestartMetadata.cpp

@@ -48,19 +48,19 @@ netCDF::NcGroup& CommonRestartMetadata::writeRestartMetadata(
 
     for (auto entry : metadata.m_config) {
         switch (entry.second.index()) {
-        case (CONFIGMAP_DOUBLE): {
+        case (ConfigMapType::DOUBLE): {
             configGroup.putAtt(entry.first, netCDF::ncDouble, *std::get_if<double>(&entry.second));
             break;
         }
-        case (CONFIGMAP_UNSIGNED): {
+        case (ConfigMapType::UNSIGNED): {
             configGroup.putAtt(entry.first, netCDF::ncUint, *std::get_if<unsigned>(&entry.second));
             break;
         }
-        case (CONFIGMAP_INT): {
+        case (ConfigMapType::INT): {
             configGroup.putAtt(entry.first, netCDF::ncInt, *std::get_if<int>(&entry.second));
             break;
         }
-        case (CONFIGMAP_STRING): {
+        case (ConfigMapType::STRING): {
             std::string extring = std::get<std::string>(entry.second);
             configGroup.putAtt(entry.first, std::get<std::string>(entry.second));
             break;

core/src/Configurator.cpp

@@ -11,12 +11,6 @@
 
 namespace Nextsim {
 
-std::vector<std::unique_ptr<std::istream>> Configurator::sources;
-int Configurator::m_argc;
-char** Configurator::m_argv;
-static NoAdditionalConfiguration noAddConf;
-Configurator::AdditionalConfiguration* Configurator::p_addConf = &noAddConf;
-
 boost::program_options::variables_map Configurator::parse(
     const boost::program_options::options_description& opt)
 {
@@ -25,9 +19,9 @@ boost::program_options::variables_map Configurator::parse(
     // Parse the command file for any overrides
     int use_argc;
     char** use_argv;
-    if (m_argc && m_argv) {
-        use_argc = m_argc;
-        use_argv = m_argv;
+    if (commandLine().m_argc && commandLine().m_argv) {
+        use_argc = commandLine().m_argc;
+        use_argv = commandLine().m_argv;
     } else {
         // Use a fake command line to ensure at least one parse happens in all cases
         use_argc = 1;
@@ -44,7 +38,7 @@ boost::program_options::variables_map Configurator::parse(
     boost::program_options::store(parsed, vm);
 
     // Parse the named streams for configuration
-    for (auto iter = sources.begin(); iter != sources.end(); ++iter) {
+    for (auto iter = sources().begin(); iter != sources().end(); ++iter) {
         try {
             boost::program_options::store(
                 boost::program_options::parse_config_file(**iter, opt, true), vm);
@@ -66,12 +60,12 @@ void Configurator::addSStream(const std::stringstream& sstream)
     addStream(std::move(std::unique_ptr<std::istream>(new std::stringstream(sstream.str()))));
 }
 
-void Configurator::setAdditionalConfiguration(AdditionalConfiguration* pAC) { p_addConf = pAC; }
+void Configurator::setAdditionalConfiguration(AdditionalConfiguration* pAC) { addConf() = pAC; }
 
 void Configurator::getAdditionalConfiguration(const std::string& source)
 {
-    if (p_addConf) {
-        addSStream(p_addConf->read(source));
+    if (addConf()) {
+        addSStream(addConf()->read(source));
     }
 }
 

core/src/ConfiguredModule.cpp

@@ -8,7 +8,7 @@
 #include "include/ConfiguredModule.hpp"
 
 #include "include/Configurator.hpp"
-#include "include/Module.hpp"
+#include "include/NextsimModule.hpp"
 
 #include <boost/program_options.hpp>
 #include <stdexcept>
@@ -17,59 +17,29 @@ namespace Nextsim {
 
 const std::string ConfiguredModule::MODULE_PREFIX = "Modules";
 
-ConfiguredModule::map ConfiguredModule::configuredModules;
-
-void ConfiguredModule::parseConfigurator()
-{
-    // A default string that can never be a valid C++ class name
-    std::string defaultStr = "+++DEFAULT+++";
-    // Construct a new options map
-    boost::program_options::options_description opt;
-
-    for (auto entry : configuredModules) {
-        std::string module = entry.first;
-        opt.add_options()(addPrefix(module).c_str(),
-            boost::program_options::value<std::string>()->default_value(defaultStr),
-            ("Load an implementation of " + module).c_str());
-    }
-
-    boost::program_options::variables_map vm = Configurator::parse(opt);
-
-    for (auto entry : configuredModules) {
-        std::string implString = vm[addPrefix(entry.first)].as<std::string>();
-        // Only do anything if the retrieved option is not the default value
-        if (implString != defaultStr) {
-            entry.second.first(implString);
-        }
-    }
-}
-
 std::string ConfiguredModule::addPrefix(const std::string& moduleName)
 {
     return MODULE_PREFIX + "." + moduleName;
 }
 
-void ConfiguredModule::setConfiguredModules(const map& ls)
+std::string ConfiguredModule::getImpl(const std::string& module)
 {
-    map newMap(ls);
-    configuredModules.merge(newMap);
-}
+    boost::program_options::options_description opt;
 
-void ConfiguredModule::configureModule(const std::string& mod, const fn& setter, const ofn& getter)
-{
-    configuredModules[mod] = { setter, getter };
-}
+    opt.add_options()(addPrefix(module).c_str(),
+        boost::program_options::value<std::string>()->default_value(""),
+        ("Load an implementation of " + module).c_str());
 
-std::string ConfiguredModule::getModuleConfiguration(const std::string& module)
-{
-    return configuredModules[module].second();
+    std::string implString = Configurator::parse(opt)[addPrefix(module)].as<std::string>();
+    // Only do anything if the retrieved option is not the default value
+    return implString;
 }
 
 ConfigMap ConfiguredModule::getAllModuleConfigurations()
 {
     ConfigMap iiMap;
-    for (auto entry : configuredModules) {
-        iiMap[addPrefix(entry.first)] = entry.second.second();
+    for (const auto& moduleImpl : Module::ImplementationNames::getAll()) {
+        iiMap[moduleImpl.first] = moduleImpl.second;
     }
     return iiMap;
 }

core/src/DevStep.cpp

@@ -8,8 +8,9 @@
 #include "include/DevStep.hpp"
 
 #include "include/ConfiguredModule.hpp"
+#include "include/Finalizer.hpp"
 #include "include/IDiagnosticOutput.hpp"
-#include "include/Module.hpp"
+#include "include/NextsimModule.hpp"
 namespace Nextsim {
 
 DevStep::DevStep()
@@ -21,6 +22,7 @@ DevStep::DevStep()
 
 void DevStep::init()
 {
+    Finalizer::registerUnique(Module::finalize<IDiagnosticOutput>);
     IDiagnosticOutput& ido = Module::getImplementation<IDiagnosticOutput>();
     ido.setFilenamePrefix("diagnostic");
     tryConfigure(ido);

core/src/FileCallbackCloser.cpp

@@ -9,16 +9,14 @@
 
 namespace Nextsim {
 
-std::list<FileCallbackCloser::ClosingFn> FileCallbackCloser::closingFns;
-
-void FileCallbackCloser::onClose(FileCallbackCloser::ClosingFn fn) { closingFns.push_back(fn); }
+void FileCallbackCloser::onClose(FileCallbackCloser::ClosingFn fn) { closingFns().push_back(fn); }
 
 void FileCallbackCloser::close(const std::string& filename)
 {
-    for (auto& fn : closingFns) {
+    for (auto& fn : closingFns()) {
         fn(filename);
     }
 }
 
-void FileCallbackCloser::clearAllClose() { closingFns.clear(); }
+void FileCallbackCloser::clearAllClose() { closingFns().clear(); }
 } /* namespace Nextsim */

core/src/Finalizer.cpp

@@ -0,0 +1,61 @@
+/*!
+ * @file Finalizer.cpp
+ *
+ * @date Sep 11, 2024
+ * @author Tim Spain <[email protected]>
+ */
+
+#include "include/Finalizer.hpp"
+
+namespace Nextsim {
+
+void Finalizer::registerFunc(const FinalFn& fn)
+{
+    auto& fns = functions();
+    fns.push_back(fn);
+}
+
+bool Finalizer::registerUnique(const FinalFn& fn)
+{
+    if (contains(fn))
+        return false;
+    registerFunc(fn);
+    return true;
+}
+
+bool Finalizer::contains(const FinalFn& fn)
+{
+    auto& fns = functions();
+    for (const auto& stored : fns) {
+        // Compare function addresses
+        if (*stored.target<FnType*>() == *fn.target<FnType*>())
+            return true;
+    }
+    return false;
+}
+
+void Finalizer::finalize()
+{
+    while (!functions().empty()) {
+        try {
+            // Execute the last function in the list
+            functions().back()();
+        } catch (const std::exception& e) {
+            // Remove the function from the finalization list even if an exception was thrown.
+            functions().pop_back();
+            throw;
+        }
+        // Remove the function from the finalization list.
+        functions().pop_back();
+    }
+}
+
+size_t Finalizer::count() { return functions().size(); }
+
+Finalizer::FinalFnContainer& Finalizer::functions()
+{
+    static FinalFnContainer set;
+    return set;
+}
+
+}

core/src/Iterator.cpp

@@ -10,20 +10,6 @@
 
 namespace Nextsim {
 
-Iterator::NullIterant Iterator::nullIterant;
-
-Iterator::Iterator()
-    : iterant(&nullIterant)
-{
-}
-
-Iterator::Iterator(Iterant* iterant)
-    : iterant(iterant)
-{
-}
-
-void Iterator::setIterant(Iterant* iterant) { this->iterant = iterant; }
-
 void Iterator::setStartStopStep(TimePoint startTime, TimePoint stopTime, Duration timestep)
 {
     this->startTime = startTime;
@@ -53,14 +39,14 @@ TimePoint Iterator::parseAndSet(const std::string& startTimeStr, const std::stri
 
 void Iterator::run()
 {
-    iterant->start(startTime);
+    iterant.start(startTime);
 
     for (auto t = startTime; t < stopTime; t += timestep) {
         TimestepTime tsTime = { t, timestep };
-        iterant->iterate(tsTime);
+        iterant.iterate(tsTime);
     }
 
-    iterant->stop(stopTime);
+    iterant.stop(stopTime);
 }
 
 } /* namespace Nextsim */