VP1ChannelManager Class Reference

#include <VP1ChannelManager.h>

Inheritance diagram for VP1ChannelManager:

Collaboration diagram for VP1ChannelManager:

Classes
class	Imp

Signals
void	uniquename_channelListChanged (const QStringList &)
void	availableChannelListChanged (const QStringList &)
void	availableUnusedChannelListChanged (const QStringList &)
void	newChannelCreated (IVP1ChannelWidget *)
void	channelUncreated (IVP1ChannelWidget *)

Public Member Functions
	VP1ChannelManager (VP1ExecutionScheduler *, VP1MainWindow *)
	~VP1ChannelManager ()
QString	loadPluginFile (const QString &filename)
bool	unloadPluginFile (const QString &filename)
QStringList	currentPluginFiles () const
QStringList	channelsInPluginFile (const QString &filename) const
QStringList	basename2UniqueNames (const QString &basename) const
bool	deleteChannel (const QString &channeluniquename)
IVP1ChannelWidget *	getChannel (const QString &channelbasename, QString &err)
unsigned	nActive (const QString &channelbasename) const
IVP1ChannelWidget *	uniqueName2Channel (const QString &uniquename) const
bool	hasRefreshingSystem (const QString &uniquename) const
QStringList	uniquenames () const
bool	uniqueNameExists (const QString &) const
bool	baseNameExists (const QString &) const
bool	channelWithBasenameIsLoaded (const QString &basename) const
QStringList	serializePluginInfo () const
QWidget *	getController (IVP1ChannelWidget *)
QString	getIconLocation (const QString &channelname, const bool &isbasename=true)
QStringList	availableChannelList ()

Private Attributes
Imp *	m_d

Detailed Description

Definition at line 27 of file VP1ChannelManager.h.

Constructor & Destructor Documentation

VP1ChannelManager()

VP1ChannelManager::VP1ChannelManager	(	VP1ExecutionScheduler *	sched,
		VP1MainWindow *	mw )

Definition at line 108 of file VP1ChannelManager.cxx.

                                                                                 : m_d(new Imp)
{
    m_d->channelmanager=this;
    m_d->scheduler=sched;
    m_d->mainwindow=mw;
}

~VP1ChannelManager()

VP1ChannelManager::~VP1ChannelManager

(

)

Definition at line 116 of file VP1ChannelManager.cxx.

{
    while(!m_d->uniquename_2_channel.empty())
        deleteChannel(m_d->uniquename_2_channel.begin()->first);
 
    std::map<QString,QPluginLoader*>::const_iterator it, itE = m_d->pluginfile_2_pluginloader.end();
    for(it=m_d->pluginfile_2_pluginloader.begin();it!=itE;++it)
        delete it->second;
 
    for (QObject* o : m_d->additionalOwnedObjects)
    delete o;
    delete m_d;
}

Member Function Documentation

availableChannelList()

QStringList VP1ChannelManager::availableChannelList

(

)

Definition at line 498 of file VP1ChannelManager.cxx.

                                                    {
    QStringList l;
    std::map<QString,QString>::const_iterator it = m_d->basename_2_pluginfile.begin();
    std::map<QString,QString>::const_iterator itE = m_d->basename_2_pluginfile.end();
    for (;it!=itE;++it) {
        l << it->first;
    }
    return l;
}

availableChannelListChanged

void VP1ChannelManager::availableChannelListChanged ( const QStringList & )

signal

availableUnusedChannelListChanged

void VP1ChannelManager::availableUnusedChannelListChanged ( const QStringList & )

signal

basename2UniqueNames()

QStringList VP1ChannelManager::basename2UniqueNames

(

const QString &

basename

)

const

Definition at line 546 of file VP1ChannelManager.cxx.

                                                                                  {
 
    if (m_d->basename_2_channels.find(basename)==m_d->basename_2_channels.end())
        return QStringList();
 
    std::set<IVP1ChannelWidget*>::const_iterator it = m_d->basename_2_channels[basename].begin();
    std::set<IVP1ChannelWidget*>::const_iterator itE = m_d->basename_2_channels[basename].end();
 
    QStringList l;
    for (;it!=itE;++it) {
        l << (*it)->unique_name();
    }
    return l;
}

baseNameExists()

bool VP1ChannelManager::baseNameExists

(

const QString &

basename

)

const

