SharedLibraryFactory.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_SHAREDLIBRARYFACTORY_H
#define YARP_OS_SHAREDLIBRARYFACTORY_H
 
#include <yarp/os/api.h>
 
#include <yarp/os/SharedLibrary.h>
#include <yarp/os/SharedLibraryClassApi.h>
#include <yarp/os/Vocab.h>
 
#include <string>
 
 
namespace yarp::os {
 
class YARP_os_API SharedLibraryFactory
{
public:
    enum
    {
        STATUS_NONE,                                                           
        STATUS_OK = yarp::os::createVocab32('o', 'k'),                           
        STATUS_LIBRARY_NOT_FOUND = yarp::os::createVocab32('f', 'o', 'u', 'n'),  
        STATUS_LIBRARY_NOT_LOADED = yarp::os::createVocab32('l', 'o', 'a', 'd'), 
        STATUS_FACTORY_NOT_FOUND = yarp::os::createVocab32('f', 'a', 'c', 't'),  
        STATUS_FACTORY_NOT_FUNCTIONAL = yarp::os::createVocab32('r', 'u', 'n')   
    };
 
    explicit SharedLibraryFactory();
 
    SharedLibraryFactory(const char* dll_name,
                         const char* fn_name = nullptr);
 
    virtual ~SharedLibraryFactory();
 
    bool open(const char* dll_name, const char* fn_name = nullptr);
 
    bool isValid() const;
 
    int getStatus() const;
 
    std::string getError() const;
 
    const SharedLibraryClassApi& getApi() const;
 
    int getReferenceCount() const;
 
    int addRef();
 
    int removeRef();
 
    std::string getName() const;
 
    std::string getClassName() const;
 
    std::string getBaseClassName() const;
 
    bool useFactoryFunction(void* factory);
 
private:
    SharedLibrary lib;
    int status;
    SharedLibraryClassApi api;
    int returnValue;
    int rct; // FIXME Remove this reference counter and use a shared_ptr instead.
    YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG(std::string) name;
    YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG(std::string) className;
    YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG(std::string) baseClassName;
    YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG(std::string) error;
};
 
} // namespace yarp::os
 
#endif // YARP_OS_SHAREDLIBRARYFACTORY_H