Move IRandomGenerator to public API

Author: adazem009

CMakeLists.txt

@@ -60,6 +60,7 @@ target_sources(scratchcpp
     include/scratchcpp/textbubble.h
     include/scratchcpp/itimer.h
     include/scratchcpp/istacktimer.h
+    include/scratchcpp/irandomgenerator.h
     include/scratchcpp/keyevent.h
     include/scratchcpp/rect.h
     include/scratchcpp/igraphicseffect.h

include/scratchcpp/irandomgenerator.h

@@ -0,0 +1,26 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include "global.h"
+
+namespace libscratchcpp
+{
+
+/*! \brief The IRandomGenerator interface represents a random number generator that can be received e. g. from an ExecutionContext. */
+class LIBSCRATCHCPP_EXPORT IRandomGenerator
+{
+    public:
+        virtual ~IRandomGenerator() { }
+
+        /*! Returns a random integer in the given range (inclusive). */
+        virtual long randint(long start, long end) const = 0;
+
+        /*! Returns a random double in the given range (inclusive). */
+        virtual double randintDouble(double start, double end) const = 0;
+
+        /*! Returns a random integer in the given range (inclusive) except the given integer. */
+        virtual long randintExcept(long start, long end, long except) const = 0;
+};
+
+} // namespace libscratchcpp

src/engine/CMakeLists.txt

@@ -20,7 +20,6 @@ target_sources(scratchcpp
     internal/stacktimer.h
     internal/randomgenerator.h
     internal/randomgenerator.cpp
-    internal/irandomgenerator.h
 )
 
 if(NOT LIBSCRATCHCPP_USE_LLVM)

src/engine/internal/irandomgenerator.h

@@ -2,11 +2,10 @@
 
 #pragma once
 
+#include <scratchcpp/irandomgenerator.h>
 #include <memory>
 #include <random>
 
-#include "irandomgenerator.h"
-
 namespace libscratchcpp
 {
 

src/engine/internal/randomgenerator.h

@@ -1,6 +1,6 @@
 #pragma once
 
-#include <engine/internal/irandomgenerator.h>
+#include <scratchcpp/irandomgenerator.h>
 #include <gmock/gmock.h>
 
 using namespace libscratchcpp;