OpenShot Library | libopenshot-audio 0.2.0
juce::SystemStats Class Referencefinal

Contains methods for finding out about the current hardware and OS configuration. More...

#include <juce_SystemStats.h>

Public Types

enum  OperatingSystemType {
  UnknownOS = 0 , MacOSX = 0x0100 , Windows = 0x0200 , Linux = 0x0400 ,
  Android = 0x0800 , iOS = 0x1000 , MacOSX_10_4 = MacOSX | 4 , MacOSX_10_5 = MacOSX | 5 ,
  MacOSX_10_6 = MacOSX | 6 , MacOSX_10_7 = MacOSX | 7 , MacOSX_10_8 = MacOSX | 8 , MacOSX_10_9 = MacOSX | 9 ,
  MacOSX_10_10 = MacOSX | 10 , MacOSX_10_11 = MacOSX | 11 , MacOSX_10_12 = MacOSX | 12 , Win2000 = Windows | 1 ,
  WinXP = Windows | 2 , WinVista = Windows | 3 , Windows7 = Windows | 4 , Windows8_0 = Windows | 5 ,
  Windows8_1 = Windows | 6 , Windows10 = Windows | 7
}
 The set of possible results of the getOperatingSystemType() method. More...
 
using CrashHandlerFunction = void(*)(void *)
 A function type for use in setApplicationCrashHandler().
 

Static Public Member Functions

static String getJUCEVersion ()
 Returns the current version of JUCE, See also the JUCE_VERSION, JUCE_MAJOR_VERSION and JUCE_MINOR_VERSION macros.
 
static OperatingSystemType getOperatingSystemType ()
 Returns the type of operating system we're running on.
 
static String getOperatingSystemName ()
 Returns the name of the type of operating system we're running on.
 
static bool isOperatingSystem64Bit ()
 Returns true if the OS is 64-bit, or false for a 32-bit OS.
 
static String getEnvironmentVariable (const String &name, const String &defaultValue)
 Returns an environment variable.
 
static String getLogonName ()
 Returns the current user's name, if available.
 
static String getFullUserName ()
 Returns the current user's full name, if available.
 
static String getComputerName ()
 Returns the host-name of the computer.
 
static String getUserLanguage ()
 Returns the language of the user's locale.
 
static String getUserRegion ()
 Returns the region of the user's locale.
 
static String getDisplayLanguage ()
 Returns the user's display language.
 
static String getDeviceDescription ()
 This will attempt to return some kind of string describing the device.
 
static String getDeviceManufacturer ()
 This will attempt to return the manufacturer of the device.
 
static StringArray getDeviceIdentifiers ()
 This method calculates some IDs to uniquely identify the device.
 
static int getNumCpus () noexcept
 Returns the number of logical CPU cores.
 
static int getNumPhysicalCpus () noexcept
 Returns the number of physical CPU cores.
 
static int getCpuSpeedInMegahertz ()
 Returns the approximate CPU speed.
 
static String getCpuVendor ()
 Returns a string to indicate the CPU vendor.
 
static String getCpuModel ()
 Attempts to return a string describing the CPU model.
 
static bool hasMMX () noexcept
 Returns true if Intel MMX instructions are available.
 
static bool has3DNow () noexcept
 Returns true if AMD 3DNOW instructions are available.
 
static bool hasSSE () noexcept
 Returns true if Intel SSE instructions are available.
 
static bool hasSSE2 () noexcept
 Returns true if Intel SSE2 instructions are available.
 
static bool hasSSE3 () noexcept
 Returns true if Intel SSE3 instructions are available.
 
static bool hasSSSE3 () noexcept
 Returns true if Intel SSSE3 instructions are available.
 
static bool hasSSE41 () noexcept
 Returns true if Intel SSE4.1 instructions are available.
 
static bool hasSSE42 () noexcept
 Returns true if Intel SSE4.2 instructions are available.
 
static bool hasAVX () noexcept
 Returns true if Intel AVX instructions are available.
 
static bool hasAVX2 () noexcept
 Returns true if Intel AVX2 instructions are available.
 
static bool hasAVX512F () noexcept
 Returns true if Intel AVX-512 Foundation instructions are available.
 
static bool hasAVX512BW () noexcept
 Returns true if Intel AVX-512 Byte and Word instructions are available.
 
