UnrealEngineUWP/Engine/Source/Editor/DeviceProfileEditor/Private/SDeviceProfileEditor.cpp

// Copyright 1998-2014 Epic Games, Inc. All Rights Reserved.


/*=============================================================================
	SDeviceProfileEditor.cpp: Implements the SDeviceProfileEditor class.
=============================================================================*/


#include "DeviceProfileEditorPCH.h"

#include "DeviceProfiles/DeviceProfileManager.h"
#include "DeviceProfiles/DeviceProfile.h"
#include "ISourceControlModule.h"
#include "PropertyEditorModule.h"
#include "PropertyPath.h"


#define LOCTEXT_NAMESPACE "DeviceProfileEditor"

// Tab names for those available in the Device Profile Editor.
static const FName DeviceProfileEditorTabName("DeviceProfiles");



/** Source control for the default device profile config saves */
class SDeviceProfileSourceControl : public SCompoundWidget
{

public:

	SLATE_BEGIN_ARGS(SDeviceProfileSourceControl) {}
		SLATE_DEFAULT_SLOT(FArguments, Content)
	SLATE_END_ARGS()


	/** Constructs this widget with InArgs */
	void Construct(const FArguments& InArgs);

	
	/** Destructor */
	~SDeviceProfileSourceControl();


	/**
	 * Indicate which SWidgetSwitcher slot should be used to show the user of the source control status
	 */
	int32 HandleNoticeSwitcherWidgetIndex() const
	{
		return bIsDefaultConfigCheckOutNeeded ? 1 : 0;
	}


	/**
	 * Take action to check out the default device profile configuration file when requested
	 *
	 * @return - Whether we handled the event
	 */
	FReply HandleSaveDefaultsButtonPressed();


	/**
	* Take action to check out the default device profile configuration file when requested
	*
	* @return - Whether we handled the event
	*/
	FReply HandleCheckoutButtonPressed();


	/**
	 * Check whether the SCC is enabled for the Checkout button to become available.
	 */
	bool IsCheckOutAvailable() const;


public:

	// Begin SCompoundWidget interface
	virtual void Tick(const FGeometry& AllottedGeometry, const double InCurrentTime, const float InDeltaTime) override;
	// End SCompoundWidget interface


private:

	// Holds a timer for checking whether the device profile configuration file needs to be checked out.
	float DefaultConfigCheckOutTimer;

	// Holds a flag indicating whether the section's configuration file needs to be checked out.
	bool bIsDefaultConfigCheckOutNeeded;

	// The direct path to the default device profile config file
	FString AbsoluteConfigFilePath;
};


SDeviceProfileSourceControl::~SDeviceProfileSourceControl()
{

}


FReply SDeviceProfileSourceControl::HandleSaveDefaultsButtonPressed()
{
	GEngine->GetDeviceProfileManager()->SaveProfiles(true);

	return FReply::Handled();
}


FReply SDeviceProfileSourceControl::HandleCheckoutButtonPressed()
{
	ISourceControlProvider& SourceControlProvider = ISourceControlModule::Get().GetProvider();
	FSourceControlStatePtr SourceControlState = SourceControlProvider.GetState(AbsoluteConfigFilePath, EStateCacheUsage::ForceUpdate);

	FText ErrorMessage;
	if(bIsDefaultConfigCheckOutNeeded && SourceControlState.IsValid() && (SourceControlState->CanCheckout() || SourceControlState->IsCheckedOutOther()))
	{
		TArray<FString> FilesToBeCheckedOut;
		FilesToBeCheckedOut.Add(AbsoluteConfigFilePath);
		if(SourceControlProvider.Execute(ISourceControlOperation::Create<FCheckOut>(), FilesToBeCheckedOut) == ECommandResult::Failed)
		{
			ErrorMessage = LOCTEXT("FailedToCheckOutConfigFileError", "Error: Failed to check out the configuration file.");
		}
	}
	
	// show errors, if any
	if (!ErrorMessage.IsEmpty())
	{
		FMessageDialog::Open(EAppMsgType::Ok, ErrorMessage);
	}

	return FReply::Handled();
}


