QxCollection.h

Go to the documentation of this file.

/****************************************************************************
**
** https://www.qxorm.com/
** Copyright (C) 2013 Lionel Marty (contact@qxorm.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 Lionel Marty
**
** 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 :
** contact@qxorm.com
**
****************************************************************************/

#ifndef _QX_COLLECTION_H_
#define _QX_COLLECTION_H_

#ifdef _MSC_VER
#pragma once
#endif

#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable:4996)
#pragma warning(disable:4503)
#endif // _MSC_VER

#include <QtCore/qmutex.h>

#include <QxCollection/IxCollection.h>
#include <QxCollection/QxForeach.h>

#include <QxCommon/QxHashValue.h>

#include <QxTraits/get_class_name.h>
#include <QxTraits/is_smart_ptr.h>

namespace qx {

template <typename Key, typename Value>
class QxCollection : public IxCollection
{

public:

   typedef QPair<Key, Value> type_pair_key_value;

protected:

   typedef QList<type_pair_key_value> type_list_pair_key_value;
   typedef QHash<Key, long> type_hash_position;

public:

   typedef typename type_list_pair_key_value::iterator iterator;
   typedef typename type_list_pair_key_value::const_iterator const_iterator;

#if (QT_VERSION >= QT_VERSION_CHECK(5, 6, 0))
   typedef typename type_list_pair_key_value::reverse_iterator reverse_iterator;
   typedef typename type_list_pair_key_value::const_reverse_iterator const_reverse_iterator;
#endif // (QT_VERSION >= QT_VERSION_CHECK(5, 6, 0))

   typedef const Key & const_reference_key;
   typedef const Value & const_reference_value;

protected:

   mutable QMutex m_mutex;             
   type_list_pair_key_value m_list;    
   type_hash_position m_hash;          
   bool m_batch;                       

public:

   QxCollection();                                          
   QxCollection(const QxCollection<Key, Value> & other);    
   virtual ~QxCollection();                                 

   QxCollection<Key, Value> & operator= (const QxCollection<Key, Value> & other);   
   bool operator== (const QxCollection<Key, Value> & other) const;                  
   bool operator!= (const QxCollection<Key, Value> & other) const;                  

   iterator begin();                  
   iterator end();                    
   const_iterator begin() const;      
   const_iterator end() const;        

#if (QT_VERSION >= QT_VERSION_CHECK(5, 6, 0))
   reverse_iterator rbegin();               
   reverse_iterator rend();                 
   const_reverse_iterator rbegin() const;   
   const_reverse_iterator rend() const;     
#endif // (QT_VERSION >= QT_VERSION_CHECK(5, 6, 0))

   void reserve(long size);                 
   void reverse();                          
   void clear();                            
   long count() const;                      
   long size() const;                       
   bool contains(const Key & key) const;    
   bool exist(const Key & key) const;       
   bool empty() const;                      

   bool push_back(const Key & key, const Value & value);               
   bool push_front(const Key & key, const Value & value);              
   bool insert(const Key & key, const Value & value);                  
   bool insert(long index, const Key & key, const Value & value);      
   bool insert(const QxCollection<Key, Value> & other);                
   bool insert(long index, const QxCollection<Key, Value> & other);    
   bool replace(long index, const Key & key, const Value & value);     
   bool swap(long index1, long index2);                                
   bool move(long indexFrom, long indexTo);                            

   bool removeByKey(const Key & key);             
   bool removeByIndex(long index);                
   bool removeByIndex(long first, long last);     
   bool removeFirst();                            
   bool removeLast();                             

   const_reference_value getByKey(const Key & key) const;     
   const_reference_value getByIndex(long index) const;        
   const_reference_value getFirst() const;                    
   const_reference_value getLast() const;                     
   const_reference_key getKeyByIndex(long index) const;       

   void sortByKey(bool bAscending = true);        
   void sortByValue(bool bAscending = true);      

   template <typename Compare>
   void sort(Compare comp) { { QMutexLocker locker(& m_mutex); std::sort(m_list.begin(), m_list.end(), comp); } updateHashPosition(); }

protected:

   void cloneCollection(QxCollection<Key, Value> * pClone, const QxCollection<Key, Value> & pRef);
   bool isSameCollection(const QxCollection<Key, Value> * p1, const QxCollection<Key, Value> & p2) const;
   void updateHashPosition(long from = 0, long to = -1, bool check = false);

   template <bool bIsPointer /* = false */, int dummy>
   struct compareKeyValue
   {
      static bool compareByKeyAscending(const type_pair_key_value & v1, const type_pair_key_value & v2)    { return (v1.first < v2.first); }
      static bool compareByKeyDescending(const type_pair_key_value & v1, const type_pair_key_value & v2)   { return (v1.first > v2.first); }
      static bool compareByValueAscending(const type_pair_key_value & v1, const type_pair_key_value & v2)  { return (v1.second < v2.second); }
      static bool compareByValueDescending(const type_pair_key_value & v1, const type_pair_key_value & v2) { return (v1.second > v2.second); }
   };

   template <int dummy>
   struct compareKeyValue<true, dummy>
   {
      static bool compareByKeyAscending(const type_pair_key_value & v1, const type_pair_key_value & v2)    { return ((v1.first && v2.first) ? ((* v1.first) < (* v2.first)) : false); }
      static bool compareByKeyDescending(const type_pair_key_value & v1, const type_pair_key_value & v2)   { return ((v1.first && v2.first) ? ((* v1.first) > (* v2.first)) : true); }
      static bool compareByValueAscending(const type_pair_key_value & v1, const type_pair_key_value & v2)  { return ((v1.second && v2.second) ? ((* v1.second) < (* v2.second)) : false); }
      static bool compareByValueDescending(const type_pair_key_value & v1, const type_pair_key_value & v2) { return ((v1.second && v2.second) ? ((* v1.second) > (* v2.second)) : true); }
   };

public:

   virtual long _count() const               { return this->count(); }
   virtual void _clear()                     { this->clear(); }
   virtual bool _remove(long index)          { return this->removeByIndex(index); }
   virtual qx::any _at(long index) const     { Value val = this->getByIndex(index); return qx::any(val); }

};

} // namespace qx

#include "../../inl/QxCollection/QxCollection.inl"

QX_REGISTER_CLASS_NAME_TEMPLATE_2(qx::QxCollection)

#ifdef _MSC_VER
#pragma warning(pop)
#endif // _MSC_VER

#endif // _QX_COLLECTION_H_