Definition at line 467 of file VP1ChannelManager.cxx.

                                                                     {
    return (m_d->basename_2_pluginfile.find(basename)!=m_d->basename_2_pluginfile.end());
}

channelsInPluginFile()

QStringList VP1ChannelManager::channelsInPluginFile

(

const QString &

filename

)

const

Definition at line 358 of file VP1ChannelManager.cxx.

                                                                                  {
    if (m_d->pluginfile_2_basenamesAndFactory.find(filename)==m_d->pluginfile_2_basenamesAndFactory.end())
        return QStringList();
    return m_d->pluginfile_2_basenamesAndFactory[filename].first;
}

channelUncreated

void VP1ChannelManager::channelUncreated ( IVP1ChannelWidget * )

signal

channelWithBasenameIsLoaded()

bool VP1ChannelManager::channelWithBasenameIsLoaded

(

const QString &

basename

)

const

Definition at line 562 of file VP1ChannelManager.cxx.

                                                                                  {
    if (m_d->basename_2_channels.find(basename)==m_d->basename_2_channels.end())
        return false;
    return !m_d->basename_2_channels[basename].empty();
}

currentPluginFiles()

QStringList VP1ChannelManager::currentPluginFiles

(

)

const

Definition at line 535 of file VP1ChannelManager.cxx.

                                                        {
    std::map<QString,QPluginLoader*>::const_iterator it = m_d->pluginfile_2_pluginloader.begin();
    std::map<QString,QPluginLoader*>::const_iterator itE = m_d->pluginfile_2_pluginloader.end();
    QStringList l;
    for(;it!=itE;++it) {
        l<<it->first;
    }
    return l;
}

deleteChannel()

bool VP1ChannelManager::deleteChannel

(

const QString &

channeluniquename

)

Definition at line 132 of file VP1ChannelManager.cxx.

                                                                       {
 
    //Find info:
    assert(m_d->uniquename_2_channel.find(channeluniquename)!=m_d->uniquename_2_channel.end());
    IVP1ChannelWidget * cw = m_d->uniquename_2_channel[channeluniquename];
    QString bn = cw->name();
    assert(m_d->basename_2_channels.find(bn)!=m_d->basename_2_channels.end());
 
    //Remove channelwidget from maps, and delete it.
    assert(m_d->basename_2_channels[bn].find(cw)!=m_d->basename_2_channels[bn].end());
    m_d->basename_2_channels[bn].erase(m_d->basename_2_channels[bn].find(cw));
    m_d->uniquename_2_channel.erase(m_d->uniquename_2_channel.find(channeluniquename));
 
    m_d->scheduler->uncreateAndDelete(cw);//The actual uncreate()+delete might be postponed if a system is
    //presently refreshing. But for all bookkeeping purposes it already
    //happened!
 
    channelUncreated(cw);
 
    //Remove controller from maps - and ensure the widget gets deleted
    //in any case (it is a scrollarea, not the controller known by the
    //actual channelwidget):
    assert(m_d->channel_2_controller.find(cw)!=m_d->channel_2_controller.end());
    m_d->channel_2_controller[cw]->deleteLater();
    m_d->channel_2_controller.erase(m_d->channel_2_controller.find(cw));
    assert(m_d->channel_2_controller.find(cw)==m_d->channel_2_controller.end());
 
    //Finally, assign new cloneids to any remaining channels of the same basename:
    //First wipe old info in uniquename_2_channel.
    std::set<IVP1ChannelWidget*>::iterator it = m_d->basename_2_channels[bn].begin();
    std::set<IVP1ChannelWidget*>::iterator itE = m_d->basename_2_channels[bn].end();
    for (;it!=itE;++it) {
        assert(m_d->uniquename_2_channel.find((*it)->unique_name())!=m_d->uniquename_2_channel.end());
        m_d->uniquename_2_channel.erase(m_d->uniquename_2_channel.find((*it)->unique_name()));
    }
 
    it = m_d->basename_2_channels[bn].begin();
    unsigned id(0);
    for (;it!=itE;++it) {
        (*it)->setCloneID(id++);
        (*it)->unique_name();
        assert(m_d->uniquename_2_channel.find((*it)->unique_name())==m_d->uniquename_2_channel.end());
        m_d->uniquename_2_channel[(*it)->unique_name()]=(*it);
    }
 
    uniquename_channelListChanged(uniquenames());
    m_d->emit_basename_availableUnusedChannelListChanged();
    return true;
}

