ResInsight/ApplicationLibCode/ProjectDataModel/Workflow/RimWorkflowFieldBinding.cpp

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2026     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 "RimWorkflowFieldBinding.h"

#include "RiuMainWindow.h"

#include "cafPdmUiFieldHandle.h"

#include <QDate>
#include <QJsonArray>
#include <QJsonDocument>
#include <QJsonObject>

CAF_PDM_ABSTRACT_SOURCE_INIT( RimWorkflowFieldBinding, "WorkflowFieldBinding" );

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimWorkflowFieldBinding::RimWorkflowFieldBinding()
{
    CAF_PDM_InitObject( "Field", ":/Bullet.png" );

    CAF_PDM_InitFieldNoDefault( &m_fieldName, "FieldName", "Field" );
    m_fieldName.uiCapability()->setUiReadOnly( true );

    CAF_PDM_InitFieldNoDefault( &m_description, "Description", "Description" );
    m_description.uiCapability()->setUiReadOnly( true );

    CAF_PDM_InitField( &m_required, "Required", false, "Required" );
    m_required.uiCapability()->setUiReadOnly( true );

    CAF_PDM_InitField( &m_hasValue, "HasValue", false, "Has Value" );
    m_hasValue.uiCapability()->setUiHidden( true );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RimWorkflowFieldBinding::fieldName() const
{
    return m_fieldName();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimWorkflowFieldBinding::setFieldName( const QString& name )
{
    m_fieldName = name;
    setUiName( name );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimWorkflowFieldBinding::setDescription( const QString& description )
{
    m_description = description;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimWorkflowFieldBinding::setRequired( bool required )
{
    m_required = required;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RimWorkflowFieldBinding::displayValue() const
{
    if ( !hasValue() ) return "(not set)";

    auto* field = const_cast<RimWorkflowFieldBinding*>( this )->valueField();
    if ( !field || !field->uiCapability() ) return {};

    const QVariant value = field->uiCapability()->uiValue();
    if ( value.metaType().id() == QMetaType::QDate ) return value.toDate().toString( Qt::ISODate );
    const QString text = value.toString();
    return text.isEmpty() ? "(not set)" : text;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimWorkflowFieldBinding::fieldChangedByUi( const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue )
{
    if ( changedField == valueField() )
    {
        m_hasValue = true;
        if ( auto* mainWindow = RiuMainWindow::instance() ) mainWindow->workflowBindingChanged( this );
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
bool RimWorkflowFieldBinding::hasValue() const
{
    return m_hasValue();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimWorkflowFieldBinding::setHasValue( bool hasValue )
{
    m_hasValue = hasValue;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
bool RimWorkflowFieldBinding::isObjectReference() const
{
    return false;
}

//--------------------------------------------------------------------------------------------------
/// Whether a null value is an entered value (None) rather than a value that is not set
//--------------------------------------------------------------------------------------------------
bool RimWorkflowFieldBinding::isExplicitNull() const
{
    return false;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimWorkflowFieldBinding::applySchema( const QJsonObject& fieldSchema )
{
    setFieldName( fieldSchema.value( "name" ).toString() );
    setDescription( fieldSchema.value( "description" ).toString() );
    setRequired( fieldSchema.value( "required" ).toBool( false ) );
    m_hasValue = fieldSchema.contains( "default" ) && !fieldSchema.value( "default" ).isNull();

    if ( auto* vf = valueField() )
    {
        vf->uiCapability()->setUiName( m_fieldName() );
        if ( !m_description().isEmpty() ) vf->uiCapability()->setUiToolTip( m_description() );
    }
}