/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2020 Equinor ASA
//
//  ResInsight is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//
//  ResInsight is distributed in the hope that it will be useful, but WITHOUT ANY
//  WARRANTY; without even the implied warranty of MERCHANTABILITY or
//  FITNESS FOR A PARTICULAR PURPOSE.
//
//  See the GNU General Public License at <http://www.gnu.org/licenses/gpl.html>
//  for more details.
//
/////////////////////////////////////////////////////////////////////////////////

#include "RimCustomObjectiveFunctionCollection.h"

#include "RimCustomObjectiveFunction.h"

#include <cafPdmUiTreeOrdering.h>

CAF_PDM_SOURCE_INIT( RimCustomObjectiveFunctionCollection, "RimCustomObjectiveFunctionCollection" );

//--------------------------------------------------------------------------------------------------
/// Internal variables
//--------------------------------------------------------------------------------------------------
static std::vector<RimCustomObjectiveFunction*> _removedFunctions;

static void garbageCollectObjectiveFunctions();

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimCustomObjectiveFunctionCollection::RimCustomObjectiveFunctionCollection()
    : objectiveFunctionAdded( this )
    , objectiveFunctionChanged( this )
    , objectiveFunctionAboutToBeDeleted( this )
    , objectiveFunctionDeleted( this )
{
    CAF_PDM_InitObject( "Custom Objective Functions", ":/ObjectiveFunctionCollection.svg", "", "" );

    CAF_PDM_InitFieldNoDefault( &m_objectiveFunctions, "ObjectiveFunctions", "", "", "", "" );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimCustomObjectiveFunction* RimCustomObjectiveFunctionCollection::addObjectiveFunction()
{
    garbageCollectObjectiveFunctions();

    auto newFunction = new RimCustomObjectiveFunction();
    m_objectiveFunctions.push_back( newFunction );
    objectiveFunctionAdded.send( newFunction );
    return newFunction;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimCustomObjectiveFunctionCollection::onObjectiveFunctionChanged( RimCustomObjectiveFunction* objectiveFunction )
{
    objectiveFunctionChanged.send( objectiveFunction );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimCustomObjectiveFunctionCollection::removeObjectiveFunction( RimCustomObjectiveFunction* objectiveFunction )
{
    objectiveFunction->invalidate();
    objectiveFunctionAboutToBeDeleted.send( objectiveFunction );

    garbageCollectObjectiveFunctions();

    size_t sizeBefore = m_objectiveFunctions.size();
    m_objectiveFunctions.removeChildObject( objectiveFunction );
    size_t sizeAfter = m_objectiveFunctions.size();

    if ( sizeAfter < sizeBefore ) _removedFunctions.push_back( objectiveFunction );

    objectiveFunctionDeleted.send();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::vector<RimCustomObjectiveFunction*> RimCustomObjectiveFunctionCollection::objectiveFunctions() const
{
    return m_objectiveFunctions.childObjects();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimCustomObjectiveFunctionCollection::defineUiTreeOrdering( caf::PdmUiTreeOrdering& uiTreeOrdering,
                                                                 QString                 uiConfigName /* = "" */ )
{
    for ( auto func : objectiveFunctions() )
    {
        uiTreeOrdering.add( func );
    }
    uiTreeOrdering.skipRemainingChildren( true );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void garbageCollectObjectiveFunctions()
{
    for ( auto func : _removedFunctions )
    {
        delete func;
    }
    _removedFunctions.clear();
}