DriverLib.h

Go to the documentation of this file.

/*
 * Driver.h
 *
 *  This file is part of the HausmiSEP project
 *
 *  Copyright (C) 2012, 2013 Marco Alvarado (malvcr@gmail.com)
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef DRIVERLIB_H_
#define DRIVERLIB_H_

#include <HSEP/Library.h>
#include <HSEP/Dictionary.h>

using namespace std;
using namespace HSEP;

namespace HSEP {

    template<class Type>
    class DriverLib : public Library {
        string  aFactoryFunctionName;
        string  aDriverInfo;
    public:
        typedef Dictionary<Type> TypeDictionary;                       
        typedef TypeDictionary* (*createTypeCatalog )();               
        typedef void            (*destroyTypeCatalog)(TypeDictionary*);
        typedef void            (*driverInfo)(string&);                
        typedef function<void (string& pKey, Type* pValue)> ForEachWorker; 
    private:
        TypeDictionary* aCatalogPtr;
    public:
        DriverLib(string& pPathRef,string& pFactoryFunctionNameRef) : Library("DriverLib",pPathRef) {

            aFactoryFunctionName = string(pFactoryFunctionNameRef); // take care with stolen references

            if (valid()) {
                createTypeCatalog vCreateCatalogPtr;
                string vCreateCatalogName("create"+aFactoryFunctionName);
                vCreateCatalogPtr = (createTypeCatalog)getMethodPtr(vCreateCatalogName);

                if (nullptr) {
                    invalidate();
                }
                else {
                    aCatalogPtr = vCreateCatalogPtr();

                    driverInfo vDriverInfoPtr;
                    string vDriverInfoName("driverInfo");

                    vDriverInfoPtr = (driverInfo)getMethodPtr(vDriverInfoName);

                    if (nullptr == vDriverInfoPtr) {
                        invalidate();
                    }
                    else {
                        vDriverInfoPtr(aDriverInfo);

                    }

                }
            }
        } // constructor

        ~DriverLib() {

            if (valid()) {

                //aCatalogPtr->clear();

                destroyTypeCatalog vDestroyCatalogPtr;
                string vDestroyCatalogName("destroy"+aFactoryFunctionName);
                vDestroyCatalogPtr = (destroyTypeCatalog)getMethodPtr(vDestroyCatalogName);

                if (nullptr != vDestroyCatalogPtr) {
                    vDestroyCatalogPtr(aCatalogPtr);
                }

                // vDestroyCatalogPtr instead of ... delete aCatalogPtr;
                //
                // This offers more flexibility to the library by itself, giving the opportunity
                // to initialize and de-initialize additional resources.
                //

            }

        } // destructor

        TypeDictionary* getCatalogPtr() {

            TypeDictionary* vResultPtr = nullptr;
            if (valid()) {
                vResultPtr = aCatalogPtr;
            }
            return vResultPtr;
        } // getCatalog

        string& infoRef() {
            return aDriverInfo;
        }

        Type* getItemPtr(string& pItemNameRef) {

            Type* vResultPtr = nullptr;
            if (valid()) {
                vResultPtr = aCatalogPtr->ptr(pItemNameRef);
            }
            return vResultPtr;

        } // getItem

        void forEach(ForEachWorker pWorker) {
            if (valid()) {
                aCatalogPtr->forEach(pWorker);
            }
        } // forEach

        bool has(string& pItemNameRef) {
            return aCatalogPtr->has(pItemNameRef);
        } // has

    }; // DriverLib class

} // HSEP namespace

#endif /* DRIVERLIB_H_ */