SharedLibraryFactory.h

Go to the documentation of this file.

/*
 * Robot Testing Framework
 *
 * Copyright (C) 2015-2019 Istituto Italiano di Tecnologia (IIT)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */


#ifndef ROBOTTESTINGFRAMEWORK_SHAREDLIBRARYFACTORY_H
#define ROBOTTESTINGFRAMEWORK_SHAREDLIBRARYFACTORY_H

#include <robottestingframework/dll/SharedLibrary.h>
#include <robottestingframework/dll/SharedLibraryClassApi.h>
#include <robottestingframework/dll/Vocab.h>

#include <string>


namespace shlibpp {
class SharedLibraryFactory;
}

class shlibpp::SharedLibraryFactory
{
public:
    enum
    {
        STATUS_NONE, 
        STATUS_OK = VOCAB('o', 'k'), 
        STATUS_LIBRARY_NOT_FOUND = VOCAB('f', 'o', 'u', 'n'), 
        STATUS_LIBRARY_NOT_LOADED = VOCAB('l', 'o', 'a', 'd'), 
        STATUS_FACTORY_NOT_FOUND = VOCAB('f', 'a', 'c', 't'), 
        STATUS_FACTORY_NOT_FUNCTIONAL = VOCAB('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;
    std::string name;
    std::string className;
    std::string baseClassName;
    std::string error;
};


#endif // ROBOTTESTINGFRAMEWORK_SHAREDLIBRARYFACTORY_H