A class for querying information about the system. More...

#include <ObjFW/ObjFW.h>

Inheritance diagram for OFSystemInfo:

Class Methods
(size_t)	+ pageSize
	Returns the size of a page.

(size_t)	+ numberOfCPUs
	Returns the number of CPUs installed in the system.

(OFString *)	+ ObjFWVersion
	The version of ObjFW.

(unsigned short)	+ ObjFWVersionMajor
	The major version of ObjFW.

(unsigned short)	+ ObjFWVersionMinor
	The minor version of ObjFW.

(nullable OFString *)	+ operatingSystemName
	Returns the name of the operating system the application is running on.

(nullable OFString *)	+ operatingSystemVersion
	Returns the version of the operating system the application is running on.

(nullable OFString *)	+ wineVersion
	Returns the version of Wine the application is running on, or `nil` if not running on Wine (e.g. on Windows natively).

(nullable OFIRI *)	+ userDataIRI
	Returns the path where user data for the application can be stored.

(nullable OFIRI *)	+ userConfigIRI
	Returns the path where user configuration for the application can be stored.

(nullable OFIRI *)	+ temporaryDirectoryIRI
	Returns a path where temporary files for can be stored.

(nullable OFString *)	+ CPUVendor
	Returns the vendor of the CPU.

(nullable OFString *)	+ CPUModel
	Returns the model of the CPU.

(bool)	+ supportsMMX
	Returns whether the CPU supports MMX.

(bool)	+ supports3DNow
	Returns whether the CPU supports 3DNow!.

(bool)	+ supportsEnhanced3DNow
	Returns whether the CPU supports enhanced 3DNow!.

(bool)	+ supportsSSE
	Returns whether the CPU supports SSE.

(bool)	+ supportsSSE2
	Returns whether the CPU supports SSE2.

(bool)	+ supportsSSE3
	Returns whether the CPU supports SSE3.

(bool)	+ supportsSSSE3
	Returns whether the CPU supports SSSE3.

(bool)	+ supportsSSE41
	Returns whether the CPU supports SSE4.1.

(bool)	+ supportsSSE42
	Returns whether the CPU supports SSE4.2.

(bool)	+ supportsAVX
	Returns whether the CPU and OS support AVX.

(bool)	+ supportsAVX2
	Returns whether the CPU and OS support AVX2.

(bool)	+ supportsAESNI
	Returns whether the CPU supports AES-NI.

(bool)	+ supportsSHAExtensions
	Returns whether the CPU supports Intel SHA Extensions.

(bool)	+ supportsFusedMultiplyAdd
	Returns whether the CPU supports fused multiply-add.

(bool)	+ supportsF16C
	Returns whether the CPU supports F16C.

(bool)	+ supportsAVX512Foundation
	Returns whether the CPU and OS support AVX-512 Foundation.

(bool)	+ supportsAVX512ConflictDetectionInstructions
	Returns whether the CPU and OS support AVX-512 Conflict Detection Instructions.

(bool)	+ supportsAVX512ExponentialAndReciprocalInstructions
	Returns whether the CPU and OS support AVX-512 Exponential and Reciprocal Instructions.

(bool)	+ supportsAVX512PrefetchInstructions
	Returns whether the CPU and OS support AVX-512 Prefetch Instructions.

(bool)	+ supportsAVX512VectorLengthExtensions
	Returns whether the CPU and OS support AVX-512 Vector Length Extensions.

(bool)	+ supportsAVX512DoublewordAndQuadwordInstructions
	Returns whether the CPU and OS support AVX-512 Doubleword and Quadword Instructions.

(bool)	+ supportsAVX512ByteAndWordInstructions
	Returns whether the CPU and OS support AVX-512 Byte and Word Instructions.

(bool)	+ supportsAVX512IntegerFusedMultiplyAdd
	Returns whether the CPU and OS support AVX-512 Integer Fused Multiply-Add.

(bool)	+ supportsAVX512VectorByteManipulationInstructions
	Returns whether the CPU and OS support AVX-512 Vector Byte Manipulation Instructions.

(bool)	+ supportsAVX512VectorPopulationCountInstruction
	Returns whether the CPU and OS support the AVX-512 Vector Population Count Instruction.

