Use shared_ptr for long-life objects

Use unique_ptr and shared_ptr for IContext, IPlatformEnvironment, IUiContext, and IAudioContext.
Centural-US · May 11, 2018 · 7dc170e · 7dc170e
1 parent c7b40ce
commit 7dc170e
Show file tree

Hide file tree

Showing 33 changed files with 144 additions and 120 deletions.
diff --git a/.vscode/c_cpp_properties.json b/.vscode/c_cpp_properties.json
@@ -31,7 +31,8 @@
             "includePath": [
                 "/usr/include",
                 "/usr/local/include",
-                "${workspaceRoot}"
+                "${workspaceRoot}",
+                "${workspaceRoot}/src"
             ],
             "defines": [],
             "intelliSenseMode": "clang-x64",

diff --git a/src/openrct2-cli/Cli.cpp b/src/openrct2-cli/Cli.cpp
@@ -36,7 +36,6 @@ int main(int argc, const char * * argv)
         // Run OpenRCT2 with a plain context
         auto context = CreateContext();
         context->RunOpenRCT2(argc, argv);
-        delete context;
     }
     return gExitCode;
 }
diff --git a/src/openrct2-ui/Ui.cpp b/src/openrct2-ui/Ui.cpp
@@ -29,6 +29,12 @@ using namespace OpenRCT2;
 using namespace OpenRCT2::Audio;
 using namespace OpenRCT2::Ui;
 
+template<typename T>
+static std::shared_ptr<T> to_shared(std::unique_ptr<T>&& src)
+{
+    return std::shared_ptr<T>(std::move(src));
+}
+
 /**
  * Main entry point for non-Windows systems. Windows instead uses its own DLL proxy.
  */
@@ -47,21 +53,16 @@ int main(int argc, const char * * argv)
             // Run OpenRCT2 with a plain context
             auto context = CreateContext();
             context->RunOpenRCT2(argc, argv);
-            delete context;
         }
         else
         {
             // Run OpenRCT2 with a UI context
-            auto env = CreatePlatformEnvironment();
-            auto audioContext = CreateAudioContext();
-            auto uiContext = CreateUiContext(env);
+            auto env = to_shared(CreatePlatformEnvironment());
+            auto audioContext = to_shared(CreateAudioContext());
+            auto uiContext = to_shared(CreateUiContext(env));
             auto context = CreateContext(env, audioContext, uiContext);
 
             context->RunOpenRCT2(argc, argv);
-
-            delete context;
-            delete uiContext;
-            delete audioContext;
         }
     }
     return gExitCode;

diff --git a/src/openrct2-ui/UiContext.cpp b/src/openrct2-ui/UiContext.cpp
@@ -94,7 +94,7 @@ class UiContext final : public IUiContext
 public:
     InGameConsole& GetInGameConsole() { return _inGameConsole; }
 
-    explicit UiContext(IPlatformEnvironment * env)
+    explicit UiContext(std::shared_ptr<IPlatformEnvironment> env)
         : _platformUiContext(CreatePlatformUiContext()),
           _windowManager(CreateWindowManager()),
           _keyboardShortcuts(env)
@@ -814,9 +814,9 @@ class UiContext final : public IUiContext
     }
 };
 
-IUiContext * OpenRCT2::Ui::CreateUiContext(IPlatformEnvironment * env)
+std::unique_ptr<IUiContext> OpenRCT2::Ui::CreateUiContext(std::shared_ptr<IPlatformEnvironment> env)
 {
-    return new UiContext(env);
+    return std::make_unique<UiContext>(env);
 }
 
 InGameConsole& OpenRCT2::Ui::GetInGameConsole()

diff --git a/src/openrct2-ui/UiContext.h b/src/openrct2-ui/UiContext.h
@@ -16,6 +16,7 @@
 
 #pragma once
 
+#include <memory>
 #include <string>
 #include <openrct2/common.h>
 
@@ -43,7 +44,7 @@ namespace OpenRCT2
             virtual std::string ShowDirectoryDialog(SDL_Window * window, const std::string &title) abstract;
         };
 
