/****************************************************************************
**
** https://www.qxorm.com/
** Copyright (C) 2013 XDL Team (ic-east.com)
**
** This file is part of the QxOrm library
**
** This software is provided 'as-is', without any express or implied
** warranty. In no event will the authors be held liable for any
** damages arising from the use of this software
**
** Commercial Usage
** Licensees holding valid commercial QxOrm licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and XDL Team
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file 'license.gpl3.txt' included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met : http://www.gnu.org/copyleft/gpl.html
**
** If you are unsure which license is appropriate for your use, or
** if you have questions regarding the use of this file, please contact :
** ic-east.com
**
****************************************************************************/

#ifndef _QX_PROPERTY_BAG_H_
#define _QX_PROPERTY_BAG_H_

#ifdef _MSC_VER
#pragma once
#endif

/*!
 * \file QxPropertyBag.h
 * \author XDL Team
 * \ingroup QxCommon
 * \brief Used by introspection engine (IxClass, IxDataMember, IxFunction, etc.) to add meta-data (property bag)
 */

#include <QtCore/qhash.h>
#include <QtCore/qstring.h>
#include <QtCore/qvariant.h>

namespace qx
{

   /*!
    * \ingroup QxCommon
    * \brief qx::QxPropertyBag : used by introspection engine (IxClass, IxDataMember, IxFunction, etc.) to add meta-data (property bag)
    */
   class QxPropertyBag
   {

   protected:
      typedef QHash<QString, QVariant> type_hash_prop_bag;
      typedef std::shared_ptr<type_hash_prop_bag> type_hash_prop_bag_ptr;

      type_hash_prop_bag_ptr m_lstPropertyBag; //!< List of all properties in the bag (meta-data)

   public:
      QxPropertyBag() { ; }
      virtual ~QxPropertyBag() { ; }

      void setPropertyBag(const QString &key, const QVariant &value)
      {
         initPropertyBag();
         m_lstPropertyBag->insert(key, value);
      }
      QVariant getPropertyBag(const QString &key) const { return ((m_lstPropertyBag && m_lstPropertyBag->contains(key)) ? m_lstPropertyBag->value(key) : QVariant()); }
      void removePropertyBag(const QString &key)
      {
         if (m_lstPropertyBag)
         {
            m_lstPropertyBag->remove(key);
         }
      }
      void clearPropertyBag()
      {
         if (m_lstPropertyBag)
         {
            m_lstPropertyBag->clear();
         }
      }
      long countPropertyBag() const { return (m_lstPropertyBag ? m_lstPropertyBag->count() : 0); }
      QList<QString> getAllPropertyBagKeys() const { return (m_lstPropertyBag ? m_lstPropertyBag->keys() : QList<QString>()); }

   private:
      inline void initPropertyBag()
      {
         if (!m_lstPropertyBag)
         {
            m_lstPropertyBag = std::make_shared<type_hash_prop_bag>();
         }
      }
   };

} // namespace qx

#endif // _QX_PROPERTY_BAG_H_