Skip to content

[Simulation.Core] Refactor logic of loading a plugin from a RequiredPlugin name #6026

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
alxbilger wants to merge 1 commit into from
+26 −15
Closed

[Simulation.Core] Refactor logic of loading a plugin from a RequiredPlugin name #6026

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 26 additions & 15 deletions Sofa/framework/Simulation/Core/src/sofa/simulation/RequiredPlugin.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,45 +103,56 @@ bool RequiredPlugin::loadPlugin()
if (suffixVec.empty())
suffixVec.push_back(defaultSuffix);

/// Copy the lost of names provided as arguments
const type::vector<std::string>& nameVec = d_pluginName.getValue();
type::vector<std::string> pluginsToLoad = nameVec;
const bool loadPluginFromName = !d_pluginName.isSet() && name.isSet();

/// In case the pluginName is not set we copy the provided name into the set to load.
if(!d_pluginName.isSet() && name.isSet())
auto pluginNameData = sofa::helper::WriteAccessor(d_pluginName);

//the plugin to load can also be defined by setting the component name to the plugin name
if (loadPluginFromName)
{
pluginsToLoad.push_back(this->getName());
auto componentName = this->getName();
pluginNameData.push_back(componentName);
// msg_info() << "The plugin name '" << componentName << "', provided by the component name, is added to the list of plugin names to load in the Data 'pluginName'.";

if (componentName.find_first_of('.') != std::string::npos)
{
//it is common for plugin names to contain a dot, but a dot in a component name can lead
//to an undefined behavior. Therefore, dots are replaced with _ in the component name.
sofa::helper::replaceAll(componentName, ".", "_");
this->setName(componentName);
// msg_info() << "The name of the component has been changed to '" << componentName << "' to avoid undefined behavior. The Data 'pluginName' is used instead to load the plugins.";
}
}

type::vector< std::string > failed;
std::ostringstream errmsg;
for (const auto& pluginName : pluginsToLoad)
for (const auto& pluginName : pluginNameData)
{
const std::string name = FileSystem::cleanPath( pluginName ); // name is not necessarily a path
const std::string cleanedName = FileSystem::cleanPath( pluginName ); // name is not necessarily a path
bool isNameLoaded = false;
for (const auto& suffix : suffixVec)
{
bool isPluginLoaded = pluginManager.pluginIsLoaded(name);
bool isPluginLoaded = pluginManager.pluginIsLoaded(cleanedName);
if (!isPluginLoaded)
{
const auto status = pluginManager.loadPlugin(name, suffix, true, true, &errmsg);
const auto status = pluginManager.loadPlugin(cleanedName, suffix, true, true, &errmsg);
isPluginLoaded = (status == PluginManager::PluginLoadStatus::SUCCESS || status == PluginManager::PluginLoadStatus::ALREADY_LOADED);
}
if (isPluginLoaded)
{
loadedPlugins.push_back(name);
loadedPlugins.push_back(cleanedName);
isNameLoaded = true;

// Register Objects explicitly
objectFactory->registerObjectsFromPlugin(name);
objectFactory->registerObjectsFromPlugin(cleanedName);

// fail-safe to check if potential components have been registered (implicitly or explicitly)
std::vector<sofa::core::ObjectFactory::ClassEntry::SPtr> entries;
objectFactory->getEntriesFromTarget(entries, name);
objectFactory->getEntriesFromTarget(entries, cleanedName);

if (entries.empty())
{
msg_warning() << "No component has been registered from " << name << ".\n"
msg_warning() << "No component has been registered from " << cleanedName << ".\n"
<< "It could be because: \n"
<< " - the entrypoint registerObjects() has not been implemented;\n"
<< " - (deprecated since v24.12) no sofa::core::RegisterObject() has been called;\n"
Expand All @@ -153,7 +164,7 @@ bool RequiredPlugin::loadPlugin()
}
if (!isNameLoaded)
{
failed.push_back(name);
failed.push_back(cleanedName);
}
else if (d_stopAfterFirstNameFound.getValue())
{
Expand Down
Loading