Method GetCommandDefinition

src/EffectAndCommandPluginManager.cpp:100–150

}

void EffectAndCommandPluginManager::GetCommandDefinition(
   const PluginID& ID, const CommandContext& context, int flags)
{
   const EffectSettingsManager* effect = nullptr;
   const EffectSettings* settings;
   AudacityCommand* command = nullptr;

   if (auto [edi, pSettings] =
          EffectManager::Get().GetEffectAndDefaultSettings(ID);
       edi)
   {
      effect = &edi->GetDefinition();
      assert(pSettings); // postcondition
      settings = pSettings;
   }
   else
      command = GetAudacityCommand(ID);
   if (!effect && !command)
      return;

   ConstSettingsVisitor NullShuttle;

   // Test if it defines any parameters at all.
   bool bHasParams = command ? command->VisitSettings(NullShuttle) :
                               effect->VisitSettings(NullShuttle, *settings);
   if ((flags == 0) && !bHasParams)
      return;

   // This is capturing the output context into the shuttle.
   ShuttleGetDefinition S(*context.pOutput.get()->mStatusTarget.get());
   S.StartStruct();
   // using GET to expose a CommandID to the user!
   // Macro command details are one place that we do expose Identifier
   // to (more sophisticated) users
   const auto& pm = PluginManager::Get();
   S.AddItem(pm.GetCommandIdentifier(ID).GET(), "id");
   S.AddItem(pm.GetName(ID).Translation(), "name");
   if (bHasParams)
   {
      S.StartField("params");
      S.StartArray();
      command ? command->VisitSettings(S) : effect->VisitSettings(S, *settings);
      S.EndArray();
      S.EndField();
   }
   // use GET() to expose some details to macro programming users
   S.AddItem(GetCommandUrl(ID).GET(), "url");
   // The tip is a translated string!
   S.AddItem(GetCommandTip(ID).Translation(), "tip");
   S.EndStruct();
}

void EffectAndCommandPluginManager::BatchProcessingOn(const PluginID& ID)
{