basedevice_p.h

Go to the documentation of this file.

/*******************************************************************************
  Copyright(c) 2011 Jasem Mutlaq. All rights reserved.
 
 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Library General Public
 License version 2 as published by the Free Software Foundation.
 
 This library 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 Library General Public License
 along with this library; see the file COPYING.LIB.  If not, write to
 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 Boston, MA 02110-1301, USA.
*******************************************************************************/
 
#pragma once
 
#include "indimacros.h"
#include "basedevice.h"
#include "lilxml.h"
#include "indibase.h"
 
#include <deque>
#include <string>
#include <mutex>
#include <map>
#include <functional>
 
#include "indipropertyblob.h"
#include "indililxml.h"
 
namespace INDI
{
 
class BaseDevice;
class BaseDevicePrivate
{
    public:
        BaseDevicePrivate();
        virtual ~BaseDevicePrivate();
 
        int setBLOB(INDI::PropertyBlob propertyBlob, const INDI::LilXmlElement &root, char *errmsg);
 
        void emitWatchProperty(const INDI::Property &property, bool isNew)
        {
            auto it = watchPropertyMap.find(property.getName());
            if (it != watchPropertyMap.end())
            {
                if (
                    (it->second.watch == BaseDevice::WATCH_NEW_OR_UPDATE) ||
                    (it->second.watch == BaseDevice::WATCH_NEW && isNew) ||
                    (it->second.watch == BaseDevice::WATCH_UPDATE && !isNew)
                )
                    it->second.callback(property);
            } 
        }
 
        void addProperty(const INDI::Property &property)
        {
            {
                std::unique_lock<std::mutex> lock(m_Lock);
                pAll.push_back(property);
            }
 
            emitWatchProperty(property, true);
        }
 
    public: // mediator
        void mediateNewDevice(BaseDevice baseDevice)
        {
            if (mediator)
            {
#if INDI_VERSION_MAJOR < 2
                mediator->newDevice(&self);
#endif
                mediator->newDevice(baseDevice);
            }
        }
 
        void mediateRemoveDevice(BaseDevice baseDevice)
        {
            if (mediator)
            {
#if INDI_VERSION_MAJOR < 2
                mediator->removeDevice(&self);
#endif
                mediator->removeDevice(baseDevice);
            }
        }
 
        void mediateNewProperty(Property property)
        {
            if (mediator)
            {
#if INDI_VERSION_MAJOR < 2
                mediator->newProperty(property.self());
#endif
                mediator->newProperty(property);
            }
        }
 
        void mediateUpdateProperty(Property property)
        {
            emitWatchProperty(property, false);
            if (mediator)
            {
                mediator->updateProperty(property);
#if INDI_VERSION_MAJOR < 2
                switch (property.getType())
                {
                    case INDI_NUMBER:
                        mediator->newNumber(property.getNumber()->cast());
                        break;
                    case INDI_SWITCH:
                        mediator->newSwitch(property.getSwitch()->cast());
                        break;
                    case INDI_TEXT:
                        mediator->newText(property.getText()->cast());
                        break;
                    case INDI_LIGHT:
                        mediator->newLight(property.getLight()->cast());
                        break;
                    case INDI_BLOB:
                        for (auto &it : PropertyBlob(property))
                        {
                            mediator->newBLOB(it.cast());
                        }
                        break;
                    case INDI_UNKNOWN:
                        ;
                }
#endif
            }
        }
 
        void mediateRemoveProperty(Property property)
        {
            if (mediator)
            {
#if INDI_VERSION_MAJOR < 2
                mediator->removeProperty(property.self());
#endif
                mediator->removeProperty(property);
            }
        }
 
        void mediateNewMessage(BaseDevice baseDevice, int messageID)
        {
            if (mediator)
            {
#if INDI_VERSION_MAJOR < 2
                mediator->newMessage(&self, messageID);
#endif
                mediator->newMessage(baseDevice, messageID);
            }
        }
    public:
        static std::shared_ptr<BaseDevicePrivate> invalid()
        {
            static struct Invalid : public BaseDevicePrivate
            {
                Invalid() { valid = false; }
            } invalid;
            return make_shared_weak(&invalid);
        }
 
    public:
        struct WatchDetails
        {
            std::function<void(INDI::Property)> callback;
            BaseDevice::WATCH watch {BaseDevice::WATCH_NEW};
        };
 
    public:
        BaseDevice self {make_shared_weak(this)}; // backward compatible (for operators as pointer)
        std::string deviceName;
        BaseDevice::Properties pAll;
        std::map<std::string, WatchDetails> watchPropertyMap;
        LilXmlParser xmlParser;
 
        INDI::BaseMediator *mediator {nullptr};
        std::deque<std::string> messageLog;
        mutable std::mutex m_Lock;
 
        bool valid {true};
};
 
}