MacroCommandsCatalog Class Reference

#include <BatchCommands.h>

Collaboration diagram for MacroCommandsCatalog:

Classes
struct	Entry

Public Types
using	Entries = std::vector< Entry >

Public Member Functions
	MacroCommandsCatalog (const AudacityProject *project)
Entries::const_iterator	ByFriendlyName (const TranslatableString &friendlyName) const
Entries::const_iterator	ByCommandId (const CommandID &commandId) const
const Entry &	operator[] (size_t index) const
Entries::const_iterator	begin () const
Entries::const_iterator	end () const

Private Attributes
Entries	mCommands

Detailed Description

Definition at line 28 of file BatchCommands.h.

Member Typedef Documentation

Entries

using MacroCommandsCatalog::Entries = std::vector<Entry>

Definition at line 35 of file BatchCommands.h.

Constructor & Destructor Documentation

MacroCommandsCatalog()

MacroCommandsCatalog::MacroCommandsCatalog

(

const AudacityProject *

project

)

Definition at line 303 of file BatchCommands.cpp.

{
   if (!project)
      return;
 
   Entries commands;
 
   PluginManager & pm = PluginManager::Get();
   EffectManager & em = EffectManager::Get();
   {
      for (auto &plug
           : pm.PluginsOfType(PluginTypeEffect|PluginTypeAudacityCommand)) {
         auto command = em.GetCommandIdentifier(plug.GetID());
         if (!command.empty())
            commands.push_back( {
               { command, plug.GetSymbol().Msgid() },
               plug.GetPluginType() == PluginTypeEffect ?
                  XO("Effect") : XO("Menu Command (With Parameters)")
            } );
      }
   }
 
   auto &manager = CommandManager::Get( *project );
   TranslatableStrings mLabels;
   CommandIDs mNames;
   std::vector<bool> vExcludeFromMacros;
   mLabels.clear();
   mNames.clear();
   manager.GetAllCommandLabels(mLabels, vExcludeFromMacros, true);
   manager.GetAllCommandNames(mNames, true);
 
   const bool english = wxGetLocale()->GetCanonicalName().StartsWith(wxT("en"));
 
   for(size_t i=0; i<mNames.size(); i++) {
      if( !vExcludeFromMacros[i] ){
         auto label = mLabels[i];
         label.Strip();
         bool suffix;
         if (!english)
            suffix = false;
         else {
            // We'll disambiguate if the squashed name is short and shorter than the internal name.
            // Otherwise not.
            // This means we won't have repetitive items like "Cut (Cut)" 
            // But we will show important disambiguation like "All (SelectAll)" and "By Date (SortByDate)"
            // Disambiguation is no longer essential as the details box will show it.
            // PRL:  I think this reasoning applies only when locale is English.
            // For other locales, show the (CamelCaseCodeName) always.  Or, never?
            wxString squashed = label.Translation();
            squashed.Replace( " ", "" );
 
            // uh oh, using GET for dubious comparison of (lengths of)
            // user-visible name and internal CommandID!
            // and doing this only for English locale!
            suffix = squashed.length() < wxMin( 18, mNames[i].GET().length());
         }
 
         if( suffix )
            // uh oh, using GET to expose CommandID to the user, as a
            // disambiguating suffix on a name, but this is only ever done if
            // the locale is English!
            // PRL:  In case this logic does get fixed for other locales,
            // localize even this punctuation format.  I'm told Chinese actually
            // prefers slightly different parenthesis characters
            label.Join( XO("(%s)").Format( mNames[i].GET() ), wxT(" ") );
 
         // Bug 2294.  The Close command pulls the rug out from under
         // batch processing, because it destroys the project.
         // So it is UNSAFE for scripting, and therefore excluded from
         // the catalog.
         if (mNames[i] == "Close")
            continue;
 
         commands.push_back(
            {
               {
                  mNames[i], // Internal name.
                  label // User readable name
               },
               XO("Menu Command (No Parameters)")
            }
         );
      }
   }
 
   // Sort commands by their user-visible names.
   // PRL:  What exactly should happen if first members of pairs are not unique?
   // I'm not sure, but at least I can sort stably for a better defined result.
   auto less =
      [](const Entry &a, const Entry &b)
         { return a.name.StrippedTranslation() <
            b.name.StrippedTranslation(); };
   std::stable_sort(commands.begin(), commands.end(), less);
 
   // Now uniquify by friendly name
   auto equal =
      [](const Entry &a, const Entry &b)
         { return a.name.StrippedTranslation() ==
            b.name.StrippedTranslation(); };
   std::unique_copy(
      commands.begin(), commands.end(), std::back_inserter(mCommands), equal);
}

