WidgetFactory.h

/*
 * 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 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 Library General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * WidgetFactory.h
 * Creates USB Widgets.
 * Copyright (C) 2014 Simon Newton
 */

#ifndef PLUGINS_USBDMX_WIDGETFACTORY_H_
#define PLUGINS_USBDMX_WIDGETFACTORY_H_

#include <libusb.h>
#include <map>
#include "ola/Logging.h"
#include "ola/base/Macro.h"
#include "ola/stl/STLUtils.h"

namespace ola {
namespace plugin {
namespace usbdmx {

class WidgetObserver {
 public:
 virtual ~WidgetObserver() {}

 virtual bool NewWidget(class AnymauDMX *widget) = 0;

 virtual bool NewWidget(class EurolitePro *widget) = 0;

 virtual bool NewWidget(class JaRuleWidget *widget) = 0;

 virtual bool NewWidget(class ScanlimeFadecandy *widget) = 0;

 virtual bool NewWidget(class Sunlite *widget) = 0;

 virtual bool NewWidget(class VellemanK8062 *widget) = 0;

 virtual void WidgetRemoved(class AnymauDMX *widget) = 0;

 virtual void WidgetRemoved(class EurolitePro *widget) = 0;

 virtual void WidgetRemoved(class JaRuleWidget *widget) = 0;

 virtual void WidgetRemoved(class ScanlimeFadecandy *widget) = 0;

 virtual void WidgetRemoved(class Sunlite *widget) = 0;

 virtual void WidgetRemoved(class VellemanK8062 *widget) = 0;
};

class WidgetFactory {
 public:
 virtual ~WidgetFactory() {}

 virtual bool DeviceAdded(
 WidgetObserver *observer,
 libusb_device *usb_device,
 const struct libusb_device_descriptor &descriptor) = 0;

 virtual void DeviceRemoved(WidgetObserver *observer,
 libusb_device *usb_device) = 0;
};

template <typename WidgetType>
class BaseWidgetFactory : public WidgetFactory {
 public:
 BaseWidgetFactory() {}

 void DeviceRemoved(WidgetObserver *observer,
 libusb_device *device);

 protected:
 bool HasDevice(libusb_device *usb_device) {
 return STLContains(m_widget_map, usb_device);
 }

 unsigned int DeviceCount() const {
 return m_widget_map.size();
 }

 bool AddWidget(WidgetObserver *observer, libusb_device *usb_device,
 WidgetType *widget);

 private:
 typedef std::map<libusb_device*, WidgetType*> WidgetMap;

 WidgetMap m_widget_map;

 DISALLOW_COPY_AND_ASSIGN(BaseWidgetFactory<WidgetType>);
};

template <typename WidgetType>
bool BaseWidgetFactory<WidgetType>::AddWidget(WidgetObserver *observer,
 libusb_device *usb_device,
 WidgetType *widget) {
 if (!widget->Init()) {
 delete widget;
 return false;
 }

 if (!observer->NewWidget(widget)) {
 delete widget;
 return false;
 }

 WidgetType *old_widget = STLReplacePtr(&m_widget_map, usb_device, widget);
 if (old_widget) {
 // This should never happen.
 OLA_WARN << "Widget conflict for " << usb_device;
 observer->WidgetRemoved(old_widget);
 delete old_widget;
 }
 return true;
}

template <typename WidgetType>
void BaseWidgetFactory<WidgetType>::DeviceRemoved(WidgetObserver *observer,
 libusb_device *usb_device) {
 WidgetType *widget = STLLookupAndRemovePtr(&m_widget_map, usb_device);
 if (widget) {
 observer->WidgetRemoved(widget);
 delete widget;
 }
}
} // namespace usbdmx
} // namespace plugin
} // namespace ola
#endif // PLUGINS_USBDMX_WIDGETFACTORY_H_