mirror of
https://github.com/OPM/ResInsight.git
synced 2026-08-27 05:37:21 -05:00
Kristian Bendiksen
c1ea8261aa
Promote the experimental feature checkboxes out of the development-only System tab into a dedicated, always-visible Experimental tab so end users can opt into experimental features without enabling development features. The m_enabledFeatures field stays owned by RiaPreferencesSystem, so its keyword, value options and legacy-keyword migration are unchanged.
461 lines
19 KiB
C++
461 lines
19 KiB
C++
/////////////////////////////////////////////////////////////////////////////////
|
|
//
|
|
// Copyright (C) 2021 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 "RiaApplication.h"
|
|
|
|
#include "RiaExperimentalFeatures.h"
|
|
#include "RiaPreferences.h"
|
|
#include "RiaPreferencesSystem.h"
|
|
|
|
#include "cafPdmUiCheckBoxAndTextEditor.h"
|
|
#include "cafPdmUiCheckBoxEditor.h"
|
|
#include "cafPdmUiFilePathEditor.h"
|
|
#include "cafPdmUiTextEditor.h"
|
|
#include "cafPdmUiTreeSelectionEditor.h"
|
|
|
|
#include <algorithm>
|
|
|
|
namespace caf
|
|
{
|
|
template <>
|
|
void RiaPreferencesSystem::EclipseTextFileReaderModeType::setUp()
|
|
{
|
|
addItem( RiaPreferencesSystem::EclipseTextFileReaderMode::MEMORY_MAPPED_FILE, "MEMORY_MAPPED_FILE", "Memory Mapped File Import" );
|
|
addItem( RiaPreferencesSystem::EclipseTextFileReaderMode::FILE, "FILE", "Default File Import" );
|
|
|
|
setDefault( RiaPreferencesSystem::EclipseTextFileReaderMode::FILE );
|
|
}
|
|
|
|
} // namespace caf
|
|
|
|
CAF_PDM_SOURCE_INIT( RiaPreferencesSystem, "RiaPreferencesSystem" );
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
RiaPreferencesSystem::RiaPreferencesSystem()
|
|
{
|
|
CAF_PDM_InitField( &m_useShaders, "useShaders", true, "Use Shaders" );
|
|
caf::PdmUiNativeCheckBoxEditor::configureFieldForEditor( &m_useShaders );
|
|
CAF_PDM_InitField( &m_showHud, "showHud", false, "Show 3D Information" );
|
|
caf::PdmUiNativeCheckBoxEditor::configureFieldForEditor( &m_showHud );
|
|
CAF_PDM_InitField( &m_appendClassNameToUiText, "appendClassNameToUiText", false, "Show Class Names" );
|
|
caf::PdmUiNativeCheckBoxEditor::configureFieldForEditor( &m_appendClassNameToUiText );
|
|
|
|
CAF_PDM_InitField( &m_appendFieldKeywordToToolTipText, "appendFieldKeywordToToolTipText", false, "Show Field Keyword in ToolTip" );
|
|
caf::PdmUiNativeCheckBoxEditor::configureFieldForEditor( &m_appendFieldKeywordToToolTipText );
|
|
|
|
CAF_PDM_InitField( &m_showViewIdInProjectTree, "showViewIdInTree", false, "Show View Id in Project Tree" );
|
|
caf::PdmUiNativeCheckBoxEditor::configureFieldForEditor( &m_showViewIdInProjectTree );
|
|
|
|
CAF_PDM_InitField( &m_showTestToolbar, "showTestToolbar", false, "Enable Test Toolbar" );
|
|
caf::PdmUiNativeCheckBoxEditor::configureFieldForEditor( &m_showTestToolbar );
|
|
|
|
CAF_PDM_InitField( &m_includeFractureDebugInfoFile, "includeFractureDebugInfoFile", false, "Include Fracture Debug Info for Completion Export" );
|
|
caf::PdmUiNativeCheckBoxEditor::configureFieldForEditor( &m_includeFractureDebugInfoFile );
|
|
|
|
CAF_PDM_InitFieldNoDefault( &m_holoLensExportFolder, "holoLensExportFolder", "HoloLens Export Folder" );
|
|
m_holoLensExportFolder.uiCapability()->setUiLabelPosition( caf::PdmUiItemInfo::LabelPosition::TOP );
|
|
m_holoLensExportFolder.uiCapability()->setUiEditorTypeName( caf::PdmUiFilePathEditor::uiEditorTypeName() );
|
|
|
|
CAF_PDM_InitField( &m_showProjectChangedDialog, "showProjectChangedDialog", true, "Show 'Project has changed' dialog" );
|
|
caf::PdmUiNativeCheckBoxEditor::configureFieldForEditor( &m_showProjectChangedDialog );
|
|
|
|
CAF_PDM_InitField( &m_showProgressBar, "showProgressBar", true, "Show Progress Bar" );
|
|
caf::PdmUiNativeCheckBoxEditor::configureFieldForEditor( &m_showProgressBar );
|
|
|
|
CAF_PDM_InitField( &m_showPdfExportDialog, "showPdfExportDialog", true, "Show PDF Export Dialog" );
|
|
caf::PdmUiNativeCheckBoxEditor::configureFieldForEditor( &m_showPdfExportDialog );
|
|
|
|
CAF_PDM_InitField( &m_mimimumAngularCellCount, "mimimumAngularCellCount", 40, "Minimum Angular Cell Count" );
|
|
|
|
CAF_PDM_InitField( &m_gtestFilter, "gtestFilter", QString(), "Unit Test Filter (gtest)" );
|
|
CAF_PDM_InitField( &m_exportScalingFactor, "exportScalingFactor", -1.0, "Export Scaling Factor (<0 disable)" );
|
|
|
|
CAF_PDM_InitField( &m_eclipseReaderMode,
|
|
"eclipseReaderMode",
|
|
EclipseTextFileReaderModeType( RiaPreferencesSystem::EclipseTextFileReaderMode::FILE ),
|
|
"Eclipse Text File Import mode (GRDECL)" );
|
|
|
|
CAF_PDM_InitField( &m_keywordsForLogging,
|
|
"KeywordsForLogging",
|
|
QString(),
|
|
"Keywords to enable debug logging, separated by semicolon.\nType 'enable-all' to enable logging for all objects." );
|
|
|
|
CAF_PDM_InitFieldNoDefault( &m_enabledFeatures, "EnabledFeatures", "Experimental Features" );
|
|
m_enabledFeatures.uiCapability()->setUiEditorTypeName( caf::PdmUiTreeSelectionEditor::uiEditorTypeName() );
|
|
|
|
// Transient UI helper fields, not stored in the preferences file.
|
|
CAF_PDM_InitFieldNoDefault( &m_currentFeatureKeyword, "currentFeatureKeyword", "" );
|
|
m_currentFeatureKeyword.uiCapability()->setUiHidden( true );
|
|
m_currentFeatureKeyword.xmlCapability()->disableIO();
|
|
|
|
CAF_PDM_InitFieldNoDefault( &m_selectedFeatureDescription, "selectedFeatureDescription", "Description" );
|
|
m_selectedFeatureDescription.uiCapability()->setUiEditorTypeName( caf::PdmUiTextEditor::uiEditorTypeName() );
|
|
m_selectedFeatureDescription.uiCapability()->setUiReadOnly( true );
|
|
m_selectedFeatureDescription.xmlCapability()->disableIO();
|
|
|
|
// Legacy free-text field, kept only to migrate older preference files into m_enabledFeatures.
|
|
CAF_PDM_InitField( &m_featureKeywords,
|
|
"FeatureKeywords",
|
|
QString(),
|
|
"Keywords to enable experimental features separated by semicolon.\nType 'enable-all' for all." );
|
|
m_featureKeywords.uiCapability()->setUiHidden( true );
|
|
|
|
CAF_PDM_InitField( &m_maximumNumberOfThreads, "maximumNumberOfThreads", std::make_pair( false, QString( "4" ) ), "Maximum Number of Threads" );
|
|
m_maximumNumberOfThreads.uiCapability()->setUiEditorTypeName( caf::PdmUiCheckBoxAndTextEditor::uiEditorTypeName() );
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
RiaPreferencesSystem* RiaPreferencesSystem::current()
|
|
{
|
|
return RiaApplication::instance()->preferences()->systemPreferences();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RiaPreferencesSystem::setAppendClassNameToUiText( bool enable )
|
|
{
|
|
m_appendClassNameToUiText = enable;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
bool RiaPreferencesSystem::appendClassNameToUiText() const
|
|
{
|
|
return RiaApplication::enableDevelopmentFeatures() && m_appendClassNameToUiText();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
bool RiaPreferencesSystem::appendFieldKeywordToToolTipText() const
|
|
{
|
|
return RiaApplication::enableDevelopmentFeatures() && m_appendFieldKeywordToToolTipText();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
bool RiaPreferencesSystem::showViewIdInProjectTree() const
|
|
{
|
|
return RiaApplication::enableDevelopmentFeatures() && m_showViewIdInProjectTree();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
bool RiaPreferencesSystem::showTestToolbar() const
|
|
{
|
|
return RiaApplication::enableDevelopmentFeatures() && m_showTestToolbar();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
bool RiaPreferencesSystem::includeFractureDebugInfoFile() const
|
|
{
|
|
return RiaApplication::enableDevelopmentFeatures() && m_includeFractureDebugInfoFile();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
bool RiaPreferencesSystem::showProjectChangedDialog() const
|
|
{
|
|
if ( !RiaApplication::enableDevelopmentFeatures() )
|
|
{
|
|
return true;
|
|
}
|
|
|
|
return m_showProjectChangedDialog();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
QString RiaPreferencesSystem::holoLensExportFolder() const
|
|
{
|
|
return m_holoLensExportFolder();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
bool RiaPreferencesSystem::useShaders() const
|
|
{
|
|
if ( !RiaApplication::enableDevelopmentFeatures() )
|
|
{
|
|
return true;
|
|
}
|
|
|
|
return m_useShaders();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
bool RiaPreferencesSystem::show3dInformation() const
|
|
{
|
|
return RiaApplication::enableDevelopmentFeatures() && m_showHud();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
QString RiaPreferencesSystem::gtestFilter() const
|
|
{
|
|
return m_gtestFilter();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
bool RiaPreferencesSystem::showProgressBar() const
|
|
{
|
|
return m_showProgressBar();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
bool RiaPreferencesSystem::showPdfExportDialog() const
|
|
{
|
|
return m_showPdfExportDialog();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
double RiaPreferencesSystem::exportPdfScalingFactor() const
|
|
{
|
|
return m_exportScalingFactor();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
std::optional<int> RiaPreferencesSystem::threadCount() const
|
|
{
|
|
const auto& [enabled, text] = m_maximumNumberOfThreads();
|
|
|
|
if ( !enabled || text.isEmpty() )
|
|
{
|
|
return std::nullopt; // No limit set
|
|
}
|
|
|
|
return text.toInt();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
int RiaPreferencesSystem::minimumAngularCellCount() const
|
|
{
|
|
return m_mimimumAngularCellCount();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
RiaPreferencesSystem::EclipseTextFileReaderMode RiaPreferencesSystem::eclipseTextFileReaderMode() const
|
|
{
|
|
return m_eclipseReaderMode();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
bool RiaPreferencesSystem::isLoggingActivatedForKeyword( const QString& keyword ) const
|
|
{
|
|
if ( keyword.isEmpty() ) return true;
|
|
|
|
QStringList keywords = m_keywordsForLogging().split( ";" );
|
|
|
|
if ( keywords.contains( "enable-all" ) ) return true;
|
|
|
|
return keywords.contains( keyword );
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
bool RiaPreferencesSystem::isFeatureEnabled( const QString& keyword ) const
|
|
{
|
|
if ( keyword.isEmpty() ) return false;
|
|
|
|
const std::vector<QString>& enabled = m_enabledFeatures();
|
|
|
|
return std::find( enabled.begin(), enabled.end(), keyword ) != enabled.end();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RiaPreferencesSystem::defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering& uiOrdering )
|
|
{
|
|
{
|
|
caf::PdmUiGroup* group = uiOrdering.addNewGroup( "Project Tree" );
|
|
group->add( &m_appendClassNameToUiText );
|
|
group->add( &m_appendFieldKeywordToToolTipText );
|
|
group->add( &m_showViewIdInProjectTree );
|
|
}
|
|
|
|
{
|
|
caf::PdmUiGroup* group = uiOrdering.addNewGroup( "3D View" );
|
|
group->add( &m_useShaders );
|
|
group->add( &m_showHud );
|
|
}
|
|
|
|
uiOrdering.add( &m_showProjectChangedDialog );
|
|
uiOrdering.add( &m_showTestToolbar );
|
|
uiOrdering.add( &m_includeFractureDebugInfoFile );
|
|
uiOrdering.add( &m_holoLensExportFolder );
|
|
uiOrdering.add( &m_showProgressBar );
|
|
|
|
uiOrdering.add( &m_showPdfExportDialog );
|
|
uiOrdering.add( &m_exportScalingFactor );
|
|
uiOrdering.add( &m_eclipseReaderMode );
|
|
|
|
{
|
|
caf::PdmUiGroup* group = uiOrdering.addNewGroup( "Radial Grid" );
|
|
group->add( &m_mimimumAngularCellCount );
|
|
}
|
|
|
|
{
|
|
caf::PdmUiGroup* group = uiOrdering.addNewGroup( "Developer Settings" );
|
|
group->add( &m_keywordsForLogging );
|
|
group->add( &m_gtestFilter );
|
|
}
|
|
|
|
uiOrdering.add( &m_maximumNumberOfThreads );
|
|
|
|
// The experimental feature fields are shown on the dedicated Experimental tab, so do not let
|
|
// them auto-append to the System tab.
|
|
uiOrdering.skipRemainingFields( true );
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RiaPreferencesSystem::appendExperimentalFeaturesItems( caf::PdmUiOrdering& uiOrdering )
|
|
{
|
|
caf::PdmUiGroup* group = uiOrdering.addNewGroup( "Experimental Features" );
|
|
group->add( &m_enabledFeatures );
|
|
group->add( &m_selectedFeatureDescription );
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
QList<caf::PdmOptionItemInfo> RiaPreferencesSystem::calculateValueOptions( const caf::PdmFieldHandle* fieldNeedingOptions )
|
|
{
|
|
QList<caf::PdmOptionItemInfo> options;
|
|
|
|
if ( fieldNeedingOptions == &m_enabledFeatures )
|
|
{
|
|
for ( const auto& feature : RiaExperimentalFeatures::availableFeatures() )
|
|
{
|
|
options.push_back( caf::PdmOptionItemInfo( feature.displayName, feature.keyword ) );
|
|
}
|
|
}
|
|
|
|
return options;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RiaPreferencesSystem::initAfterRead()
|
|
{
|
|
// Migrate the legacy semicolon-separated keyword string into the checkbox-based field.
|
|
if ( !m_featureKeywords().isEmpty() )
|
|
{
|
|
std::vector<QString> enabled = m_enabledFeatures();
|
|
|
|
const QStringList legacyKeywords = m_featureKeywords().split( ";", Qt::SkipEmptyParts );
|
|
for ( const QString& keyword : legacyKeywords )
|
|
{
|
|
if ( std::find( enabled.begin(), enabled.end(), keyword ) == enabled.end() )
|
|
{
|
|
enabled.push_back( keyword );
|
|
}
|
|
}
|
|
|
|
m_enabledFeatures = enabled;
|
|
m_featureKeywords = QString();
|
|
}
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RiaPreferencesSystem::defineEditorAttribute( const caf::PdmFieldHandle* field, QString uiConfigName, caf::PdmUiEditorAttribute* attribute )
|
|
{
|
|
if ( field == &m_holoLensExportFolder )
|
|
{
|
|
caf::PdmUiFilePathEditorAttribute* myAttr = dynamic_cast<caf::PdmUiFilePathEditorAttribute*>( attribute );
|
|
if ( myAttr )
|
|
{
|
|
myAttr->m_selectDirectory = true;
|
|
}
|
|
}
|
|
else if ( field == &m_enabledFeatures )
|
|
{
|
|
// Report the highlighted (clicked) feature so its description can be shown below the list.
|
|
if ( auto* myAttr = dynamic_cast<caf::PdmUiTreeSelectionEditorAttribute*>( attribute ) )
|
|
{
|
|
myAttr->currentIndexFieldHandle = &m_currentFeatureKeyword;
|
|
}
|
|
}
|
|
else if ( field == &m_selectedFeatureDescription )
|
|
{
|
|
if ( auto* myAttr = dynamic_cast<caf::PdmUiTextEditorAttribute*>( attribute ) )
|
|
{
|
|
myAttr->wrapMode = caf::PdmUiTextEditorAttribute::WordWrap;
|
|
myAttr->heightHint = 60;
|
|
}
|
|
}
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RiaPreferencesSystem::fieldChangedByUi( const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue )
|
|
{
|
|
if ( changedField == &m_currentFeatureKeyword )
|
|
{
|
|
QString description;
|
|
for ( const auto& feature : RiaExperimentalFeatures::availableFeatures() )
|
|
{
|
|
if ( feature.keyword == m_currentFeatureKeyword() )
|
|
{
|
|
description = feature.description;
|
|
break;
|
|
}
|
|
}
|
|
|
|
m_selectedFeatureDescription = description;
|
|
m_selectedFeatureDescription.uiCapability()->updateConnectedEditors();
|
|
}
|
|
}
|