(bool)	+ supportsAVX512VectorNeuralNetworkInstructions
	Returns whether the CPU and OS support AVX-512 Vector Neural Network Instructions.

(bool)	+ supportsAVX512VectorByteManipulationInstructions2
	Returns whether the CPU and OS support AVX-512 Vector Byte Manipulation Instructions 2.

(bool)	+ supportsAVX512BitAlgorithms
	Returns whether the CPU and OS support AVX-512 Bit Algorithms.

(bool)	+ supportsAVX512Float16Instructions
	Returns whether the CPU and OS support AVX-512 Float16 Instructions.

(bool)	+ supportsAVX512BFloat16Instructions
	Returns whether the CPU and OS support AVX-512 BFloat16 Instructions.

(bool)	+ supportsAltiVec
	Returns whether the CPU and OS support AltiVec.

(bool)	+ supportsLSX
	Returns whether the CPU and OS support LSX.

(bool)	+ supportsLASX
	Returns whether the CPU and OS support LASX.

(bool)	+ isWindowsNT
	Returns whether the application is running on Windows NT.

(nullable OFDictionary *)	+ networkInterfaces
	Returns the available (though not necessarily configured) network interfaces.

Class Methods inherited from OFObject
(void)	+ load
	A method which is called once when the class is loaded into the runtime.

(void)	+ unload
	A method which is called when the class is unloaded from the runtime.

(void)	+ initialize
	A method which is called the moment before the first call to the class is being made.

(instancetype)	+ alloc
	Allocates memory for an instance of the class and sets up the memory pool for the object.

(Class)	+ class
	Returns the class.

(OFString *)	+ className
	Returns the name of the class as a string.

(bool)	+ isSubclassOfClass:
	Returns a boolean whether the class is a subclass of the specified class.

(nullable Class)	+ superclass
	Returns the superclass of the class.

(bool)	+ instancesRespondToSelector:
	Checks whether instances of the class respond to a given selector.

(bool)	+ conformsToProtocol:
	Checks whether the class conforms to a given protocol.

(nullable IMP)	+ instanceMethodForSelector:
	Returns the implementation of the instance method for the specified selector.

(nullable OFMethodSignature *)	+ instanceMethodSignatureForSelector:
	Returns the method signature of the instance method for the specified selector.

(OFString *)	+ description
	Returns a description for the class, which is usually the class name.

(nullable IMP)	+ replaceClassMethod:withMethodFromClass:
	Replaces a class method with a class method from another class.

(nullable IMP)	+ replaceInstanceMethod:withMethodFromClass:
	Replaces an instance method with an instance method from another class.

(void)	+ inheritMethodsFromClass:
	Adds all methods from the specified class to the class that is the receiver.

(bool)	+ resolveClassMethod:
	Try to resolve the specified class method.

(bool)	+ resolveInstanceMethod:
	Try to resolve the specified instance method.

(id)	+ copy
	Returns the class.

Additional Inherited Members
Instance Methods inherited from OFObject
(instancetype)	- init
	Initializes an already allocated object.

(nullable OFMethodSignature *)	- methodSignatureForSelector:
	Returns the method signature for the specified selector.

(void)	- dealloc
	Deallocates the object.

(void)	- performSelector:afterDelay:
	Performs the specified selector after the specified delay.

(void)	- performSelector:withObject:afterDelay:
	Performs the specified selector with the specified object after the specified delay.

(void)	- performSelector:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.

(void)	- performSelector:withObject:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.

(void)	- performSelector:withObject:withObject:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.

(void)	- performSelector:onThread:waitUntilDone:
	Performs the specified selector on the specified thread.

(void)	- performSelector:onThread:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified object.

(void)	- performSelector:onThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.

(void)	- performSelector:onThread:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.

(void)	- performSelector:onThread:withObject:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.

(void)	- performSelectorOnMainThread:waitUntilDone:
	Performs the specified selector on the main thread.

(void)	- performSelectorOnMainThread:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified object.

(void)	- performSelectorOnMainThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.

(void)	- performSelectorOnMainThread:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.

(void)	- performSelectorOnMainThread:withObject:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.

(void)	- performSelector:onThread:afterDelay:
	Performs the specified selector on the specified thread after the specified delay.

(void)	- performSelector:onThread:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified object after the specified delay.

