toolfactory.h

   1 /*
   2   toolfactory.h
   3
   4   This file is part of GammaRay, the Qt application inspection and
   5   manipulation tool.
   6
   7   Copyright (C) 2010-2011 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com
   8   Author: Volker Krause <volker.krause@kdab.com>
   9
  10   This program is free software; you can redistribute it and/or modify
  11   it under the terms of the GNU General Public License as published by
  12   the Free Software Foundation, either version 2 of the License, or
  13   (at your option) any later version.
  14
  15   This program is distributed in the hope that it will be useful,
  16   but WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18   GNU General Public License for more details.
  19
  20   You should have received a copy of the GNU General Public License
  21   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22 */
  23
  24 #ifndef GAMMARAY_TOOLFACTORY_H
  25 #define GAMMARAY_TOOLFACTORY_H
  26
  27 #include <QtPlugin>
  28 #include <QtCore/QStringList>
  29 #include <QMetaType>
  30
  31 namespace GammaRay {
  32
  33 class ProbeInterface;
  34
  35 /**
  36  * Abstract interface for probe tools.
  37  */
  38 class ToolFactory
  39 {
  40   public:
  41     virtual inline ~ToolFactory() {}
  42
  43     /**
  44      * Unique id of this tool
  45      */
  46     virtual QString id() const = 0;
  47
  48     /**
  49      * Human readable name of this tool.
  50      */
  51     virtual QString name() const = 0;
  52
  53     /**
  54      * Class names of types this tool can handle.
  55      * The tool will only be activated if an object of one of these types
  56      * is seen in the probed application.
  57      */
  58     virtual QStringList supportedTypes() const = 0;
  59
  60     /**
  61      * Initialize the tool.
  62      * Implement this method to do non-GUI initialization, such as creating
  63      * object tracking models etc.
  64      * @param probe The probe interface allowing access to the object models.
  65      */
  66     virtual void init(ProbeInterface *probe) = 0;
  67
  68     /**
  69      * Create the UI part of this tool.
  70      * @param probe The probe interface allowing access to the object models.
  71      * @param parentWidget The parent widget for the visual elements of this tool.
  72      */
  73     virtual QWidget *createWidget(ProbeInterface *probe, QWidget *parentWidget) = 0;
  74 };
  75
  76 template <typename Type, typename Tool>
  77 class StandardToolFactory : public ToolFactory
  78 {
  79   public:
  80     virtual inline QStringList supportedTypes() const {
  81       return QStringList(Type::staticMetaObject.className());
  82     }
  83     virtual inline QString id() const {
  84       return Tool::staticMetaObject.className();
  85     }
  86     virtual inline void init(ProbeInterface *) {}
  87     virtual inline QWidget *createWidget(ProbeInterface *probe, QWidget *parentWidget) {
  88       return new Tool(probe, parentWidget);
  89     }
  90 };
  91
  92 }
  93
  94 Q_DECLARE_INTERFACE(GammaRay::ToolFactory, "com.kdab.GammaRay.ToolFactory/1.0")
  95 Q_DECLARE_METATYPE(GammaRay::ToolFactory *)
  96
  97 #endif