static bool hasAVX512CD () noexcept
 Returns true if Intel AVX-512 Conflict Detection instructions are available.
 
static bool hasAVX512DQ () noexcept
 Returns true if Intel AVX-512 Doubleword and Quadword instructions are available.
 
static bool hasAVX512ER () noexcept
 Returns true if Intel AVX-512 Exponential and Reciprocal instructions are available.
 
static bool hasAVX512IFMA () noexcept
 Returns true if Intel AVX-512 Integer Fused Multiply-Add instructions are available.
 
static bool hasAVX512PF () noexcept
 Returns true if Intel AVX-512 Prefetch instructions are available.
 
static bool hasAVX512VBMI () noexcept
 Returns true if Intel AVX-512 Vector Bit Manipulation instructions are available.
 
static bool hasAVX512VL () noexcept
 Returns true if Intel AVX-512 Vector Length instructions are available.
 
static bool hasAVX512VPOPCNTDQ () noexcept
 Returns true if Intel AVX-512 Vector Population Count Double and Quad-word instructions are available.
 
static bool hasNeon () noexcept
 Returns true if ARM NEON instructions are available.
 
static int getMemorySizeInMegabytes ()
 Finds out how much RAM is in the machine.
 
static int getPageSize ()
 Returns the system page-size.
 
static String getStackBacktrace ()
 Returns a backtrace of the current call-stack.
 
static void setApplicationCrashHandler (CrashHandlerFunction)
 Sets up a global callback function that will be called if the application executes some kind of illegal instruction.
 
static bool isRunningInAppExtensionSandbox () noexcept
 Returns true if this code is running inside an app extension sandbox.
 

Detailed Description

Contains methods for finding out about the current hardware and OS configuration.

Definition at line 36 of file juce_SystemStats.h.

Member Typedef Documentation

◆ CrashHandlerFunction

A function type for use in setApplicationCrashHandler().

When called, its void* argument will contain platform-specific data about the crash.

Definition at line 219 of file juce_SystemStats.h.

Member Enumeration Documentation

◆ OperatingSystemType

The set of possible results of the getOperatingSystemType() method.

Enumerator
MacOSX 

To test whether any version of OSX is running, you can use the expression ((getOperatingSystemType() & MacOSX) != 0).

Windows 

To test whether any version of Windows is running, you can use the expression ((getOperatingSystemType() & Windows) != 0).

Definition at line 47 of file juce_SystemStats.h.

Member Function Documentation

◆ getJUCEVersion()

String juce::SystemStats::getJUCEVersion ( )
static

Returns the current version of JUCE, See also the JUCE_VERSION, JUCE_MAJOR_VERSION and JUCE_MINOR_VERSION macros.

Definition at line 26 of file juce_SystemStats.cpp.

References JUCE_MAJOR_VERSION.

◆ getOperatingSystemType()

static OperatingSystemType juce::SystemStats::getOperatingSystemType ( )
static

Returns the type of operating system we're running on.

Returns
one of the values from the OperatingSystemType enum.
See also
getOperatingSystemName

◆ getOperatingSystemName()

static String juce::SystemStats::getOperatingSystemName ( )
static

Returns the name of the type of operating system we're running on.

Returns
a string describing the OS type.
See also
getOperatingSystemType

◆ getEnvironmentVariable()

static String juce::SystemStats::getEnvironmentVariable ( const String name,
const String defaultValue 
)
static

Returns an environment variable.

If the named value isn't set, this will return the defaultValue string instead.

◆ getLogonName()

static String juce::SystemStats::getLogonName ( )
static

Returns the current user's name, if available.

See also
getFullUserName()

◆ getFullUserName()

static String juce::SystemStats::getFullUserName ( )
static

Returns the current user's full name, if available.

On some OSes, this may just return the same value as getLogonName().

See also
getLogonName()

◆ getUserLanguage()

static String juce::SystemStats::getUserLanguage ( )
static

Returns the language of the user's locale.

The return value is a 2 or 3 letter language code (ISO 639-1 or ISO 639-2)

◆ getUserRegion()

static String juce::SystemStats::getUserRegion ( )
static

Returns the region of the user's locale.

The return value is a 2 letter country code (ISO 3166-1 alpha-2).

◆ getDisplayLanguage()

static String juce::SystemStats::getDisplayLanguage ( )
static

