!brief A plugins list model that can be attached to wxDataViewCtrl More...

#include <PluginDataModel.h>

Inheritance diagram for PluginDataModel:

Collaboration diagram for PluginDataModel:

Public Types
enum	Column { ColumnName , ColumnType , ColumnPath , ColumnState , ColumnNum }

Public Member Functions
	PluginDataModel (int filterEffectCategory=-1, int filterState=-1, const wxString &filterType={}, const wxString &filterExpr={})

wxDataViewItem	GetItemForRow (uint32_t row) const

bool	GetRowForItem (const wxDataViewItem &item, uint32_t &row) const

uint32_t	GetRowCount () const

bool	IsEnabled (const wxDataViewItem &, unsigned) const override

bool	HasContainerColumns (const wxDataViewItem &item) const override

void	SetFilterType (const wxString &type)

wxString	GetFilterType () const

void	SetFilterState (int state)

int	GetFilterState () const

void	SetFilterExpr (const wxString &expr)

wxString	GetFilterExpr () const

void	SetFilterCategory (int category)

int	GetFilterCategory () const

int	Compare (const wxDataViewItem &item1, const wxDataViewItem &item2, unsigned column, bool ascending) const override

void	ApplyChanges (const std::function< bool(int, int, const wxString &)> &progressUpdateFn, const std::function< void(const TranslatableString &)> &errorFn)

unsigned	GetColumnCount () const override

wxString	GetColumnType (unsigned col) const override

void	GetValue (wxVariant &variant, const wxDataViewItem &item, unsigned col) const override

bool	SetValue (const wxVariant &variant, const wxDataViewItem &item, unsigned col) override

wxDataViewItem	GetParent (const wxDataViewItem &item) const override

bool	IsContainer (const wxDataViewItem &item) const override

unsigned	GetChildren (const wxDataViewItem &item, wxDataViewItemArray &children) const override

PluginDescriptor *	GetPlugin (wxDataViewItem item)

bool	IsListModel () const override

Private Member Functions
void	UpdateFilter ()

bool	IsFilterEmpty () const

Private Attributes
std::vector< std::pair< PluginDescriptor *, bool > >	mPluginStateModel

std::vector< void * >	mIndexFilterMap

wxString	mFilterType

wxString	mFilterExpr

int	mFilterState {-1}

int	mFilterCategory {-1}

Static Private Attributes
static const void *	RowIdRoot {}

Detailed Description

!brief A plugins list model that can be attached to wxDataViewCtrl

Definition at line 19 of file PluginDataModel.h.

Member Enumeration Documentation

◆ Column

enum PluginDataModel::Column

Enumerator
ColumnName
ColumnType
ColumnPath
ColumnState
ColumnNum

Definition at line 33 of file PluginDataModel.h.

   {
      ColumnName,
      ColumnType,
      ColumnPath,
      ColumnState,
      ColumnNum
   };

Constructor & Destructor Documentation

◆ PluginDataModel()

PluginDataModel::PluginDataModel	(	int	filterEffectCategory = `-1`,
		int	filterState = `-1`,
		const wxString &	filterType = `{}`,
		const wxString &	filterExpr = `{}`
	)

Definition at line 37 of file PluginDataModel.cpp.

   : mFilterType(filterType)
   , mFilterExpr(filterExpr)
   , mFilterState(filterState)
   , mFilterCategory(filterEffectCategory)
{
   auto& pm = PluginManager::Get();
   for(auto& desc : pm.AllPlugins())
   {
      if ((desc.GetPluginType() != PluginTypeEffect || desc.GetEffectType() == EffectTypeHidden) &&
         desc.GetPluginType() != PluginTypeStub)
      {
         continue;
      }
      mPluginStateModel.emplace_back(&desc, desc.IsEnabled());
   }
   UpdateFilter();
}

References anonymous_namespace{ExportPCM.cpp}::desc, EffectTypeHidden, PluginManager::Get(), mPluginStateModel, PluginTypeEffect, PluginTypeStub, and UpdateFilter().

