YarpPluginSettings.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef YARP_OS_YARPPLUGINSETTINGS_H
#define YARP_OS_YARPPLUGINSETTINGS_H
 
#include <yarp/os/api.h>
 
#include <yarp/os/Log.h>
#include <yarp/os/SharedLibraryClass.h>
#include <yarp/os/YarpPluginSelector.h>
 
namespace yarp::os {
 
class YARP_os_API YarpPluginSettings
{
public:
    YarpPluginSettings() = default;
 
    void setLibraryMethodName(const std::string& dll_name,
                              const std::string& fn_name)
    {
        this->dll_name = dll_name;
        this->fn_name = fn_name;
    }
 
    void setPluginName(const std::string& name)
    {
        this->name = name;
    }
 
    void setClassInfo(const std::string& class_name,
                      const std::string& baseclass_name)
    {
        this->class_name = class_name;
        this->baseclass_name = baseclass_name;
    }
 
 
    bool setSelector(YarpPluginSelector& selector)
    {
        this->selector = &selector;
        if (name != "") {
            return readFromSelector(name);
        }
        return false;
    }
 
#ifndef YARP_NO_DEPRECATED // Since YARP 3.4
    YARP_DEPRECATED_MSG("Use log components instead")
    void setVerboseMode(bool verbose);
#endif // YARP_NO_DEPRECATED
 
    bool readFromSearchable(Searchable& options, const std::string& name)
    {
        std::string iname = options.find("library").toString();
        std::string pname = options.find("part").toString();
 
        if (iname == "") {
            iname = name;
        }
        if (pname == "") {
            pname = name;
        }
 
        if (this->name == "") {
            this->name = iname;
        }
        this->dll_name = iname;
        this->fn_name = pname;
        this->wrapper_name = options.find("wrapper").toString();
        return true;
    }
 
    std::string getPluginName() const
    {
        return name;
    }
 
    std::string getLibraryName() const
    {
        return dll_name;
    }
 
    std::string getMethodName() const
    {
        return fn_name;
    }
 
    YarpPluginSelector* getSelector() const
    {
        return selector;
    }
 
    std::string getWrapperName() const
    {
        return wrapper_name;
    }
 
    std::string getClassName() const
    {
        return class_name;
    }
 
    std::string getBaseClassName() const
    {
        return class_name;
    }
 
    bool open(SharedLibraryFactory& factory);
 
    void reportStatus(SharedLibraryFactory& factory) const;
 
    void reportFailure() const;
 
private:
    YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG(std::string) name;
    YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG(std::string) dll_name;
    YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG(std::string) fn_name;
    YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG(std::string) wrapper_name {"unknown"};
    YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG(std::string) class_name;
    YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG(std::string) baseclass_name;
    YarpPluginSelector* selector {nullptr};
 
    bool subopen(SharedLibraryFactory& factory,
                 const std::string& dll_name,
                 const std::string& fn_name);
 
    bool open(SharedLibraryFactory& factory,
              const std::string& dll_name,
              const std::string& fn_name);
 
    bool readFromSelector(const std::string& name);
};
 
} // namespace yarp::os
 
#endif // YARP_OS_YARPPLUGINSELECTOR_H