Add preferences setting for maximum search depth in script folders. Clean up context menu a bit. (#9012)

This commit is contained in:
jonjenssen
2022-06-02 06:53:05 +02:00
committed by GitHub
parent 41904df681
commit fd7821a10b
12 changed files with 44 additions and 48 deletions

View File

@@ -1223,7 +1223,7 @@ void RiaApplication::applyPreferences()
if ( this->project() )
{
this->project()->setScriptDirectories( m_preferences->scriptDirectories() );
this->project()->setScriptDirectories( m_preferences->scriptDirectories(), m_preferences->maxScriptFoldersDepth() );
this->project()->setPlotTemplateFolders( m_preferences->plotTemplateFolders() );
project()->scriptCollection()->updateConnectedEditors();
@@ -1510,7 +1510,7 @@ void RiaApplication::initialize()
// Start with a project
m_project = std::make_unique<RimProject>();
m_project->setScriptDirectories( m_preferences->scriptDirectories() );
m_project->setScriptDirectories( m_preferences->scriptDirectories(), m_preferences->maxScriptFoldersDepth() );
m_project->setPlotTemplateFolders( m_preferences->plotTemplateFolders() );
caf::SelectionManager::instance()->setPdmRootObject( project() );

View File

@@ -113,6 +113,8 @@ RiaPreferences::RiaPreferences()
CAF_PDM_InitField( &scriptEditorExecutable, "scriptEditorExecutable", defaultTextEditor, "Script Editor" );
scriptEditorExecutable.uiCapability()->setUiEditorTypeName( caf::PdmUiFilePathEditor::uiEditorTypeName() );
CAF_PDM_InitField( &m_maxScriptFoldersDepth, "MaxScriptFoldersDepth", 2, "Maximum Scripts Folder Search Depth" );
CAF_PDM_InitField( &m_octaveExecutable, "octaveExecutable", QString( "octave" ), "Octave Executable Location" );
m_octaveExecutable.uiCapability()->setUiEditorTypeName( caf::PdmUiFilePathEditor::uiEditorTypeName() );
m_octaveExecutable.uiCapability()->setUiLabelPosition( caf::PdmUiItemInfo::TOP );
@@ -426,6 +428,7 @@ void RiaPreferences::defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering&
#endif
caf::PdmUiGroup* scriptGroup = uiOrdering.addNewGroup( "Script files" );
scriptGroup->add( &scriptDirectories );
scriptGroup->add( &m_maxScriptFoldersDepth );
scriptGroup->add( &scriptEditorExecutable );
}
#ifdef USE_ODB_API
@@ -667,6 +670,14 @@ QString RiaPreferences::dateTimeFormat( RiaDefines::DateFormatComponents dateCom
.arg( RiaQDateTimeTools::timeFormatString( m_timeFormat(), timeComponents ) );
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
int RiaPreferences::maxScriptFoldersDepth() const
{
return m_maxScriptFoldersDepth();
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------

View File

@@ -76,7 +76,9 @@ public:
RiaDefines::DateFormatComponents dateComponents = RiaDefines::DateFormatComponents::DATE_FORMAT_YEAR_MONTH_DAY,
RiaDefines::TimeFormatComponents timeComponents = RiaDefines::TimeFormatComponents::TIME_FORMAT_HOUR_MINUTE_SECOND ) const;
int maxPlotTemplateFoldersDepth() const;
int maxScriptFoldersDepth() const;
int maxPlotTemplateFoldersDepth() const;
QStringList plotTemplateFolders() const;
void appendPlotTemplateFolders( const QString& folder );
QString lastUsedPlotTemplateAbsolutePath() const;
@@ -173,6 +175,8 @@ private:
caf::PdmField<caf::AppEnum<RiaDefines::ThemeEnum>> m_guiTheme;
caf::PdmField<int> m_maxScriptFoldersDepth;
caf::PdmField<PageSizeEnum> m_pageSize;
caf::PdmField<PageOrientationEnum> m_pageOrientation;
caf::PdmField<double> m_pageLeftMargin;

View File

@@ -41,6 +41,10 @@ CAF_CMD_SOURCE_INIT( RicDeleteScriptPathFeature, "RicDeleteScriptPathFeature" );
bool RicDeleteScriptPathFeature::isCommandEnabled()
{
std::vector<RimScriptCollection*> selection = RicScriptFeatureImpl::selectedScriptCollections();
if ( selection.size() == 1 )
{
if ( selection.front()->directory().isEmpty() ) return false;
}
return selection.size() > 0;
}

View File

@@ -21,6 +21,7 @@
#include "RiaApplication.h"
#include "RiaLogging.h"
#include "RiaPreferences.h"
#include "RicRefreshScriptsFeature.h"
#include "RicScriptFeatureImpl.h"
@@ -124,7 +125,7 @@ void RicNewPythonScriptFeature::onActionTriggered( bool isChecked )
"resinsight.version_string())\n";
}
scriptColl->readContentFromDisc();
scriptColl->readContentFromDisc( RiaPreferences::current()->maxScriptFoldersDepth() );
scriptColl->updateConnectedEditors();
if ( calcScript )

View File

@@ -60,6 +60,6 @@ void RicRefreshScriptsFeature::refreshScriptFolders()
RimProject* proj = RimProject::current();
RiaPreferences* prefs = RiaPreferences::current();
proj->setScriptDirectories( prefs->scriptDirectories() );
proj->setScriptDirectories( prefs->scriptDirectories(), prefs->maxScriptFoldersDepth() );
proj->scriptCollection()->updateConnectedEditors();
}