Here is the call graph for this function:

Member Function Documentation

◆ ApplyChanges()

void PluginDataModel::ApplyChanges	(	const std::function< bool(int, int, const wxString &)> &	progressUpdateFn,
		const std::function< void(const TranslatableString &)> &	errorFn
	)

Definition at line 171 of file PluginDataModel.cpp.

{
   auto& mm = ModuleManager::Get();
   auto& pm = PluginManager::Get();
 
   const auto enableCount = std::count_if(
      mPluginStateModel.begin(),
      mPluginStateModel.end(),
      [](const auto& p) { return p.first->GetPluginType() == PluginTypeStub && p.second; }
   );
 
   auto counter = 0;
   for(const auto& [desc, enabled] : mPluginStateModel)
   {
      if(desc->GetPluginType() == PluginTypeStub && enabled)
      {
         if(progressUpdateFn)
         {
            if(!progressUpdateFn(++counter, enableCount, desc->GetPath()))
               break;
         }
 
         TranslatableString errMsg;
         if (mm.RegisterEffectPlugin(desc->GetProviderID(), desc->GetPath(), errMsg))
            pm.UnregisterPlugin(desc->GetProviderID() + wxT("_") + desc->GetPath());
         else if (errorFn)
         {
            errorFn(XO("Effect or Command at %s failed to register:\n%s")
                  .Format( desc->GetPath(), !errMsg.empty() ? errMsg : XO("Unknown error") ));
         }
      }
      else
         desc->SetEnabled(enabled);
   }
   pm.Save();
   pm.NotifyPluginsChanged();
}

References anonymous_namespace{ExportPCM.cpp}::desc, TranslatableString::empty(), ModuleManager::Get(), PluginManager::Get(), mPluginStateModel, PluginTypeStub, wxT(), and XO().

Here is the call graph for this function:

◆ Compare()

int PluginDataModel::Compare	(	const wxDataViewItem &	item1,
		const wxDataViewItem &	item2,
		unsigned	column,
		bool	ascending
	)		const

override

Definition at line 147 of file PluginDataModel.cpp.

{
   switch(column)
   {
   case ColumnName:
   case ColumnPath:
   case ColumnType:
      {
         wxVariant value1;
         GetValue(value1, item1, column);
         wxVariant value2;
         GetValue(value2, item2, column);
         const auto result = value1.GetString().CmpNoCase(value2.GetString());
         //Prevent row "jumping" when strings are equal
         if(result == 0)
            return ascending == wxPtrToUInt(item1.GetID()) > wxPtrToUInt(item2.GetID()) ? 1 : -1;
         return ascending ? result : -result;
      } break;
   default:
      return wxDataViewModel::Compare(item1, item2, column, ascending);
   }
}

References ColumnName, ColumnPath, ColumnType, and GetValue().

Here is the call graph for this function:

◆ GetChildren()

unsigned PluginDataModel::GetChildren	(	const wxDataViewItem &	item,
		wxDataViewItemArray &	children
	)		const

override

Definition at line 292 of file PluginDataModel.cpp.

{
   children.clear();
   if(item.GetID() != RowIdRoot)
      return 0;
 
   children.reserve(mIndexFilterMap.size());
   for(const auto index : mIndexFilterMap)
      children.push_back(wxDataViewItem(index));
 
   return children.size();
}

References mIndexFilterMap, and RowIdRoot.

◆ GetColumnCount()

unsigned PluginDataModel::GetColumnCount ( ) const

override

Definition at line 210 of file PluginDataModel.cpp.

{
   return 4;
}

◆ GetColumnType()

wxString PluginDataModel::GetColumnType ( unsigned col ) const

override

Definition at line 215 of file PluginDataModel.cpp.

{
   switch(col)
   {
   case ColumnName:
   case ColumnType:
   case ColumnPath:
      return "string";
   case ColumnState:
      return "bool";
   default: break;
   }
   return "null";
}