bool SDeviceProfileSourceControl::IsCheckOutAvailable() const
{
	return ISourceControlModule::Get().IsEnabled() && ISourceControlModule::Get().GetProvider().IsAvailable();
}


void SDeviceProfileSourceControl::Construct(const FArguments& InArgs)
{
	DefaultConfigCheckOutTimer = 0.0f;
	bIsDefaultConfigCheckOutNeeded = true;

	const FString RelativeConfigFilePath = FString::Printf(TEXT("%sDefault%ss.ini"), *FPaths::SourceConfigDir(), *UDeviceProfile::StaticClass()->GetName());
	AbsoluteConfigFilePath = FPaths::ConvertRelativePathToFull(RelativeConfigFilePath);

	ChildSlot
	[
		SNew(SBorder)
		.BorderBackgroundColor(FLinearColor::Yellow)
		.BorderImage(FEditorStyle::GetBrush("ToolPanel.GroupBorder"))
		.Padding(8.0f)
		[
			SNew(SBox)
			.VAlign(VAlign_Center)
			.Content()
			[
				SNew(SWidgetSwitcher)
				.WidgetIndex(this, &SDeviceProfileSourceControl::HandleNoticeSwitcherWidgetIndex)
				// Unlocked slot
				+ SWidgetSwitcher::Slot()
				[
					SNew(SHorizontalBox)
					+ SHorizontalBox::Slot()
					.VAlign(VAlign_Center)
					.AutoWidth()
					[
						SNew(SImage)
						.Image(FEditorStyle::GetBrush("GenericUnlock"))
					]
					+ SHorizontalBox::Slot()
					.VAlign(VAlign_Center)
					.Padding(FMargin(8.0f, 0.0f))
					.AutoWidth()
					[
						SNew(STextBlock)
						.Text(LOCTEXT("DeviceProfileEditorSCCUnlockedLabel", "The default device profile configuration is under Source Control. This file is currently writable."))
					]
					+ SHorizontalBox::Slot()
					.HAlign(HAlign_Right)
					[
						SNew(SButton)
						.OnClicked(this, &SDeviceProfileSourceControl::HandleSaveDefaultsButtonPressed)
						.Text(LOCTEXT("SaveAsDefaultButtonText", "Save as Default"))
					]
				]
				// Locked slot
				+SWidgetSwitcher::Slot()
				[
					SNew(SHorizontalBox)
					+ SHorizontalBox::Slot()
					.VAlign(VAlign_Center)
					.AutoWidth()
					[
						SNew(SImage)
						.Image(FEditorStyle::GetBrush("GenericLock"))
					]
					+ SHorizontalBox::Slot()
					.VAlign(VAlign_Center)
					.Padding(FMargin(8.0f, 0.0f))
					.AutoWidth()
					[
						SNew(STextBlock)
						.Text(LOCTEXT("DeviceProfileEditorSCCLockedLabel", "The default device profile configuration is under Source Control. This file is currently locked."))
					]
					+ SHorizontalBox::Slot()
					.HAlign(HAlign_Right)
					[
						SNew(SButton)
						.OnClicked(this, &SDeviceProfileSourceControl::HandleCheckoutButtonPressed)
						.IsEnabled(this, &SDeviceProfileSourceControl::IsCheckOutAvailable)
						.Text(LOCTEXT("CheckOutButtonText", "Check Out File"))
					]
				]
			]
		]
	];
}


void SDeviceProfileSourceControl::Tick(const FGeometry& AllottedGeometry, const double InCurrentTime, const float InDeltaTime)
{
	SCompoundWidget::Tick(AllottedGeometry, InCurrentTime, InDeltaTime);

	// cache selected settings object's configuration file state
	DefaultConfigCheckOutTimer += InDeltaTime;

	if(DefaultConfigCheckOutTimer >= 1.0f)
	{
		bIsDefaultConfigCheckOutNeeded = (FPaths::FileExists(AbsoluteConfigFilePath) && IFileManager::Get().IsReadOnly(*AbsoluteConfigFilePath));

		DefaultConfigCheckOutTimer = 0.0f;
	}
}


