[[ Cleanup ]] Refactor the processor to reuse code

montegoulding · montegoulding · commit c2158fe22ad7 · 2018-10-11T13:15:44.000+11:00
This patch refactors `the processor` to reuse code between platforms
and also between LCS and LCB. A new `MCSInfo` api was implemented in
libfoundation with `MCSInfoGetArchitecture` returning a string based
architecture definitions in `foundation.h`.

Additionally `the processor` documentation was updated to clarify
returned values in emulated environments and to disassociate the
returned values with particular operating systems to reduce maintenance.
diff --git a/docs/dictionary/function/processor.lcdoc b/docs/dictionary/function/processor.lcdoc
@@ -7,32 +7,38 @@ Syntax: the processor
 Syntax: processor()
 
 Summary:
-<return|Returns> a <string> describing the system's CPU chip.
+<return|Returns> a <string> describing the system's architecture.
 
 Introduced: 1.0
 
-OS: mac, windows, ios, android
+OS: mac, windows, linux, ios, android, html5
 
 Platforms: desktop, server, mobile
 
 Example:
 the processor
 
 Example:
-if the processor is "ARM" then ...
+if the processor is "arm" then ...
 
 Returns (enum):
 
--   x86: Windows systems (any architecture) and Mac OS X and Linux
-    systems with a 32 bit processor.
--   x86_64: Mac and Linux systems running a 64 bit processor
--   i386: iOS Simulator.
--   ARM: iOS and Android Devices and the Android simulator
-
+- x86: x86 32 bit architecure
+- x86_64: x86 64 bit architecure
+- arm: arm 32 bit architecture
+- arm64: arm 64 bit architecture
+- js: HTML 5
 
 Description:
-Use the <processor> function to determine which microprocessor the
-device has.
+Use the <processor> function to determine the system architecture. The system
+architecture may either be emulated or the architecture of the host CPU. For
+example, when running the application in an android emulator the <processor>
+will return the emulated architecture rather than the architecture of the host
+CPU.
+
+>*Note:* Some operating systems have emulators built in. For example, Windows
+> has WOW64 which allows x86 executables to run under x86_64 versions of
+> Windows.
 
 References: machine (function), platform (function), return (glossary),
 string (keyword)
diff --git a/engine/src/dsklnx.cpp b/engine/src/dsklnx.cpp
@@ -765,19 +765,6 @@ class MCLinuxDesktop: public MCSystemInterface
         return MCStringCreateWithNativeChars((const char_t *)u.machine, MCCStringLength(u.machine), r_string);
     }
 
-    virtual MCNameRef GetProcessor(void)
-    {
-#if   defined(__X86_64__)
-        return MCN_x86_64;
-#elif defined(__ARM__)
-        return MCN_arm;
-#elif defined(__i386__)
-        return MCN_x86;
-#else
-#  error "One of __X86_64__, __ARM__ or __i386__ must be defined"
-#endif
-    }
-
     virtual bool GetAddress(MCStringRef& r_address)
     {
         struct utsname u;
diff --git a/engine/src/dskmac.cpp b/engine/src/dskmac.cpp
@@ -3014,16 +3014,8 @@ struct MCMacDesktop: public MCSystemInterface, public MCMacSystemService
 
 		return MCStringCopy(MCNameGetString(MCN_unknown), r_string); //in case model name can't be read
     }
