File indexing completed on 2024-05-12 16:01:52

 /*
  *  SPDX-FileCopyrightText: 2016 Dmitry Kazakov <dimula73@gmail.com>
  *
  *  SPDX-License-Identifier: GPL-2.0-or-later
  */
 
 #ifndef KISBASEOPTION_H
 #define KISBASEOPTION_H
 
 #include <kis_types.h>
 #include <kritaui_export.h>
 #include "kis_pointer_utils.h"
 
 class KoResource;
 using KoResourceSP = QSharedPointer<KoResource>;
 
 class KisResourcesInterface;
 using KisResourcesInterfaceSP = QSharedPointer<KisResourcesInterface>;
 
 class KoCanvasResourcesInterface;
 using KoCanvasResourcesInterfaceSP = QSharedPointer<KoCanvasResourcesInterface>;
 
 class KoResourceLoadResult;
 
 /**
  * This is a special base class for all the options that load/save
  * settings into a properties objects and do *not* store the properties
  * themselves. A KisPaintOpOption derived class generates a QWidget for
  * its configuration page. This cannot be created from a KisPaintO[
  *
  * This class adapts your option to allow its easy use with
  * both raw pointers and shared pointers.
  *
  * Motivation:
  * In quite a lot of places we call some options from the KisPaintOpSettings
  * class itself with patting 'this' as a parameter into
  * read/writeOptionSetting(). Conversion of 'this' into a shared pointer is
  * extremely dangerous, and, ideally, should be prohibited. We cannot prohibit
  * it atm, but we still can create a special interface for accepting raw pointers,
  * which will be used automatically, when 'this' is passed.
  */
 class KRITAUI_EXPORT KisPaintopPropertiesCanvasResourcesBase
 {
 public:
     virtual ~KisPaintopPropertiesCanvasResourcesBase();
 
     template <typename KisPropertiesConfigurationPointer>
     void readOptionSetting(KisPropertiesConfigurationPointer settings, KisResourcesInterfaceSP resourcesInterface, KoCanvasResourcesInterfaceSP canvasResourcesInterface)
     {
         readOptionSettingResourceImpl(removeSharedPointer(settings), resourcesInterface, canvasResourcesInterface);
     }
 
     template <typename KisPropertiesConfigurationPointer>
     void writeOptionSetting(KisPropertiesConfigurationPointer settings) const
     {
         writeOptionSettingImpl(removeSharedPointer(settings));
     }
 
     template <typename KisPropertiesConfigurationPointer>
     QList<KoResourceLoadResult> prepareLinkedResources(const KisPropertiesConfigurationPointer settings, KisResourcesInterfaceSP resourcesInterface) const
     {
         return prepareLinkedResourcesImpl(removeSharedPointer(settings), resourcesInterface);
     }
 
     template <typename KisPropertiesConfigurationPointer>
     QList<KoResourceLoadResult> prepareEmbeddedResources(const KisPropertiesConfigurationPointer settings, KisResourcesInterfaceSP resourcesInterface) const
     {
         return prepareEmbeddedResourcesImpl(removeSharedPointer(settings), resourcesInterface);
     }
 
 protected:
     virtual void readOptionSettingResourceImpl(const KisPropertiesConfiguration *settings, KisResourcesInterfaceSP resourcesInterface, KoCanvasResourcesInterfaceSP canvasResourcesInterface) = 0;
     virtual void writeOptionSettingImpl(KisPropertiesConfiguration *settings) const = 0;
     virtual QList<KoResourceLoadResult> prepareLinkedResourcesImpl(const KisPropertiesConfiguration *settings, KisResourcesInterfaceSP resourcesInterface) const = 0;
     virtual QList<KoResourceLoadResult> prepareEmbeddedResourcesImpl(const KisPropertiesConfiguration *settings, KisResourcesInterfaceSP resourcesInterface) const = 0;
 };
 
 class KRITAUI_EXPORT KisPaintopPropertiesResourcesBase
 {
 public:
     virtual ~KisPaintopPropertiesResourcesBase();
 
     template <typename KisPropertiesConfigurationPointer>
     void readOptionSetting(KisPropertiesConfigurationPointer settings, KisResourcesInterfaceSP resourcesInterface)
     {
         readOptionSettingResourceImpl(removeSharedPointer(settings), resourcesInterface);
     }
 
     template <typename KisPropertiesConfigurationPointer>
     void writeOptionSetting(KisPropertiesConfigurationPointer settings) const
     {
         writeOptionSettingImpl(removeSharedPointer(settings));
     }
 
     template <typename KisPropertiesConfigurationPointer>
     QList<KoResourceLoadResult> prepareLinkedResources(const KisPropertiesConfigurationPointer settings, KisResourcesInterfaceSP resourcesInterface) const
     {
         return prepareLinkedResourcesImpl(removeSharedPointer(settings), resourcesInterface);
     }
 
     template <typename KisPropertiesConfigurationPointer>
     QList<KoResourceLoadResult> prepareEmbeddedResources(const KisPropertiesConfigurationPointer settings, KisResourcesInterfaceSP resourcesInterface) const
     {
         return prepareEmbeddedResourcesImpl(removeSharedPointer(settings), resourcesInterface);
     }
 
 
 protected:
     virtual void readOptionSettingResourceImpl(const KisPropertiesConfiguration *settings, KisResourcesInterfaceSP resourcesInterface) = 0;
     virtual void writeOptionSettingImpl(KisPropertiesConfiguration *settings) const = 0;
     virtual QList<KoResourceLoadResult> prepareLinkedResourcesImpl(const KisPropertiesConfiguration *settings, KisResourcesInterfaceSP resourcesInterface) const = 0;
     virtual QList<KoResourceLoadResult> prepareEmbeddedResourcesImpl(const KisPropertiesConfiguration *settings, KisResourcesInterfaceSP resourcesInterface) const = 0;
 };
 
 class KRITAUI_EXPORT KisPaintopPropertiesBase /*: public KisPaintopPropertiesResourcesBase*/
 {
 public:
     virtual ~KisPaintopPropertiesBase();
 
     template <typename KisPropertiesConfigurationPointer>
     void readOptionSetting(KisPropertiesConfigurationPointer settings)
     {
         readOptionSettingImpl(removeSharedPointer(settings));
     }
 
     template <typename KisPropertiesConfigurationPointer>
     void writeOptionSetting(KisPropertiesConfigurationPointer settings) const
     {
         writeOptionSettingImpl(removeSharedPointer(settings));
 
     }
 
 protected:
     virtual void readOptionSettingImpl(const KisPropertiesConfiguration *settings) = 0;
     virtual void writeOptionSettingImpl(KisPropertiesConfiguration *settings) const = 0;
 };
 
 #endif // KISBASEOPTION_H