View File

@@ -61,5 +61,5 @@ void RicReloadPlotTemplatesFeature::onActionTriggered( bool isChecked )
void RicReloadPlotTemplatesFeature::setupActionLook( QAction* actionToSetup )
{
actionToSetup->setText( "Reload Templates" );
actionToSetup->setIcon( QIcon( ":/SummaryTemplate16x16.png" ) );
actionToSetup->setIcon( QIcon( ":/Refresh.svg" ) );
}

View File

@@ -37,7 +37,7 @@ RimCalcScript::RimCalcScript()
CAF_PDM_InitObject( "CalcScript", ":/OctaveScriptFile16x16.png", "Calc Script", "" );
CAF_PDM_InitField( &absoluteFileName, "AbsolutePath", QString(), "Location" );
absoluteFileName.uiCapability()->setUiReadOnly( true );
absoluteFileName.uiCapability()->setUiEditorTypeName( caf::PdmUiFilePathEditor::uiEditorTypeName() );
}

View File

@@ -376,7 +376,7 @@ bool RimProject::writeProjectFile()
//--------------------------------------------------------------------------------------------------
/// Support list of multiple script paths divided by ';'
//--------------------------------------------------------------------------------------------------
void RimProject::setScriptDirectories( const QString& scriptDirectories )
void RimProject::setScriptDirectories( const QString& scriptDirectories, int maxFolderDepth )
{
scriptCollection->calcScripts().deleteChildren();
scriptCollection->subDirectories().deleteChildren();
@@ -391,7 +391,7 @@ void RimProject::setScriptDirectories( const QString& scriptDirectories )
sharedScriptLocation->directory = path;
sharedScriptLocation->setUiName( dir.dirName() );
sharedScriptLocation->readContentFromDisc();
sharedScriptLocation->readContentFromDisc( maxFolderDepth );
scriptCollection->subDirectories.push_back( sharedScriptLocation );
}

View File

@@ -113,7 +113,7 @@ public:
bool writeProjectFile();
void setScriptDirectories( const QString& scriptDirectories );
void setScriptDirectories( const QString& scriptDirectories, int maxFolderDepth );
void setPlotTemplateFolders( const QStringList& plotTemplateFolders );
QString projectFileVersionString() const;

