[[libsystem]] Move MCRandom* API into system library.

peter-b · peter-b · commit cc066ac66189 · 2015-01-27T11:11:07.000Z
This includes random number and random data generation.
diff --git a/engine/src/exec-security.cpp b/engine/src/exec-security.cpp
@@ -83,7 +83,7 @@ void MCSecurityEvalRandomBytes(MCExecContext& ctxt, uinteger_t p_byte_count, MCD
 		return;
 	}
 
-	if (MCDataCreateRandom (p_byte_count, r_bytes))
+	if (MCSRandomData (p_byte_count, r_bytes))
 	{
 		ctxt.SetTheResultToEmpty();
 		return;
diff --git a/engine/src/srvsession.cpp b/engine/src/srvsession.cpp
@@ -696,7 +696,7 @@ bool MCSessionGenerateID(MCStringRef &r_id)
 	
 	MCAutoDataRef t_randombytes;
     
-	/* UNCHECKED */ MCDataCreateRandom (64, &t_randombytes);
+	/* UNCHECKED */ MCSRandomData (64, &t_randombytes);
 	
 	md5_state_t t_state;
 	md5_byte_t t_digest[16];
diff --git a/engine/src/util.cpp b/engine/src/util.cpp
@@ -100,7 +100,7 @@ void MCU_init()
      * source. If that fails, fall back to constructing using some of the
      * entropy available from the properties of the current process. */
     MCAutoDataRef t_seed_data;
-    if (MCDataCreateRandom(sizeof(MCrandomseed), &t_seed_data))
+    if (MCSRandomData(sizeof(MCrandomseed), &t_seed_data))
     {
         MCMemoryCopy(&MCrandomseed, MCDataGetBytePtr(*t_seed_data),
                      sizeof(MCrandomseed));
diff --git a/engine/src/uuid.cpp b/engine/src/uuid.cpp
@@ -49,7 +49,7 @@ bool MCUuidGenerateRandom(MCUuid& r_uuid)
 	// Fill the UUID with random bytes (returns false if not enough random data
 	// is available).
     MCAutoDataRef t_data;
-	if (!MCDataCreateRandom (sizeof(MCUuid), &t_data))
+	if (!MCSRandomData (sizeof(MCUuid), &t_data))
 		return false;
     MCMemoryCopy(&r_uuid, MCDataGetBytePtr(*t_data), sizeof(MCUuid));
     
diff --git a/libfoundation/Makefile b/libfoundation/Makefile
@@ -23,7 +23,6 @@ SOURCES= \
 	foundation-number.cpp \
 	foundation-pickle.cpp \
 	foundation-proper-list.cpp \
-	foundation-random.cpp \
 	foundation-record.cpp \
 	foundation-set.cpp \
 	foundation-stream.cpp \
@@ -37,6 +36,7 @@ SOURCES= \
 	system-file.cpp \
 	system-file-posix.cpp \
 	system-init.cpp \
+	system-random.cpp \
 	system-stream.cpp
 
 CUSTOM_DEFINES=
diff --git a/libfoundation/include/foundation-math.h b/libfoundation/include/foundation-math.h
@@ -36,10 +36,6 @@
 
 ////////////////////////////////////////////////////////////////////////////////
 
-/* Return a random number in the range [0, 1).  If any random number
- * generation error occurs, returns a quiet NaN. */
-real64_t MCMathRandom (void);
-
 // Convert from base 10 to a string in the desired base. Destination base should be between 2 and 32 inclusive.
 bool MCMathConvertFromBase10(uint32_t p_value, bool p_negative, integer_t p_dest_base, MCStringRef& r_result);
 
diff --git a/libfoundation/include/foundation-system.h b/libfoundation/include/foundation-system.h
@@ -25,6 +25,7 @@ extern "C" {
 
 #include <system-file.h>
 #include <system-init.h>
+#include <system-random.h>
 #include <system-stream.h>
 
 }
diff --git a/libfoundation/include/foundation.h b/libfoundation/include/foundation.h
@@ -2257,9 +2257,6 @@ MC_DLLEXPORT bool MCDataLastIndexOf(MCDataRef p_data, MCDataRef p_chunk, MCRange
 MC_DLLEXPORT bool MCDataConvertToCFDataRef(MCDataRef p_data, CFDataRef& r_cfdata);
 #endif
 
-// Create a data buffer filled with uniformly-distributed random bytes
-MC_DLLEXPORT bool MCDataCreateRandom (uindex_t p_length, MCDataRef & r_data);
-
 ////////////////////////////////////////////////////////////////////////////////
 //
 //  ARRAY DEFINITIONS
diff --git a/libfoundation/include/system-random.h b/libfoundation/include/system-random.h
@@ -0,0 +1,39 @@
+/*                                                                     -*-c++-*-
+Copyright (C) 2015 Runtime Revolution Ltd.
+
+This file is part of LiveCode.
+
+LiveCode is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License v3 as published by the Free
+Software Foundation.
+
+LiveCode 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 LiveCode.  If not see <http://www.gnu.org/licenses/>.  */
+
+#if !defined(__MCS_SYSTEM_H_INSIDE__)
+#	error "Only <foundation-system.h> can be included directly"
+#endif
+
+/* ================================================================
+ * Random number generation
+ * ================================================================ */
+
+/* Generate p_length bytes of random data. */
+MC_DLLEXPORT bool MCSRandomData (uindex_t p_length, MCDataRef & r_data);
+
+/* Generate a random real number on the interval [0,1).  If any random
+ * number generation failure occurs, returns a quiet NaN. */
+MC_DLLEXPORT real64_t MCSRandomReal (void);
+
+#ifdef __MCS_INTERNAL_API__
+
+/* Populate x_buffer with p_buffer_length uniformly-distributed random
+ * bytes. */
+bool __MCSRandomBytes (void *x_buffer, size_t p_buffer_length);
+
+#endif
diff --git a/libfoundation/src/foundation-data.cpp b/libfoundation/src/foundation-data.cpp
@@ -156,28 +156,6 @@ bool MCDataConvertStringToData(MCStringRef string, MCDataRef& r_data)
     return t_success;
 }
 
-bool
-MCDataCreateRandom (uindex_t p_length,
-                    MCDataRef & r_data)
-{
-	MCDataRef t_mutable;
-	byte_t *t_buffer;
-
-	if (!MCDataCreateMutable (p_length, t_mutable))
-		return false;
-
-	t_buffer = (byte_t *) MCDataGetBytePtr (t_mutable);
-
-	if (!__MCRandomBytes (t_buffer, p_length))
-	{
-		MCValueRelease (t_mutable);
-		return false;
-	}
-
-	return MCDataCopyAndRelease (t_mutable, r_data);
-}
-
-
 bool MCDataIsEmpty(MCDataRef p_data)
 {
     if (__MCDataIsIndirect(p_data))
diff --git a/libfoundation/src/foundation-math.cpp b/libfoundation/src/foundation-math.cpp
@@ -21,27 +21,6 @@ along with LiveCode.  If not see <http://www.gnu.org/licenses/>.  */
 
 ////////////////////////////////////////////////////////////////////////////////
 
-real64_t
-MCMathRandom (void)
-{
-	real64_t t_random_bytes;
-	int t_ignored;
-
-	/* Ensure that if we can't obtain a valid random number, the
-	 * return value is obviously useless.  __MCRandomBytes() should
-	 * have thrown an error. */
-	if (!__MCRandomBytes (&t_random_bytes, sizeof (t_random_bytes)))
-		return NAN;
-
-	/* Convert the value to a value in the range [0, 1).  frexp(3)
-	 * always returns a value with absolute value in the range [0.5,
-	 * 1). */
-	real64_t value = frexp (copysign (t_random_bytes, 1), &t_ignored) * 2 - 1;
-	return value;
-}
-
-////////////////////////////////////////////////////////////////////////////////
-
 bool MCMathConvertFromBase10(uint32_t p_value, bool p_negative, integer_t p_dest_base, MCStringRef& r_result)
 {
     char_t result[64];
diff --git a/libfoundation/src/foundation-private.h b/libfoundation/src/foundation-private.h
@@ -540,8 +540,6 @@ bool __MCForeignValueCopyDescription(__MCForeignValue *self, MCStringRef& r_desc
 bool __MCStreamInitialize(void);
 void __MCStreamFinalize(void);
 
-bool __MCRandomBytes (void *, size_t);
-
 /* Default implementations of each of the function members of struct &
  * MCValueCustomCallbacks */
 void __MCCustomDefaultDestroy(MCValueRef);
diff --git a/libfoundation/src/system-random.cpp b/libfoundation/src/system-random.cpp
@@ -15,20 +15,58 @@ for more details.
 You should have received a copy of the GNU General Public License
 along with LiveCode.  If not see <http://www.gnu.org/licenses/>.  */
 
-
-#include <foundation.h>
-#include <foundation-auto.h>
-#include <foundation-system.h>
-
-#include "foundation-private.h"
+#include "system-private.h"
 
 #if defined(__WINDOWS__)
 #  include <windows.h>
 #  include <Wincrypt.h>
 #endif
 
 /* ================================================================
- * Random data generation
+ * Random value generation
+ * ================================================================ */
+
+bool
+MCSRandomData (uindex_t p_length, MCDataRef & r_data)
+{
+	MCDataRef t_mutable;
+	byte_t *t_buffer;
+
+	if (!MCDataCreateMutable (p_length, t_mutable))
+		return false;
+
+	t_buffer = (byte_t *) MCDataGetBytePtr (t_mutable);
+
+	if (!__MCSRandomBytes (t_buffer, p_length))
+	{
+		MCValueRelease (t_mutable);
+		return false;
+	}
+
+	return MCDataCopyAndRelease (t_mutable, r_data);
+}
+
+real64_t
+MCSRandomReal (void)
+{
+	real64_t t_random_bytes;
+	int t_ignored;
+
+	/* Ensure that if we can't obtain a valid random number, the
+	 * return value is obviously useless.  __MCSRandomBytes() should
+	 * have thrown an error. */
+	if (!__MCSRandomBytes (&t_random_bytes, sizeof (t_random_bytes)))
+		return NAN;
+
+	/* Convert the value to a value in the range [0, 1).  frexp(3)
+	 * always returns a value with absolute value in the range [0.5,
+	 * 1). */
+	real64_t value = frexp (copysign (t_random_bytes, 1), &t_ignored);
+	return (value * 2 - 1);
+}
+
+/* ================================================================
+ * Low-level random data generation
  * ================================================================
  *
  * The __MCRandomBytes() function obtains cryptographic-quality
@@ -42,8 +80,8 @@ along with LiveCode.  If not see <http://www.gnu.org/licenses/>.  */
  * ---------------------------------------------------------------- */
 
 bool
-__MCRandomBytes (void *x_buffer,
-                 size_t p_buffer_length)
+__MCSRandomBytes (void *x_buffer,
+                  size_t p_buffer_length)
 {
 	/* Acquire cryptographic provider */
 	HCRYPTPROV t_provider;
@@ -81,8 +119,8 @@ __MCRandomBytes (void *x_buffer,
  * ---------------------------------------------------------------- */
 
 bool
-__MCRandomBytes (void *x_buffer,
-                 size_t p_buffer_length)
+__MCSRandomBytes (void *x_buffer,
+                  size_t p_buffer_length)
 {
 
 #	if defined(__MAC__) || defined(__IOS__)
diff --git a/libscript/src/module-byte.cpp b/libscript/src/module-byte.cpp
@@ -15,6 +15,7 @@
  along with LiveCode.  If not see <http://www.gnu.org/licenses/>.  */
 
 #include <foundation.h>
+#include <foundation-system.h>
 #include <foundation-auto.h>
 #include <foundation-chunk.h>
 
@@ -209,7 +210,7 @@ extern "C" MC_DLLEXPORT bool MCByteRepeatForEachByte(void*& x_iterator, MCDataRe
 extern "C" MC_DLLEXPORT void
 MCDataExecRandomBytes (uindex_t p_count, MCDataRef & r_data)
 {
-	/* UNCHECKED */ MCDataCreateRandom (p_count, r_data);
+	/* UNCHECKED */ MCSRandomData (p_count, r_data);
 }
 
 ////////////////////////////////////////////////////////////////////////////////////////////////////
diff --git a/libscript/src/module-math.cpp b/libscript/src/module-math.cpp
@@ -16,6 +16,7 @@
 
 #include <foundation.h>
 #include "foundation-math.h"
+#include <foundation-system.h>
 
 #include <float.h>
 
@@ -348,7 +349,7 @@ extern "C" MC_DLLEXPORT void MCMathEvalMaxNumber(MCNumberRef p_left, MCNumberRef
 
 extern "C" MC_DLLEXPORT void MCMathEvalRandomReal(double& r_output)
 {
-    r_output = MCMathRandom();
+    r_output = MCSRandomReal();
 }
 
 ////////////////////////////////////////////////////////////////////////////////////////////////////

Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,7 @@ void MCSecurityEvalRandomBytes(MCExecContext& ctxt, uinteger_t p_byte_count, MCD`
`83`	`83`	`return;`
`84`	`84`	`}`
`85`	`85`
`86`		`- if (MCDataCreateRandom (p_byte_count, r_bytes))`
	`86`	`+ if (MCSRandomData (p_byte_count, r_bytes))`
`87`	`87`	`{`
`88`	`88`	`ctxt.SetTheResultToEmpty();`
`89`	`89`	`return;`
Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,7 @@ void MCU_init()`
`100`	`100`	`* source. If that fails, fall back to constructing using some of the`
`101`	`101`	`* entropy available from the properties of the current process. */`
`102`	`102`	`MCAutoDataRef t_seed_data;`
`103`		`- if (MCDataCreateRandom(sizeof(MCrandomseed), &t_seed_data))`
	`103`	`+ if (MCSRandomData(sizeof(MCrandomseed), &t_seed_data))`
`104`	`104`	`{`
`105`	`105`	`MCMemoryCopy(&MCrandomseed, MCDataGetBytePtr(*t_seed_data),`
`106`	`106`	`sizeof(MCrandomseed));`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@ extern "C" {`
`25`	`25`
`26`	`26`	`#include <system-file.h>`
`27`	`27`	`#include <system-init.h>`
	`28`	`+#include <system-random.h>`
`28`	`29`	`#include <system-stream.h>`
`29`	`30`
`30`	`31`	`}`