1. Epic GamesDeveloper
  3. ISourceControlProvider

ISourceControlProvider

Interface to talking with source control providers.

Unreal Engine C++ API Reference > Developer > SourceControl

Inheritance Hierarchy

References

   
Module SourceControl
Header /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h
Include #include "ISourceControlProvider.h"

Syntax

class ISourceControlProvider : public IModularFeature

Remarks

Interface to talking with source control providers.

Destructors

  Type Name Description
Public function Virtual   Virtual destructor

Functions

  Type Name Description
Public function Const bool Whether the provider allow a diff between a changed file and the depot
Public function Const bool Check to see if we can cancel an operation.
Public function void Attempt to cancel an operation in progress.
Public function Const bool Check to see if we can execute an operation.
Public function void

Close ()

 Shut down source control provider.
Protected function Virtual Const TUniquePtr< ISourceControlProvider >

Create ( const FStringView& OwnerName,
const FSourceControlInitSettings& InitialSettings
)

 Creates a new instance of the source control provider type.
Public function Virtual ECommandResult::Type

Execute ( const FSourceControlOperationRef& InOperation,
const EConcurrency::Type InConcurrency,
const FSourceControlOperationComplete& InOperationCompleteDelegate
)

 Helper overload for operation execution, see Execute().
Public function Virtual ECommandResult::Type

Execute ( const FSourceControlOperationRef& InOperation,
const FString& InFile,
const EConcurrency::Type InConcurrency,
const FSourceControlOperationComplete& InOperationCompleteDelegate
)

 Helper overload for operation execution, see Execute().
Public function Virtual ECommandResult::Type

Execute ( const FSourceControlOperationRef& InOperation,
const TArray< UPackage* >& InPackages,
const EConcurrency::Type InConcurrency,
const FSourceControlOperationComplete& InOperationCompleteDelegate
)

 Helper overload for operation execution, see Execute().
Public function Virtual ECommandResult::Type

Execute ( const FSourceControlOperationRef& InOperation,
FSourceControlChangelistPtr InChangelist,
const EConcurrency::Type InConcurrency,
const FSourceControlOperationComplete& InOperationCompleteDelegate
)

 Helper overload for operation execution, see Execute().
Public function ECommandResult::Type

Execute ( const FSourceControlOperationRef& InOperation,
FSourceControlChangelistPtr InChangelist,
const TArray< FString >& InFiles,
EConcurrency::Type InConcurrency,
const FSourceControlOperationComplete& InOperationCompleteDelegate
)

 Attempt to execute an operation on the passed-in files (if any are required).
Public function Virtual ECommandResult::Type

Execute ( const FSourceControlOperationRef& InOperation,
const TArray< FString >& InFiles,
EConcurrency::Type InConcurrency,
const FSourceControlOperationComplete& InOperationCompleteDelegate
)

 Helper overload for operation execution, see Execute().
Public function Virtual ECommandResult::Type

Execute ( const FSourceControlOperationRef& InOperation,
const UPackage* InPackage,
const EConcurrency::Type InConcurrency,
const FSourceControlOperationComplete& InOperationCompleteDelegate
)

 Helper overload for operation execution, see Execute().
Public function Const TArray< FSourceControlStateRef > Get all cached source control state objects for which the supplied predicate returns true
Public function TArray< FSourceControlChangelistRef >

GetChangelists ( EStateCacheUsage::Type InStateCacheUsage
)

 Returns the list of available changelists if the underlying source control supports the 'changelist' concept.
Public function Virtual Const TSharedPtr< class ISourceControlLabel >

GetLabel ( const FString& InLabelName
)

 Get a label matching the passed-in name.
Public function Const TArray< TSharedRef< class ISourceControlLabel > >

GetLabels ( const FString& InMatchingSpec
)

 Get an array of labels matching the passed-in spec.
Public function Const const FName &

GetName ()

 Get the source control provider name
Public function Const TOptional< int > Returns the number of changes in the local workspace NOTE: This concept is currently only implemented for the Skein source control provider.
Public function Virtual ECommandResult::Type