References ColumnName, ColumnPath, ColumnState, and ColumnType.

◆ GetFilterCategory()

int PluginDataModel::GetFilterCategory ( ) const

Definition at line 142 of file PluginDataModel.cpp.

{
   return mFilterCategory;
}

References mFilterCategory.

◆ GetFilterExpr()

wxString PluginDataModel::GetFilterExpr ( ) const

Definition at line 128 of file PluginDataModel.cpp.

{
   return mFilterExpr;
}

References mFilterExpr.

◆ GetFilterState()

int PluginDataModel::GetFilterState ( ) const

Definition at line 114 of file PluginDataModel.cpp.

{
   return mFilterState;
}

References mFilterState.

◆ GetFilterType()

wxString PluginDataModel::GetFilterType ( ) const

Definition at line 100 of file PluginDataModel.cpp.

{
   return mFilterType;
}

References mFilterType.

◆ GetItemForRow()

wxDataViewItem PluginDataModel::GetItemForRow ( uint32_t row ) const

Definition at line 59 of file PluginDataModel.cpp.

{
   if(row < mIndexFilterMap.size())
      return wxDataViewItem { mIndexFilterMap[row] };
   return {};
}

References mIndexFilterMap.

◆ GetParent()

wxDataViewItem PluginDataModel::GetParent ( const wxDataViewItem & item ) const

override

Definition at line 282 of file PluginDataModel.cpp.

{
   return {};
}

◆ GetPlugin()

PluginDescriptor * PluginDataModel::GetPlugin ( wxDataViewItem item )

Definition at line 305 of file PluginDataModel.cpp.

{
   if(!item.IsOk())
      return nullptr;
   const auto index = GetRowIndex(item);
   if(index >= mPluginStateModel.size())
      return nullptr;
 
   return mPluginStateModel[index].first;
}

References GetRowIndex(), and mPluginStateModel.

Here is the call graph for this function:

◆ GetRowCount()

uint32_t PluginDataModel::GetRowCount ( ) const

Definition at line 76 of file PluginDataModel.cpp.

{
   return mIndexFilterMap.size();
}

References mIndexFilterMap.

◆ GetRowForItem()

bool PluginDataModel::GetRowForItem	(	const wxDataViewItem &	item,
		uint32_t &	row
	)		const

Definition at line 66 of file PluginDataModel.cpp.

{
   if(item.IsOk())
   {
      row = GetRowIndex(item);
      return row < mIndexFilterMap.size();
   }
   return false;
}

References GetRowIndex(), and mIndexFilterMap.

Here is the call graph for this function:

◆ GetValue()

void PluginDataModel::GetValue	(	wxVariant &	variant,
		const wxDataViewItem &	item,
		unsigned	col
	)		const

override

Definition at line 230 of file PluginDataModel.cpp.

{
   assert(item.IsOk());
 
   const auto index = GetRowIndex(item);
   if(index >= mPluginStateModel.size())
      return;
 
   const auto [descriptor, state] = mPluginStateModel[index];
   switch(col)
   {
   case ColumnName:
      {
         if (descriptor->GetPluginType() == PluginTypeEffect)
            variant = descriptor->GetSymbol().Translation();
         // This is not right and will not work when other plugin types are added.
         // But it's presumed that the plugin manager dialog will be fully developed
         // by then.
         else if (descriptor->GetPluginType() == PluginTypeStub)
         {
            wxFileName fname{ descriptor->GetPath() };
            variant = fname.GetName().Trim(false).Trim(true);
         }
      } break;
   case ColumnPath:
      variant = descriptor->GetPath();
      break;
   case ColumnType:
      variant = descriptor->GetEffectFamily();
      break;
   case ColumnState:
      variant = state;
      break;
   default:
      break;
   }
}

References ColumnName, ColumnPath, ColumnState, ColumnType, GetRowIndex(), mPluginStateModel, PluginTypeEffect, and PluginTypeStub.

