2019-01-02 14:54:39 -05:00
|
|
|
// Copyright 1998-2019 Epic Games, Inc. All Rights Reserved.
|
2014-07-17 13:49:42 -04:00
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
|
Copying //UE4/Dev-Build to //UE4/Dev-Main (Source: //UE4/Dev-Build @ 3209340)
#lockdown Nick.Penwarden
#rb none
==========================
MAJOR FEATURES + CHANGES
==========================
Change 3209340 on 2016/11/23 by Ben.Marsh
Convert UE4 codebase to an "include what you use" model - where every header just includes the dependencies it needs, rather than every source file including large monolithic headers like Engine.h and UnrealEd.h.
Measured full rebuild times around 2x faster using XGE on Windows, and improvements of 25% or more for incremental builds and full rebuilds on most other platforms.
* Every header now includes everything it needs to compile.
* There's a CoreMinimal.h header that gets you a set of ubiquitous types from Core (eg. FString, FName, TArray, FVector, etc...). Most headers now include this first.
* There's a CoreTypes.h header that sets up primitive UE4 types and build macros (int32, PLATFORM_WIN64, etc...). All headers in Core include this first, as does CoreMinimal.h.
* Every .cpp file includes its matching .h file first.
* This helps validate that each header is including everything it needs to compile.
* No engine code includes a monolithic header such as Engine.h or UnrealEd.h any more.
* You will get a warning if you try to include one of these from the engine. They still exist for compatibility with game projects and do not produce warnings when included there.
* There have only been minor changes to our internal games down to accommodate these changes. The intent is for this to be as seamless as possible.
* No engine code explicitly includes a precompiled header any more.
* We still use PCHs, but they're force-included on the compiler command line by UnrealBuildTool instead. This lets us tune what they contain without breaking any existing include dependencies.
* PCHs are generated by a tool to get a statistical amount of coverage for the source files using it, and I've seeded the new shared PCHs to contain any header included by > 15% of source files.
Tool used to generate this transform is at Engine\Source\Programs\IncludeTool.
[CL 3209342 by Ben Marsh in Main branch]
2016-11-23 15:48:37 -05:00
|
|
|
#include "CoreMinimal.h"
|
|
|
|
|
#include "IDirectoryWatcher.h"
|
2014-07-17 13:49:42 -04:00
|
|
|
#include <sys/inotify.h>
|
|
|
|
|
|
|
|
|
|
#define EVENT_SIZE ( sizeof (struct inotify_event) )
|
2015-05-13 11:15:57 -04:00
|
|
|
#define EVENT_BUF_LEN ( 1024 * ( EVENT_SIZE + 16 ) )
|
2014-07-17 13:49:42 -04:00
|
|
|
|
|
|
|
|
class FDirectoryWatchRequestLinux
|
|
|
|
|
{
|
|
|
|
|
public:
|
2015-05-13 11:15:57 -04:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Template class to support FString to TValueType maps with a case sensitive key
|
|
|
|
|
*/
|
|
|
|
|
template<typename TValueType>
|
|
|
|
|
struct FCaseSensitiveLookupKeyFuncs : BaseKeyFuncs<TValueType, FString>
|
|
|
|
|
{
|
|
|
|
|
static FORCEINLINE const FString& GetSetKey(const TPair<FString, TValueType>& Element)
|
|
|
|
|
{
|
|
|
|
|
return Element.Key;
|
|
|
|
|
}
|
|
|
|
|
static FORCEINLINE bool Matches(const FString& A, const FString& B)
|
|
|
|
|
{
|
|
|
|
|
return A.Equals(B, ESearchCase::CaseSensitive);
|
|
|
|
|
}
|
|
|
|
|
static FORCEINLINE uint32 GetKeyHash(const FString& Key)
|
|
|
|
|
{
|
|
|
|
|
return FCrc::StrCrc32<TCHAR>(*Key);
|
|
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
2014-07-17 13:49:42 -04:00
|
|
|
FDirectoryWatchRequestLinux();
|
|
|
|
|
virtual ~FDirectoryWatchRequestLinux();
|
|
|
|
|
|
|
|
|
|
/** Sets up the directory handle and request information */
|
2015-06-25 20:17:42 -04:00
|
|
|
bool Init(const FString& InDirectory, uint32 Flags);
|
2014-07-17 13:49:42 -04:00
|
|
|
|
|
|
|
|
/** Adds a delegate to get fired when the directory changes */
|
2019-01-08 09:58:31 -05:00
|
|
|
FDelegateHandle AddDelegate( const IDirectoryWatcher::FDirectoryChanged& InDelegate, uint32 Flags );
|
2014-07-17 13:49:42 -04:00
|
|
|
/** Removes a delegate to get fired when the directory changes */
|
2015-01-08 09:29:27 -05:00
|
|
|
bool RemoveDelegate( FDelegateHandle InHandle );
|
2014-07-17 13:49:42 -04:00
|
|
|
/** Returns true if this request has any delegates listening to directory changes */
|
|
|
|
|
bool HasDelegates() const;
|
|
|
|
|
/** Prepares the request for deletion */
|
|
|
|
|
void EndWatchRequest();
|
|
|
|
|
/** Triggers all pending file change notifications */
|
|
|
|
|
void ProcessPendingNotifications();
|
|
|
|
|
|
|
|
|
|
private:
|
|
|
|
|
|
2015-05-13 11:15:57 -04:00
|
|
|
/** Adds watches for all files (and subdirectories) in a directory. */
|
|
|
|
|
void WatchDirectoryTree(const FString & RootAbsolutePath);
|
|
|
|
|
|
|
|
|
|
/** Removes all watches from a */
|
|
|
|
|
void UnwatchDirectoryTree(const FString & RootAbsolutePath);
|
|
|
|
|
|
2014-08-05 19:12:20 -04:00
|
|
|
FString Directory;
|
|
|
|
|
|
|
|
|
|
bool bRunning;
|
2014-07-17 13:49:42 -04:00
|
|
|
bool bEndWatchRequestInvoked;
|
|
|
|
|
|
2015-06-25 20:17:42 -04:00
|
|
|
/** Whether or not watch subtree. */
|
|
|
|
|
bool bWatchSubtree;
|
|
|
|
|
|
2014-08-05 19:12:20 -04:00
|
|
|
int FileDescriptor;
|
2015-05-13 11:15:57 -04:00
|
|
|
|
|
|
|
|
/** Mapping from watch descriptors to their path names */
|
|
|
|
|
TMap<int32, FString> WatchDescriptorsToPaths;
|
|
|
|
|
|
|
|
|
|
/** Mapping from paths to watch descriptors */
|
|
|
|
|
TMap<FString, int32, FDefaultSetAllocator, FCaseSensitiveLookupKeyFuncs<int32>> PathsToWatchDescriptors;
|
|
|
|
|
|
2014-08-05 19:12:20 -04:00
|
|
|
int NotifyFilter;
|
2014-07-17 13:49:42 -04:00
|
|
|
|
2019-01-08 09:58:31 -05:00
|
|
|
/** A delegate with its corresponding IDirectoryWatcher::WatchOptions flags */
|
|
|
|
|
typedef TPair<IDirectoryWatcher::FDirectoryChanged, uint32> FWatchDelegate;
|
|
|
|
|
TArray<FWatchDelegate> Delegates;
|
|
|
|
|
/** Each FFileChangeData tracks whether it is a directory or not */
|
|
|
|
|
TArray<TPair<FFileChangeData, bool>> FileChanges;
|
2014-07-17 13:49:42 -04:00
|
|
|
|
2014-08-05 19:12:20 -04:00
|
|
|
void Shutdown();
|
|
|
|
|
void ProcessChanges();
|
2014-07-17 13:49:42 -04:00
|
|
|
};
|