Plugin/Source/SenseGloveSettings/Private/SGSettings/SGSettings.cpp

/**
 * @file
 *
 * @author  Mamadou Babaei <mamadou@senseglove.com>
 *
 * @section LICENSE
 *
 * (The MIT License)
 *
 * Copyright (c) 2020 - 2025 SenseGlove
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 * @section DESCRIPTION
 *
 *
 */


#include "SGSettings/SGSettings.h"

#include "Containers/Array.h"
#include "Engine/Engine.h"
#include "PropertyEditorModule.h"
#include "UObject/NameTypes.h"
#include "UObject/Object.h"
#include "UObject/Package.h"
#include "UObject/UObjectGlobals.h"

#include "SGLog/SGLog.h"
#include "SGSettings/SGWristTrackingDetailsCustomization.h"

struct USGSettings::FImpl
{
    /************************
     * Static methods
     ************************/

    FORCENOINLINE static const FName& GetWristTrackingSettingsPropertyName()
    {
        static const FName Name{TEXT("SGWristTrackingSettings")};
        return Name;
    }

    /************************
     * Owner object
     ************************/

    USGSettings* Owner;

    /************************
     * Constructor / Destructor
     ************************/

    explicit FImpl(USGSettings* InOwner);
    ~FImpl();

    /************************
     * Default copy constructor & copy assignment operator
     ************************/

    FImpl(const FImpl& Rhs) = default;
    FImpl& operator=(const FImpl& Rhs) = default;

    /************************
     * Methods
     ************************/

    void RegisterCustomPropertyTypeLayouts();
    void UnregisterCustomPropertyTypeLayouts();
};

USGSettings* USGSettings::GetInstance()
{
    /// HACK
    // Allow the game module to use the settings system in situations when GEngine is not initialized, yet!
    // e.g. from SGPawn's CDO.
    if (!GEngine)
    {
        USGSettings* StartupInstance{
            NewObject<USGSettings>(GetTransientPackage(), FName(TEXT("SGSettings")))
        };
        return StartupInstance;
    }

    USGSettings* Instance{GEngine->GetEngineSubsystem<USGSettings>()};
    return Instance;
}

USGSettings::USGSettings()
    : Pimpl(TUniquePtr<FImpl, FImplDeleter>(new FImpl{this}, PimplDeleter))
{
}

bool USGSettings::ShouldCreateSubsystem(UObject* Outer) const
{
    return true;
}

void USGSettings::Initialize(FSubsystemCollectionBase& Collection)
{
    SGLOG("Initializing the SenseGlove settings singleton with the engine lifetime...");

    Super::Initialize(Collection);

    Pimpl->RegisterCustomPropertyTypeLayouts();

    SGLOG("The SenseGlove settings singleton has been successfully initialized with the engine lifetime!");
}

void USGSettings::Deinitialize()
{
    SGLOG("De-initializing the SenseGlove settings singleton due to the engine lifetime expiration...");

    Super::Deinitialize();

    Pimpl->UnregisterCustomPropertyTypeLayouts();

    (void) Pimpl.Release();

    SGLOG("The SenseGlove settings singleton has been successfully de-initialized!");
}

USGSettings::FImpl::FImpl(USGSettings* InOwner)
    : Owner(InOwner)
{
}

void USGSettings::FImpl::RegisterCustomPropertyTypeLayouts()
{
    SGLOG("Registering SGSettings custom property type layouts...");

    FPropertyEditorModule& PropertyEditorModule =
        FModuleManager::LoadModuleChecked<FPropertyEditorModule>(FName{TEXT("PropertyEditor")});

    SGLOG("Registering SGSettings custom property type layout", GetWristTrackingSettingsPropertyName());
    PropertyEditorModule.RegisterCustomPropertyTypeLayout(
        GetWristTrackingSettingsPropertyName(),
        FOnGetPropertyTypeCustomizationInstance::CreateStatic(
            &FSGWristTrackingDetailsCustomization::NewWristTrackingDetailsCustomization)
        );
}

void USGSettings::FImpl::UnregisterCustomPropertyTypeLayouts()
{
    SGLOG("Unregistering SGSettings custom property type layouts...");

    FPropertyEditorModule& PropertyEditorModule =
        FModuleManager::LoadModuleChecked<FPropertyEditorModule>(FName{TEXT("PropertyEditor")});

    SGLOG("Unregistering SGSettings custom property type layout", GetWristTrackingSettingsPropertyName());
    PropertyEditorModule.UnregisterCustomPropertyTypeLayout(GetWristTrackingSettingsPropertyName());
}

USGSettings::FImpl::~FImpl() = default;

void USGSettings::FImplDeleter::operator()(const FImpl* P) const
{
    delete P;
}