You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
51711d7764
#9156: Update PlasticSCM Plugin from 1.4.6 to 1.5.0 for UE5 (Contributed by SRombauts) #jira UE-151199 - GitHub 9156 : Update PlasticSCM Plugin from 1.4.6 to 1.5.0 for UE5 #rb patrick.laflamme #preflight 6282956c162e4a77e535b24b [CL 20228732 by SRombauts in ue5-main branch]
462 lines
16 KiB
C++
462 lines
16 KiB
C++
// Copyright Epic Games, Inc. All Rights Reserved.
|
|
|
|
#include "PlasticSourceControlState.h"
|
|
#include "ISourceControlModule.h"
|
|
#include "Styling/AppStyle.h"
|
|
|
|
#define LOCTEXT_NAMESPACE "PlasticSourceControl.State"
|
|
|
|
namespace EWorkspaceState
|
|
{
|
|
const TCHAR* ToString(EWorkspaceState::Type InWorkspaceState)
|
|
{
|
|
const TCHAR* WorkspaceStateStr = nullptr;
|
|
switch (InWorkspaceState)
|
|
{
|
|
case EWorkspaceState::Unknown: WorkspaceStateStr = TEXT("Unknown"); break;
|
|
case EWorkspaceState::Ignored: WorkspaceStateStr = TEXT("Ignored"); break;
|
|
case EWorkspaceState::Controlled: WorkspaceStateStr = TEXT("Controlled"); break;
|
|
case EWorkspaceState::CheckedOut: WorkspaceStateStr = TEXT("CheckedOut"); break;
|
|
case EWorkspaceState::Added: WorkspaceStateStr = TEXT("Added"); break;
|
|
case EWorkspaceState::Moved: WorkspaceStateStr = TEXT("Moved"); break;
|
|
case EWorkspaceState::Copied: WorkspaceStateStr = TEXT("Copied"); break;
|
|
case EWorkspaceState::Replaced: WorkspaceStateStr = TEXT("Replaced"); break;
|
|
case EWorkspaceState::Deleted: WorkspaceStateStr = TEXT("Deleted"); break;
|
|
case EWorkspaceState::LocallyDeleted: WorkspaceStateStr = TEXT("LocallyDeleted"); break;
|
|
case EWorkspaceState::Changed: WorkspaceStateStr = TEXT("Changed"); break;
|
|
case EWorkspaceState::Conflicted: WorkspaceStateStr = TEXT("Conflicted"); break;
|
|
case EWorkspaceState::LockedByOther: WorkspaceStateStr = TEXT("LockedByOther"); break;
|
|
case EWorkspaceState::Private: WorkspaceStateStr = TEXT("Private"); break;
|
|
default: WorkspaceStateStr = TEXT("???"); break;
|
|
}
|
|
return WorkspaceStateStr;
|
|
}
|
|
}
|
|
|
|
|
|
int32 FPlasticSourceControlState::GetHistorySize() const
|
|
{
|
|
return History.Num();
|
|
}
|
|
|
|
TSharedPtr<class ISourceControlRevision, ESPMode::ThreadSafe> FPlasticSourceControlState::GetHistoryItem( int32 HistoryIndex ) const
|
|
{
|
|
check(History.IsValidIndex(HistoryIndex));
|
|
return History[HistoryIndex];
|
|
}
|
|
|
|
TSharedPtr<class ISourceControlRevision, ESPMode::ThreadSafe> FPlasticSourceControlState::FindHistoryRevision( int32 RevisionNumber ) const
|
|
{
|
|
for (const auto& Revision : History)
|
|
{
|
|
if (Revision->GetRevisionNumber() == RevisionNumber)
|
|
{
|
|
return Revision;
|
|
}
|
|
}
|
|
|
|
return nullptr;
|
|
}
|
|
|
|
TSharedPtr<class ISourceControlRevision, ESPMode::ThreadSafe> FPlasticSourceControlState::FindHistoryRevision(const FString& InRevision) const
|
|
{
|
|
for (const auto& Revision : History)
|
|
{
|
|
if (Revision->GetRevision() == InRevision)
|
|
{
|
|
return Revision;
|
|
}
|
|
}
|
|
|
|
return nullptr;
|
|
}
|
|
|
|
TSharedPtr<class ISourceControlRevision, ESPMode::ThreadSafe> FPlasticSourceControlState::GetBaseRevForMerge() const
|
|
{
|
|
for (const auto& Revision : History)
|
|
{
|
|
// look for the the SHA1 id of the file, not the commit id (revision)
|
|
if (Revision->ChangesetNumber == PendingMergeBaseChangeset)
|
|
{
|
|
return Revision;
|
|
}
|
|
}
|
|
|
|
return nullptr;
|
|
}
|
|
|
|
FSlateIcon FPlasticSourceControlState::GetIcon() const
|
|
{
|
|
if (!IsCurrent())
|
|
{
|
|
return FSlateIcon(FAppStyle::GetAppStyleSetName(),"Perforce.NotAtHeadRevision");
|
|
}
|
|
else if (WorkspaceState != EWorkspaceState::CheckedOut && WorkspaceState != EWorkspaceState::LockedByOther)
|
|
{
|
|
if (IsModifiedInOtherBranch())
|
|
{
|
|
return FSlateIcon(FAppStyle::GetAppStyleSetName(), "Perforce.ModifiedOtherBranch");
|
|
}
|
|
}
|
|
|
|
switch (WorkspaceState)
|
|
{
|
|
case EWorkspaceState::CheckedOut:
|
|
case EWorkspaceState::Replaced: // Merged (waiting for checkin)
|
|
return FSlateIcon(FAppStyle::GetAppStyleSetName(), "Perforce.CheckedOut");
|
|
case EWorkspaceState::Added:
|
|
case EWorkspaceState::Copied:
|
|
return FSlateIcon(FAppStyle::GetAppStyleSetName(), "Perforce.OpenForAdd");
|
|
case EWorkspaceState::Moved:
|
|
return FSlateIcon(FAppStyle::GetAppStyleSetName(), "Perforce.Branched");
|
|
case EWorkspaceState::Deleted:
|
|
case EWorkspaceState::LocallyDeleted:
|
|
return FSlateIcon(FAppStyle::GetAppStyleSetName(), "Perforce.MarkedForDelete");
|
|
case EWorkspaceState::Conflicted:
|
|
return FSlateIcon(FAppStyle::GetAppStyleSetName(), "Perforce.NotAtHeadRevision");
|
|
case EWorkspaceState::LockedByOther:
|
|
return FSlateIcon(FAppStyle::GetAppStyleSetName(), "Perforce.CheckedOutByOtherUser", NAME_None, "SourceControl.LockOverlay");
|
|
case EWorkspaceState::Private: // Not controlled
|
|
case EWorkspaceState::Changed: // Changed but unchecked-out file is in a certain way not controlled
|
|
return FSlateIcon(FAppStyle::GetAppStyleSetName(), "Perforce.NotInDepot");
|
|
case EWorkspaceState::Unknown:
|
|
case EWorkspaceState::Ignored:
|
|
case EWorkspaceState::Controlled: // (Unchanged) same as "Pristine" for Perforce (not checked out) ie no icon
|
|
default:
|
|
return FSlateIcon();
|
|
}
|
|
}
|
|
|
|
FText FPlasticSourceControlState::GetDisplayName() const
|
|
{
|
|
if (!IsCurrent())
|
|
{
|
|
return LOCTEXT("NotCurrent", "Not current");
|
|
}
|
|
else if (WorkspaceState != EWorkspaceState::LockedByOther)
|
|
{
|
|
if (IsModifiedInOtherBranch())
|
|
{
|
|
FNumberFormattingOptions NoCommas;
|
|
NoCommas.UseGrouping = false;
|
|
return FText::Format(LOCTEXT("ModifiedOtherBranch", "Modified in {0} CS:{1} by {2}"), FText::FromString(HeadBranch), FText::AsNumber(HeadChangeList, &NoCommas), FText::FromString(HeadUserName));
|
|
}
|
|
}
|
|
switch (WorkspaceState)
|
|
{
|
|
case EWorkspaceState::Unknown:
|
|
return LOCTEXT("Unknown", "Unknown");
|
|
case EWorkspaceState::Ignored:
|
|
return LOCTEXT("Ignored", "Ignored");
|
|
case EWorkspaceState::Controlled:
|
|
return LOCTEXT("Controlled", "Controlled");
|
|
case EWorkspaceState::CheckedOut:
|
|
return LOCTEXT("CheckedOut", "Checked-out");
|
|
case EWorkspaceState::Added:
|
|
return LOCTEXT("Added", "Added");
|
|
case EWorkspaceState::Moved:
|
|
return LOCTEXT("Moved", "Moved");
|
|
case EWorkspaceState::Copied:
|
|
return LOCTEXT("Copied", "Copied");
|
|
case EWorkspaceState::Replaced:
|
|
return LOCTEXT("Replaced", "Replaced");
|
|
case EWorkspaceState::Deleted:
|
|
return LOCTEXT("Deleted", "Deleted");
|
|
case EWorkspaceState::LocallyDeleted:
|
|
return LOCTEXT("LocallyDeleted", "Missing");
|
|
case EWorkspaceState::Changed:
|
|
return LOCTEXT("Changed", "Changed");
|
|
case EWorkspaceState::Conflicted:
|
|
return LOCTEXT("ContentsConflict", "Conflicted");
|
|
case EWorkspaceState::LockedByOther:
|
|
return FText::Format(LOCTEXT("CheckedOutOther", "Checked out by: {0} in {1}"), FText::FromString(LockedBy), FText::FromString(LockedWhere));
|
|
case EWorkspaceState::Private:
|
|
return LOCTEXT("NotControlled", "Not Under Source Control");
|
|
}
|
|
|
|
return FText();
|
|
}
|
|
|
|
FText FPlasticSourceControlState::GetDisplayTooltip() const
|
|
{
|
|
if (!IsCurrent())
|
|
{
|
|
return LOCTEXT("NotCurrent_Tooltip", "Not at the head revision");
|
|
}
|
|
else if (WorkspaceState != EWorkspaceState::LockedByOther)
|
|
{
|
|
if (IsModifiedInOtherBranch())
|
|
{
|
|
FNumberFormattingOptions NoCommas;
|
|
NoCommas.UseGrouping = false;
|
|
return FText::Format(LOCTEXT("ModifiedOtherBranch_Tooltip", "Modified in {0} CS:{1} by {2}"), FText::FromString(HeadBranch), FText::AsNumber(HeadChangeList, &NoCommas), FText::FromString(HeadUserName));
|
|
}
|
|
}
|
|
|
|
switch (WorkspaceState)
|
|
{
|
|
case EWorkspaceState::Unknown:
|
|
return LOCTEXT("Unknown_Tooltip", "The file status is unknown");
|
|
case EWorkspaceState::Ignored:
|
|
return LOCTEXT("Ignored_Tooltip", "The file is ignored");
|
|
case EWorkspaceState::Controlled:
|
|
return LOCTEXT("Pristine_Tooltip", "The file has no modification");
|
|
case EWorkspaceState::CheckedOut:
|
|
return LOCTEXT("CheckedOut_Tooltip", "The file is checked out");
|
|
case EWorkspaceState::Added:
|
|
return LOCTEXT("Added_Tooltip", "The file has been added");
|
|
case EWorkspaceState::Moved:
|
|
return LOCTEXT("Moved_Tooltip", "The file has been moved or renamed");
|
|
case EWorkspaceState::Copied:
|
|
return LOCTEXT("Copied_Tooltip", "The file has been copied");
|
|
case EWorkspaceState::Replaced:
|
|
return LOCTEXT("Replaced_Tooltip", "The file has been replaced / merged");
|
|
case EWorkspaceState::Deleted:
|
|
return LOCTEXT("Deleted_Tooltip", "The file has been deleted");
|
|
case EWorkspaceState::LocallyDeleted:
|
|
return LOCTEXT("LocallyDeleted_Tooltip", "The file is missing");
|
|
case EWorkspaceState::Changed:
|
|
return LOCTEXT("Modified_Tooltip", "The file has been modified");
|
|
case EWorkspaceState::Conflicted:
|
|
return LOCTEXT("ContentsConflict_Tooltip", "The content of the file conflict with updates received from the repository");
|
|
case EWorkspaceState::LockedByOther:
|
|
return FText::Format(LOCTEXT("CheckedOutOther_Tooltip", "Checked out by {0} in {1}"), FText::FromString(LockedBy), FText::FromString(LockedWhere));
|
|
case EWorkspaceState::Private:
|
|
return LOCTEXT("NotControlled_Tooltip", "The file is not under version control");
|
|
}
|
|
|
|
return FText();
|
|
}
|
|
|
|
const FString& FPlasticSourceControlState::GetFilename() const
|
|
{
|
|
// UE_LOG(LogSourceControl, Log, TEXT("GetFilename(%s)"), *LocalFilename);
|
|
|
|
return LocalFilename;
|
|
}
|
|
|
|
const FDateTime& FPlasticSourceControlState::GetTimeStamp() const
|
|
{
|
|
// UE_LOG(LogSourceControl, Log, TEXT("GetTimeStamp(%s)=%s"), *LocalFilename, *TimeStamp.ToString());
|
|
|
|
return TimeStamp;
|
|
}
|
|
|
|
// Deleted and Missing assets cannot appear in the Content Browser but does appear in Submit to Source Control Window
|
|
bool FPlasticSourceControlState::CanCheckIn() const
|
|
{
|
|
const bool bCanCheckIn =
|
|
( WorkspaceState == EWorkspaceState::Added
|
|
|| WorkspaceState == EWorkspaceState::Deleted
|
|
|| WorkspaceState == EWorkspaceState::LocallyDeleted
|
|
|| WorkspaceState == EWorkspaceState::Changed
|
|
|| WorkspaceState == EWorkspaceState::Moved
|
|
|| WorkspaceState == EWorkspaceState::Copied
|
|
|| WorkspaceState == EWorkspaceState::Replaced
|
|
|| WorkspaceState == EWorkspaceState::CheckedOut
|
|
) && !IsConflicted() && IsCurrent();
|
|
|
|
if (!IsUnknown())
|
|
{
|
|
UE_LOG(LogSourceControl, Verbose, TEXT("%s CanCheckIn=%d"), *LocalFilename, bCanCheckIn);
|
|
}
|
|
|
|
return bCanCheckIn;
|
|
}
|
|
|
|
bool FPlasticSourceControlState::CanCheckout() const
|
|
{
|
|
const bool bCanCheckout = ( WorkspaceState == EWorkspaceState::Controlled // In source control, Unmodified
|
|
|| WorkspaceState == EWorkspaceState::Changed // In source control, but not checked-out
|
|
|| WorkspaceState == EWorkspaceState::Replaced) // In source control, merged, waiting for checkin to conclude the merge
|
|
&& IsCurrent(); // Is up to date (at the revision of the repo)
|
|
|
|
if (!IsUnknown())
|
|
{
|
|
UE_LOG(LogSourceControl, Verbose, TEXT("%s CanCheckout=%d"), *LocalFilename, bCanCheckout);
|
|
}
|
|
|
|
return bCanCheckout;
|
|
}
|
|
|
|
bool FPlasticSourceControlState::IsCheckedOut() const
|
|
{
|
|
const bool bIsCheckedOut = WorkspaceState == EWorkspaceState::CheckedOut
|
|
|| WorkspaceState == EWorkspaceState::Moved
|
|
|| WorkspaceState == EWorkspaceState::Conflicted // In source control, waiting for merged
|
|
|| WorkspaceState == EWorkspaceState::Replaced // In source control, merged, waiting for checkin to conclude the merge
|
|
|| WorkspaceState == EWorkspaceState::Changed; // Note: Workaround to enable checkin (still required by UE5.0)
|
|
|
|
if (bIsCheckedOut)
|
|
{
|
|
UE_LOG(LogSourceControl, Verbose, TEXT("%s IsCheckedOut"), *LocalFilename);
|
|
}
|
|
|
|
return bIsCheckedOut;
|
|
}
|
|
|
|
bool FPlasticSourceControlState::IsCheckedOutOther(FString* Who) const
|
|
{
|
|
if (Who != NULL)
|
|
{
|
|
*Who = LockedBy;
|
|
}
|
|
const bool bIsLockedByOther = WorkspaceState == EWorkspaceState::LockedByOther;
|
|
|
|
if (bIsLockedByOther)
|
|
{
|
|
UE_LOG(LogSourceControl, VeryVerbose, TEXT("%s IsCheckedOutOther by '%s' (%s)"), *LocalFilename, *LockedBy, *LockedWhere);
|
|
}
|
|
|
|
return bIsLockedByOther;
|
|
}
|
|
|
|
|
|
/** Get whether this file is checked out in a different branch, if no branch is specified defaults to FEngineVerion current branch */
|
|
bool FPlasticSourceControlState::IsCheckedOutInOtherBranch(const FString& CurrentBranch /* = FString() */) const
|
|
{
|
|
// Note: to my knowledge, it's not possible to detect that with PlasticSCM withouth the Locks,
|
|
// which are already detected by fileinfo LockedBy/LockedWhere and reported by IsCheckedOutOther() above
|
|
return false;
|
|
}
|
|
|
|
/** Get whether this file is modified in a different branch, if no branch is specified defaults to FEngineVerion current branch */
|
|
bool FPlasticSourceControlState::IsModifiedInOtherBranch(const FString& CurrentBranch /* = FString() */) const
|
|
{
|
|
return !HeadBranch.IsEmpty();
|
|
}
|
|
|
|
/** Get head modification information for other branches
|
|
* @returns true with parameters populated if there is a branch with a newer modification (edit/delete/etc)
|
|
*/
|
|
bool FPlasticSourceControlState::GetOtherBranchHeadModification(FString& HeadBranchOut, FString& ActionOut, int32& HeadChangeListOut) const
|
|
{
|
|
HeadBranchOut = HeadBranch;
|
|
ActionOut = HeadAction;
|
|
HeadChangeListOut = HeadChangeList;
|
|
|
|
return !HeadBranch.IsEmpty();
|
|
}
|
|
|
|
bool FPlasticSourceControlState::IsCurrent() const
|
|
{
|
|
// NOTE: Deleted assets get a "-1" HeadRevision which we do not want to override the real icon state
|
|
const bool bIsCurrent = (LocalRevisionChangeset == DepotRevisionChangeset) || (WorkspaceState == EWorkspaceState::Deleted);
|
|
|
|
if (bIsCurrent)
|
|
{
|
|
UE_LOG(LogSourceControl, VeryVerbose, TEXT("%s IsCurrent"), *LocalFilename);
|
|
}
|
|
|
|
return bIsCurrent;
|
|
}
|
|
|
|
bool FPlasticSourceControlState::IsSourceControlled() const
|
|
{
|
|
const bool bIsSourceControlled = WorkspaceState != EWorkspaceState::Private
|
|
&& WorkspaceState != EWorkspaceState::Ignored
|
|
&& WorkspaceState != EWorkspaceState::Unknown;
|
|
|
|
if (!bIsSourceControlled && !IsUnknown()) UE_LOG(LogSourceControl, Log, TEXT("%s NOT SourceControlled"), *LocalFilename);
|
|
|
|
return bIsSourceControlled;
|
|
}
|
|
|
|
bool FPlasticSourceControlState::IsAdded() const
|
|
{
|
|
const bool bIsAdded = WorkspaceState == EWorkspaceState::Added
|
|
|| WorkspaceState == EWorkspaceState::Copied;
|
|
|
|
if (bIsAdded) UE_LOG(LogSourceControl, Log, TEXT("%s IsAdded"), *LocalFilename);
|
|
|
|
return bIsAdded;
|
|
}
|
|
|
|
bool FPlasticSourceControlState::IsDeleted() const
|
|
{
|
|
const bool bIsDeleted = WorkspaceState == EWorkspaceState::Deleted
|
|
|| WorkspaceState == EWorkspaceState::LocallyDeleted;
|
|
|
|
if (bIsDeleted) UE_LOG(LogSourceControl, Log, TEXT("%s IsDeleted"), *LocalFilename);
|
|
|
|
return bIsDeleted;
|
|
}
|
|
|
|
bool FPlasticSourceControlState::IsIgnored() const
|
|
{
|
|
if (WorkspaceState == EWorkspaceState::Ignored) UE_LOG(LogSourceControl, Log, TEXT("%s IsIgnored"), *LocalFilename);
|
|
|
|
return WorkspaceState == EWorkspaceState::Ignored;
|
|
}
|
|
|
|
bool FPlasticSourceControlState::CanEdit() const
|
|
{
|
|
const bool bCanEdit = WorkspaceState == EWorkspaceState::CheckedOut
|
|
|| WorkspaceState == EWorkspaceState::Added
|
|
|| WorkspaceState == EWorkspaceState::Moved
|
|
|| WorkspaceState == EWorkspaceState::Copied
|
|
|| WorkspaceState == EWorkspaceState::Replaced;
|
|
|
|
UE_LOG(LogSourceControl, Log, TEXT("%s CanEdit=%d"), *LocalFilename, bCanEdit);
|
|
|
|
return bCanEdit;
|
|
}
|
|
|
|
bool FPlasticSourceControlState::CanDelete() const
|
|
{
|
|
return !IsCheckedOutOther() && IsSourceControlled() && IsCurrent();
|
|
}
|
|
|
|
bool FPlasticSourceControlState::IsUnknown() const
|
|
{
|
|
return WorkspaceState == EWorkspaceState::Unknown;
|
|
}
|
|
|
|
bool FPlasticSourceControlState::IsModified() const
|
|
{
|
|
// Warning: for a clean "check-in" (commit) checked-out files unmodified should be removed from the changeset (the index)
|
|
//
|
|
// Thus, before check-in UE4 Editor call RevertUnchangedFiles() in PromptForCheckin() and CheckinFiles().
|
|
//
|
|
// So here we must take care to enumerate all states that need to be commited, all other will be discarded:
|
|
// - Unknown
|
|
// - Controlled (Unchanged)
|
|
// - Private (Not Controlled)
|
|
// - Ignored
|
|
const bool bIsModified = WorkspaceState == EWorkspaceState::CheckedOut
|
|
|| WorkspaceState == EWorkspaceState::Added
|
|
|| WorkspaceState == EWorkspaceState::Moved
|
|
|| WorkspaceState == EWorkspaceState::Copied
|
|
|| WorkspaceState == EWorkspaceState::Replaced
|
|
|| WorkspaceState == EWorkspaceState::Deleted
|
|
|| WorkspaceState == EWorkspaceState::LocallyDeleted
|
|
|| WorkspaceState == EWorkspaceState::Changed
|
|
|| WorkspaceState == EWorkspaceState::Conflicted;
|
|
|
|
UE_LOG(LogSourceControl, Verbose, TEXT("%s IsModified=%d"), *LocalFilename, bIsModified);
|
|
|
|
return bIsModified;
|
|
}
|
|
|
|
|
|
bool FPlasticSourceControlState::CanAdd() const
|
|
{
|
|
if (!IsUnknown()) UE_LOG(LogSourceControl, Log, TEXT("%s CanAdd=%d"), *LocalFilename, WorkspaceState == EWorkspaceState::Private);
|
|
|
|
return WorkspaceState == EWorkspaceState::Private;
|
|
}
|
|
|
|
bool FPlasticSourceControlState::IsConflicted() const
|
|
{
|
|
if (WorkspaceState == EWorkspaceState::Conflicted) UE_LOG(LogSourceControl, Log, TEXT("%s IsConflicted"), *LocalFilename);
|
|
|
|
return WorkspaceState == EWorkspaceState::Conflicted;
|
|
}
|
|
|
|
bool FPlasticSourceControlState::CanRevert() const
|
|
{
|
|
return IsModified();
|
|
}
|
|
|
|
#undef LOCTEXT_NAMESPACE
|