PluginManager::Iterator Class Reference

#include <PluginManager.h>

Collaboration diagram for PluginManager::Iterator:

Public Member Functions
	Iterator (PluginManager &manager)
	Iterates all, even disabled. More...
	Iterator (PluginManager &manager, int pluginType)
	Iterates only enabled and matching plugins, with family enabled too if an effect. More...
	Iterator (PluginManager &manager, EffectType type)
	Iterates only enabled and matching effects, with family enabled too. More...
bool	operator!= (int) const
Iterator &	operator++ ()
auto &	operator* () const

Private Member Functions
void	Advance (bool incrementing)

Private Attributes
const PluginManager &	mPm
PluginMap::iterator	mIterator
EffectType	mEffectType { EffectTypeNone }
int	mPluginType { PluginTypeNone }

Detailed Description

Definition at line 130 of file PluginManager.h.

Constructor & Destructor Documentation

Iterator() [1/3]

PluginManager::Iterator::Iterator ( PluginManager &  manager )

explicit

Iterates all, even disabled.

Definition at line 1090 of file PluginManager.cpp.

: mPm{ manager }
, mIterator{ manager.mRegisteredPlugins.begin() }
{   
}

Iterator() [2/3]

PluginManager::Iterator::Iterator	(	PluginManager &	manager,
		int	pluginType
	)

Iterates only enabled and matching plugins, with family enabled too if an effect.

Parameters

pluginType

bitwise or of values in PluginType

Definition at line 1096 of file PluginManager.cpp.

: mPm{ manager }
, mIterator{ manager.mRegisteredPlugins.begin() }
, mPluginType{ type }
{
   Advance(false);
}

References Advance().

Here is the call graph for this function:

Iterator() [3/3]

PluginManager::Iterator::Iterator	(	PluginManager &	manager,
		EffectType	type
	)

Iterates only enabled and matching effects, with family enabled too.

Definition at line 1104 of file PluginManager.cpp.

: mPm{ manager }
, mIterator{ manager.mRegisteredPlugins.begin() }
, mEffectType{ type }
{
   Advance(false);
}

References Advance().

Here is the call graph for this function:

Member Function Documentation

Advance()

void PluginManager::Iterator::Advance ( bool  incrementing )

private

Definition at line 1065 of file PluginManager.cpp.

{
   const auto end = mPm.mRegisteredPlugins.end();
   if (incrementing && mIterator != end)
      ++mIterator;
   bool all = mPluginType == PluginTypeNone && mEffectType == EffectTypeNone;
   for (; mIterator != end; ++mIterator) {
      auto &plug = mIterator->second;
      if (!all && !(plug.IsValid() && plug.IsEnabled()))
         continue;
      auto plugType = plug.GetPluginType();
      if ((mPluginType == PluginTypeNone || (plugType & mPluginType)) &&
         (mEffectType == EffectTypeNone || plug.GetEffectType() == mEffectType)) {
         if (!all && (plugType & PluginTypeEffect)) {
            // This preference may be written by EffectsPrefs
            auto setting = mPm.GetPluginEnabledSetting( plug );
            if (!(setting.empty() || gPrefs->Read( setting, true )))
               continue;
         }
         // Pause iteration at this match
         break;
      }
   }
}

References EffectTypeNone, details::end(), PluginManager::GetPluginEnabledSetting(), gPrefs, mEffectType, mIterator, mPluginType, mPm, PluginManager::mRegisteredPlugins, PluginTypeEffect, PluginTypeNone, and audacity::BasicSettings::Read().

Referenced by Iterator().

Here is the call graph for this function:

Here is the caller graph for this function:

operator!=()

bool PluginManager::Iterator::operator!= ( int  ) const

inline

Definition at line 140 of file PluginManager.h.

                                   {
         return mIterator != mPm.mRegisteredPlugins.end();
      }

operator*()

auto & PluginManager::Iterator::operator* ( ) const

inline

Definition at line 144 of file PluginManager.h.

{ return mIterator->second; }

operator++()

auto PluginManager::Iterator::operator++

(

)

Definition at line 1112 of file PluginManager.cpp.

{
   Advance(true);
   return *this;
}

Member Data Documentation

mEffectType

EffectType PluginManager::Iterator::mEffectType { EffectTypeNone }

private

Definition at line 149 of file PluginManager.h.

Referenced by Advance().

mIterator

PluginMap::iterator PluginManager::Iterator::mIterator

private

Definition at line 148 of file PluginManager.h.

Referenced by Advance().

mPluginType

int PluginManager::Iterator::mPluginType { PluginTypeNone }

private

Definition at line 150 of file PluginManager.h.

Referenced by Advance().

mPm

const PluginManager& PluginManager::Iterator::mPm

private

Definition at line 147 of file PluginManager.h.

Referenced by Advance().

---

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

• PluginManager.h
• PluginManager.cpp