Returns the user's display language.

The return value is a 2 or 3 letter language code (ISO 639-1 or ISO 639-2). Note that depending on the OS and region, this may also be followed by a dash and a sub-region code, e.g "en-GB"

◆ getDeviceDescription()

static String juce::SystemStats::getDeviceDescription ( )
static

This will attempt to return some kind of string describing the device.

If no description is available, it'll just return an empty string. You may want to use this for things like determining the type of phone/iPad, etc.

◆ getDeviceManufacturer()

static String juce::SystemStats::getDeviceManufacturer ( )
static

This will attempt to return the manufacturer of the device.

If no description is available, it'll just return an empty string.

◆ getDeviceIdentifiers()

StringArray juce::SystemStats::getDeviceIdentifiers ( )
static

This method calculates some IDs to uniquely identify the device.

The first choice for an ID is a filesystem ID for the user's home folder or windows directory. If that fails then this function returns the MAC addresses.

Definition at line 61 of file juce_SystemStats.cpp.

References juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::add(), juce::MACAddress::getAllAddresses(), juce::File::getFileIdentifier(), juce::File::getSpecialLocation(), juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::isEmpty(), juce::String::toHexString(), and juce::File::windowsSystemDirectory.

◆ getNumCpus()

int juce::SystemStats::getNumCpus ( )
staticnoexcept

Returns the number of logical CPU cores.

Definition at line 109 of file juce_SystemStats.cpp.

Referenced by juce::ThreadPool::ThreadPool().

◆ getNumPhysicalCpus()

int juce::SystemStats::getNumPhysicalCpus ( )
staticnoexcept

Returns the number of physical CPU cores.

Definition at line 110 of file juce_SystemStats.cpp.

◆ getCpuSpeedInMegahertz()

static int juce::SystemStats::getCpuSpeedInMegahertz ( )
static

Returns the approximate CPU speed.