getChannel()

IVP1ChannelWidget * VP1ChannelManager::getChannel	(	const QString &	channelbasename,
		QString &	err )

Definition at line 403 of file VP1ChannelManager.cxx.

                                                                                                {
    IVP1ChannelWidget * cw = m_d->constructChannel( channelbasename, err );
    if (!cw)
        return 0;
    cw->setUpdatesEnabled(false);
    cw->setCloneID(nActive(channelbasename));
    assert(m_d->uniquename_2_channel.find(cw->unique_name())==m_d->uniquename_2_channel.end());
    m_d->uniquename_2_channel[cw->unique_name()]=cw;
    m_d->basename_2_channels[channelbasename].insert(cw);
 
    assert(cw->state()==IVP1ChannelWidget::CONSTRUCTED);
    m_d->scheduler->bringFromConstructedToReady(cw);//Fixme: should return bool
    assert(cw->state()==IVP1ChannelWidget::READY);
 
    assert(m_d->channel_2_controller.find(cw)==m_d->channel_2_controller.end());
    QWidget * controller = cw->controllerWidget();
    QScrollArea * scrollarea = new QScrollArea;
    //  controller->setParent(scrollarea);
    scrollarea->setObjectName("VP1ControllerScrollArea");
    scrollarea->setWidgetResizable(true);
    scrollarea->setFrameShape(QFrame::NoFrame);
    scrollarea->setFrameShadow(QFrame::Plain);
 
 
    //scrollArea->setBackgroundRole(QPalette::Dark);
    scrollarea->setWidget(controller);
    m_d->channel_2_controller[cw] = scrollarea;
 
    uniquename_channelListChanged(uniquenames());
    m_d->emit_basename_availableUnusedChannelListChanged();
    newChannelCreated(cw);
    cw->setUpdatesEnabled(true);
 
    return cw;
}

getController()

QWidget * VP1ChannelManager::getController

(

IVP1ChannelWidget *

cw

)

Definition at line 440 of file VP1ChannelManager.cxx.

                                                              {
    assert(m_d->channel_2_controller.find(cw)!=m_d->channel_2_controller.end());
    return m_d->channel_2_controller[cw];
}

getIconLocation()

QString VP1ChannelManager::getIconLocation	(	const QString &	channelname,
		const bool &	isbasename = true )

Definition at line 588 of file VP1ChannelManager.cxx.

{
    if (!isbasename) {
        IVP1ChannelWidget* cw = uniqueName2Channel(channelname);
        if (!cw)
            return "";
        return m_d->channelTypeToIconLocation(cw->type());
    }
 
    if (m_d->basename2iconlocation.contains(channelname))
        return m_d->basename2iconlocation[channelname];
 
    //We have to briefly construct a channel in order to get its type.
    //The following create and destruct maneouver is to get a proper
    //cache of the icontext associated with the channel:
    QString err;
    IVP1ChannelWidget * cw = m_d->constructChannel( channelname, err, false /*don't init()*/ );
    if (!cw)
        return "";
    cw->deleteControllers();
    delete cw;
    // cppcheck-suppress deallocuse
    assert(m_d->channel_2_controller.find(cw)==m_d->channel_2_controller.end());
 
    //Try again;
    if (m_d->basename2iconlocation.contains(channelname))
        return m_d->basename2iconlocation[channelname];
    return "";
}

hasRefreshingSystem()

bool VP1ChannelManager::hasRefreshingSystem

(

const QString &

uniquename

)

const

Definition at line 581 of file VP1ChannelManager.cxx.

{
    IVP1ChannelWidget*cw = uniqueName2Channel(uniquename);
    return cw ? cw->hasRefreshingSystem() : false;
}

loadPluginFile()

QString VP1ChannelManager::loadPluginFile

(

const QString &

filename

)

Definition at line 229 of file VP1ChannelManager.cxx.

