ApplePlatformMisc.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================================
    ApplePlatformMisc.h: Apple platform misc functions
==============================================================================================*/
 
#pragma once
#include "GenericPlatform/GenericPlatformMisc.h"
#if PLATFORM_MAC
#include "Mac/MacSystemIncludes.h"
#else
#include "IOS/IOSSystemIncludes.h"
#endif
 
#ifndef APPLE_PROFILING_ENABLED
#define APPLE_PROFILING_ENABLED (UE_BUILD_DEBUG | UE_BUILD_DEVELOPMENT)
#endif
 
#ifndef WITH_IOS_SIMULATOR
#define WITH_IOS_SIMULATOR 0
#endif
 
#define UE_DEBUG_BREAK_IMPL() PLATFORM_BREAK()
 
#ifdef __OBJC__
#if !__has_feature(objc_arc)
 
class FScopeAutoreleasePool
{
public:
 
    FScopeAutoreleasePool()
    {
        Pool = [[NSAutoreleasePool alloc] init];
    }
 
    ~FScopeAutoreleasePool()
    {
        [Pool release];
    }
 
private:
 
    NSAutoreleasePool*  Pool;
};
 
#define SCOPED_AUTORELEASE_POOL const FScopeAutoreleasePool PREPROCESSOR_JOIN(Pool,__LINE__);
 
#endif // !__has_feature(objc_arc)
#endif // __OBJC__
 
struct CORE_API FApplePlatformMisc : public FGenericPlatformMisc
{
    static void PlatformInit();
 
    UE_DEPRECATED(4.21, "void FPlatformMisc::GetEnvironmentVariable(Name, Result, Length) is deprecated. Use FString FPlatformMisc::GetEnvironmentVariable(Name) instead.")
    static void GetEnvironmentVariable(const TCHAR* VariableName, TCHAR* Result, int32 ResultLength);
 
    static FString GetEnvironmentVariable(const TCHAR* VariableName);
 
#if !UE_BUILD_SHIPPING
    static bool IsDebuggerPresent();
#endif
 
    UE_FORCEINLINE_HINT static void MemoryBarrier()
    {
        __sync_synchronize();
    }
 
    static void LocalPrint(const TCHAR* Message);
    static const TCHAR* GetSystemErrorMessage(TCHAR* OutBuffer, int32 BufferCount, int32 Error);
    static uint32 GetLastError();
    static int32 NumberOfCores();
    
    static bool SupportsMultithreadedFileHandles()
    {
        // ApplePlatformFile currently uses thread-local lists that can close filehandles arbitrarily and reopen them at need, so filehandles are not transferrable between threads
        return false;
    }
 
    static void CreateGuid(struct FGuid& Result);
    static TArray<uint8> GetSystemFontBytes();
    static FString GetDefaultLocale();
    static FString GetDefaultLanguage();
    static FString GetLocalCurrencyCode();
    static FString GetLocalCurrencySymbol();
 
    static bool IsOSAtLeastVersion(const uint32 MacOSVersion[3], const uint32 IOSVersion[3], const uint32 TVOSVersion[3]);
 
#if APPLE_PROFILING_ENABLED
    static void BeginNamedEvent(const struct FColor& Color, const TCHAR* Text);
    static void BeginNamedEvent(const struct FColor& Color, const ANSICHAR* Text);
    static void EndNamedEvent();
#endif
 
    static void* CreateAutoreleasePool();
    static void ReleaseAutoreleasePool(void *Pool);
    
    static CORE_API void SetEnvironmentVar(const TCHAR* InVariableName, const TCHAR* Value);
};