Method GetCOMPlugins

PathCopyCopy/src/PathCopyCopyPluginsRegistry.cpp:243–288

Adds all COM plugins to the given vector. Takes care of sorting them by group info (ID and position). @param p_COMPluginProvider Object to access registered COM plugins. @param p_rvspPlugins Vector where to store plugins.

    // @param p_rvspPlugins Vector where to store plugins.
    //
    void PluginsRegistry::GetCOMPlugins(const COMPluginProvider& p_COMPluginProvider,
                                        PluginSPV& p_rvspPlugins)
    {
        // Get list of COM plugins from settings.
        CLSIDV vPluginCLSIDs = p_COMPluginProvider.GetCOMPlugins();
        if (!vPluginCLSIDs.empty()) {
            // Load list of plugins by creating the COM objects and store group IDs and positions.
            COMPluginInfoV vCOMPluginInfos;            
            for (const CLSID& clsid : vPluginCLSIDs) {
                try {
                    COMPluginInfo pluginInfo;
                    pluginInfo.m_CLSID = clsid;
                    pluginInfo.m_spPlugin = std::make_shared<Plugins::COMPlugin>(clsid);
                    pluginInfo.m_GroupId = pluginInfo.m_spPlugin->GroupId();
                    pluginInfo.m_GroupPosition = pluginInfo.m_spPlugin->GroupPosition();

                    // Only care about position if the group ID is set.
                    if (pluginInfo.m_GroupId == 0) {
                        pluginInfo.m_GroupPosition = 0;
                    }
                    vCOMPluginInfos.push_back(std::move(pluginInfo));
                } catch (const Plugins::COMPluginError&) {
                    // The plugin is not functional, simply skip it.
                }
            }

            // Check if we have some plugins left. We might fail to load them.
            if (!vCOMPluginInfos.empty()) {
                // Sort plugins by group ID and position.
                if (vCOMPluginInfos.size() > 1) {
                    std::stable_sort(vCOMPluginInfos.begin(), vCOMPluginInfos.end());
                }

                // Register all plugins. Insert a separator between each group.
                PluginSP spSeparator = std::make_shared<PluginSeparator>();
                ULONG currentGroup = 0xFFFFFFFF;
                for (const COMPluginInfo& pluginInfo : vCOMPluginInfos) {
                    if (pluginInfo.m_GroupId != currentGroup) {
                        p_rvspPlugins.push_back(spSeparator);
                    }
                    p_rvspPlugins.push_back(pluginInfo.m_spPlugin);
                    currentGroup = pluginInfo.m_GroupId;
                }
            }
        }
    }

    //
    // Adds pipeline plugins to the given vector.