(void)	- performSelector:onThread:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.

(void)	- performSelector:onThread:withObject:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.

(void)	- performSelector:onThread:withObject:withObject:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.

(nullable id)	- forwardingTargetForSelector:
	This method is called when resolveClassMethod: or resolveInstanceMethod: returned false. It should return a target to which the message should be forwarded.

(void)	- doesNotRecognizeSelector:
	Handles messages which are not understood by the receiver.

Instance Methods inherited from <OFObject>
(unsigned long)	- hash
	Returns a hash for the object.

(unsigned int)	- retainCount
	Returns the retain count.

(bool)	- isProxy
	Returns whether the object is a proxy object.

(bool)	- isKindOfClass:
	Returns a boolean whether the object is of the specified kind.

(bool)	- isMemberOfClass:
	Returns a boolean whether the object is a member of the specified class.

(bool)	- respondsToSelector:
	Returns a boolean whether the object responds to the specified selector.

(nullable IMP)	- methodForSelector:
	Returns the implementation for the specified selector.

(nullable id)	- performSelector:
	Performs the specified selector.

(nullable id)	- performSelector:withObject:
	Performs the specified selector with the specified object.

(nullable id)	- performSelector:withObject:withObject:
	Performs the specified selector with the specified objects.

(nullable id)	- performSelector:withObject:withObject:withObject:
	Performs the specified selector with the specified objects.

(nullable id)	- performSelector:withObject:withObject:withObject:withObject:
	Performs the specified selector with the specified objects.

(bool)	- isEqual:
	Checks two objects for equality.

(instancetype)	- retain
	Increases the retain count.

(void)	- release
	Decreases the retain count.

(instancetype)	- autorelease
	Adds the object to the topmost autorelease pool of the thread's autorelease pool stack.

(instancetype)	- self
	Returns the receiver.

(bool)	- allowsWeakReference
	Returns whether the object allows a weak reference.

(bool)	- retainWeakReference
	Retain a weak reference to this object.

Properties inherited from OFObject
OFString *	className
	The name of the object's class.

OFString *	description
	A description for the object.

Detailed Description

A class for querying information about the system.

Method Documentation

◆ CPUModel

+ (OFString *) CPUModel

Returns the model of the CPU.

If the model could not be determined, nil is returned instead.

Returns: The model of the CPU

◆ CPUVendor

+ (OFString *) CPUVendor

Returns the vendor of the CPU.

If the vendor could not be determined, nil is returned instead.

Returns: The vendor of the CPU

◆ isWindowsNT

+ (bool) isWindowsNT

Returns whether the application is running on Windows NT.

Note: This method is only available on Windows.

Returns: Whether the application is running on Windows NT

◆ networkInterfaces

+ (nullable OFDictionary *) networkInterfaces

Returns the available (though not necessarily configured) network interfaces.

Returns: The available network interfaces

◆ numberOfCPUs

+ (size_t) numberOfCPUs

Returns the number of CPUs installed in the system.

A CPU with multiple cores counts as multiple CPUs.

If the system has no CPU, the return value is undefined.

Returns: The number of CPUs installed in the system

◆ ObjFWVersion

+ (OFString *) ObjFWVersion

The version of ObjFW.

Returns: The version of ObjFW

◆ ObjFWVersionMajor

+ (unsigned short) ObjFWVersionMajor

The major version of ObjFW.

Returns: The major version of ObjFW

◆ ObjFWVersionMinor

+ (unsigned short) ObjFWVersionMinor

The minor version of ObjFW.

Returns: The minor version of ObjFW

◆ operatingSystemName

+ (OFString *) operatingSystemName

Returns the name of the operating system the application is running on.

Returns: The name of the operating system the application is running on

◆ operatingSystemVersion

+ (OFString *) operatingSystemVersion

Returns the version of the operating system the application is running on.

Returns: The version of the operating system the application is running on

◆ pageSize

+ (size_t) pageSize

Returns the size of a page.

Returns: The size of a page

◆ supports3DNow

+ (bool) supports3DNow

Returns whether the CPU supports 3DNow!.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU supports 3DNow!

◆ supportsAESNI

+ (bool) supportsAESNI

Returns whether the CPU supports AES-NI.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU supports AES-NI