-        IUiContext * CreateUiContext(IPlatformEnvironment * env);
+        std::unique_ptr<IUiContext> CreateUiContext(std::shared_ptr<IPlatformEnvironment> env);
         IPlatformUiContext * CreatePlatformUiContext();
 
         InGameConsole& GetInGameConsole();

diff --git a/src/openrct2-ui/audio/AudioContext.cpp b/src/openrct2-ui/audio/AudioContext.cpp
@@ -94,8 +94,8 @@ namespace OpenRCT2::Audio
         void StopVehicleSounds() override { }
     };
 
-    IAudioContext * CreateAudioContext()
+    std::unique_ptr<IAudioContext> CreateAudioContext()
     {
-        return new AudioContext();
+        return std::make_unique<AudioContext>();
     }
 } // namespace OpenRCT2::Audio
diff --git a/src/openrct2-ui/audio/AudioContext.h b/src/openrct2-ui/audio/AudioContext.h
@@ -1,6 +1,7 @@
 
 #pragma once
 
+#include <memory>
 #include <string>
 #include <openrct2/common.h>
 #include <openrct2/audio/AudioChannel.h>
@@ -69,5 +70,6 @@ namespace OpenRCT2::Audio
         IAudioMixer * Create();
     }
 
-    IAudioContext * CreateAudioContext();
+    std::unique_ptr<IAudioContext> CreateAudioContext();
+
 } // namespace OpenRCT2::Audio
diff --git a/src/openrct2-ui/input/KeyboardShortcuts.cpp b/src/openrct2-ui/input/KeyboardShortcuts.cpp
@@ -32,7 +32,7 @@ using namespace OpenRCT2::Input;
 // Remove when the C calls are removed
 static KeyboardShortcuts * _instance;
 