GetState ( const TArray< UPackage* >& InPackages,
TArray< FSourceControlStateRef >& OutState,
EStateCacheUsage::Type InStateCacheUsage
)

 Helper overload for state retrieval, see GetState().
Public function Virtual FSourceControlStatePtr

GetState ( const FString& InFile,
EStateCacheUsage::Type InStateCacheUsage
)

 Helper overload for state retrieval, see GetState().
Public function Virtual FSourceControlStatePtr

GetState ( const UPackage* InPackage,
EStateCacheUsage::Type InStateCacheUsage
)

 Helper overload for state retrieval, see GetState().
Public function Virtual FSourceControlChangelistStatePtr

GetState ( const FSourceControlChangelistRef& InChangelist,
EStateCacheUsage::Type InStateCacheUsage
)

 Helper overload for state retrieval, see GetState().
Public function ECommandResult::Type

GetState ( const TArray< FSourceControlChangelistRef >& InChangelists,
TArray< FSourceControlChangelistStateRef >& OutState,
EStateCacheUsage::Type InStateCacheUsage
)

 Get the state of each of the passed-in changelists.
Public function ECommandResult::Type

GetState ( const TArray< FString >& InFiles,
TArray< FSourceControlStateRef >& OutState,
EStateCacheUsage::Type InStateCacheUsage
)

 Get the state of each of the passed-in files.
Public function Const int32

GetStateBranchIndex ( const FString& BranchName
)

 Gets the state index of the specified branch, higher index branches are generally closer to releases
Public function Const TMap< EStatus, FString > Get the source control status as a series of key value pairs
Public function Const FText Get the source control status as plain, human-readable text
Public function void

Init ( bool bForceConnection
)

 Initialize source control provider.
Public function Const TOptional< bool > Whether the current source control client is at the latest version
Public function Const bool Quick check if source control is available for use (server-based providers can use this to return whether the server is available or not)
Public function Const bool Quick check if source control is enabled.
Public function Virtual ECommandResult::Type

Login ( const FString& InPassword,
EConcurrency::Type InConcurrency,
const FSourceControlOperationComplete& InOperationCompleteDelegate
)

 Login to the source control server (if any).
Public function Const TSharedRef< class SWidget > Create a settings widget for display in the login window.
Public function bool

QueryStateBranchConfig ( const FString& ConfigSrc,
const FString& ConfigDest
)

 Queries branch configuration from source control
Public function FDelegateHandle

RegisterSourceControlStateChanged_Handle ( const FSourceControlStateChanged::FDelegate& SourceControlStateChanged
)

 Register a delegate to be called when source control state(s) change
Public function void

RegisterStateBranches ( const TArray< FString >& BranchNames,
const FString& ContentRoot
)

 Register branches to query for state in addition to the current branch
Public function Virtual ECommandResult::Type

SwitchWorkspace ( FStringView NewWorkspaceName,
FSourceControlResultInfo& OutResultInfo,
FString* OutOldWorkspaceName
)

 Used to switch the provider from one workspace to another.
Public function void

Tick ()

 Called every update.
Public function bool

TryToDownloadFileFromBackgroundThread ( const TSharedRef< class FDownloadFile >& InOperation,
const FString& InFile
)

 Executes the FDownloadFile operation, but unlike the Execute method this can be called from a background thread, this works because FDownloadFile is thread safe and it does not change the state of source control.
Public function Virtual bool

TryToDownloadFileFromBackgroundThread ( const TSharedRef< class FDownloadFile >& InOperation,
const TArray< FString >& InFiles
)

 Executes the FDownloadFile operation, but unlike the Execute method this can be called from a background thread, this works because FDownloadFile is thread safe and it does not change the state of source control.
Public function void Unregister a delegate to be called when source control state(s) change
Public function Const bool Whether the provider uses changelists to identify commits/revisions
Public function Const bool Whether the provider uses the checkout workflow
Public function Const bool Whether the provider uses individual file revisions
Public function Const bool Whether the provider uses local read-only state to signal whether a file is editable.
Public function Const bool Whether the provider uses snapshots
Public function Const bool Whether the provider supports uncontrolled changelists to allow work offline

Enums

  Type Name Description
Public enum EStatus    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page