{
 
    VP1Msg::messageVerbose("VP1ChannelManager::loadPluginFile() - filename: " + filename);
 
    QString bn = QFileInfo(filename).fileName();
 
    if (m_d->pluginfile_2_basenamesAndFactory.find(filename)!=m_d->pluginfile_2_basenamesAndFactory.end()) {
        return "Error: Plugin already loaded.";
    } else {
 
 
        QFileInfo fi(filename);
        if (!fi.exists())
            return "File does not exist";
        if (!fi.isReadable())
            return "File is not readable";
 
        VP1Msg::messageVerbose("plugin path: " + fi.absoluteFilePath());
        VP1Msg::messageVerbose("app path: " + QCoreApplication::applicationDirPath());
        VP1Msg::messageVerbose("library path: " + QLibraryInfo::location(QLibraryInfo::PluginsPath));
 
        QString pluginAbsPath = fi.absoluteFilePath();
 
        QPluginLoader * loader = new QPluginLoader(pluginAbsPath);//Fixme: Ensure all loaders gets unloaded on shutdown (and thus deleted)
        m_d->pluginfile_2_pluginloader[filename]=loader;
 
        bool loadOk = loader->load();
 
        if (!loadOk) {
      VP1Msg::message("ERROR! Failed to load plugin. Error message: "+loader->errorString());
 
            VP1Msg::message("Trying to load the 'dbg' build...");
 
            /*
             * when running VP1 sometimes (especially from the devval release) the
             * load of the plugin fails silently...
             * After a long investigation, I found that the problem is in the mismatch
             * between the compilation flag of the main Qt application
             * and the flag of the plugin modules.
             * For example the main application is compiled in 'dbg', while the plugins
             * are compiled in 'opt' mode...
             * We still understand why...
             * In the meantime I implemented a workaround: the 'opt' flag is replaced
             * by the 'dbg' flag when the plugin fails to load.
             *
             */
            // QString build = "x86_64-slc6-gcc47-opt";
            //QString buildB = "x86_64-slc6-gcc47-dbg";
            //pluginAbsPath.replace(build, buildB);
 
            pluginAbsPath.replace("opt", "dbg");
 
            loader = new QPluginLoader(pluginAbsPath);
            loadOk = loader->load();
 
            if (loadOk) VP1Msg::message("Ok! 'dbg' build of the plugin successfully loaded!");
            else VP1Msg::message("ERROR!! Also the 'dbg' build failed to load!!");
 
        }
 
 
        QObject *plugin = loader->instance();
 
 
        if (!plugin) {
 
            bool error = loader->errorString().isNull();
 
 
            QString errStr = "ERROR!!";
            if (error)
                errStr = QString("Did not find any compatible plugins in file");
            else
                errStr = loader->errorString();
 
 
            return errStr;
        }
 
 
        IVP1ChannelWidgetFactory * fact = qobject_cast<IVP1ChannelWidgetFactory *>(plugin);
        m_d->additionalOwnedObjects << plugin;
 
 
        if (!fact)
            return "Did not find any channel factory in plugin file";
 
 
        QStringList providedbasenames = fact->channelWidgetsProvided();
 
 
        if (providedbasenames.count()==0)
            return "Found channel factory in plugin file, but no advertised channels!";
 
 
        m_d->pluginfile_2_basenamesAndFactory[filename] = std::pair<QStringList,IVP1ChannelWidgetFactory *>(providedbasenames,fact);
 
 
        for (const QString& bn : providedbasenames) {
            if (m_d->basename_2_pluginfile.find(bn)!=m_d->basename_2_pluginfile.end())
                return "Channels navp1 '"+bn+"' are already provided by plugin file "
                        +m_d->basename_2_pluginfile[bn]+" (ignoring other plugins in file '"+filename+"')";
        }
 
 
        for (const QString& bn : providedbasenames) {
            m_d->basename_2_pluginfile[bn] = filename;
            m_d->basename_2_channels[bn] = std::set<IVP1ChannelWidget*>();
        }
 
 
        m_d->emit_basename_availableChannelListChanged();
        m_d->emit_basename_availableUnusedChannelListChanged();
 
 
        //Fixme: check 20 chars.
    }
 
 
    m_d->mainwindow->addToMessageBox( "Successfully loaded "+bn, "color:#008b00" );
    QString out = "providing channels: "+channelsInPluginFile(filename).join(", ");
    m_d->mainwindow->addToMessageBox( out, "color:#008b00" );
 
 
    return "";
}

nActive()

unsigned VP1ChannelManager::nActive

(

const QString &

channelbasename

)

const

Definition at line 446 of file VP1ChannelManager.cxx.

                                                                           {
    if (m_d->basename_2_channels.find(channelbasename)==m_d->basename_2_channels.end())
        return 0;
    return m_d->basename_2_channels[channelbasename].size();
}

