Files
UnrealEngineUWP/Engine/Source/Editor/UnrealEd/Private/EditorTransaction.cpp
Julien StJean 2eba3b5a65 Improved the performance of the TypedElementSelectionSet Selection.
From 119 Seconds to 269 ms when measuring the time redo a large marquee selection (30 384 static mesh instances).

#jira UE-148888
#preflight 627146b75e6ce673f443ccea

[CL 20393379 by Julien StJean in ue5-main branch]
2022-05-27 10:44:22 -04:00

1743 lines
51 KiB
C++

// Copyright Epic Games, Inc. All Rights Reserved.
#include "CoreMinimal.h"
#include "Misc/MemStack.h"
#include "UObject/Object.h"
#include "UObject/Package.h"
#include "Algo/Find.h"
#include "Algo/Reverse.h"
#include "Engine/Level.h"
#include "Components/ActorComponent.h"
#include "Model.h"
#include "Editor/Transactor.h"
#include "Editor/TransBuffer.h"
#include "Components/ModelComponent.h"
#include "Engine/BlueprintGeneratedClass.h"
#include "BSPOps.h"
#include "Engine/DataTable.h"
DEFINE_LOG_CATEGORY_STATIC(LogEditorTransaction, Log, All);
/*-----------------------------------------------------------------------------
A single transaction.
-----------------------------------------------------------------------------*/
FTransaction::FObjectRecord::FObjectRecord(FTransaction* Owner, UObject* InObject, TUniquePtr<FChange> InCustomChange, FScriptArray* InArray, int32 InIndex, int32 InCount, int32 InOper, int32 InElementSize, uint32 InElementAlignment, STRUCT_DC InDefaultConstructor, STRUCT_AR InSerializer, STRUCT_DTOR InDestructor)
: Object ( InObject )
, CustomChange ( MoveTemp( InCustomChange ) )
, Array ( InArray )
, Index ( InIndex )
, Count ( InCount )
, Oper ( InOper )
, ElementSize ( InElementSize )
, ElementAlignment ( InElementAlignment )
, DefaultConstructor ( InDefaultConstructor )
, Serializer ( InSerializer )
, Destructor ( InDestructor )
{
// Blueprint compile-in-place can alter class layout so use tagged serialization for objects relying on a UBlueprint's Class
if (UBlueprintGeneratedClass* Class = Cast<UBlueprintGeneratedClass>(InObject->GetClass()))
{
bWantsBinarySerialization = false;
}
// Data tables can contain user structs, so it's unsafe to use binary
if (UDataTable* DataTable = Cast<UDataTable>(InObject))
{
bWantsBinarySerialization = false;
}
// Update any sub-object caches for use by ARO (to keep sub-objects alive during GC)
UObject* CurrentObject = Object.Get();
checkSlow(CurrentObject == InObject);
// Don't bother saving the object state if we have a custom change which can perform the undo operation
if( CustomChange.IsValid() )
{
// @todo mesheditor debug
//GWarn->Logf( TEXT( "------------ Saved Undo Change ------------" ) );
//CustomChange->PrintToLog( *GWarn );
//GWarn->Logf( TEXT( "-------------------------------------------" ) );
}
else
{
SerializedObject.SetObject(CurrentObject);
FWriter Writer( SerializedObject, bWantsBinarySerialization );
SerializeContents( Writer, Oper );
}
}
void FTransaction::FObjectRecord::SerializeContents( FArchive& Ar, int32 InOper )
{
if( Array )
{
const bool bWasArIgnoreOuterRef = Ar.ArIgnoreOuterRef;
if (Object.IsSubObjectReference())
{
Ar.ArIgnoreOuterRef = true;
}
UObject* CurrentObject = Object.Get();
//UE_LOG( LogEditorTransaction, Log, TEXT("Array %s %i*%i: %i"), CurrentObject ? *CurrentObject->GetFullName() : TEXT("Invalid Object"), Index, ElementSize, InOper);
check((SIZE_T)Array >= (SIZE_T)CurrentObject + sizeof(UObject));
check((SIZE_T)Array + sizeof(FScriptArray) <= (SIZE_T)CurrentObject + CurrentObject->GetClass()->GetPropertiesSize());
check(ElementSize!=0);
check(DefaultConstructor!=NULL);
check(Serializer!=NULL);
check(Index>=0);
check(Count>=0);
if( InOper==1 )
{
// "Saving add order" or "Undoing add order" or "Redoing remove order".
if( Ar.IsLoading() )
{
checkSlow(Index+Count<=Array->Num());
for( int32 i=Index; i<Index+Count; i++ )
{
Destructor( (uint8*)Array->GetData() + i*ElementSize );
}
Array->Remove( Index, Count, ElementSize, ElementAlignment );
}
}
else
{
// "Undo/Redo Modify" or "Saving remove order" or "Undoing remove order" or "Redoing add order".
if( InOper==-1 && Ar.IsLoading() )
{
Array->InsertZeroed( Index, Count, ElementSize, ElementAlignment );
for( int32 i=Index; i<Index+Count; i++ )
{
DefaultConstructor( (uint8*)Array->GetData() + i*ElementSize );
}
}
// Serialize changed items.
check(Index+Count<=Array->Num());
for( int32 i=Index; i<Index+Count; i++ )
{
Serializer( Ar, (uint8*)Array->GetData() + i*ElementSize );
}
}
Ar.ArIgnoreOuterRef = bWasArIgnoreOuterRef;
}
else
{
//UE_LOG(LogEditorTransaction, Log, TEXT("Object %s"), *Object.Get()->GetFullName());
check(Index==0);
check(ElementSize==0);
check(DefaultConstructor==NULL);
check(Serializer==NULL);
SerializeObject( Ar );
}
}
void FTransaction::FObjectRecord::SerializeObject( FArchive& Ar )
{
check(!Array);
UObject* CurrentObject = Object.Get();
if (CurrentObject)
{
const bool bWasArIgnoreOuterRef = Ar.ArIgnoreOuterRef;
if (Object.IsSubObjectReference())
{
Ar.ArIgnoreOuterRef = true;
}
CurrentObject->Serialize(Ar);
Ar.ArIgnoreOuterRef = bWasArIgnoreOuterRef;
}
}
void FTransaction::FObjectRecord::Restore( FTransaction* Owner )
{
// only used by FMatineeTransaction:
if( !bRestored )
{
bRestored = true;
check(!Owner->bFlip);
check(!CustomChange.IsValid());
FReader Reader( Owner, SerializedObject, bWantsBinarySerialization );
SerializeContents( Reader, Oper );
}
}
void FTransaction::FObjectRecord::Save(FTransaction* Owner)
{
// if record has a custom change, no need to do anything here
if( CustomChange.IsValid() )
{
return;
}
// common undo/redo path, before applying undo/redo buffer we save current state:
check(Owner->bFlip);
if (!bRestored)
{
SerializedObjectFlip.Reset();
UObject* CurrentObject = Object.Get();
if (CurrentObject)
{
SerializedObjectFlip.SetObject(CurrentObject);
}
FWriter Writer(SerializedObjectFlip, bWantsBinarySerialization);
SerializeContents(Writer, -Oper);
}
}
void FTransaction::FObjectRecord::Load(FTransaction* Owner)
{
// common undo/redo path, we apply the saved state and then swap it for the state we cached in ::Save above
check(Owner->bFlip);
if (!bRestored)
{
bRestored = true;
if (CustomChange.IsValid())
{
if (CustomChange->HasExpired(Object.Get()) == false) // skip expired changes
{
if (CustomChange->GetChangeType() == FChange::EChangeStyle::InPlaceSwap)
{
TUniquePtr<FChange> InvertedChange = CustomChange->Execute(Object.Get());
ensure(InvertedChange->GetChangeType() == FChange::EChangeStyle::InPlaceSwap);
CustomChange = MoveTemp(InvertedChange);
}
else
{
bool bIsRedo = (Owner->Inc == 1);
if (bIsRedo)
{
CustomChange->Apply(Object.Get());
}
else
{
CustomChange->Revert(Object.Get());
}
}
}
}
else
{
// When objects are created outside the transaction system we can end up
// finding them but not having any data for them, so don't serialize
// when that happens:
if (SerializedObject.Data.Num() > 0)
{
FReader Reader(Owner, SerializedObject, bWantsBinarySerialization);
SerializeContents(Reader, Oper);
}
SerializedObject.Swap(SerializedObjectFlip);
}
Oper *= -1;
}
}
void FTransaction::FObjectRecord::Finalize( FTransaction* Owner, TSharedPtr<ITransactionObjectAnnotation>& OutFinalizedObjectAnnotation )
{
OutFinalizedObjectAnnotation.Reset();
if (Array)
{
// Can only diff objects
return;
}
if (!bFinalized)
{
bFinalized = true;
UObject* CurrentObject = Object.Get();
if (CurrentObject)
{
// Serialize the object so we can diff it
FSerializedObject CurrentSerializedObject;
{
CurrentSerializedObject.SetObject(CurrentObject);
OutFinalizedObjectAnnotation = CurrentSerializedObject.ObjectAnnotation;
FWriter Writer(CurrentSerializedObject, bWantsBinarySerialization);
SerializeObject(Writer);
}
// Diff against the object state when the transaction started
Diff(Owner, SerializedObject, CurrentSerializedObject, DeltaChange);
// If we have a previous snapshot then we need to consider that part of the diff for the finalized object, as systems may
// have been tracking delta-changes between snapshots and this finalization will need to account for those changes too
if (bSnapshot)
{
Diff(Owner, SerializedObjectSnapshot, CurrentSerializedObject, DeltaChange, /*bFullDiff*/false);
}
SerializedObjectFlip.Swap(CurrentSerializedObject);
}
// Clear out any snapshot data now as we won't be getting any more snapshot requests once finalized
bSnapshot = false;
SerializedObjectSnapshot.Reset();
}
}
void FTransaction::FObjectRecord::Snapshot( FTransaction* Owner, TArrayView<const FProperty*> Properties )
{
if (Array)
{
// Can only diff objects
return;
}
if (bFinalized)
{
// Cannot snapshot once finalized
return;
}
UObject* CurrentObject = Object.Get();
if (CurrentObject)
{
// Serialize the object so we can diff it
FSerializedObject CurrentSerializedObject;
{
CurrentSerializedObject.SetObject(CurrentObject);
FWriter Writer(CurrentSerializedObject, bWantsBinarySerialization, Properties);
// although it would be preferable to use SerializeScriptProperties, this cause a false diff between the first snapshot and the base object
// since they were serialized with different algo and we don't record enough context to make the comparison appropriately
SerializeObject(Writer);
}
// Diff against the correct serialized data depending on whether we already had a snapshot
const FSerializedObject& InitialSerializedObject = bSnapshot ? SerializedObjectSnapshot : SerializedObject;
FTransactionObjectDeltaChange SnapshotDeltaChange;
Diff(Owner, InitialSerializedObject, CurrentSerializedObject, SnapshotDeltaChange, /*bFullDiff*/false);
// Update the snapshot data for next time
bSnapshot = true;
SerializedObjectSnapshot.Swap(CurrentSerializedObject);
TSharedPtr<ITransactionObjectAnnotation> ChangedObjectTransactionAnnotation = SerializedObjectSnapshot.ObjectAnnotation;
// Notify any listeners of this change
if (SnapshotDeltaChange.HasChanged() || ChangedObjectTransactionAnnotation.IsValid())
{
CurrentObject->PostTransacted(FTransactionObjectEvent(Owner->GetId(), Owner->GetOperationId(), ETransactionObjectEventType::Snapshot, SnapshotDeltaChange, ChangedObjectTransactionAnnotation
, InitialSerializedObject.ObjectPackageName
, InitialSerializedObject.ObjectName
, InitialSerializedObject.ObjectPathName
, InitialSerializedObject.ObjectOuterPathName
, InitialSerializedObject.ObjectExternalPackageName
, InitialSerializedObject.ObjectClassPathName));
}
}
}
void FTransaction::FObjectRecord::Diff( const FTransaction* Owner, const FSerializedObject& OldSerializedObject, const FSerializedObject& NewSerializedObject, FTransactionObjectDeltaChange& OutDeltaChange, const bool bFullDiff )
{
auto AreObjectPointersIdentical = [&OldSerializedObject, &NewSerializedObject](const FName InPropertyName)
{
TArray<int32, TInlineAllocator<8>> OldSerializedObjectIndices;
OldSerializedObject.SerializedObjectIndices.MultiFind(InPropertyName, OldSerializedObjectIndices, true);
TArray<int32, TInlineAllocator<8>> NewSerializedObjectIndices;
NewSerializedObject.SerializedObjectIndices.MultiFind(InPropertyName, NewSerializedObjectIndices, true);
bool bAreObjectPointersIdentical = OldSerializedObjectIndices.Num() == NewSerializedObjectIndices.Num();
for (int32 ObjIndex = 0; ObjIndex < OldSerializedObjectIndices.Num() && bAreObjectPointersIdentical; ++ObjIndex)
{
const FPersistentObjectRef& OldObjectRef = OldSerializedObject.ReferencedObjects.IsValidIndex(OldSerializedObjectIndices[ObjIndex]) ? OldSerializedObject.ReferencedObjects[OldSerializedObjectIndices[ObjIndex]] : FPersistentObjectRef();
const FPersistentObjectRef& NewObjectRef = NewSerializedObject.ReferencedObjects.IsValidIndex(NewSerializedObjectIndices[ObjIndex]) ? NewSerializedObject.ReferencedObjects[NewSerializedObjectIndices[ObjIndex]] : FPersistentObjectRef();
bAreObjectPointersIdentical = OldObjectRef == NewObjectRef;
}
return bAreObjectPointersIdentical;
};
auto AreNamesIdentical = [&OldSerializedObject, &NewSerializedObject](const FName InPropertyName)
{
TArray<int32, TInlineAllocator<8>> OldSerializedNameIndices;
OldSerializedObject.SerializedNameIndices.MultiFind(InPropertyName, OldSerializedNameIndices, true);
TArray<int32, TInlineAllocator<8>> NewSerializedNameIndices;
NewSerializedObject.SerializedNameIndices.MultiFind(InPropertyName, NewSerializedNameIndices, true);
bool bAreNamesIdentical = OldSerializedNameIndices.Num() == NewSerializedNameIndices.Num();
for (int32 ObjIndex = 0; ObjIndex < OldSerializedNameIndices.Num() && bAreNamesIdentical; ++ObjIndex)
{
const FName& OldName = OldSerializedObject.ReferencedNames.IsValidIndex(OldSerializedNameIndices[ObjIndex]) ? OldSerializedObject.ReferencedNames[OldSerializedNameIndices[ObjIndex]] : FName();
const FName& NewName = NewSerializedObject.ReferencedNames.IsValidIndex(NewSerializedNameIndices[ObjIndex]) ? NewSerializedObject.ReferencedNames[NewSerializedNameIndices[ObjIndex]] : FName();
bAreNamesIdentical = OldName == NewName;
}
return bAreNamesIdentical;
};
if (bFullDiff)
{
OutDeltaChange.bHasNameChange |= OldSerializedObject.ObjectName != NewSerializedObject.ObjectName;
OutDeltaChange.bHasOuterChange |= OldSerializedObject.ObjectOuterPathName != NewSerializedObject.ObjectOuterPathName;
OutDeltaChange.bHasExternalPackageChange |= OldSerializedObject.ObjectExternalPackageName != NewSerializedObject.ObjectExternalPackageName;
OutDeltaChange.bHasPendingKillChange |= OldSerializedObject.bIsPendingKill != NewSerializedObject.bIsPendingKill;
if (!AreObjectPointersIdentical(NAME_None))
{
OutDeltaChange.bHasNonPropertyChanges = true;
}
if (!AreNamesIdentical(NAME_None))
{
OutDeltaChange.bHasNonPropertyChanges = true;
}
}
if (OldSerializedObject.SerializedProperties.Num() > 0 || NewSerializedObject.SerializedProperties.Num() > 0)
{
int64 StartOfOldPropertyBlock = INT64_MAX;
int64 StartOfNewPropertyBlock = INT64_MAX;
int64 EndOfOldPropertyBlock = -1;
int64 EndOfNewPropertyBlock = -1;
for (const TPair<FName, FSerializedProperty>& NewNamePropertyPair : NewSerializedObject.SerializedProperties)
{
const FSerializedProperty* OldSerializedProperty = OldSerializedObject.SerializedProperties.Find(NewNamePropertyPair.Key);
if (!OldSerializedProperty)
{
if (bFullDiff)
{
// Missing property, assume that the property changed
OutDeltaChange.ChangedProperties.AddUnique(NewNamePropertyPair.Key);
}
continue;
}
// Update the tracking for the start/end of the property block within the serialized data
StartOfOldPropertyBlock = FMath::Min(StartOfOldPropertyBlock, OldSerializedProperty->DataOffset);
StartOfNewPropertyBlock = FMath::Min(StartOfNewPropertyBlock, NewNamePropertyPair.Value.DataOffset);
EndOfOldPropertyBlock = FMath::Max(EndOfOldPropertyBlock, OldSerializedProperty->DataOffset + OldSerializedProperty->DataSize);
EndOfNewPropertyBlock = FMath::Max(EndOfNewPropertyBlock, NewNamePropertyPair.Value.DataOffset + NewNamePropertyPair.Value.DataSize);
// Binary compare the serialized data to see if something has changed for this property
bool bIsPropertyIdentical = OldSerializedProperty->DataSize == NewNamePropertyPair.Value.DataSize;
if (bIsPropertyIdentical && NewNamePropertyPair.Value.DataSize > 0)
{
bIsPropertyIdentical = FMemory::Memcmp(&OldSerializedObject.Data[OldSerializedProperty->DataOffset], &NewSerializedObject.Data[NewNamePropertyPair.Value.DataOffset], NewNamePropertyPair.Value.DataSize) == 0;
}
if (bIsPropertyIdentical)
{
bIsPropertyIdentical = AreObjectPointersIdentical(NewNamePropertyPair.Key);
}
if (bIsPropertyIdentical)
{
bIsPropertyIdentical = AreNamesIdentical(NewNamePropertyPair.Key);
}
if (!bIsPropertyIdentical)
{
OutDeltaChange.ChangedProperties.AddUnique(NewNamePropertyPair.Key);
}
}
for (const TPair<FName, FSerializedProperty>& OldNamePropertyPair : OldSerializedObject.SerializedProperties)
{
const FSerializedProperty* NewSerializedProperty = NewSerializedObject.SerializedProperties.Find(OldNamePropertyPair.Key);
if (!NewSerializedProperty)
{
if (bFullDiff)
{
// Missing property, assume that the property changed
OutDeltaChange.ChangedProperties.AddUnique(OldNamePropertyPair.Key);
}
continue;
}
}
if (bFullDiff)
{
// Compare the data before the property block to see if something else in the object has changed
if (!OutDeltaChange.bHasNonPropertyChanges)
{
const int64 OldHeaderSize = FMath::Min(StartOfOldPropertyBlock, OldSerializedObject.Data.Num());
const int64 CurrentHeaderSize = FMath::Min(StartOfNewPropertyBlock, NewSerializedObject.Data.Num());
bool bIsHeaderIdentical = OldHeaderSize == CurrentHeaderSize;
if (bIsHeaderIdentical && CurrentHeaderSize > 0)
{
bIsHeaderIdentical = FMemory::Memcmp(&OldSerializedObject.Data[0], &NewSerializedObject.Data[0], CurrentHeaderSize) == 0;
}
if (!bIsHeaderIdentical)
{
OutDeltaChange.bHasNonPropertyChanges = true;
}
}
// Compare the data after the property block to see if something else in the object has changed
if (!OutDeltaChange.bHasNonPropertyChanges)
{
const int64 OldFooterSize = OldSerializedObject.Data.Num() - FMath::Max<int64>(EndOfOldPropertyBlock, 0);
const int64 CurrentFooterSize = NewSerializedObject.Data.Num() - FMath::Max<int64>(EndOfNewPropertyBlock, 0);
bool bIsFooterIdentical = OldFooterSize == CurrentFooterSize;
if (bIsFooterIdentical && CurrentFooterSize > 0)
{
bIsFooterIdentical = FMemory::Memcmp(&OldSerializedObject.Data[EndOfOldPropertyBlock], &NewSerializedObject.Data[EndOfNewPropertyBlock], CurrentFooterSize) == 0;
}
if (!bIsFooterIdentical)
{
OutDeltaChange.bHasNonPropertyChanges = true;
}
}
}
}
else if (bFullDiff)
{
// No properties, so just compare the whole blob
bool bIsBlobIdentical = OldSerializedObject.Data.Num() == NewSerializedObject.Data.Num();
if (bIsBlobIdentical && NewSerializedObject.Data.Num() > 0)
{
bIsBlobIdentical = FMemory::Memcmp(&OldSerializedObject.Data[0], &NewSerializedObject.Data[0], NewSerializedObject.Data.Num()) == 0;
}
if (!bIsBlobIdentical)
{
OutDeltaChange.bHasNonPropertyChanges = true;
}
}
}
int32 FTransaction::GetRecordCount() const
{
return Records.Num();
}
bool FTransaction::IsTransient() const
{
bool bHasChanges = false;
for (const FObjectRecord& Record : Records)
{
if (Record.ContainsPieObject())
{
return true;
}
bHasChanges |= Record.HasChanges();
}
return !bHasChanges;
}
bool FTransaction::ContainsPieObjects() const
{
for( const FObjectRecord& Record : Records )
{
if( Record.ContainsPieObject() )
{
return true;
}
}
return false;
}
bool FTransaction::HasExpired() const
{
if (Records.Num() == 0) // only return true if we definitely have expired changes
{
return false;
}
for (const FObjectRecord& Record : Records)
{
if (Record.HasExpired() == false)
{
return false;
}
}
return true;
}
bool FTransaction::IsObjectTransacting(const UObject* Object) const
{
// This function is meaningless when called outside of a transaction context. Without this
// ensure clients will commonly introduced bugs by having some logic that runs during
// the transacting and some logic that does not, yielding asymmetrical results.
ensure(GIsTransacting);
ensure(ChangedObjects.Num() != 0);
return ChangedObjects.Contains(Object);
}
void FTransaction::RemoveRecords( int32 Count /* = 1 */ )
{
if ( Count > 0 && Records.Num() >= Count )
{
// Remove anything from the ObjectRecordMap which is about to be removed from the Records array
for (int32 Index = 0; Index < Count; Index++)
{
FObjectRecord& Record = Records[Records.Num() - Count + Index];
if (FObjectRecords* ObjectRecords = ObjectRecordsMap.Find(Record.Object))
{
ObjectRecords->Records.RemoveSingle(&Record);
if (ObjectRecords->Records.Num() == 0)
{
ObjectRecordsMap.Remove(Record.Object);
}
}
}
Records.RemoveAt( Records.Num() - Count, Count );
}
}
/**
* Outputs the contents of the ObjectMap to the specified output device.
*/
void FTransaction::DumpObjectMap(FOutputDevice& Ar) const
{
Ar.Logf( TEXT("===== DumpObjectMap %s ==== "), *Title.ToString() );
for ( auto It = ObjectRecordsMap.CreateConstIterator(); It; ++It )
{
const UObject* CurrentObject = It.Key().Get();
const int32 SaveCount = It.Value().SaveCount;
Ar.Logf( TEXT("%i\t: %s"), SaveCount, *CurrentObject->GetPathName() );
}
Ar.Logf( TEXT("=== EndDumpObjectMap %s === "), *Title.ToString() );
}
FArchive& operator<<( FArchive& Ar, FTransaction::FObjectRecord& R )
{
FMemMark Mark(FMemStack::Get());
Ar << R.Object;
Ar << R.SerializedObject.Data;
Ar << R.SerializedObject.ReferencedObjects;
Ar << R.SerializedObject.ReferencedNames;
Mark.Pop();
return Ar;
}
FTransaction::FPersistentObjectRef::FPersistentObjectRef(UObject* InObject)
{
RootObject = InObject;
{
auto UseOuter = [](const UObject* Obj)
{
if (Obj == nullptr)
{
return false;
}
const bool bIsCDO = Obj->HasAllFlags(RF_ClassDefaultObject);
const UObject* CDO = bIsCDO ? Obj : nullptr;
const bool bIsClassCDO = (CDO != nullptr) ? (CDO->GetClass()->ClassDefaultObject == CDO) : false;
if (!bIsClassCDO && CDO)
{
// Likely a trashed CDO, try to recover
// Only known cause of this is ambiguous use of DSOs
CDO = CDO->GetClass()->ClassDefaultObject;
}
const UActorComponent* AsComponent = Cast<UActorComponent>(Obj);
const bool bIsDSO = Obj->HasAnyFlags(RF_DefaultSubObject);
const bool bIsSCSComponent = AsComponent && AsComponent->IsCreatedByConstructionScript();
return (bIsCDO && bIsClassCDO) || bIsDSO || bIsSCSComponent;
};
while (UseOuter(RootObject))
{
SubObjectHierarchyIDs.Add(RootObject->GetFName());
RootObject = RootObject->GetOuter();
}
}
check(RootObject);
if (SubObjectHierarchyIDs.Num() > 0)
{
ReferenceType = EReferenceType::SubObject;
Algo::Reverse(SubObjectHierarchyIDs);
}
else
{
ReferenceType = EReferenceType::RootObject;
}
// Make sure that when we look up the object we find the same thing:
checkSlow(Get() == InObject);
}
UObject* FTransaction::FPersistentObjectRef::Get() const
{
if (ReferenceType == EReferenceType::SubObject)
{
check(SubObjectHierarchyIDs.Num() > 0);
UObject* CurrentObject = nullptr;
// Do we have a valid cached pointer?
if (!CachedRootObject.IsExplicitlyNull() && SubObjectHierarchyIDs.Num() == CachedSubObjectHierarchy.Num())
{
// Root object is a pointer test
{
CurrentObject = CachedRootObject.GetEvenIfUnreachable();
if (CurrentObject != RootObject)
{
CurrentObject = nullptr;
}
}
// All other sub-objects are a name test
for (int32 SubObjectIndex = 0; CurrentObject && SubObjectIndex < SubObjectHierarchyIDs.Num(); ++SubObjectIndex)
{
CurrentObject = CachedSubObjectHierarchy[SubObjectIndex].GetEvenIfUnreachable();
if (CurrentObject && CurrentObject->GetFName() != SubObjectHierarchyIDs[SubObjectIndex])
{
CurrentObject = nullptr;
}
}
}
if (CurrentObject)
{
return CurrentObject;
}
// Cached pointer is invalid
CachedRootObject.Reset();
CachedSubObjectHierarchy.Reset();
// Try to find and cache the subobject
CachedRootObject = RootObject;
CurrentObject = RootObject;
for (int32 SubObjectIndex = 0; CurrentObject && SubObjectIndex < SubObjectHierarchyIDs.Num(); ++SubObjectIndex)
{
CurrentObject = StaticFindObjectFast(UObject::StaticClass(), CurrentObject, SubObjectHierarchyIDs[SubObjectIndex]);
CachedSubObjectHierarchy.Add(CurrentObject);
}
if (CurrentObject)
{
check(!CachedRootObject.IsExplicitlyNull() && SubObjectHierarchyIDs.Num() == CachedSubObjectHierarchy.Num());
return CurrentObject;
}
// Cached pointer is invalid
CachedRootObject.Reset();
CachedSubObjectHierarchy.Reset();
return nullptr;
}
return RootObject;
}
void FTransaction::FPersistentObjectRef::AddReferencedObjects(FReferenceCollector& Collector)
{
Collector.AddReferencedObject(RootObject);
if (ReferenceType == EReferenceType::SubObject)
{
// We can't refresh the resolved pointers during ARO, as it's not safe to call FindObject to update the cache if stale
// Instead we'll just ARO whatever we may have cached, as this may result in the resolved pointers being updated anyway
// Note: This is needed as sub-objects may be subject to GC while inside the transaction buffer, as the references from their root
// object may have been removed (eg, a component on an actor will no longer be referenced by the actor after a delete operation)
for (TWeakObjectPtr<UObject>& CachedSubObject : CachedSubObjectHierarchy)
{
UObject* CachedSubObjectPtr = CachedSubObject.GetEvenIfUnreachable();
Collector.AddReferencedObject(CachedSubObjectPtr);
CachedSubObject = CachedSubObjectPtr;
}
}
}
void FTransaction::FObjectRecord::AddReferencedObjects( FReferenceCollector& Collector )
{
Object.AddReferencedObjects(Collector);
auto AddSerializedObjectReferences = [&Collector](FSerializedObject& InSerializedObject)
{
for (FPersistentObjectRef& ReferencedObject : InSerializedObject.ReferencedObjects)
{
ReferencedObject.AddReferencedObjects(Collector);
}
if (InSerializedObject.ObjectAnnotation.IsValid())
{
InSerializedObject.ObjectAnnotation->AddReferencedObjects(Collector);
}
};
AddSerializedObjectReferences(SerializedObject);
AddSerializedObjectReferences(SerializedObjectFlip);
AddSerializedObjectReferences(SerializedObjectSnapshot);
if (CustomChange.IsValid())
{
CustomChange->AddReferencedObjects(Collector);
}
}
bool FTransaction::FObjectRecord::ContainsPieObject() const
{
{
const UObject* Obj = Object.Get();
if(Obj && Obj->GetOutermost()->HasAnyPackageFlags(PKG_PlayInEditor))
{
return true;
}
}
auto SerializedObjectContainPieObjects = [](const FSerializedObject& InSerializedObject) -> bool
{
for (const FPersistentObjectRef& ReferencedObject : InSerializedObject.ReferencedObjects)
{
const UObject* Obj = ReferencedObject.Get();
if (Obj && Obj->GetOutermost()->HasAnyPackageFlags(PKG_PlayInEditor))
{
return true;
}
}
return false;
};
if (SerializedObjectContainPieObjects(SerializedObject))
{
return true;
}
if (SerializedObjectContainPieObjects(SerializedObjectFlip))
{
return true;
}
if (SerializedObjectContainPieObjects(SerializedObjectSnapshot))
{
return true;
}
return false;
}
bool FTransaction::FObjectRecord::HasChanges() const
{
// A record contains change if it has a detected delta or a custom change or an object annotation
return DeltaChange.HasChanged() || CustomChange || SerializedObject.ObjectAnnotation || SerializedObjectFlip.ObjectAnnotation;
}
bool FTransaction::FObjectRecord::HasExpired() const
{
if (CustomChange && CustomChange->HasExpired(Object.Get()) == true)
{
return true;
}
return false;
}
void FTransaction::AddReferencedObjects( FReferenceCollector& Collector )
{
for( FObjectRecord& ObjectRecord : Records )
{
ObjectRecord.AddReferencedObjects( Collector );
}
for (TTuple<FPersistentObjectRef, FObjectRecords>& ObjectRecordsPair : ObjectRecordsMap)
{
ObjectRecordsPair.Key.AddReferencedObjects(Collector);
}
}
void FTransaction::SaveObject( UObject* Object )
{
check(Object);
Object->CheckDefaultSubobjects();
FObjectRecords& ObjectRecords = ObjectRecordsMap.FindOrAdd(FPersistentObjectRef(Object));
if (ObjectRecords.Records.Num() == 0)
{
// Save the object.
FObjectRecord* UndoRecord = ObjectRecords.Records.Add_GetRef(new FObjectRecord(this, Object, nullptr, nullptr, 0, 0, 0, 0, 0, nullptr, nullptr, nullptr));
Records.Add(UndoRecord);
}
++ObjectRecords.SaveCount;
}
void FTransaction::SaveArray( UObject* Object, FScriptArray* Array, int32 Index, int32 Count, int32 Oper, int32 ElementSize, uint32 ElementAlignment, STRUCT_DC DefaultConstructor, STRUCT_AR Serializer, STRUCT_DTOR Destructor )
{
check(Object);
check(Array);
check(ElementSize);
check(ElementAlignment);
check(DefaultConstructor);
check(Serializer);
check(Object->IsValidLowLevel());
check((SIZE_T)Array>=(SIZE_T)Object);
check((SIZE_T)Array+sizeof(FScriptArray)<=(SIZE_T)Object+Object->GetClass()->PropertiesSize);
check(Index>=0);
check(Count>=0);
check(Index+Count<=Array->Num());
// don't serialize the array if the object is contained within a PIE package
if( Object->HasAnyFlags(RF_Transactional) && !Object->GetOutermost()->HasAnyPackageFlags(PKG_PlayInEditor))
{
// Save the array.
Records.Add(new FObjectRecord( this, Object, nullptr, Array, Index, Count, Oper, ElementSize, ElementAlignment, DefaultConstructor, Serializer, Destructor ));
}
}
void FTransaction::StoreUndo(UObject* Object, TUniquePtr<FChange> UndoChange)
{
check(Object);
Object->CheckDefaultSubobjects();
// Save the undo record
FObjectRecords& ObjectRecords = ObjectRecordsMap.FindOrAdd(FPersistentObjectRef(Object));
FObjectRecord* UndoRecord = ObjectRecords.Records.Add_GetRef(new FObjectRecord(this, Object, MoveTemp(UndoChange), nullptr, 0, 0, 0, 0, 0, nullptr, nullptr, nullptr));
Records.Add(UndoRecord);
}
void FTransaction::SetPrimaryObject(UObject* InObject)
{
if (PrimaryObject == NULL)
{
PrimaryObject = InObject;
}
}
void FTransaction::SnapshotObject( UObject* InObject, TArrayView<const FProperty*> Properties )
{
check(InObject);
if (const FObjectRecords* ObjectRecords = ObjectRecordsMap.Find(FPersistentObjectRef(InObject)))
{
for (FObjectRecord* Record : ObjectRecords->Records)
{
checkSlow(Record->Object.Get() == InObject);
if (!Record->CustomChange)
{
Record->Snapshot(this, Properties);
}
}
}
}
bool FTransaction::ContainsObject(const UObject* Object) const
{
FPersistentObjectRef PersistentObjectRef(const_cast<UObject*>(Object));
if (const FObjectRecords* ObjectRecords = ObjectRecordsMap.Find(PersistentObjectRef))
{
for (FObjectRecord* Record : ObjectRecords->Records)
{
if (Record->Object == PersistentObjectRef)
{
return true;
}
}
}
return false;
}
void FTransaction::BeginOperation()
{
check(!OperationId.IsValid());
OperationId = FGuid::NewGuid();
}
void FTransaction::EndOperation()
{
check(OperationId.IsValid());
OperationId.Invalidate();
}
void FTransaction::Apply()
{
checkSlow(Inc==1||Inc==-1);
// Figure out direction.
const int32 Start = Inc==1 ? 0 : Records.Num()-1;
const int32 End = Inc==1 ? Records.Num() : -1;
// Init objects.
for( int32 i=Start; i!=End; i+=Inc )
{
FObjectRecord& Record = Records[i];
Record.bRestored = false;
// Apply may be called before Finalize in order to revert an object back to its prior state in the case that a transaction is canceled
// In this case we still need to generate a diff for the transaction so that we notify correctly
if (!Record.bFinalized)
{
TSharedPtr<ITransactionObjectAnnotation> FinalizedObjectAnnotation;
Record.Finalize(this, FinalizedObjectAnnotation);
}
UObject* Object = Record.Object.Get();
if (Object)
{
if (!ChangedObjects.Contains(Object))
{
Object->CheckDefaultSubobjects();
Object->PreEditUndo();
}
ChangedObjects.Add(Object, FChangedObjectValue(i, Record.SerializedObject.ObjectAnnotation));
}
}
if (bFlip)
{
for (int32 i = Start; i != End; i += Inc)
{
Records[i].Save(this);
}
for (int32 i = Start; i != End; i += Inc)
{
Records[i].Load(this);
}
}
else
{
for (int32 i = Start; i != End; i += Inc)
{
Records[i].Restore(this);
}
}
// An Actor's components must always get its PostEditUndo before the owning Actor
// so do a quick sort on Outer depth, component will deeper than their owner
ChangedObjects.KeyStableSort([](UObject& A, UObject& B)
{
return Cast<UActorComponent>(&A) != nullptr;
});
TArray<ULevel*> LevelsToCommitModelSurface;
for (auto ChangedObjectIt : ChangedObjects)
{
UObject* ChangedObject = ChangedObjectIt.Key;
UModel* Model = Cast<UModel>(ChangedObject);
if (Model && Model->Nodes.Num())
{
FBSPOps::bspBuildBounds(Model);
}
if (UModelComponent* ModelComponent = Cast<UModelComponent>(ChangedObject))
{
ULevel* Level = ModelComponent->GetTypedOuter<ULevel>();
check(Level);
LevelsToCommitModelSurface.AddUnique(Level);
}
TSharedPtr<ITransactionObjectAnnotation> ChangedObjectTransactionAnnotation = ChangedObjectIt.Value.Annotation;
if (ChangedObjectTransactionAnnotation.IsValid())
{
ChangedObject->PostEditUndo(ChangedObjectTransactionAnnotation);
}
else
{
ChangedObject->PostEditUndo();
}
const FObjectRecord& ChangedObjectRecord = Records[ChangedObjectIt.Value.RecordIndex];
const FTransactionObjectDeltaChange& DeltaChange = ChangedObjectRecord.DeltaChange;
if (DeltaChange.HasChanged() || ChangedObjectTransactionAnnotation.IsValid())
{
const FObjectRecord::FSerializedObject& InitialSerializedObject = ChangedObjectRecord.SerializedObject;
ChangedObject->PostTransacted(FTransactionObjectEvent(Id, OperationId, ETransactionObjectEventType::UndoRedo, DeltaChange, ChangedObjectTransactionAnnotation
, InitialSerializedObject.ObjectPackageName
, InitialSerializedObject.ObjectName
, InitialSerializedObject.ObjectPathName
, InitialSerializedObject.ObjectOuterPathName
, InitialSerializedObject.ObjectExternalPackageName
, InitialSerializedObject.ObjectClassPathName));
}
}
// Commit model surfaces for unique levels within the transaction
for (ULevel* Level : LevelsToCommitModelSurface)
{
Level->CommitModelSurfaces();
}
// Flip it.
if (bFlip)
{
Inc *= -1;
}
for (auto ChangedObjectIt : ChangedObjects)
{
UObject* ChangedObject = ChangedObjectIt.Key;
ChangedObject->CheckDefaultSubobjects();
}
ChangedObjects.Reset();
}
void FTransaction::Finalize()
{
for (int32 i = 0; i < Records.Num(); ++i)
{
TSharedPtr<ITransactionObjectAnnotation> FinalizedObjectAnnotation;
FObjectRecord& ObjectRecord = Records[i];
ObjectRecord.Finalize(this, FinalizedObjectAnnotation);
UObject* Object = ObjectRecord.Object.Get();
if (Object)
{
if (!ChangedObjects.Contains(Object))
{
ChangedObjects.Add(Object, FChangedObjectValue(i, FinalizedObjectAnnotation));
}
}
}
// An Actor's components must always be notified before the owning Actor
// so do a quick sort on Outer depth, component will deeper than their owner
ChangedObjects.KeyStableSort([](UObject& A, UObject& B)
{
return Cast<UActorComponent>(&A) != nullptr;
});
for (auto ChangedObjectIt : ChangedObjects)
{
TSharedPtr<ITransactionObjectAnnotation> ChangedObjectTransactionAnnotation = ChangedObjectIt.Value.Annotation;
const FObjectRecord& ChangedObjectRecord = Records[ChangedObjectIt.Value.RecordIndex];
const FTransactionObjectDeltaChange& DeltaChange = ChangedObjectRecord.DeltaChange;
if (DeltaChange.HasChanged() || ChangedObjectTransactionAnnotation.IsValid())
{
UObject* ChangedObject = ChangedObjectIt.Key;
const FObjectRecord::FSerializedObject& InitialSerializedObject = ChangedObjectRecord.SerializedObject;
ChangedObject->PostTransacted(FTransactionObjectEvent(Id, OperationId, ETransactionObjectEventType::Finalized, DeltaChange, ChangedObjectTransactionAnnotation
, InitialSerializedObject.ObjectPackageName
, InitialSerializedObject.ObjectName
, InitialSerializedObject.ObjectPathName
, InitialSerializedObject.ObjectOuterPathName
, InitialSerializedObject.ObjectExternalPackageName
, InitialSerializedObject.ObjectClassPathName));
}
}
ChangedObjects.Reset();
}
SIZE_T FTransaction::DataSize() const
{
SIZE_T Result=0;
for( int32 i=0; i<Records.Num(); i++ )
{
Result += Records[i].SerializedObject.Data.Num();
}
return Result;
}
/**
* Get all the objects that are part of this transaction.
* @param Objects [out] Receives the object list. Previous contents are cleared.
*/
void FTransaction::GetTransactionObjects(TArray<UObject*>& Objects) const
{
Objects.Empty(); // Just in case.
for(int32 i=0; i<Records.Num(); i++)
{
UObject* Obj = Records[i].Object.Get();
if (Obj)
{
Objects.AddUnique(Obj);
}
}
}
FTransactionDiff FTransaction::GenerateDiff() const
{
FTransactionDiff TransactionDiff{Id, Title.ToString()};
// Only generate diff if the transaction is finalized.
if (ChangedObjects.Num() == 0)
{
// For each record, create a diff
for (int32 i = 0; i < Records.Num(); ++i)
{
const FObjectRecord& ObjectRecord = Records[i];
if (UObject* TransactedObject = ObjectRecord.Object.Get())
{
// The last snapshot object is reset so we can only diff against the initial object for the moment.
FTransactionObjectDeltaChange RecordDeltaChange;
FObjectRecord::Diff(this, ObjectRecord.SerializedObject, ObjectRecord.SerializedObjectFlip, RecordDeltaChange);
// TODO: Add annotation
if (RecordDeltaChange.HasChanged())
{
// Since this transaction is not currently in an undo operation, generate a valid Guid.
FGuid Guid = FGuid::NewGuid();
TransactionDiff.DiffMap.Emplace(FName(*TransactedObject->GetPathName()), MakeShared<FTransactionObjectEvent>(this->GetId(), Guid, ETransactionObjectEventType::Finalized, RecordDeltaChange, ObjectRecord.SerializedObject.ObjectAnnotation
, ObjectRecord.SerializedObject.ObjectPackageName
, ObjectRecord.SerializedObject.ObjectName
, ObjectRecord.SerializedObject.ObjectPathName
, ObjectRecord.SerializedObject.ObjectOuterPathName
, ObjectRecord.SerializedObject.ObjectExternalPackageName
, ObjectRecord.SerializedObject.ObjectClassPathName));
}
}
}
}
return TransactionDiff;
}
/*-----------------------------------------------------------------------------
Transaction tracking system.
-----------------------------------------------------------------------------*/
UTransactor::UTransactor(const FObjectInitializer& ObjectInitializer)
: Super(ObjectInitializer)
{
}
void UTransBuffer::Initialize(SIZE_T InMaxMemory)
{
MaxMemory = InMaxMemory;
// Reset.
Reset( NSLOCTEXT("UnrealEd", "Startup", "Startup") );
CheckState();
UE_LOG(LogInit, Log, TEXT("Transaction tracking system initialized") );
}
// UObject interface.
void UTransBuffer::Serialize( FArchive& Ar )
{
check( !Ar.IsPersistent() );
CheckState();
Super::Serialize( Ar );
if ( IsObjectSerializationEnabled() || !Ar.IsObjectReferenceCollector() )
{
Ar << UndoBuffer;
}
Ar << ResetReason << UndoCount << ActiveCount << ActiveRecordCounts;
CheckState();
}
void UTransBuffer::FinishDestroy()
{
if ( !HasAnyFlags(RF_ClassDefaultObject) )
{
CheckState();
UE_LOG(LogExit, Log, TEXT("Transaction tracking system shut down") );
}
Super::FinishDestroy();
}
void UTransBuffer::AddReferencedObjects(UObject* InThis, FReferenceCollector& Collector)
{
UTransBuffer* This = CastChecked<UTransBuffer>(InThis);
This->CheckState();
if ( This->IsObjectSerializationEnabled() )
{
// We cannot support undoing across GC if we allow it to eliminate references so we need
// to suppress it.
Collector.AllowEliminatingReferences(false);
for (const TSharedRef<FTransaction>& SharedTrans : This->UndoBuffer)
{
SharedTrans->AddReferencedObjects( Collector );
}
for (const TSharedRef<FTransaction>& SharedTrans : This->RemovedTransactions)
{
SharedTrans->AddReferencedObjects(Collector);
}
Collector.AllowEliminatingReferences(true);
}
This->CheckState();
Super::AddReferencedObjects( This, Collector );
}
int32 UTransBuffer::Begin( const TCHAR* SessionContext, const FText& Description )
{
return BeginInternal<FTransaction>(SessionContext, Description);
}
namespace TransBuffer
{
static FAutoConsoleVariable DumpTransBufferObjectMap(TEXT("TransBuffer.DumpObjectMap"), false, TEXT("Whether to dump the object map each time a transaction is written for debugging purposes."));
}
int32 UTransBuffer::End()
{
CheckState();
const int32 Result = ActiveCount;
// Don't assert as we now purge the buffer when resetting.
// So, the active count could be 0, but the code path may still call end.
if (ActiveCount >= 1)
{
if( --ActiveCount==0 )
{
if (GUndo)
{
if (GLog && TransBuffer::DumpTransBufferObjectMap->GetBool())
{
// @todo DB: Fix this potentially unsafe downcast.
static_cast<FTransaction*>(GUndo)->DumpObjectMap( *GLog );
}
// End the current transaction.
GUndo->Finalize();
TransactionStateChangedDelegate.Broadcast(GUndo->GetContext(), ETransactionStateEventType::TransactionFinalized);
GUndo->EndOperation();
// Once the transaction is finalized, remove it from the undo buffer if it's flagged as transient. (i.e contains PIE objects is no-op)
if (GUndo->IsTransient())
{
check(UndoCount == 0);
UndoBuffer.Pop(false);
UndoBufferChangedDelegate.Broadcast();
}
}
GUndo = nullptr;
PreviousUndoCount = INDEX_NONE;
RemovedTransactions.Reset();
}
ActiveRecordCounts.Pop();
CheckState();
}
return Result;
}
void UTransBuffer::Reset( const FText& Reason )
{
if (ensure(!GIsTransacting))
{
CheckState();
if (ActiveCount != 0)
{
FString ErrorMessage = TEXT("");
ErrorMessage += FString::Printf(TEXT("Non zero active count in UTransBuffer::Reset") LINE_TERMINATOR);
ErrorMessage += FString::Printf(TEXT("ActiveCount : %d") LINE_TERMINATOR, ActiveCount);
ErrorMessage += FString::Printf(TEXT("SessionName : %s") LINE_TERMINATOR, *GetUndoContext(false).Context);
ErrorMessage += FString::Printf(TEXT("Reason : %s") LINE_TERMINATOR, *Reason.ToString());
ErrorMessage += FString::Printf(LINE_TERMINATOR);
ErrorMessage += FString::Printf(TEXT("Purging the undo buffer...") LINE_TERMINATOR);
UE_LOG(LogEditorTransaction, Log, TEXT("%s"), *ErrorMessage);
// Clear out the transaction buffer...
Cancel(0);
}
// Reset all transactions.
UndoBuffer.Empty();
UndoCount = 0;
ResetReason = Reason;
ActiveCount = 0;
ActiveRecordCounts.Empty();
UndoBufferChangedDelegate.Broadcast();
CheckState();
}
}
void UTransBuffer::Cancel( int32 StartIndex /*=0*/ )
{
CheckState();
// if we don't have any active actions, we shouldn't have an active transaction at all
if ( ActiveCount > 0 )
{
// Canceling partial transaction isn't supported properly at this time, just cancel the transaction entirely
if (StartIndex != 0)
{
FString TransactionTitle = GUndo ? GUndo->GetContext().Title.ToString() : FString(TEXT("Unknown"));
UE_LOG(LogEditorTransaction, Warning, TEXT("Canceling transaction partially is unsupported. Canceling %s entirely."), *TransactionTitle);
StartIndex = 0;
}
// StartIndex needs to be 0 when cancelling
{
if (GUndo)
{
TransactionStateChangedDelegate.Broadcast(GUndo->GetContext(), ETransactionStateEventType::TransactionCanceled);
GUndo->EndOperation();
}
// clear the global pointer to the soon-to-be-deleted transaction
GUndo = nullptr;
UndoBuffer.Pop(false);
UndoBuffer.Reserve(UndoBuffer.Num() + RemovedTransactions.Num());
if (PreviousUndoCount > 0)
{
UndoBuffer.Append(RemovedTransactions);
}
else
{
UndoBuffer.Insert(RemovedTransactions, 0);
}
RemovedTransactions.Reset();
UndoCount = PreviousUndoCount;
PreviousUndoCount = INDEX_NONE;
UndoBufferChangedDelegate.Broadcast();
}
// reset the active count
ActiveCount = StartIndex;
ActiveRecordCounts.SetNum(StartIndex);
}
CheckState();
}
bool UTransBuffer::CanUndo( FText* Text )
{
CheckState();
if (ActiveCount || CurrentTransaction != nullptr )
{
if (Text)
{
*Text = GUndo ? FText::Format(NSLOCTEXT("TransactionSystem", "CantUndoDuringTransactionX", "(Can't undo while '{0}' is in progress)"), GUndo->GetContext().Title) : NSLOCTEXT("TransactionSystem", "CantUndoDuringTransaction", "(Can't undo while action is in progress)");
}
return false;
}
if (UndoBarrierStack.Num())
{
const int32 UndoBarrier = UndoBarrierStack.Last();
if (UndoBuffer.Num() - UndoCount <= UndoBarrier)
{
if (Text)
{
*Text = NSLOCTEXT("TransactionSystem", "HitUndoBarrier", "(Hit Undo barrier; can't undo any further)");
}
return false;
}
}
if (UndoBuffer.Num() == UndoCount)
{
if( Text )
{
*Text = FText::Format( NSLOCTEXT("TransactionSystem", "CantUndoAfter", "(Can't undo after: {0})"), ResetReason );
}
return false;
}
return true;
}
bool UTransBuffer::CanRedo( FText* Text )
{
CheckState();
if( ActiveCount || CurrentTransaction != nullptr )
{
if( Text )
{
*Text = GUndo ? FText::Format(NSLOCTEXT("TransactionSystem", "CantRedoDuringTransactionX", "(Can't redo while '{0}' is in progress)"), GUndo->GetContext().Title) : NSLOCTEXT("TransactionSystem", "CantRedoDuringTransaction", "(Can't redo while action is in progress)");
}
return 0;
}
if( UndoCount==0 )
{
if( Text )
{
*Text = NSLOCTEXT("TransactionSystem", "NothingToRedo", "(Nothing to redo)");
}
return 0;
}
return 1;
}
int32 UTransBuffer::FindTransactionIndex(const FGuid & TransactionId) const
{
for (int32 Index = 0; Index < UndoBuffer.Num(); ++Index)
{
if (UndoBuffer[Index]->GetId() == TransactionId)
{
return Index;
}
}
return INDEX_NONE;
}
const FTransaction* UTransBuffer::GetTransaction( int32 QueueIndex ) const
{
if (UndoBuffer.Num() > QueueIndex && QueueIndex != INDEX_NONE)
{
return &UndoBuffer[QueueIndex].Get();
}
return NULL;
}
FTransactionContext UTransBuffer::GetUndoContext( bool bCheckWhetherUndoPossible )
{
FTransactionContext Context;
FText Title;
if( bCheckWhetherUndoPossible && !CanUndo( &Title ) )
{
Context.Title = Title;
return Context;
}
if (UndoBuffer.Num() > UndoCount)
{
TSharedRef<FTransaction>& Transaction = UndoBuffer[UndoBuffer.Num() - (UndoCount + 1)];
return Transaction->GetContext();
}
return Context;
}
FTransactionContext UTransBuffer::GetRedoContext()
{
FTransactionContext Context;
FText Title;
if( !CanRedo( &Title ) )
{
Context.Title = Title;
return Context;
}
TSharedRef<FTransaction>& Transaction = UndoBuffer[ UndoBuffer.Num() - UndoCount ];
return Transaction->GetContext();
}
void UTransBuffer::SetUndoBarrier()
{
UndoBarrierStack.Push(UndoBuffer.Num() - UndoCount);
}
void UTransBuffer::RemoveUndoBarrier()
{
if (UndoBarrierStack.Num() > 0)
{
UndoBarrierStack.Pop();
}
}
void UTransBuffer::ClearUndoBarriers()
{
UndoBarrierStack.Empty();
}
bool UTransBuffer::Undo(bool bCanRedo)
{
CheckState();
if (!CanUndo())
{
UndoDelegate.Broadcast(FTransactionContext(), false);
return false;
}
// Apply the undo changes.
GIsTransacting = true;
// custom changes (FChange) can be applied to temporary objects that require undo/redo for some time,
// but we want to skip over these changes later (eg in the context of a Tool that is used for a while and
// then closed). In this case the Transaction is "expired" and we continue to Undo until we find a
// non-Expired Transaction.
bool bDoneTransacting = false;
do
{
FTransaction& Transaction = UndoBuffer[ UndoBuffer.Num() - ++UndoCount ].Get();
if (Transaction.HasExpired() == false)
{
UE_LOG(LogEditorTransaction, Log, TEXT("Undo %s"), *Transaction.GetTitle().ToString());
CurrentTransaction = &Transaction;
CurrentTransaction->BeginOperation();
const FTransactionContext TransactionContext = CurrentTransaction->GetContext();
TransactionStateChangedDelegate.Broadcast(TransactionContext, ETransactionStateEventType::UndoRedoStarted);
BeforeRedoUndoDelegate.Broadcast(TransactionContext);
Transaction.Apply();
UndoDelegate.Broadcast(TransactionContext, true);
TransactionStateChangedDelegate.Broadcast(TransactionContext, ETransactionStateEventType::UndoRedoFinalized);
CurrentTransaction->EndOperation();
CurrentTransaction = nullptr;
bDoneTransacting = true;
}
if (!bCanRedo)
{
UndoBuffer.RemoveAt(UndoBuffer.Num() - UndoCount, UndoCount);
UndoCount = 0;
UndoBufferChangedDelegate.Broadcast();
}
}
while (bDoneTransacting == false && CanUndo());
GIsTransacting = false;
// if all transactions were expired, reproduce the !CanUndo() branch at the top of the function
if (bDoneTransacting == false)
{
UndoDelegate.Broadcast(FTransactionContext(), false);
return false;
}
CheckState();
return true;
}
bool UTransBuffer::Redo()
{
CheckState();
if (!CanRedo())
{
RedoDelegate.Broadcast(FTransactionContext(), false);
return false;
}
// Apply the redo changes.
GIsTransacting = true;
// Skip over Expired transactions (see comments in ::Undo)
bool bDoneTransacting = false;
do
{
FTransaction& Transaction = UndoBuffer[ UndoBuffer.Num() - UndoCount-- ].Get();
if (Transaction.HasExpired() == false)
{
UE_LOG(LogEditorTransaction, Log, TEXT("Redo %s"), *Transaction.GetTitle().ToString());
CurrentTransaction = &Transaction;
CurrentTransaction->BeginOperation();
const FTransactionContext TransactionContext = CurrentTransaction->GetContext();
TransactionStateChangedDelegate.Broadcast(TransactionContext, ETransactionStateEventType::UndoRedoStarted);
BeforeRedoUndoDelegate.Broadcast(TransactionContext);
Transaction.Apply();
RedoDelegate.Broadcast(TransactionContext, true);
TransactionStateChangedDelegate.Broadcast(TransactionContext, ETransactionStateEventType::UndoRedoFinalized);
CurrentTransaction->EndOperation();
CurrentTransaction = nullptr;
bDoneTransacting = true;
}
}
while (bDoneTransacting == false && CanRedo());
GIsTransacting = false;
// if all transactions were expired, reproduce the !CanRedo() branch at the top of the function
if (bDoneTransacting == false)
{
RedoDelegate.Broadcast(FTransactionContext(), false);
return false;
}
CheckState();
return true;
}
bool UTransBuffer::EnableObjectSerialization()
{
return --DisallowObjectSerialization == 0;
}
bool UTransBuffer::DisableObjectSerialization()
{
return ++DisallowObjectSerialization == 0;
}
SIZE_T UTransBuffer::GetUndoSize() const
{
SIZE_T Result=0;
for( int32 i=0; i<UndoBuffer.Num(); i++ )
{
Result += UndoBuffer[i]->DataSize();
}
return Result;
}
void UTransBuffer::CheckState() const
{
// Validate the internal state.
check(UndoBuffer.Num()>=UndoCount);
check(ActiveCount>=0);
check(ActiveRecordCounts.Num() == ActiveCount);
}
void UTransBuffer::SetPrimaryUndoObject(UObject* PrimaryObject)
{
// Only record the primary object if its transactional, not in any of the temporary packages and theres an active transaction
if ( PrimaryObject && PrimaryObject->HasAnyFlags( RF_Transactional ) &&
(PrimaryObject->GetOutermost()->HasAnyPackageFlags( PKG_PlayInEditor|PKG_ContainsScript|PKG_CompiledIn ) == false) )
{
const int32 NumTransactions = UndoBuffer.Num();
const int32 CurrentTransactionIdx = NumTransactions - (UndoCount + 1);
if ( CurrentTransactionIdx >= 0 )
{
TSharedRef<FTransaction>& Transaction = UndoBuffer[ CurrentTransactionIdx ];
Transaction->SetPrimaryObject(PrimaryObject);
}
}
}
bool UTransBuffer::IsObjectInTransationBuffer( const UObject* Object ) const
{
TArray<UObject*> TransactionObjects;
for( const TSharedRef<FTransaction>& Transaction : UndoBuffer )
{
Transaction->GetTransactionObjects(TransactionObjects);
if( TransactionObjects.Contains(Object) )
{
return true;
}
TransactionObjects.Reset();
}
return false;
}
bool UTransBuffer::IsObjectTransacting(const UObject* Object) const
{
// We can't provide a truly meaningful answer to this question when not transacting:
if (ensure(CurrentTransaction))
{
return CurrentTransaction->IsObjectTransacting(Object);
}
return false;
}
bool UTransBuffer::ContainsPieObjects() const
{
for( const TSharedRef<FTransaction>& Transaction : UndoBuffer )
{
if( Transaction->ContainsPieObjects() )
{
return true;
}
}
return false;
}