Returns
the speed in megahertz, e.g. 1500, 2500, 32000 (depending on what year you're reading this...)

◆ getCpuVendor()

static String juce::SystemStats::getCpuVendor ( )
static

Returns a string to indicate the CPU vendor.

Might not be known on some systems.

◆ getCpuModel()

static String juce::SystemStats::getCpuModel ( )
static

Attempts to return a string describing the CPU model.

May not be available on some systems.

◆ hasMMX()

bool juce::SystemStats::hasMMX ( )
staticnoexcept

Returns true if Intel MMX instructions are available.

Definition at line 111 of file juce_SystemStats.cpp.

◆ has3DNow()

bool juce::SystemStats::has3DNow ( )
staticnoexcept

Returns true if AMD 3DNOW instructions are available.

Definition at line 112 of file juce_SystemStats.cpp.

◆ hasSSE()

bool juce::SystemStats::hasSSE ( )
staticnoexcept

Returns true if Intel SSE instructions are available.

Definition at line 113 of file juce_SystemStats.cpp.

◆ hasSSE2()

bool juce::SystemStats::hasSSE2 ( )
staticnoexcept

Returns true if Intel SSE2 instructions are available.

Definition at line 114 of file juce_SystemStats.cpp.

◆ hasSSE3()

bool juce::SystemStats::hasSSE3 ( )
staticnoexcept

Returns true if Intel SSE3 instructions are available.

Definition at line 115 of file juce_SystemStats.cpp.

◆ hasSSSE3()

bool juce::SystemStats::hasSSSE3 ( )
staticnoexcept

Returns true if Intel SSSE3 instructions are available.

Definition at line 116 of file juce_SystemStats.cpp.

◆ hasSSE41()

bool juce::SystemStats::hasSSE41 ( )
staticnoexcept

Returns true if Intel SSE4.1 instructions are available.

Definition at line 117 of file juce_SystemStats.cpp.

◆ hasSSE42()

bool juce::SystemStats::hasSSE42 ( )
staticnoexcept

Returns true if Intel SSE4.2 instructions are available.

Definition at line 118 of file juce_SystemStats.cpp.

◆ hasAVX()

bool juce::SystemStats::hasAVX ( )
staticnoexcept

Returns true if Intel AVX instructions are available.

Definition at line 119 of file juce_SystemStats.cpp.

◆ hasAVX2()

bool juce::SystemStats::hasAVX2 ( )
staticnoexcept

Returns true if Intel AVX2 instructions are available.

Definition at line 120 of file juce_SystemStats.cpp.

◆ hasAVX512F()

bool juce::SystemStats::hasAVX512F ( )
staticnoexcept

Returns true if Intel AVX-512 Foundation instructions are available.

Definition at line 121 of file juce_SystemStats.cpp.

◆ hasAVX512BW()

bool juce::SystemStats::hasAVX512BW ( )
staticnoexcept

Returns true if Intel AVX-512 Byte and Word instructions are available.

Definition at line 122 of file juce_SystemStats.cpp.

◆ hasAVX512CD()

bool juce::SystemStats::hasAVX512CD ( )
staticnoexcept

Returns true if Intel AVX-512 Conflict Detection instructions are available.

Definition at line 123 of file juce_SystemStats.cpp.

◆ hasAVX512DQ()

bool juce::SystemStats::hasAVX512DQ ( )
staticnoexcept

Returns true if Intel AVX-512 Doubleword and Quadword instructions are available.

Definition at line 124 of file juce_SystemStats.cpp.

◆ hasAVX512ER()

bool juce::SystemStats::hasAVX512ER ( )
staticnoexcept

Returns true if Intel AVX-512 Exponential and Reciprocal instructions are available.

Definition at line 125 of file juce_SystemStats.cpp.

◆ hasAVX512IFMA()

bool juce::SystemStats::hasAVX512IFMA ( )
staticnoexcept

Returns true if Intel AVX-512 Integer Fused Multiply-Add instructions are available.

Definition at line 126 of file juce_SystemStats.cpp.

◆ hasAVX512PF()

bool juce::SystemStats::hasAVX512PF ( )
staticnoexcept

Returns true if Intel AVX-512 Prefetch instructions are available.

Definition at line 127 of file juce_SystemStats.cpp.

◆ hasAVX512VBMI()

bool juce::SystemStats::hasAVX512VBMI ( )
staticnoexcept

Returns true if Intel AVX-512 Vector Bit Manipulation instructions are available.

Definition at line 128 of file juce_SystemStats.cpp.

◆ hasAVX512VL()

bool juce::SystemStats::hasAVX512VL ( )
staticnoexcept

Returns true if Intel AVX-512 Vector Length instructions are available.

Definition at line 129 of file juce_SystemStats.cpp.

◆ hasAVX512VPOPCNTDQ()

bool juce::SystemStats::hasAVX512VPOPCNTDQ ( )
staticnoexcept

Returns true if Intel AVX-512 Vector Population Count Double and Quad-word instructions are available.

Definition at line 130 of file juce_SystemStats.cpp.

◆ hasNeon()

bool juce::SystemStats::hasNeon ( )
staticnoexcept

Returns true if ARM NEON instructions are available.

Definition at line 131 of file juce_SystemStats.cpp.

◆ getMemorySizeInMegabytes()

static int juce::SystemStats::getMemorySizeInMegabytes ( )
static

Finds out how much RAM is in the machine.

Returns
the approximate number of megabytes of memory, or zero if something goes wrong when finding out.

◆ getPageSize()

static int juce::SystemStats::getPageSize ( )
static

Returns the system page-size.

This is only used by programmers with beards.

◆ getStackBacktrace()

String juce::SystemStats::getStackBacktrace ( )
static

Returns a backtrace of the current call-stack.

The usefulness of the result will depend on the level of debug symbols that are available in the executable.

Definition at line 135 of file juce_SystemStats.cpp.

References juce::String::toHexString().

◆ setApplicationCrashHandler()

void juce::SystemStats::setApplicationCrashHandler ( CrashHandlerFunction  handler)
static

Sets up a global callback function that will be called if the application executes some kind of illegal instruction.

You may want to call getStackBacktrace() in your handler function, to find out where the problem happened and log it, etc.

Definition at line 206 of file juce_SystemStats.cpp.

◆ isRunningInAppExtensionSandbox()

bool juce::SystemStats::isRunningInAppExtensionSandbox ( )
staticnoexcept

Returns true if this code is running inside an app extension sandbox.

This function will always return false on windows, linux and android.

Definition at line 224 of file juce_SystemStats.cpp.

References juce::File::getSpecialLocation(), and juce::File::invokedExecutableFile.


The documentation for this class was generated from the following files: