CoreMisc.cpp File Reference

#include "Misc/CoreMisc.h"
#include "Misc/Parse.h"
#include "Misc/CommandLine.h"
#include "Containers/Ticker.h"
#include "HAL/IConsoleManager.h"
#include "HAL/PlatformTime.h"
#include "Misc/App.h"
#include "Misc/LazySingleton.h"
#include "Misc/OutputDeviceError.h"
#include "Misc/ScopeLock.h"
#include "Misc/ScopeRWLock.h"
#include "CoreGlobals.h"
#include "Templates/RefCounting.h"
#include "Misc/ConfigCacheIni.h"
#include "Modules/ModuleManager.h"
#include "DerivedDataCacheModule.h"
#include "Interfaces/ITargetPlatformManagerModule.h"
#include "Interfaces/ITargetPlatform.h"

Typedefs
using	FSelfRegisteredExecArray = TArray< FSelfRegisteringExec *, TInlineAllocator< 8 > >

Functions
	DEFINE_LOG_CATEGORY (LogSHA)
	DEFINE_LOG_CATEGORY (LogStats)
	DEFINE_LOG_CATEGORY (LogStreaming)
	DEFINE_LOG_CATEGORY (LogInit)
	DEFINE_LOG_CATEGORY (LogExit)
	DEFINE_LOG_CATEGORY (LogExec)
	DEFINE_LOG_CATEGORY (LogScript)
	DEFINE_LOG_CATEGORY (LogLocalization)
	DEFINE_LOG_CATEGORY (LogLongPackageNames)
	DEFINE_LOG_CATEGORY (LogProcess)
	DEFINE_LOG_CATEGORY (LogLoad)
	DEFINE_LOG_CATEGORY (LogCore)
FTransactionallySafeCriticalSection *	GetExecRegistryLock ()
FSelfRegisteredExecArray &	GetExecRegistry ()
FDerivedDataCacheInterface *	GetDerivedDataCache ()
FDerivedDataCacheInterface &	GetDerivedDataCacheRef ()
FDerivedDataCacheInterface *	TryGetDerivedDataCache ()
class ITargetPlatformManagerModule *	GetTargetPlatformManager (bool bFailOnInitErrors)
class ITargetPlatformManagerModule &	GetTargetPlatformManagerRef ()
bool	WillNeedAudioVisualData ()
bool	IsServerForOnlineSubsystems (FName WorldContextHandle)
void	SetIsServerForOnlineSubsystemsDelegate (FQueryIsRunningServer NewDelegate)
bool CORE_API	StringHasBadDashes (const TCHAR *Str)
void	EnsureRetrievingVTablePtrDuringCtor (const TCHAR *CtorSignature)
void	NotifyLoadingStateChanged (bool bState, const TCHAR *Message)

Variables
FQueryIsRunningServer	GIsServerDelegate
bool	GIsRetrievingVTablePtr = false
int32	GEnsureOnNANDiagnostic = false

Typedef Documentation

FSelfRegisteredExecArray

using FSelfRegisteredExecArray = TArray<FSelfRegisteringExec*, TInlineAllocator<8> >

Function Documentation

DEFINE_LOG_CATEGORY() [1/12]

DEFINE_LOG_CATEGORY

(

LogCore

)

DEFINE_LOG_CATEGORY() [2/12]

DEFINE_LOG_CATEGORY

(

LogExec

)

DEFINE_LOG_CATEGORY() [3/12]

DEFINE_LOG_CATEGORY

(

LogExit

)

DEFINE_LOG_CATEGORY() [4/12]

DEFINE_LOG_CATEGORY

(

LogInit

)

DEFINE_LOG_CATEGORY() [5/12]

DEFINE_LOG_CATEGORY

(

LogLoad

)

DEFINE_LOG_CATEGORY() [6/12]

DEFINE_LOG_CATEGORY

(

LogLocalization

)

DEFINE_LOG_CATEGORY() [7/12]

DEFINE_LOG_CATEGORY

(

LogLongPackageNames

)

DEFINE_LOG_CATEGORY() [8/12]

DEFINE_LOG_CATEGORY

(

LogProcess

)

DEFINE_LOG_CATEGORY() [9/12]

DEFINE_LOG_CATEGORY

(

LogScript

)

DEFINE_LOG_CATEGORY() [10/12]

DEFINE_LOG_CATEGORY

(

LogSHA

)

For FConfigFile in appInit

DEFINE_LOG_CATEGORY() [11/12]

DEFINE_LOG_CATEGORY

(

LogStats

)

DEFINE_LOG_CATEGORY() [12/12]

DEFINE_LOG_CATEGORY

(

LogStreaming

)

EnsureRetrievingVTablePtrDuringCtor()

void EnsureRetrievingVTablePtrDuringCtor

(

const TCHAR *

CtorSignature

)

This class can be used to Tag an execution context but only in case it has not already been tagged It is usually used for the IsInRendering/GamethreadFunctions.

Parameters

CtorSignature	InTag the Tag to use Ensures that current thread is during retrieval of vtable ptr of some UClass.
CtorSignature	The signature of the ctor currently running to construct proper error message.

GetDerivedDataCache()

FDerivedDataCacheInterface * GetDerivedDataCache

(

)

Returns the derived data cache interface if it is available, otherwise null.

GetDerivedDataCacheRef()

FDerivedDataCacheInterface & GetDerivedDataCacheRef

(

)

Returns the derived data cache interface, or fatal error if it is not available.

GetExecRegistry()

FSelfRegisteredExecArray & GetExecRegistry

(

)

GetExecRegistryLock()

FTransactionallySafeCriticalSection * GetExecRegistryLock

(

)

GetTargetPlatformManager()

class ITargetPlatformManagerModule * GetTargetPlatformManager

(

bool

bFailOnInitErrors = true

)

Return the Target Platform Manager interface, if it is available, otherwise return nullptr.

Parameters

bFailOnInitErrors

If true (default) and errors occur during init of the TPM, an error will be logged and the process may terminate, otherwise will return whether there was an error or not.

Returns

The Target Platform Manager interface, if it is available, otherwise return nullptr.

GetTargetPlatformManagerRef()

class ITargetPlatformManagerModule & GetTargetPlatformManagerRef

(

)

Return the Target Platform Manager interface, fatal error if it is not available.

IsServerForOnlineSubsystems()

bool IsServerForOnlineSubsystems

(

FName

WorldContextHandle

)

Returns

true if there is a running game world that is a server (including listen servers), false otherwise

NotifyLoadingStateChanged()

void NotifyLoadingStateChanged	(	bool	bState,
		const TCHAR *	Message
	)

Boot loading timers

SetIsServerForOnlineSubsystemsDelegate()

void SetIsServerForOnlineSubsystemsDelegate

(

FQueryIsRunningServer

NewDelegate

)

Sets the delegate used for IsServerForOnlineSubsystems

StringHasBadDashes()

bool CORE_API StringHasBadDashes

(

const TCHAR *

Str

)

TryGetDerivedDataCache()

FDerivedDataCacheInterface * TryGetDerivedDataCache

(

)

Returns the derived data cache interface if it is available and initialized, otherwise null.

WillNeedAudioVisualData()

bool WillNeedAudioVisualData

(

)

Return true if we are currently in a commandlet is targeting platforms with AV requirements (ie not a server) or we are not targetingother platforms, and the current platform needs to render (CanEverRender())

Variable Documentation

GEnsureOnNANDiagnostic

int32 GEnsureOnNANDiagnostic = false

GIsRetrievingVTablePtr

bool GIsRetrievingVTablePtr = false

true when we are retrieving VTablePtr from UClass

GIsServerDelegate

FQueryIsRunningServer GIsServerDelegate