Referenced by Compare().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HasContainerColumns()

bool PluginDataModel::HasContainerColumns ( const wxDataViewItem & item ) const

override

Definition at line 86 of file PluginDataModel.cpp.

{
   return item.GetID() == RowIdRoot;
}

References RowIdRoot.

◆ IsContainer()

bool PluginDataModel::IsContainer ( const wxDataViewItem & item ) const

override

Definition at line 287 of file PluginDataModel.cpp.

{
   return item.GetID() == RowIdRoot;
}

References RowIdRoot.

◆ IsEnabled()

bool PluginDataModel::IsEnabled	(	const wxDataViewItem &	item,
		unsigned	col
	)		const

override

Definition at line 81 of file PluginDataModel.cpp.

{
   return true;
}

◆ IsFilterEmpty()

bool PluginDataModel::IsFilterEmpty ( ) const

private

Definition at line 357 of file PluginDataModel.cpp.

{
   return mFilterState == -1 && mFilterType.empty() && mFilterExpr.empty();
}

References mFilterExpr, mFilterState, and mFilterType.

◆ IsListModel()

bool PluginDataModel::IsListModel ( ) const

inlineoverride

Definition at line 78 of file PluginDataModel.h.

78{ return false; }

◆ SetFilterCategory()

void PluginDataModel::SetFilterCategory ( int category )

Definition at line 133 of file PluginDataModel.cpp.

{
   if(mFilterCategory != category)
   {
      mFilterCategory = category;
      UpdateFilter();
   }
}

References mFilterCategory, and UpdateFilter().

Here is the call graph for this function:

◆ SetFilterExpr()

void PluginDataModel::SetFilterExpr ( const wxString & expr )

Definition at line 119 of file PluginDataModel.cpp.

{
   if(mFilterExpr != expr)
   {
      mFilterExpr = expr;
      UpdateFilter();
   }
}

References mFilterExpr, and UpdateFilter().

Here is the call graph for this function:

◆ SetFilterState()

void PluginDataModel::SetFilterState ( int state )

Definition at line 105 of file PluginDataModel.cpp.

{
   if(mFilterState != state)
   {
      mFilterState = state;
      UpdateFilter();
   }
}

References mFilterState, and UpdateFilter().

Here is the call graph for this function:

◆ SetFilterType()

void PluginDataModel::SetFilterType ( const wxString & type )

Definition at line 91 of file PluginDataModel.cpp.

{
   if(mFilterType != type)
   {
      mFilterType = type;
      UpdateFilter();
   }
}

References mFilterType, and UpdateFilter().

Here is the call graph for this function:

◆ SetValue()

bool PluginDataModel::SetValue	(	const wxVariant &	variant,
		const wxDataViewItem &	item,
		unsigned	col
	)

override

Definition at line 268 of file PluginDataModel.cpp.

{
   if(col == ColumnState)
   {
      const auto index = GetRowIndex(item);
      if(index < mPluginStateModel.size())
      {
         mPluginStateModel[index].second = variant.GetBool();
         return true;
      }
   }
   return false;
}

References ColumnState, GetRowIndex(), and mPluginStateModel.

Here is the call graph for this function:

◆ UpdateFilter()

void PluginDataModel::UpdateFilter ( )

private

Definition at line 316 of file PluginDataModel.cpp.