-	virtual MCNameRef GetProcessor(void)
-    {
-//get machine processor
-#ifdef __64_BIT__
-        return MCN_x86_64;
-#else
-        return MCN_x86;
-#endif
-    }
-	virtual bool GetAddress(MCStringRef& r_address)
+
+    virtual bool GetAddress(MCStringRef& r_address)
     {
         static struct utsname u;
         uname(&u);
diff --git a/engine/src/dskw32.cpp b/engine/src/dskw32.cpp
@@ -1613,21 +1613,10 @@ struct MCWindowsDesktop: public MCSystemInterface, public MCWindowsSystemService
     
 	virtual bool GetMachine(MCStringRef& r_string)
     {
-		r_string = MCValueRetain(MCNameGetString(GetProcessor()));
+		r_string = MCValueRetain(MCS_getprocessor());
 		return true;
     }
     
-	virtual MCNameRef GetProcessor(void)
-    {
-#if defined _M_IX86
-        return MCN_x86;
-#elif defined _M_AMD64
-		return MCN_x86_64;
-#else
-#  error Unknown processor
-#endif
-    }
-    
 	virtual bool GetAddress(MCStringRef& r_address)
     {
         if (!wsainit())
diff --git a/engine/src/em-system.cpp b/engine/src/em-system.cpp
@@ -194,12 +194,6 @@ MCEmscriptenSystem::GetMachine(MCStringRef & r_string)
 	return MCStringCopy(kMCEmptyString, r_string);
 }
 
-MCNameRef
-MCEmscriptenSystem::GetProcessor()
-{
-	return kMCEmptyName;
-}
-
 bool
 MCEmscriptenSystem::GetAddress(MCStringRef & r_address)
 {
diff --git a/engine/src/em-system.h b/engine/src/em-system.h
@@ -55,7 +55,6 @@ class MCEmscriptenSystem: public MCSystemInterface
 	/* ---------- System information */
 	virtual bool GetVersion(MCStringRef & r_string);
 	virtual bool GetMachine(MCStringRef & r_string);
-	virtual MCNameRef GetProcessor(void);
 	virtual bool GetAddress(MCStringRef & r_address);
 
 	/* ---------- Engine process information */
diff --git a/engine/src/exec-engine.cpp b/engine/src/exec-engine.cpp
@@ -157,9 +157,9 @@ void MCEngineEvalMachine(MCExecContext& ctxt, MCStringRef& r_string)
 	ctxt.Throw();
 }
 
-void MCEngineEvalProcessor(MCExecContext& ctxt, MCNameRef& r_name)
+void MCEngineEvalProcessor(MCExecContext& ctxt, MCStringRef& r_string)
 {
-    r_name = MCValueRetain(MCS_getprocessor());
+    r_string = MCValueRetain(MCS_getprocessor());
 }
 
 void MCEngineEvalSystemVersion(MCExecContext& ctxt, MCStringRef& r_string)
diff --git a/engine/src/exec.h b/engine/src/exec.h
@@ -2975,7 +2975,7 @@ void MCEngineEvalBuildNumber(MCExecContext& ctxt, integer_t& r_build_number);
 void MCEngineEvalPlatform(MCExecContext& ctxt, MCNameRef& r_name);
 void MCEngineEvalEnvironment(MCExecContext& ctxt, MCNameRef& r_name);
 void MCEngineEvalMachine(MCExecContext& ctxt, MCStringRef& r_string);
-void MCEngineEvalProcessor(MCExecContext& ctxt, MCNameRef& r_name);
+void MCEngineEvalProcessor(MCExecContext& ctxt, MCStringRef& r_string);
 void MCEngineEvalSystemVersion(MCExecContext& ctxt, MCStringRef& r_string);
 
 void MCEngineEvalCommandNames(MCExecContext& ctxt, MCStringRef& r_string);
diff --git a/engine/src/funcs.h b/engine/src/funcs.h
@@ -1241,7 +1241,7 @@ class MCPopulationVariance : public MCParamFunctionCtxt<MCMathEvalPopulationVari
     virtual ~MCPopulationVariance(){}
 };
 
-class MCProcessor : public MCConstantFunctionCtxt<MCNameRef, MCEngineEvalProcessor>
+class MCProcessor : public MCConstantFunctionCtxt<MCStringRef, MCEngineEvalProcessor>
 {
 public:
 };
diff --git a/engine/src/mblandroid.h b/engine/src/mblandroid.h
@@ -36,7 +36,6 @@ struct MCAndroidSystem: public MCSystemInterface
     
 	virtual bool GetVersion(MCStringRef& r_string);
 	virtual bool GetMachine(MCStringRef& r_string);
-	virtual MCNameRef GetProcessor(void);
 	virtual bool GetAddress(MCStringRef& r_address);
     
 	virtual uint32_t GetProcessId(void);
diff --git a/engine/src/mblandroidprocess.cpp b/engine/src/mblandroidprocess.cpp
@@ -50,15 +50,6 @@ bool MCAndroidSystem::GetMachine(MCStringRef& r_string)
 	return true;
 }
 
-MCNameRef MCAndroidSystem::GetProcessor(void)
-{
-#ifdef __i386__
-    return MCN_i386;
-#else
-    return MCN_arm;
-#endif
-}
-
 bool MCAndroidSystem::GetAddress(MCStringRef& r_address)
 {
 	extern MCStringRef MCcmd;
diff --git a/engine/src/mbliphone.h b/engine/src/mbliphone.h
@@ -37,7 +37,6 @@ struct MCIPhoneSystem: public MCSystemInterface
     
 	virtual bool GetVersion(MCStringRef& r_string);
 	virtual bool GetMachine(MCStringRef& r_string);
-	virtual MCNameRef GetProcessor(void);
 	virtual bool GetAddress(MCStringRef& r_address);
     
 	virtual uint32_t GetProcessId(void);
diff --git a/engine/src/mbliphone.mm b/engine/src/mbliphone.mm
@@ -391,19 +391,6 @@ virtual uint64_t GetFileSize(void)
     return MCStringCreateWithCFStringRef((CFStringRef)t_machine, r_string);
 }
 