-KeyboardShortcuts::KeyboardShortcuts(IPlatformEnvironment * env)
+KeyboardShortcuts::KeyboardShortcuts(std::shared_ptr<IPlatformEnvironment> env)
     : _env(env)
 {
     _instance = this;

diff --git a/src/openrct2-ui/input/KeyboardShortcuts.h b/src/openrct2-ui/input/KeyboardShortcuts.h
@@ -16,6 +16,7 @@
 
 #pragma once
 
+#include <memory>
 #include <openrct2/common.h>
 
 #define SHIFT   0x100
@@ -119,11 +120,11 @@ namespace OpenRCT2
             constexpr static sint32 CURRENT_FILE_VERSION = 1;
             static const uint16 DefaultKeys[SHORTCUT_COUNT];
 
-            IPlatformEnvironment * const _env;
+            std::shared_ptr<IPlatformEnvironment> const _env;
             uint16 _keys[SHORTCUT_COUNT];
 
         public:
-            KeyboardShortcuts(IPlatformEnvironment * env);
+            KeyboardShortcuts(std::shared_ptr<IPlatformEnvironment> env);
 
             void Reset();
             bool Load();

diff --git a/src/openrct2/Context.cpp b/src/openrct2/Context.cpp
@@ -82,9 +82,9 @@ namespace OpenRCT2
     {
     private:
         // Dependencies
-        IPlatformEnvironment * const    _env = nullptr;
-        IAudioContext * const           _audioContext = nullptr;
-        IUiContext * const              _uiContext = nullptr;
+        std::shared_ptr<IPlatformEnvironment> const _env;
+        std::shared_ptr<IAudioContext> const _audioContext;
+        std::shared_ptr<IUiContext> const _uiContext;
 
         // Services
         IObjectRepository *         _objectRepository = nullptr;
@@ -116,7 +116,10 @@ namespace OpenRCT2
         static Context * Instance;
 
     public:
-        Context(IPlatformEnvironment * env, IAudioContext * audioContext, IUiContext * uiContext)
+        Context(
+            std::shared_ptr<IPlatformEnvironment> env,
+            std::shared_ptr<IAudioContext> audioContext,
+            std::shared_ptr<IUiContext> uiContext)
             : _env(env),
               _audioContext(audioContext),
               _uiContext(uiContext)
@@ -153,17 +156,17 @@ namespace OpenRCT2
 
         IAudioContext * GetAudioContext() override
         {
-            return _audioContext;
+            return _audioContext.get();
         }
 
         IUiContext * GetUiContext() override
         {
-            return _uiContext;
+            return _uiContext.get();
         }
 
         IPlatformEnvironment * GetPlatformEnvironment() override
         {
-            return _env;
+            return _env.get();
         }
 
         IObjectManager * GetObjectManager() override
@@ -548,7 +551,7 @@ namespace OpenRCT2
 
         bool LoadBaseGraphics()
         {
-            if (!gfx_load_g1(_env))
+            if (!gfx_load_g1(*_env))
             {
                 return false;
             }
@@ -902,35 +905,41 @@ namespace OpenRCT2
 
     class PlainContext final : public Context
     {
-        std::unique_ptr<IPlatformEnvironment>   _env;
-        std::unique_ptr<IAudioContext>          _audioContext;
-        std::unique_ptr<IUiContext>             _uiContext;
+        std::shared_ptr<IPlatformEnvironment> _env;
+        std::shared_ptr<IAudioContext> _audioContext;
+        std::shared_ptr<IUiContext> _uiContext;
 
     public:
         PlainContext()
             : PlainContext(CreatePlatformEnvironment(), CreateDummyAudioContext(), CreateDummyUiContext())
         {
         }
 
-        PlainContext(IPlatformEnvironment * env, IAudioContext * audioContext, IUiContext * uiContext)
-            : Context(env, audioContext, uiContext)
+        PlainContext(
+            std::shared_ptr<IPlatformEnvironment> env,
+            std::shared_ptr<IAudioContext> audioContext,
+            std::shared_ptr<IUiContext> uiContext)
+            : Context(env, audioContext, uiContext),
+              _env(env),
+              _audioContext(audioContext),
+              _uiContext(uiContext)
         {
-            _env = std::unique_ptr<IPlatformEnvironment>(env);
-            _audioContext = std::unique_ptr<IAudioContext>(audioContext);
-            _uiContext = std::unique_ptr<IUiContext>(uiContext);
         }
     };
 
     Context * Context::Instance = nullptr;
 
-    IContext * CreateContext()
+    std::unique_ptr<IContext> CreateContext()
     {
-        return new PlainContext();
+        return std::make_unique<PlainContext>();
     }
 
-    IContext * CreateContext(IPlatformEnvironment * env, Audio::IAudioContext * audioContext, IUiContext * uiContext)
+    std::unique_ptr<IContext> CreateContext(
+        std::shared_ptr<IPlatformEnvironment> env,
+        std::shared_ptr<Audio::IAudioContext> audioContext,
+        std::shared_ptr<IUiContext> uiContext)
     {
-        return new Context(env, audioContext, uiContext);
+        return std::make_unique<Context>(env, audioContext, uiContext);
     }
 
     IContext * GetContext()

diff --git a/src/openrct2/Context.h b/src/openrct2/Context.h
@@ -18,6 +18,7 @@
 
 #include "common.h"
 
+#include <memory>
 #include <string>
 
 interface IObjectManager;
@@ -111,8 +112,11 @@ namespace OpenRCT2
         virtual std::string GetPathLegacy(sint32 pathId) abstract;
     };
 
-    IContext * CreateContext();
-    IContext * CreateContext(IPlatformEnvironment * env, Audio::IAudioContext * audioContext, Ui::IUiContext * uiContext);
+    std::unique_ptr<IContext> CreateContext();
+    std::unique_ptr<IContext> CreateContext(
+        std::shared_ptr<IPlatformEnvironment> env,
+        std::shared_ptr<Audio::IAudioContext> audioContext,
+        std::shared_ptr<Ui::IUiContext> uiContext);
     IContext * GetContext();
 } // namespace OpenRCT2
 

diff --git a/src/openrct2/PlatformEnvironment.cpp b/src/openrct2/PlatformEnvironment.cpp
@@ -109,9 +109,9 @@ class PlatformEnvironment final : public IPlatformEnvironment
     }
 };
 