◆ supportsAltiVec

+ (bool) supportsAltiVec

Returns whether the CPU and OS support AltiVec.

Note: This method is only available on PowerPC and PowerPC 64.

Returns: Whether the CPU and OS support AltiVec

◆ supportsAVX

+ (bool) supportsAVX

Returns whether the CPU and OS support AVX.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU and OS support AVX

◆ supportsAVX2

+ (bool) supportsAVX2

Returns whether the CPU and OS support AVX2.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU and OS support AVX2

◆ supportsAVX512BFloat16Instructions

+ (bool) supportsAVX512BFloat16Instructions

Returns whether the CPU and OS support AVX-512 BFloat16 Instructions.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU and OS support AVX-512 BFloat16 Instructions

◆ supportsAVX512BitAlgorithms

+ (bool) supportsAVX512BitAlgorithms

Returns whether the CPU and OS support AVX-512 Bit Algorithms.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU and OS support AVX-512 Bit Algorithms

◆ supportsAVX512ByteAndWordInstructions

+ (bool) supportsAVX512ByteAndWordInstructions

Returns whether the CPU and OS support AVX-512 Byte and Word Instructions.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU and OS support AVX-512 Byte and Word Instructions

◆ supportsAVX512ConflictDetectionInstructions

+ (bool) supportsAVX512ConflictDetectionInstructions

Returns whether the CPU and OS support AVX-512 Conflict Detection Instructions.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU and OS support AVX-512 Conflict Detection Instructions

◆ supportsAVX512DoublewordAndQuadwordInstructions

+ (bool) supportsAVX512DoublewordAndQuadwordInstructions

Returns whether the CPU and OS support AVX-512 Doubleword and Quadword Instructions.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU and OS support AVX-512 Doubleword and Quadword Instructions

◆ supportsAVX512ExponentialAndReciprocalInstructions

+ (bool) supportsAVX512ExponentialAndReciprocalInstructions

Returns whether the CPU and OS support AVX-512 Exponential and Reciprocal Instructions.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU and OS support AVX-512 Exponential and Reciprocal Instructions

◆ supportsAVX512Float16Instructions

+ (bool) supportsAVX512Float16Instructions

Returns whether the CPU and OS support AVX-512 Float16 Instructions.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU and OS support AVX-512 Float16 Instructions

◆ supportsAVX512Foundation

+ (bool) supportsAVX512Foundation

Returns whether the CPU and OS support AVX-512 Foundation.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU and OS support AVX-512 Foundation

◆ supportsAVX512IntegerFusedMultiplyAdd

+ (bool) supportsAVX512IntegerFusedMultiplyAdd

Returns whether the CPU and OS support AVX-512 Integer Fused Multiply-Add.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU and OS support AVX-512 Integer Fused Multiply-Add

◆ supportsAVX512PrefetchInstructions

+ (bool) supportsAVX512PrefetchInstructions

Returns whether the CPU and OS support AVX-512 Prefetch Instructions.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU and OS support AVX-512 Prefetch Instructions

◆ supportsAVX512VectorByteManipulationInstructions

+ (bool) supportsAVX512VectorByteManipulationInstructions

Returns whether the CPU and OS support AVX-512 Vector Byte Manipulation Instructions.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU and OS support AVX-512 Vector Byte Manipulation Instructions

◆ supportsAVX512VectorByteManipulationInstructions2

+ (bool) supportsAVX512VectorByteManipulationInstructions2

Returns whether the CPU and OS support AVX-512 Vector Byte Manipulation Instructions 2.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU and OS support AVX-512 Vector Byte Manipulation Instructions 2

◆ supportsAVX512VectorLengthExtensions

+ (bool) supportsAVX512VectorLengthExtensions

Returns whether the CPU and OS support AVX-512 Vector Length Extensions.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU and OS support AVX-512 Vector Length Extensions

◆ supportsAVX512VectorNeuralNetworkInstructions

+ (bool) supportsAVX512VectorNeuralNetworkInstructions

Returns whether the CPU and OS support AVX-512 Vector Neural Network Instructions.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU and OS support AVX-512 Vector Neural Network Instructions

◆ supportsAVX512VectorPopulationCountInstruction

+ (bool) supportsAVX512VectorPopulationCountInstruction