{
   auto textFilters = wxSplit(mFilterExpr, ' ');
   std::for_each(
      textFilters.begin(),
      textFilters.end(),
      [](wxString& str) { str.MakeLower(); }
   );
   mIndexFilterMap.clear();
 
   auto filterFn = [=](PluginDescriptor* desc, bool state)
   {
      if((!mFilterType.empty() && desc->GetProviderID() != mFilterType) ||
         (mFilterState != -1 && state != static_cast<bool>(mFilterState)) ||
         (mFilterCategory != -1 && mFilterCategory != desc->GetEffectType()))
      {
         return false;
      }
 
      for(auto& filter : textFilters)
      {
         if((desc->GetPluginType() != PluginTypeEffect || 
               desc->GetSymbol().Translation().Lower().Find(filter) == wxNOT_FOUND) &&
            (desc->GetPluginType() != PluginTypeStub ||
               wxFileName(desc->GetPath()).GetName().Lower().Find(filter) == wxNOT_FOUND))
         {
            return false;
         }
      }
      return true;
   };
 
   for(uint32_t i = 0; i < mPluginStateModel.size(); ++i)
   {
      const auto [desc, state] = mPluginStateModel[i];
      if(filterFn(desc, state))
         mIndexFilterMap.push_back(MakeRow(i));
   }
   Cleared();
}

References anonymous_namespace{ExportPCM.cpp}::desc, MakeRow(), mFilterCategory, mFilterExpr, mFilterState, mFilterType, mIndexFilterMap, mPluginStateModel, PluginTypeEffect, PluginTypeStub, str, and TranslatableString::Translation().

Referenced by PluginDataModel(), SetFilterCategory(), SetFilterExpr(), SetFilterState(), and SetFilterType().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mFilterCategory

int PluginDataModel::mFilterCategory {-1}

private

Definition at line 29 of file PluginDataModel.h.

Referenced by GetFilterCategory(), SetFilterCategory(), and UpdateFilter().

◆ mFilterExpr

wxString PluginDataModel::mFilterExpr

private

Definition at line 27 of file PluginDataModel.h.

Referenced by GetFilterExpr(), IsFilterEmpty(), SetFilterExpr(), and UpdateFilter().

◆ mFilterState

int PluginDataModel::mFilterState {-1}

private

Definition at line 28 of file PluginDataModel.h.

Referenced by GetFilterState(), IsFilterEmpty(), SetFilterState(), and UpdateFilter().

◆ mFilterType

wxString PluginDataModel::mFilterType

private

Definition at line 26 of file PluginDataModel.h.

Referenced by GetFilterType(), IsFilterEmpty(), SetFilterType(), and UpdateFilter().

◆ mIndexFilterMap

std::vector<void*> PluginDataModel::mIndexFilterMap

private

Definition at line 24 of file PluginDataModel.h.

Referenced by GetChildren(), GetItemForRow(), GetRowCount(), GetRowForItem(), and UpdateFilter().

◆ mPluginStateModel

std::vector<std::pair<PluginDescriptor*, bool> > PluginDataModel::mPluginStateModel

private

Definition at line 23 of file PluginDataModel.h.

Referenced by ApplyChanges(), GetPlugin(), GetValue(), PluginDataModel(), SetValue(), and UpdateFilter().

◆ RowIdRoot

const void * PluginDataModel::RowIdRoot {}

staticprivate

Definition at line 21 of file PluginDataModel.h.

Referenced by GetChildren(), HasContainerColumns(), and IsContainer().

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Column

Constructor & Destructor Documentation

◆ PluginDataModel()

Member Function Documentation

◆ ApplyChanges()

◆ Compare()

◆ GetChildren()

◆ GetColumnCount()

◆ GetColumnType()

◆ GetFilterCategory()

◆ GetFilterExpr()

◆ GetFilterState()

◆ GetFilterType()

◆ GetItemForRow()

◆ GetParent()

◆ GetPlugin()

◆ GetRowCount()

◆ GetRowForItem()

◆ GetValue()

◆ HasContainerColumns()

◆ IsContainer()

◆ IsEnabled()

◆ IsFilterEmpty()

◆ IsListModel()

◆ SetFilterCategory()

◆ SetFilterExpr()

◆ SetFilterState()

◆ SetFilterType()

◆ SetValue()

◆ UpdateFilter()

Member Data Documentation

◆ mFilterCategory

◆ mFilterExpr

◆ mFilterState

◆ mFilterType

◆ mIndexFilterMap

◆ mPluginStateModel

◆ RowIdRoot