-IPlatformEnvironment * OpenRCT2::CreatePlatformEnvironment(DIRBASE_VALUES basePaths)
+std::unique_ptr<IPlatformEnvironment> OpenRCT2::CreatePlatformEnvironment(DIRBASE_VALUES basePaths)
 {
-    return new PlatformEnvironment(basePaths);
+    return std::make_unique<PlatformEnvironment>(basePaths);
 }
 
 static std::string GetOpenRCT2DirectoryName()
@@ -123,7 +123,7 @@ static std::string GetOpenRCT2DirectoryName()
 #endif
 }
 
-IPlatformEnvironment * OpenRCT2::CreatePlatformEnvironment()
+std::unique_ptr<IPlatformEnvironment> OpenRCT2::CreatePlatformEnvironment()
 {
     auto subDirectory = GetOpenRCT2DirectoryName();
 

diff --git a/src/openrct2/PlatformEnvironment.h b/src/openrct2/PlatformEnvironment.h
@@ -16,6 +16,7 @@
 
 #pragma once
 
+#include <memory>
 #include <string>
 #include "common.h"
 
@@ -82,6 +83,7 @@ namespace OpenRCT2
         virtual void SetBasePath(DIRBASE base, const std::string &path) abstract;
     };
 
-    IPlatformEnvironment * CreatePlatformEnvironment(DIRBASE_VALUES basePaths);
-    IPlatformEnvironment * CreatePlatformEnvironment();
+    std::unique_ptr<IPlatformEnvironment> CreatePlatformEnvironment(DIRBASE_VALUES basePaths);
+    std::unique_ptr<IPlatformEnvironment> CreatePlatformEnvironment();
+
 } // namespace OpenRCT2
diff --git a/src/openrct2/audio/AudioContext.h b/src/openrct2/audio/AudioContext.h
@@ -16,6 +16,7 @@
 
 #pragma once
 
+#include <memory>
 #include <string>
 #include <vector>
 #include "../common.h"
@@ -59,5 +60,6 @@ namespace OpenRCT2::Audio
         virtual void StopVehicleSounds() abstract;
     };
 
-    IAudioContext * CreateDummyAudioContext();
+    std::unique_ptr<IAudioContext> CreateDummyAudioContext();
+
 } // namespace OpenRCT2::Audio
diff --git a/src/openrct2/audio/DummyAudioContext.cpp b/src/openrct2/audio/DummyAudioContext.cpp
@@ -45,8 +45,8 @@ namespace OpenRCT2::Audio
         void StopVehicleSounds() override { }
     };
 
-    IAudioContext * CreateDummyAudioContext()
+    std::unique_ptr<IAudioContext> CreateDummyAudioContext()
     {
-        return new DummyAudioContext();
+        return std::make_unique<DummyAudioContext>();
     }
 } // namespace OpenRCT2::Audio
diff --git a/src/openrct2/cmdline/RootCommands.cpp b/src/openrct2/cmdline/RootCommands.cpp
@@ -399,7 +399,7 @@ static exitcode_t HandleCommandScanObjects([[maybe_unused]] CommandLineArgEnumer
 
     auto context = std::unique_ptr<OpenRCT2::IContext>(OpenRCT2::CreateContext());
     auto env = context->GetPlatformEnvironment();
-    auto objectRepository = std::unique_ptr<IObjectRepository>(CreateObjectRepository(env));
+    auto objectRepository = CreateObjectRepository(env);
 
     // HACK: set gCurrentLanguage otherwise it be wrong for the index file
     gCurrentLanguage = gConfigGeneral.language;

diff --git a/src/openrct2/core/Guard.hpp b/src/openrct2/core/Guard.hpp
@@ -16,6 +16,7 @@
 
 #pragma once
 
+#include <memory>
 #include <stdarg.h>
 #include <stdbool.h>
 
@@ -52,6 +53,15 @@ namespace Guard
         va_end(args);
     }
 
+    template<typename T>
+    static void ArgumentNotNull(const std::shared_ptr<T>& argument, const char * message = nullptr, ...)
+    {
+        va_list args;
+        va_start(args, message);
+        Assert_VA(argument != nullptr, message, args);
+        va_end(args);
+    }
+
     template<typename T>
     static void ArgumentInRange(T argument, T min, T max, const char * message = nullptr, ...)
     {