References PluginManager::Get(), EffectManager::Get(), CommandManager::Get(), EffectManager::GetCommandIdentifier(), TranslatableString::Join(), label, manager, mCommands, MacroCommandsCatalog::Entry::name, PluginManager::PluginsOfType(), PluginTypeAudacityCommand, PluginTypeEffect, TranslatableString::Strip(), ComponentInterfaceSymbol::StrippedTranslation(), TranslatableString::Translation(), wxT(), and XO().

Here is the call graph for this function:

Member Function Documentation

begin()

Entries::const_iterator MacroCommandsCatalog::begin ( ) const

inline

Definition at line 47 of file BatchCommands.h.

{ return mCommands.begin(); }

References mCommands.

Referenced by MacroCommandDialog::SetCommandAndParams().

Here is the caller graph for this function:

ByCommandId()

auto MacroCommandsCatalog::ByCommandId

(

const CommandID &

commandId

)

const

Definition at line 426 of file BatchCommands.cpp.

{
   // Maybe this too should have a uniqueness check?
   return std::find_if( begin(), end(),
      [&](const Entry &entry)
         { return entry.name.Internal() == commandId; });
}

References PackedArray::begin(), PackedArray::end(), and entry.

Referenced by MacrosWindow::AddItem(), BatchEvalCommand::Apply(), MacroCommands::ApplyMacro(), and MacroCommandDialog::SetCommandAndParams().

Here is the call graph for this function:

Here is the caller graph for this function:

ByFriendlyName()

auto MacroCommandsCatalog::ByFriendlyName

(

const TranslatableString &

friendlyName

)

const

Definition at line 407 of file BatchCommands.cpp.

{
   const auto less = [](const Entry &entryA, const Entry &entryB)
      { return entryA.name.StrippedTranslation() <
         entryB.name.StrippedTranslation(); };
   auto range = std::equal_range(
      begin(), end(), Entry{ { {}, friendlyName }, {} }, less
   );
   if (range.first != range.second) {
      wxASSERT_MSG( range.first + 1 == range.second,
                    "Non-unique user-visible command name" );
      return range.first;
   }
   else
      return end();
}

References PackedArray::begin(), PackedArray::end(), MacroCommandsCatalog::Entry::name, and ComponentInterfaceSymbol::StrippedTranslation().

Here is the call graph for this function:

end()

Entries::const_iterator MacroCommandsCatalog::end ( ) const

inline

Definition at line 48 of file BatchCommands.h.

{ return mCommands.end(); }

References mCommands.

Referenced by MacrosWindow::AddItem(), BatchEvalCommand::Apply(), MacroCommands::ApplyMacro(), and MacroCommandDialog::SetCommandAndParams().

Here is the caller graph for this function:

operator[]()

const Entry & MacroCommandsCatalog::operator[] ( size_t  index ) const

inline

Definition at line 45 of file BatchCommands.h.

{ return mCommands[index]; }

References mCommands.

Member Data Documentation

mCommands

Entries MacroCommandsCatalog::mCommands

private

Definition at line 52 of file BatchCommands.h.

Referenced by begin(), end(), MacroCommandsCatalog(), and operator[]().

---

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

• BatchCommands.h
• BatchCommands.cpp