From 68ea3c59f109c6d8bd06a0c3484c4db4d9c32cc0 Mon Sep 17 00:00:00 2001 From: Lauri Nurmi Date: Thu, 19 Nov 2020 00:20:48 +0200 Subject: [PATCH] Explain in wxPlatformInfo docs that it means bitness when it says architecture In the context of wxPlatformInfo, 'architecture' means either '32 bit' or '64 bit'. Anywhere outside the context of wxPlatformInfo, this concept is known as 'bitness'. For the rest of the world, 'architecture' generally refers to the CPU instruction set architecture, i.e. something like x86, x86_64, arm64, whereas 'operating system architecture' refers to the design of separating kernel space, user space, etc. --- include/wx/platinfo.h | 6 +++--- include/wx/utils.h | 2 +- interface/wx/platinfo.h | 12 ++++++------ interface/wx/utils.h | 5 ++--- tests/interactive/output.cpp | 2 +- 5 files changed, 13 insertions(+), 14 deletions(-) diff --git a/include/wx/platinfo.h b/include/wx/platinfo.h index 631b5c1c4d..17f9dbea08 100644 --- a/include/wx/platinfo.h +++ b/include/wx/platinfo.h @@ -82,7 +82,7 @@ enum wxPortId wxPORT_QT = 1 << 10 // wxQT, using Qt 5+ }; -// architecture of the operating system +// architecture bitness of the operating system // (regardless of the build environment of wxWidgets library - see // wxIsPlatform64bit documentation for more info) enum wxArchitecture @@ -134,7 +134,7 @@ struct wxLinuxDistributionInfo // ---------------------------------------------------------------------------- // Information about the toolkit that the app is running under and some basic -// platform and architecture info +// platform and architecture bitness info class WXDLLIMPEXP_BASE wxPlatformInfo { public: @@ -359,7 +359,7 @@ protected: // others // ----------------- - // architecture of the OS/machine + // architecture bitness of the OS/machine wxArchitecture m_arch; // endianness of the machine diff --git a/include/wx/utils.h b/include/wx/utils.h index f70bbd4b20..ff1dc72acf 100644 --- a/include/wx/utils.h +++ b/include/wx/utils.h @@ -150,7 +150,7 @@ WXDLLIMPEXP_BASE bool wxCheckOsVersion(int majorVsn, int minorVsn = 0, int micro // Get platform endianness WXDLLIMPEXP_BASE bool wxIsPlatformLittleEndian(); -// Get platform architecture +// Get platform architecture bitness WXDLLIMPEXP_BASE bool wxIsPlatform64Bit(); // Get machine CPU architecture diff --git a/interface/wx/platinfo.h b/interface/wx/platinfo.h index 1447df23c7..93372516ee 100644 --- a/interface/wx/platinfo.h +++ b/interface/wx/platinfo.h @@ -74,7 +74,7 @@ enum wxPortId /** - The architecture of the operating system + The architecture bitness of the operating system (regardless of the build environment of wxWidgets library - see ::wxIsPlatform64Bit() documentation for more info). */ @@ -126,7 +126,7 @@ struct wxLinuxDistributionInfo @class wxPlatformInfo This class holds information about the operating system, the toolkit and the - basic architecture of the machine where the application is currently running. + basic architecture bitness of the machine where the application is currently running. This class does not only have @e getters for the information above, it also has @e setters. This allows you to e.g. save the current platform information in a @@ -227,7 +227,7 @@ public: /** Converts the given string to a wxArchitecture enum value or to - @c wxARCH_INVALID if the given string is not a valid architecture string + @c wxARCH_INVALID if the given string is not a valid architecture bitness string (i.e. does not contain nor @c 32 nor @c 64 strings). */ static wxArchitecture GetArch(const wxString& arch); @@ -322,7 +322,7 @@ public: //@{ /** - Returns the architecture ID of this wxPlatformInfo instance. + Returns the architecture bitness ID of this wxPlatformInfo instance. */ wxArchitecture GetArchitecture() const; @@ -440,7 +440,7 @@ public: //@{ /** - Returns the name for the architecture of this wxPlatformInfo instance. + Returns the name for the architecture bitness of this wxPlatformInfo instance. */ wxString GetArchName() const; @@ -483,7 +483,7 @@ public: //@{ /** - Sets the architecture enum value associated with this wxPlatformInfo instance. + Sets the architecture bitness enum value associated with this wxPlatformInfo instance. */ void SetArchitecture(wxArchitecture n); diff --git a/interface/wx/utils.h b/interface/wx/utils.h index 1793b13062..b241060a96 100644 --- a/interface/wx/utils.h +++ b/interface/wx/utils.h @@ -970,12 +970,11 @@ bool wxCheckOsVersion(int majorVsn, int minorVsn = 0, int microVsn = 0); bit. The check is performed at run-time and may differ from the value available at compile-time (at compile-time you can just check if sizeof(void*) == 8) since the program could be running in - emulation mode or in a mixed 32/64 bit system (bi-architecture operating - system). + emulation mode or in a mixed 32/64 bit system. @note This function is not 100% reliable on some systems given the fact that there isn't always a standard way to do a reliable check on the - OS architecture. + OS bitness. @header{wx/utils.h} */ diff --git a/tests/interactive/output.cpp b/tests/interactive/output.cpp index 7e61454059..f854cd2d8a 100644 --- a/tests/interactive/output.cpp +++ b/tests/interactive/output.cpp @@ -280,7 +280,7 @@ void InteractiveOutputTestCase::TestPlatformInfo() wxPrintf(wxT("Operating system name is: %s\n"), plat.GetOperatingSystemIdName()); wxPrintf(wxT("Port ID name is: %s\n"), plat.GetPortIdName()); wxPrintf(wxT("Port ID short name is: %s\n"), plat.GetPortIdShortName()); - wxPrintf(wxT("Architecture is: %s\n"), plat.GetArchName()); + wxPrintf(wxT("Architecture bitness is: %s\n"), plat.GetArchName()); wxPrintf(wxT("Endianness is: %s\n"), plat.GetEndiannessName()); wxPuts(wxEmptyString);