void SDeviceProfileEditor::Construct( const FArguments& InArgs )
{
	DeviceProfileManager = GEngine->GetDeviceProfileManager();

	// Setup the tab layout for the editor.
	TSharedRef<FWorkspaceItem> RootMenuGroup = FWorkspaceItem::NewGroup( LOCTEXT("RootMenuGroupName", "Root") );
	DeviceManagerMenuGroup = RootMenuGroup->AddGroup(LOCTEXT("DeviceProfileEditorMenuGroupName", "Device Profile Editor Tabs"));
	{
		TSharedRef<SDockTab> DeviceProfilePropertyEditorTab =
			SNew(SDockTab)
			. TabRole( ETabRole::MajorTab )
			. Label( LOCTEXT("TabTitle", "Device Profile Editor") )
			. ToolTipText( LOCTEXT( "TabTitle_ToolTip", "The Device Profile Editor" ) );

		TabManager = FGlobalTabmanager::Get()->NewTabManager( DeviceProfilePropertyEditorTab );

		TabManager->RegisterTabSpawner( DeviceProfileEditorTabName, FOnSpawnTab::CreateRaw( this, &SDeviceProfileEditor::HandleTabManagerSpawnTab, DeviceProfileEditorTabName) )
			.SetDisplayName(LOCTEXT("DeviceProfilePropertyEditorLabel", "Device Profile Property Editor..."))
			.SetIcon(FSlateIcon(FEditorStyle::GetStyleSetName(), "DeviceDetails.Tabs.ProfileEditor"))
			.SetGroup( DeviceManagerMenuGroup.ToSharedRef() );
	}

	EditorTabStack = FTabManager::NewStack()
		->AddTab(DeviceProfileEditorTabName, ETabState::OpenedTab)
		->SetHideTabWell(true)
		->SetForegroundTab(DeviceProfileEditorTabName);

	// Create the tab layout widget
	const TSharedRef<FTabManager::FLayout> Layout = FTabManager::NewLayout("DeviceProfileEditorLayout_v2.0")
		->AddArea
		(
			FTabManager::NewPrimaryArea()
			->SetOrientation(Orient_Horizontal)
			->Split
			(
				EditorTabStack.ToSharedRef()
			)
		);


	// Create & initialize main menu
	FMenuBarBuilder MenuBarBuilder = FMenuBarBuilder(TSharedPtr<FUICommandList>());
	MenuBarBuilder.AddPullDownMenu(
		LOCTEXT("WindowMenuLabel", "Window"),
		FText::GetEmpty(),
		FNewMenuDelegate::CreateSP(TabManager.ToSharedRef(), &FTabManager::PopulateTabSpawnerMenu, RootMenuGroup)
	);


	ChildSlot
	[		
		// Create tab well where our property grid etc. will live
		SNew(SSplitter)
		+ SSplitter::Slot()
		.Value(0.3f)
		[
			CreateMainDeviceProfilePanel().ToSharedRef()
		]
		+ SSplitter::Slot()
		.Value(0.7f)
		[
			SNew(SVerticalBox)
			+SVerticalBox::Slot()
			.AutoHeight()
			[
				SNew(SDeviceProfileSourceControl)
			]
			+SVerticalBox::Slot()
			.Padding(FMargin(0.0f,2.0f))
			.AutoHeight()
			[
				MenuBarBuilder.MakeWidget()
			]
			+ SVerticalBox::Slot()
			[
				TabManager->RestoreFrom(Layout, TSharedPtr<SWindow>()).ToSharedRef()
			]
		]
	];
}


SDeviceProfileEditor::~SDeviceProfileEditor()
{
	if( DeviceProfileManager.IsValid() )
	{
		DeviceProfileManager->SaveProfiles();

		// Unbind our delegates when destroyed
		DeviceProfileManager->OnManagerUpdated().RemoveRaw( this, &SDeviceProfileEditor::RebuildPropertyTable );
	}

	if (TabManager.IsValid())
	{
		TabManager->CloseAllAreas();
	}
}


