CTK/Libs/Core/ctkAbstractPluginFactory.tpp

/*=========================================================================

  Library:   CTK

  Copyright (c) Kitware Inc.

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0.txt

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

=========================================================================*/

#ifndef __ctkAbstractPluginFactory_tpp
#define __ctkAbstractPluginFactory_tpp

// CTK includes
#include "ctkAbstractPluginFactory.h"
#include "ctkScopedCurrentDir.h"

// QT includes
#include <QPluginLoader>
#include <QDebug>

//----------------------------------------------------------------------------
// ctkFactoryPluginItem methods
/*
//----------------------------------------------------------------------------
template<typename BaseClassType>
ctkFactoryPluginItem<BaseClassType>::ctkFactoryPluginItem(const QString& _path)
  :ctkAbstractFactoryFileBasedItem<BaseClassType>(_path)
{
}
*/

//----------------------------------------------------------------------------
template<typename BaseClassType>
bool ctkFactoryPluginItem<BaseClassType>::load()
{
  ctkScopedCurrentDir scopedCurrentDir(QFileInfo(this->path()).path());
  this->Loader.setFileName(this->path());
  bool loaded = this->Loader.load();
  if (!loaded)
    {
    this->appendLoadErrorString(this->loadErrorString());
    }
  return loaded;
}

//----------------------------------------------------------------------------
template<typename BaseClassType>
QString ctkFactoryPluginItem<BaseClassType>::loadErrorString()const
{
  return this->Loader.errorString();
}

//----------------------------------------------------------------------------
template<typename BaseClassType>
BaseClassType* ctkFactoryPluginItem<BaseClassType>::instanciator()
{
  //qDebug() << "PluginItem::instantiate - name:" << this->path();
  QObject * object = this->Loader.instance();
  if (!object)
    {
    if (this->verbose())
      {
      this->appendLoadErrorString(QString("Failed to instantiate plugin: %1").arg(this->path()));
      }
    return 0;
    }
  BaseClassType* castedObject = qobject_cast<BaseClassType*>(object);
  if (!castedObject)
    {
    if (this->verbose())
      {
      this->appendLoadErrorString(
            QString("Plugin %1 - Failed to access expected interface [%2] - Instead got object of type [%3]")
            .arg(this->path())
            .arg(BaseClassType::staticMetaObject.className())
            .arg(object->metaObject()->className()));
      }
    delete object; // Clean memory
    return 0;
    }
  return castedObject;
}

//----------------------------------------------------------------------------
// ctkAbstractPluginFactory methods

//-----------------------------------------------------------------------------
template<typename BaseClassType>
ctkAbstractFactoryItem<BaseClassType>* ctkAbstractPluginFactory<BaseClassType>
::createFactoryFileBasedItem()
{
  return new ctkFactoryPluginItem<BaseClassType>();
}

//-----------------------------------------------------------------------------
template<typename BaseClassType>
bool ctkAbstractPluginFactory<BaseClassType>
::isValidFile(const QFileInfo& fileInfo)const
{
  return this->ctkAbstractFileBasedFactory<BaseClassType>::isValidFile(fileInfo) &&
    QLibrary::isLibrary(fileInfo.fileName());
}

#endif