Returns whether the CPU and OS support the AVX-512 Vector Population Count Instruction.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU and OS support AVX-512 the Vector Population Count Instruction

◆ supportsEnhanced3DNow

+ (bool) supportsEnhanced3DNow

Returns whether the CPU supports enhanced 3DNow!.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU supports enhanced 3DNow!

◆ supportsF16C

+ (bool) supportsF16C

Returns whether the CPU supports F16C.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU supports F16C

◆ supportsFusedMultiplyAdd

+ (bool) supportsFusedMultiplyAdd

Returns whether the CPU supports fused multiply-add.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU supports fused multiply-add

◆ supportsLASX

+ (bool) supportsLASX

Returns whether the CPU and OS support LASX.

Note: This method is only available on LoongArch 64!

Returns: Whether the CPU and OS support LASX

◆ supportsLSX

+ (bool) supportsLSX

Returns whether the CPU and OS support LSX.

Note: This method is only available on LoongArch 64!

Returns: Whether the CPU and OS support LSX

◆ supportsMMX

+ (bool) supportsMMX

Returns whether the CPU supports MMX.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU supports MMX

◆ supportsSHAExtensions

+ (bool) supportsSHAExtensions

Returns whether the CPU supports Intel SHA Extensions.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU supports Intel SHA Extensions

◆ supportsSSE

+ (bool) supportsSSE

Returns whether the CPU supports SSE.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU supports SSE

◆ supportsSSE2

+ (bool) supportsSSE2

Returns whether the CPU supports SSE2.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU supports SSE2

◆ supportsSSE3

+ (bool) supportsSSE3

Returns whether the CPU supports SSE3.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU supports SSE3

◆ supportsSSE41

+ (bool) supportsSSE41

Returns whether the CPU supports SSE4.1.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU supports SSE4.1

◆ supportsSSE42

+ (bool) supportsSSE42

Returns whether the CPU supports SSE4.2.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU supports SSE4.2

◆ supportsSSSE3

+ (bool) supportsSSSE3

Returns whether the CPU supports SSSE3.

Note: This method is only available on AMD64 and x86.

Returns: Whether the CPU supports SSSE3

◆ temporaryDirectoryIRI

+ (OFIRI *) temporaryDirectoryIRI

Returns a path where temporary files for can be stored.

If possible, returns a temporary directory for the user, otherwise returns a global temporary directory.

On UNIX systems, this adheres to the XDG Base Directory specification and returns /tmp if XDG_RUNTIME_DIR is not set.
On macOS and iOS, this uses _CS_DARWIN_USER_TEMP_DIR, falling back to /tmp if this fails.
On Windows, it uses GetTempPath.
On Haiku, it uses the B_SYSTEM_TEMP_DIRECTORY directory. On AmigaOS and MorphOS, it returns T:.

Returns: A path where temporary files can be stored

◆ userConfigIRI

+ (OFIRI *) userConfigIRI

Returns the path where user configuration for the application can be stored.

On UNIX systems, this adheres to the XDG Base Directory specification.
On macOS and iOS, it uses the Preferences directory inside of NSLibraryDirectory directory.
On Windows, it uses the APPDATA environment variable.
On Haiku, it uses the B_USER_SETTINGS_DIRECTORY directory. On AmigaOS and MorphOS, it returns PROGDIR:.

Returns: The path where user configuration for the application can be stored

◆ userDataIRI

+ (OFIRI *) userDataIRI

Returns the path where user data for the application can be stored.

On UNIX systems, this adheres to the XDG Base Directory specification.
On macOS and iOS, it uses the NSApplicationSupportDirectory directory.
On Windows, it uses the APPDATA environment variable.
On Haiku, it uses the B_USER_SETTINGS_DIRECTORY directory.
On AmigaOS and MorphOS, it returns PROGDIR:.

Returns: The path where user data for the application can be stored

◆ wineVersion

+ (nullable OFString *) wineVersion

Returns the version of Wine the application is running on, or nil if not running on Wine (e.g. on Windows natively).

Note: This is only available on Windows.

Returns: The version of Wine the application is running on, or nil if not running on Wine (e.g. on Windows natively)

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

src/OFSystemInfo.h
src/OFSystemInfo.m

Class Methods

Additional Inherited Members