-MCNameRef MCIPhoneSystem::GetProcessor(void)
-{
-#if defined __i386__
-    return MCN_i386;
-#elif defined __amd64__
-    return MCN_x86_64;
-#elif defined __arm64__
-    return MCN_arm64;
-#else
-	return MCN_arm;
-#endif
-}
-
 bool MCIPhoneSystem::GetAddress(MCStringRef& r_address)
 {
 //    bool MCS_getaddress(MCStringRef &r_address)
diff --git a/engine/src/mcstring.cpp b/engine/src/mcstring.cpp
@@ -718,12 +718,6 @@ const struct { const char *cstring; MCNameRef *name_var; } kInitialNames[] =
 	{ "bold-italic", &MCN_bold_italic },
 
 	{ "unknown", &MCN_unknown },
-	{ "x86", &MCN_x86 },
-    { "x86_64", &MCN_x86_64 },
-	{ "Motorola PowerPC", &MCN_motorola_powerpc },
-	{ "i386", &MCN_i386 },
-	{ "ARM", &MCN_arm },
-    { "arm64", &MCN_arm64 },
 
 	{ "local Mac", &MCN_local_mac },
 	{ "local Win32", &MCN_local_win32 },
diff --git a/engine/src/osspec.h b/engine/src/osspec.h
@@ -100,7 +100,7 @@ extern Boolean MCS_rmdir(MCStringRef path);
 extern uint4 MCS_getpid();
 extern bool MCS_getaddress(MCStringRef& r_string);
 extern bool MCS_getmachine(MCStringRef& r_string);
-extern MCNameRef MCS_getprocessor();
+extern MCStringRef MCS_getprocessor();
 extern real8 MCS_getfreediskspace(void);
 extern bool MCS_getsystemversion(MCStringRef& r_string);
 extern bool MCS_loadtextfile(MCStringRef p_filename, MCStringRef& r_text);
diff --git a/engine/src/srvwindows.cpp b/engine/src/srvwindows.cpp
@@ -297,12 +297,8 @@ struct MCWindowsSystem: public MCSystemInterface
 
 	virtual bool GetMachine(MCStringRef& r_string)
 	{
-		return MCStringCopy(MCNameGetString(MCN_x86), r_string);
-	}
-
-	virtual MCNameRef GetProcessor(void)
-	{
-		return MCN_x86;
+        r_string = MCValueRetain(MCS_getprocessor());
+        return true;
 	}
 
 	virtual void GetAddress(MCStringRef& r_address)
diff --git a/engine/src/sysspec.cpp b/engine/src/sysspec.cpp
@@ -39,6 +39,7 @@
 #include "system.h"
 
 #include "foundation.h"
+#include "foundation-system.h"
 
 #if defined(_IOS_MOBILE) || defined(_ANDROID_MOBILE)
 #include "mblcontrol.h"
@@ -53,7 +54,6 @@
 
 extern bool MCSystemLaunchUrl(MCStringRef p_document);
 extern char *MCSystemGetVersion(void);
-extern MCNameRef MCSystemGetProcessor(void);
 extern char *MCSystemGetAddress(void);
 extern uint32_t MCSystemPerformTextConversion(const char *string, uint32_t string_length, char *buffer, uint32_t buffer_length, uint1 from_charset, uint1 to_charset);
 
@@ -555,9 +555,15 @@ bool MCS_getsystemversion(MCStringRef& r_string)
 	return MCsystem->GetVersion(r_string);
 }
 
-MCNameRef MCS_getprocessor(void)
+MCStringRef MCS_getprocessor(void)
 {
-	return MCsystem -> GetProcessor();
+    MCAutoStringRef t_arch;
+    if (!MCSInfoGetArchitecture(&t_arch))
+    {
+        return kMCEmptyString;
+    }
+    
+    return t_arch.Take();
 }
 
 bool MCS_getmachine(MCStringRef& r_string)
diff --git a/engine/src/system.h b/engine/src/system.h
@@ -481,7 +481,6 @@ struct MCSystemInterface
 
 	virtual bool GetVersion(MCStringRef& r_string) = 0;
 	virtual bool GetMachine(MCStringRef& r_string) = 0;
-	virtual MCNameRef GetProcessor(void) = 0;
 	virtual bool GetAddress(MCStringRef& r_address) = 0;
 
 	virtual uint32_t GetProcessId(void) = 0;