TSharedPtr< SWidget > SDeviceProfileEditor::CreateMainDeviceProfilePanel()
{
	TSharedPtr< SWidget > PanelWidget = SNew( SSplitter )
		.Orientation( Orient_Vertical )
		+ SSplitter::Slot()
		.Value( 1.0f )
		[
			SNew( SBorder )
			.BorderImage( FEditorStyle::GetBrush( "Docking.Tab.ContentAreaBrush" ) )
			[
				SAssignNew( DeviceProfileSelectionPanel, SDeviceProfileSelectionPanel, DeviceProfileManager )
				.OnDeviceProfilePinned( this, &SDeviceProfileEditor::HandleDeviceProfilePinned )
				.OnDeviceProfileUnpinned( this, &SDeviceProfileEditor::HandleDeviceProfileUnpinned )
				.OnDeviceProfileViewAlone( this, &SDeviceProfileEditor::HandleDeviceProfileViewAlone )
			]
		]
		+ SSplitter::Slot()
		.SizeRule(SSplitter::ESizeRule::SizeToContent)
		[
			SNew( SBorder )
			.BorderImage( FEditorStyle::GetBrush( "Docking.Tab.ContentAreaBrush" ) )
			[
				SNew( SDeviceProfileCreateProfilePanel, DeviceProfileManager )
			]
		];

	return PanelWidget;
}


TSharedRef<SDockTab> SDeviceProfileEditor::HandleTabManagerSpawnTab( const FSpawnTabArgs& Args, FName TabIdentifier )
{
	TSharedPtr<SWidget> TabWidget = SNullWidget::NullWidget;

	if( TabIdentifier == DeviceProfileEditorTabName )
	{
		TabWidget = SNew(SBorder)
			.BorderImage(FEditorStyle::GetBrush("ToolBar.Background"))
			[
				SNew(SOverlay)
				+ SOverlay::Slot()
				[
					// Show the property editor
					SNew(SHorizontalBox)
					+ SHorizontalBox::Slot()
					.FillWidth(0.375f)
					[
						SNew(SBorder)
						.Padding(2)
						.Content()
						[
							SetupPropertyEditor()
						]
					]
				]

				+ SOverlay::Slot()
				[
					// Conditionally draw a notification that indicates profiles should be pinned to be visible.
					SNew(SVerticalBox)
					.Visibility(this, &SDeviceProfileEditor::GetEmptyDeviceProfileGridNotificationVisibility)
					+ SVerticalBox::Slot()
					[
						SNew(SBorder)
						.BorderImage(FEditorStyle::GetBrush("ToolBar.Background"))
						[
							SNew(SHorizontalBox)
							+ SHorizontalBox::Slot()
							.AutoWidth()
							.HAlign(HAlign_Center)
							.VAlign(VAlign_Center)
							[
								SNew(SImage)
								.Image(FEditorStyle::GetBrush("PropertyEditor.AddColumnOverlay"))
							]

							+ SHorizontalBox::Slot()
							.AutoWidth()
							.HAlign(HAlign_Center)
							.VAlign(VAlign_Center)
							[
								SNew(SImage)
								.Image(FEditorStyle::GetBrush("PropertyEditor.RemoveColumn"))
							]

							+ SHorizontalBox::Slot()
							.AutoWidth()
							.HAlign(HAlign_Center)
							.VAlign(VAlign_Center)
							.Padding(FMargin(0, 0, 3, 0))
							[
								SNew(STextBlock)
								.Font(FEditorStyle::GetFontStyle("PropertyEditor.AddColumnMessage.Font"))
								.Text(LOCTEXT("GenericPropertiesTitle", "Pin Profiles to Add Columns"))
								.ColorAndOpacity(FEditorStyle::GetColor("PropertyEditor.AddColumnMessage.Color"))
							]
						]
					]
				]
			];
	}

	// Return the tab with the relevant widget embedded
	return SNew(SDockTab)
		.TabRole(ETabRole::PanelTab)
		[
			TabWidget.ToSharedRef()
		];
}


TSharedRef<SDockTab> SDeviceProfileEditor::HandleTabManagerSpawnSingleProfileTab(const FSpawnTabArgs& Args, TWeakObjectPtr< UDeviceProfile > InDeviceProfile)
{
	TSharedPtr<SWidget> TabWidget = SNullWidget::NullWidget;

	TabWidget = SNew(SVerticalBox)
		+ SVerticalBox::Slot()
		[
			SNew(SDeviceProfileEditorSingleProfileView, InDeviceProfile)
		];

	TSharedPtr< SDockTab > Tab = SNew(SDockTab)
		.TabRole(ETabRole::PanelTab)
		[
			TabWidget.ToSharedRef()
		];

	// Return the tab with the relevant widget embedded
	return Tab.ToSharedRef();
}


