// Copyright Epic Games, Inc. All Rights Reserved. #pragma once #include "CoreMinimal.h" #include "Modules/ModuleInterface.h" #include "Modules/ModuleManager.h" #include "UObject/UObjectGlobals.h" class ISourceControlProvider; class ISourceControlChangelist; class FSourceControlAssetDataCache; typedef TSharedPtr FSourceControlChangelistPtr; SOURCECONTROL_API DECLARE_LOG_CATEGORY_EXTERN(LogSourceControl, Log, All); /** Delegate called when the source control login window is closed. Parameter determines if source control is enabled or not */ DECLARE_DELEGATE_OneParam( FSourceControlLoginClosed, bool ); /** Delegate called when the active source control provider is changed */ DECLARE_MULTICAST_DELEGATE_TwoParams( FSourceControlProviderChanged, ISourceControlProvider& /*OldProvider*/, ISourceControlProvider& /*NewProvider*/ ); /** Delegate called on pre-submit for data validation */ DECLARE_DELEGATE_FourParams(FSourceControlPreSubmitDataValidationDelegate, FSourceControlChangelistPtr /*Changelist*/, EDataValidationResult& /*Result*/, TArray& /*ValidationErrors*/, TArray& /*ValidationWarnings*/); /** * Delegate called once the user has confirmed that they want to submit files to source control BUT before the files are actually submitted. * It is intended for last minute checks that can only run once there is no chance of the user canceling the actual submit. * At this point the only way to prevent the files from being submitted is for this delegate to return errors. * * @param FilesToSubmit The absolute file paths of the files being submitted * @param OutDescriptionTags Lines of text to be appending to the submit description * @param OutErrors Errors encountered while the delegate is invoked. If the array contains entries then files will not be submitted and the user given the errors instead */ DECLARE_MULTICAST_DELEGATE_ThreeParams(FSourceControlPreSubmitFinalizeDelegate, const TArray& /*FilesToSubmit*/, TArray& /*OutDescriptionTags*/, TArray& /*OutErrors*/); /** * Delegate called after source control operations deleted files. * * @param DeletedFiles The absolute file paths of the deleted files */ DECLARE_MULTICAST_DELEGATE_OneParam(FSourceControlFilesDeletedDelegate, const TArray& /*InDeletedFiles*/); /** * The modality of the login window. */ namespace ELoginWindowMode { enum Type { Modal, Modeless }; }; /** * Login window startup behavior */ namespace EOnLoginWindowStartup { enum Type { ResetProviderToNone, PreserveProvider }; }; /** * Interface for talking to source control providers */ class ISourceControlModule : public IModuleInterface { public: /** * Returns a list of the registered source control providers */ virtual void GetProviderNames(TArray& OutProviderNames) = 0; /** * Tick the source control module. * This is responsible for dispatching batched/queued status requests & for calling ISourceControlProvider::Tick() */ virtual void Tick() = 0; /** * Queues a file to have its source control status updated in the background. * @param InPackages The packages to queue. */ virtual void QueueStatusUpdate(const TArray& InPackages) = 0; /** * Queues a file to have its source control status updated in the background. * @param InFilenames The files to queue. */ virtual void QueueStatusUpdate(const TArray& InFilenames) = 0; /** * Queues a file to have its source control status updated in the background. * @param InPackage The package to queue. */ virtual void QueueStatusUpdate(UPackage* InPackage) = 0; /** * Queues a file to have its source control status updated in the background. * @param InFilename The file to queue. */ virtual void QueueStatusUpdate(const FString& InFilename) = 0; /** * Check whether source control is enabled. Specifically, it returns true if a source control provider is set (regardless of whether the provider is available) and false if no provider is set. */ virtual bool IsEnabled() const = 0; /** * Get the source control provider that is currently in use. */ virtual ISourceControlProvider& GetProvider() const = 0; /** * Get the source control AssetData information cache. */ virtual FSourceControlAssetDataCache& GetAssetDataCache() = 0; /** * Set the current source control provider to the one specified here by name. * This will assert if the provider does not exist. * @param InName The name of the provider */ virtual void SetProvider( const FName& InName ) = 0; /** * Show the source control login dialog * @param InOnWindowClosed Delegate to be called when the login window is closed. * @param InLoginWindowMode Whether the dialog should be presented modally or not. Note that this function blocks if the modality is Modal. * @param InOnLoginWindowStartup Whether the provider should be set to 'None' on dialog startup */ virtual void ShowLoginDialog(const FSourceControlLoginClosed& InOnSourceControlLoginClosed, ELoginWindowMode::Type InLoginWindowMode, EOnLoginWindowStartup::Type InOnLoginWindowStartup = EOnLoginWindowStartup::ResetProviderToNone) = 0; /** * Get whether we should use global or per-project settings * @return true if we should use global settings */ virtual bool GetUseGlobalSettings() const = 0; /** * Set whether we should use global or per-project settings * @param bIsUseGlobalSettings Whether we should use global settings */ virtual void SetUseGlobalSettings(bool bIsUseGlobalSettings) = 0; /** * Register a delegate to be called when the source control provider changes */ virtual FDelegateHandle RegisterProviderChanged(const FSourceControlProviderChanged::FDelegate& SourceControlProviderChanged) = 0; /** * Unregister a delegate to be called when the source control provider changes */ virtual void UnregisterProviderChanged(FDelegateHandle Handle) = 0; /** * Register a delegate to be called to validate asset changes before submitting changes */ virtual void RegisterPreSubmitDataValidation(const FSourceControlPreSubmitDataValidationDelegate& PreSubmitDataValidationDelegate) = 0; /** * Unregister a delegate called before submitting changes */ virtual void UnregisterPreSubmitDataValidation() = 0; /** * Gets currently registered delegates for pre-submit data validation */ virtual FSourceControlPreSubmitDataValidationDelegate GetRegisteredPreSubmitDataValidation() = 0; /** * Register a delegate that is invokes right before files are submitted to source control. @see FSourceControlPreSubmitFinalizeDelegate */ virtual FDelegateHandle RegisterPreSubmitFinalize(const FSourceControlPreSubmitFinalizeDelegate::FDelegate& Delegate) = 0; /** * Unregister a previously registered delegate. @see FSourceControlPreSubmitFinalizeDelegate */ virtual void UnregisterPreSubmitFinalize(FDelegateHandle Handle) = 0; /** * Returns access to the delegate so that it can be broadcast as needed. @see FSourceControlPreSubmitFinalizeDelegate */ virtual const FSourceControlPreSubmitFinalizeDelegate& GetOnPreSubmitFinalize() const = 0; /** * Registers a delegate that is invoked after source control operation deleted files. @see FSourceControlFilesDeletedDelegate */ virtual FDelegateHandle RegisterFilesDeleted(const FSourceControlFilesDeletedDelegate::FDelegate& InDelegate) = 0; /** * Unregister a previously registered delegate. @see FSourceControlFilesDeletedDelegate */ virtual void UnregisterFilesDeleted(FDelegateHandle InHandle) = 0; /** * Returns access to the delegate so that it can be broadcast as needed. @see FSourceControlFilesDeletedDelegate */ virtual const FSourceControlFilesDeletedDelegate& GetOnFilesDeleted() const = 0; /** * Gets a reference to the source control module instance. * * @return A reference to the source control module. */ static inline ISourceControlModule& Get() { static FName SourceControlModule("SourceControl"); return FModuleManager::LoadModuleChecked(SourceControlModule); } };