newChannelCreated

void VP1ChannelManager::newChannelCreated ( IVP1ChannelWidget * )

signal

serializePluginInfo()

QStringList VP1ChannelManager::serializePluginInfo

(

)

const

Definition at line 523 of file VP1ChannelManager.cxx.

                                                         {
    std::map<QString,std::pair<QStringList,IVP1ChannelWidgetFactory *> >::const_iterator
    it, itE = m_d->pluginfile_2_basenamesAndFactory.end();
 
    QStringList l;
    for( it = m_d->pluginfile_2_basenamesAndFactory.begin(); it!=itE; ++it ) {
        l<<QFileInfo(it->first).fileName();
    }
    return l;
}

uniqueName2Channel()

IVP1ChannelWidget * VP1ChannelManager::uniqueName2Channel

(

const QString &

uniquename

)

const

Definition at line 455 of file VP1ChannelManager.cxx.

                                                                                         {
    if (m_d->uniquename_2_channel.find(uniquename)==m_d->uniquename_2_channel.end())
        return 0;
    return m_d->uniquename_2_channel[uniquename];
}

uniquename_channelListChanged

void VP1ChannelManager::uniquename_channelListChanged ( const QStringList & )

signal

uniqueNameExists()

bool VP1ChannelManager::uniqueNameExists

(

const QString &

uniquename

)

const

Definition at line 462 of file VP1ChannelManager.cxx.

                                                                         {
    return (m_d->uniquename_2_channel.find(uniquename)!=m_d->uniquename_2_channel.end());
}

uniquenames()

QStringList VP1ChannelManager::uniquenames

(

)

const

Definition at line 472 of file VP1ChannelManager.cxx.

                                                 {
    QStringList l;
    std::map<QString,IVP1ChannelWidget*>::iterator it = m_d->uniquename_2_channel.begin();
    std::map<QString,IVP1ChannelWidget*>::iterator itE = m_d->uniquename_2_channel.end();
 
    for (;it!=itE;++it)
        l << it->first;
 
    return l;
}

unloadPluginFile()

bool VP1ChannelManager::unloadPluginFile

(

const QString &

filename

)

Definition at line 184 of file VP1ChannelManager.cxx.

                                                                 {
 
    VP1Msg::messageVerbose("VP1ChannelManager::unloadPluginFile()");
 
    if (m_d->pluginfile_2_pluginloader.find(filename)==m_d->pluginfile_2_pluginloader.end())
        return false;
 
    assert(m_d->pluginfile_2_basenamesAndFactory.find(filename)!=m_d->pluginfile_2_basenamesAndFactory.end());
    assert(m_d->pluginfile_2_pluginloader.find(filename)!=m_d->pluginfile_2_pluginloader.end());
 
    //Find basenames provided by this plugin, as well as factory and pluginloader:
    QStringList bns = channelsInPluginFile(filename);
    IVP1ChannelWidgetFactory * fact = m_d->pluginfile_2_basenamesAndFactory.find(filename)->second.second;
    QPluginLoader* loader = m_d->pluginfile_2_pluginloader[filename];
 
    //Abort if any active channels are affected by this plugin:
    for (const QString& bn : bns)
    if (nActive(bn)>0)
        return false;
 
    //Delete factory:
    delete fact;
 
    //Unload:
    bool success = loader->unload();
    delete loader;
 
    //Update maps:
    m_d->pluginfile_2_basenamesAndFactory.erase(m_d->pluginfile_2_basenamesAndFactory.find(filename));
    m_d->pluginfile_2_pluginloader.erase(m_d->pluginfile_2_pluginloader.find(filename));
    for (const QString& bn : bns) {
        m_d->basename_2_channels.erase(m_d->basename_2_channels.find(bn));
        m_d->basename_2_pluginfile.erase(m_d->basename_2_pluginfile.find(bn));
    }
 
    //Emit signals regarding changes:
    uniquename_channelListChanged(uniquenames());
    m_d->emit_basename_availableChannelListChanged();
    m_d->emit_basename_availableUnusedChannelListChanged();
 
    //Return:
    return success;
}

Member Data Documentation

m_d

Imp* VP1ChannelManager::m_d

private

Definition at line 82 of file VP1ChannelManager.h.

---

The documentation for this class was generated from the following files:

• VP1ChannelManager.h
• VP1ChannelManager.cxx