View File

@@ -38,14 +38,13 @@ RimScriptCollection::RimScriptCollection()
CAF_PDM_InitObject( "ScriptLocation", ":/Folder.png" );
CAF_PDM_InitFieldNoDefault( &directory, "ScriptDirectory", "Folder" );
directory.uiCapability()->setUiReadOnly( true );
directory.uiCapability()->setUiEditorTypeName( caf::PdmUiFilePathEditor::uiEditorTypeName() );
CAF_PDM_InitFieldNoDefault( &calcScripts, "CalcScripts", "" );
calcScripts.uiCapability()->setUiTreeHidden( true );
CAF_PDM_InitFieldNoDefault( &subDirectories, "SubDirectories", "" );
subDirectories.uiCapability()->setUiTreeHidden( true );
CAF_PDM_InitField( &m_searchSubFolders, "SearchSubFolders", false, "Add Subfolders" );
directory.uiCapability()->setUiEditorTypeName( caf::PdmUiFilePathEditor::uiEditorTypeName() );
}
//--------------------------------------------------------------------------------------------------
@@ -60,15 +59,19 @@ RimScriptCollection::~RimScriptCollection()
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimScriptCollection::readContentFromDisc()
void RimScriptCollection::readContentFromDisc( int folderLevelsLeft )
{
calcScripts.deleteChildren();
subDirectories.deleteChildren();
folderLevelsLeft--;
if ( folderLevelsLeft < 0 ) return;
if ( directory().isEmpty() )
{
for ( size_t i = 0; i < subDirectories.size(); ++i )
{
if ( subDirectories[i] ) subDirectories[i]->readContentFromDisc();
if ( subDirectories[i] ) subDirectories[i]->readContentFromDisc( folderLevelsLeft );
}
return;
}
@@ -104,9 +107,7 @@ void RimScriptCollection::readContentFromDisc()
}
}
subDirectories.deleteChildren();
if ( m_searchSubFolders() )
if ( folderLevelsLeft > 0 )
{
QDir dir( directory );
QFileInfoList fileInfoList = dir.entryInfoList( QDir::AllDirs | QDir::NoDotAndDotDot | QDir::Readable );
@@ -120,7 +121,7 @@ void RimScriptCollection::readContentFromDisc()
RimScriptCollection* scriptLocation = new RimScriptCollection;
scriptLocation->directory = fi.absoluteFilePath();
scriptLocation->setUiName( fi.baseName() );
scriptLocation->readContentFromDisc();
scriptLocation->readContentFromDisc( folderLevelsLeft );
subDirectories.push_back( scriptLocation );
}
@@ -128,25 +129,6 @@ void RimScriptCollection::readContentFromDisc()
}
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimScriptCollection::fieldChangedByUi( const caf::PdmFieldHandle* changedField,
const QVariant& oldValue,
const QVariant& newValue )
{
if ( &directory == changedField )
{
QFileInfo fi( directory );
this->setUiName( fi.baseName() );
this->readContentFromDisc();
}
else if ( &m_searchSubFolders == changedField )
{
this->readContentFromDisc();
}
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------

View File

@@ -43,23 +43,17 @@ public:
RimScriptCollection();
~RimScriptCollection() override;
public: // Pdm Fields
public:
caf::PdmField<QString> directory;
caf::PdmChildArrayField<RimCalcScript*> calcScripts;
caf::PdmChildArrayField<RimScriptCollection*> subDirectories;
public: // Methods
void readContentFromDisc();
// Overrides from PdmObject
void fieldChangedByUi( const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue ) override;
public:
void readContentFromDisc( int folderLevelsLeft );
protected:
void defineEditorAttribute( const caf::PdmFieldHandle* field,
QString uiConfigName,
caf::PdmUiEditorAttribute* attribute ) override;
private:
caf::PdmField<bool> m_searchSubFolders;
};