/***************************************************************************
 *             __________               __   ___.
 *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
 *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
 *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
 *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
 *                     \/            \/     \/    \/            \/
 * $Id$
 *
 * Copyright (C) 2014 by Amaury Pouly
 *
 * 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 2
 * of the License, or (at your option) any later version.
 *
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
 * KIND, either express or implied.
 *
 ****************************************************************************/
#ifndef _ANALYSER_H_
#define _ANALYSER_H_

#include <QObject>
#include <QVector>
#include <QString>
#include "backend.h"
#include "regtab.h"

class Analyser : public RegTabPanel
{
public:
    Analyser(const soc_desc::soc_ref_t& soc, IoBackend *backend);
    virtual ~Analyser();
    virtual void AllowWrite(bool en) { Q_UNUSED(en); }
    virtual QWidget *GetWidget() = 0;

protected:
    soc_desc::soc_ref_t m_soc;
    IoBackend *m_io_backend;
};

class AnalyserFactory
{
public:
    AnalyserFactory(bool _register);
    virtual ~AnalyserFactory();

    virtual QString GetName() = 0;
    virtual bool SupportSoc(const QString& soc_name) = 0;
    // return NULL of soc is not handled by the analyser
    virtual Analyser *Create(const soc_desc::soc_ref_t& soc, IoBackend *backend) = 0;
private:
    QString m_name;

public:
    static QStringList GetAnalysersForSoc(const QString& soc_name);
    static AnalyserFactory *GetAnalyserByName(const QString& name);
    static void RegisterAnalyser(AnalyserFactory *factory);

private:
    static QVector< AnalyserFactory * > m_factories;
};

template< typename T >
class TmplAnalyserFactory : public AnalyserFactory
{
public:
    TmplAnalyserFactory(bool _register, const QString& name) :AnalyserFactory(_register) { m_name = name; }
    virtual ~TmplAnalyserFactory() {}

    virtual QString GetName() { return m_name; }
    virtual bool SupportSoc(const QString& soc_name) { return T::SupportSoc(soc_name); }
    // return NULL of soc is not handled by the analyser
    virtual T *Create(const soc_desc::soc_ref_t& soc, IoBackend *backend)
    {
        if(!T::SupportSoc(QString::fromStdString(soc.get()->name)))
            return 0;
        return new T(soc, backend);
    }
private:
    QString m_name;
};

#endif /* _ANALYSER_H_ */