diff --git a/libfoundation/include/foundation-system.h b/libfoundation/include/foundation-system.h
@@ -34,6 +34,7 @@ extern "C" {
 #include <system-random.h>
 #include <system-stream.h>
 #include <system-error.h>
+#include <system-info.h>
 
 }
 
diff --git a/libfoundation/include/system-info.h b/libfoundation/include/system-info.h
@@ -0,0 +1,26 @@
+/*                                                                     -*-c++-*-
+Copyright (C) 2018 LiveCode 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
+
+/* ================================================================
+ * System information
+ * ================================================================ */
+
+MC_DLLEXPORT bool MCSInfoGetArchitecture(MCStringRef & r_string);
diff --git a/libfoundation/libfoundation.gyp b/libfoundation/libfoundation.gyp
@@ -73,6 +73,7 @@
                 'include/system-library.h',
 				'include/system-random.h',
 				'include/system-stream.h',
+				'include/system-info.h',
 				
 				'src/foundation-private.h',
 				'src/foundation-unicode-private.h',
@@ -130,6 +131,7 @@
                 'src/system-library-w32.hpp',
 				'src/system-random.cpp',
 				'src/system-stream.cpp',
+				'src/system-info.cpp',
 				
 				'<(SHARED_INTERMEDIATE_DIR)/src/icudata-minimal.cpp',
 			],
diff --git a/libfoundation/src/system-info.cpp b/libfoundation/src/system-info.cpp
@@ -0,0 +1,40 @@
+/*                                                                     -*-c++-*-
+Copyright (C) 2018 LiveCode 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/>.  */
+
+#include "system-private.h"
+
+MC_DLLEXPORT_DEF bool
+MCSInfoGetArchitecture(MCStringRef & r_string)
+{
+    const char t_arch[] =
+#if defined(__X86__) || defined(__i386__)
+    "x86"
+#elif defined(__X86_64__)
+    "x86_64"
+#elif defined(__ARM64__)
+    "arm64"
+#elif defined(__ARM__)
+    "arm"
+#elif defined(__EMSCRIPTEN__)
+    "js"
+#else
+#  error "Unrecognized architecture"
+#endif
+    ;
+    
+    return MCStringCreateWithCString (t_arch, r_string);
+}
diff --git a/libscript/src/module-system.cpp b/libscript/src/module-system.cpp

Original file line number	Diff line number	Diff line change
`@@ -194,12 +194,6 @@ MCEmscriptenSystem::GetMachine(MCStringRef & r_string)`
`194`	`194`	`return MCStringCopy(kMCEmptyString, r_string);`
`195`	`195`	`}`
`196`	`196`
`197`		`-MCNameRef`
`198`		`-MCEmscriptenSystem::GetProcessor()`
`199`		`-{`
`200`		`- return kMCEmptyName;`
`201`		`-}`
`202`		`-`
`203`	`197`	`bool`
`204`	`198`	`MCEmscriptenSystem::GetAddress(MCStringRef & r_address)`
`205`	`199`	`{`
Original file line number	Diff line number	Diff line change
`@@ -157,9 +157,9 @@ void MCEngineEvalMachine(MCExecContext& ctxt, MCStringRef& r_string)`
`157`	`157`	`ctxt.Throw();`
`158`	`158`	`}`
`159`	`159`
`160`		`-void MCEngineEvalProcessor(MCExecContext& ctxt, MCNameRef& r_name)`
	`160`	`+void MCEngineEvalProcessor(MCExecContext& ctxt, MCStringRef& r_string)`
`161`	`161`	`{`
`162`		`- r_name = MCValueRetain(MCS_getprocessor());`
	`162`	`+ r_string = MCValueRetain(MCS_getprocessor());`
`163`	`163`	`}`
`164`	`164`
`165`	`165`	`void MCEngineEvalSystemVersion(MCExecContext& ctxt, MCStringRef& r_string)`
Original file line number	Diff line number	Diff line change
`@@ -1241,7 +1241,7 @@ class MCPopulationVariance : public MCParamFunctionCtxt<MCMathEvalPopulationVari`
`1241`	`1241`	`virtual ~MCPopulationVariance(){}`
`1242`	`1242`	`};`
`1243`	`1243`
`1244`		`-class MCProcessor : public MCConstantFunctionCtxt<MCNameRef, MCEngineEvalProcessor>`
	`1244`	`+class MCProcessor : public MCConstantFunctionCtxt<MCStringRef, MCEngineEvalProcessor>`
`1245`	`1245`	`{`
`1246`	`1246`	`public:`
`1247`	`1247`	`};`