void SDeviceProfileEditor::HandleDeviceProfilePinned( const TWeakObjectPtr< UDeviceProfile >& DeviceProfile )
{
	if( !DeviceProfiles.Contains( DeviceProfile.Get() ) )
	{
		DeviceProfiles.Add( DeviceProfile.Get() );
		RebuildPropertyTable();

		TabManager->InvokeTab(DeviceProfileEditorTabName);
	}
}


void SDeviceProfileEditor::HandleDeviceProfileUnpinned( const TWeakObjectPtr< UDeviceProfile >& DeviceProfile )
{
	if( DeviceProfiles.Contains( DeviceProfile.Get() ) )
	{
		DeviceProfiles.Remove( DeviceProfile.Get() );
		RebuildPropertyTable();

		TabManager->InvokeTab(DeviceProfileEditorTabName);
	}
}


void SDeviceProfileEditor::HandleDeviceProfileViewAlone( const TWeakObjectPtr< UDeviceProfile >& DeviceProfile )
{
	FName TabId = DeviceProfile->GetFName();

	if( !RegisteredTabIds.Contains( TabId ) )
	{
		RegisteredTabIds.Add(TabId);

		TabManager->RegisterTabSpawner(TabId, FOnSpawnTab::CreateRaw(this, &SDeviceProfileEditor::HandleTabManagerSpawnSingleProfileTab, DeviceProfile))
			.SetDisplayName(FText::FromName(TabId))
			.SetIcon(FSlateIcon(FEditorStyle::GetStyleSetName(), "DeviceDetails.Tabs.ProfileEditorSingleProfile"))
			.SetGroup(DeviceManagerMenuGroup.ToSharedRef());
	}

	TabManager->InvokeTab(TabId);
}


EVisibility SDeviceProfileEditor::GetEmptyDeviceProfileGridNotificationVisibility() const
{
	// IF we aren't showing any items, our prompt should be visible
	return PropertyTable->GetRows().Num() > 0 ?	EVisibility::Hidden : EVisibility::Visible;
}


TSharedRef< SWidget > SDeviceProfileEditor::SetupPropertyEditor()
{
	FPropertyEditorModule& PropertyEditorModule = FModuleManager::LoadModuleChecked<FPropertyEditorModule>( "PropertyEditor" );

	PropertyTable = PropertyEditorModule.CreatePropertyTable();
	RebuildPropertyTable();

	// Adapt the CVars column as a button to open a single editor which will allow better control of the Console Variables
	TSharedRef<FDeviceProfileConsoleVariableColumn> CVarsColumn = MakeShareable(new FDeviceProfileConsoleVariableColumn());

	// Bind our action to open a single editor when requested from the property table
	CVarsColumn->OnEditCVarsRequest().BindRaw(this, &SDeviceProfileEditor::HandleDeviceProfileViewAlone);

	// Add our Custom Rows to the table
	TArray<TSharedRef<IPropertyTableCustomColumn>> CustomColumns;
	CustomColumns.Add(CVarsColumn);

	return PropertyEditorModule.CreatePropertyTableWidget(PropertyTable.ToSharedRef(), CustomColumns);
}


void SDeviceProfileEditor::RebuildPropertyTable()
{
	PropertyTable->SetObjects( DeviceProfiles );
	PropertyTable->SetSelectionMode( ESelectionMode::None );

	PropertyTable->SetIsUserAllowedToChangeRoot( false );

	for (TFieldIterator<UProperty> DeviceProfilePropertyIter( UDeviceProfile::StaticClass() ); DeviceProfilePropertyIter; ++DeviceProfilePropertyIter)
	{
		TWeakObjectPtr< UProperty > DeviceProfileProperty = *DeviceProfilePropertyIter;
		if(DeviceProfileProperty->GetName() != TEXT("Parent") )
		{
			PropertyTable->AddColumn(DeviceProfileProperty);
		}
	}

	PropertyTable->RequestRefresh();
}


#undef LOCTEXT_NAMESPACE