kdgantt2/kdganttconstraint.cpp

   1 /****************************************************************************
   2  ** Copyright (C) 2001-2006 Klarälvdalens Datakonsult AB.  All rights reserved.
   3  **
   4  ** This file is part of the KD Gantt library.
   5  **
   6  ** This file may be distributed and/or modified under the terms of the
   7  ** GNU General Public License version 2 as published by the Free Software
   8  ** Foundation and appearing in the file LICENSE.GPL included in the
   9  ** packaging of this file.
  10  **
  11  ** Licensees holding valid commercial KD Gantt licenses may use this file in
  12  ** accordance with the KD Gantt Commercial License Agreement provided with
  13  ** the Software.
  14  **
  15  ** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  ** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  17  **
  18  ** See http://www.kdab.net/kdgantt for
  19  **   information about KD Gantt Commercial License Agreements.
  20  **
  21  ** Contact info@kdab.net if any conditions of this
  22  ** licensing are not clear to you.
  23  **
  24  **********************************************************************/
  25 #include "kdganttconstraint.h"
  26 #include "kdganttconstraint_p.h"
  27
  28 #include <QDateTime>
  29
  30 using namespace KDGantt;
  31
  32 /*!\class KDGantt::Constraint
  33  *\ingroup KDGantt
  34  * \brief A class used to represent a dependency.
  35  *
  36  * Instances of this class represent a dependency between the
  37  * data items pointed to by a start-QModelIndex and an
  38  * end-QModelIndex.
  39  */
  40
  41 /*!\enum KDGantt::Constraint::Type
  42  * This enum is unused for now.
  43  */
  44
  45 /*!\enum KDGantt::Constraint::ConstraintDataRole
  46  * Data roles used when specifying the pen to draw constraints with.
  47  * \sa setData
  48  */
  49
  50 Constraint::Private::Private()
  51     : type( TypeSoft )
  52 {
  53 }
  54
  55 Constraint::Private::Private( const Private& other )
  56     : QSharedData( other )
  57 {
  58     start=other.start;
  59     end=other.end;
  60     type=other.type;
  61 }
  62
  63 /*! Constructor. Creates a dependency for \a idx2 on \a idx1.
  64  * \param type controls if the constraint is a soft one that
  65  * is allowed to be broken (ie, go backwards in time) or a hard
  66  * constraint that will not allow the user to move an item so
  67  * that the constraint would have to go backwards. The default is
  68  * TypeSoft.
  69  *
  70  * Actually enforcing hard constraints is the responsibility of
  71  * the AbstractGrid subclass used in the view.
  72  */
  73 Constraint::Constraint( const QModelIndex& idx1,  const QModelIndex& idx2, Type type )
  74     : d( new Private )
  75 {
  76     d->start=idx1;
  77     d->end=idx2;
  78     d->type=type;
  79     Q_ASSERT_X( idx1 != idx2 || !idx1.isValid(), "Constraint::Constraint", "cannot create a constraint with idx1 == idx2" );
  80 }
  81
  82 /*! Copy-Constructor. */
  83 Constraint::Constraint( const Constraint& other )
  84     : d( other.d )
  85 {
  86 }
  87
  88 /*! Destructor */
  89 Constraint::~Constraint()
  90 {
  91 }
  92
  93 /*! Assignment operator. */
  94 Constraint& Constraint::operator=( const Constraint& other )
  95 {
  96     d = other.d;
  97     return *this;
  98 }
  99
 100 /*! This is unused for now. */
 101 Constraint::Type Constraint::type() const
 102 {
 103     return d->type;
 104 }
 105
 106 /*! \returns The dependency index */
 107 QModelIndex Constraint::startIndex() const
 108 {
 109     return d->start;
 110 }
 111
 112 /*! \returns The constrained index */
 113 QModelIndex Constraint::endIndex() const
 114 {
 115     return d->end;
 116 }
 117
 118 /*! \returns The data associated with this index for the specified role.
 119  * \param role The role to fetch the data for.
 120  * \sa ConstraintDataRole
 121  */
 122 QVariant Constraint::data( int role ) const
 123 {
 124     return d->data.value( role );
 125 }
 126
 127 /*! Set data on this index for the specified role.
 128  * \param role The role to set the data for.
 129  * \param value The data to set on the index.
 130  * \sa ConstraintDataRole
 131  */
 132 void Constraint::setData( int role, const QVariant& value )
 133 {
 134     d->data.insert( role, value );
 135 }
 136
 137 /*! Compare two Constraint objects. Two Constraints are equal
 138  * if the have the same start and end indexes
 139  */
 140 bool Constraint::operator==( const Constraint& other ) const
 141 {
 142     if ( d == other.d ) return true;
 143     return ( *d ).equals( *( other.d ) );
 144 }
 145
 146 /*!\internal*/
 147 uint Constraint::hash() const
 148 {
 149     return ::qHash( d->start ) ^ ::qHash( d->end ) ^ ::qHash( static_cast<uint>( d->type ) );
 150 }
 151
 152 #ifndef QT_NO_DEBUG_STREAM
 153
 154 QDebug operator<<( QDebug dbg, const Constraint& c )
 155 {
 156     return c.debug( dbg );
 157 }
 158
 159 QDebug Constraint::debug( QDebug dbg ) const
 160 {
 161     dbg << "KDGantt::Constraint[ start="<<d->start<<" end="<<d->end<<"]";
 162     return dbg;
 163 }
 164
 165 #endif /* QT_NO_DEBUG_STREAM */
 166
 167 #ifndef KDAB_NO_UNIT_TESTS
 168
 169 #include <QStandardItemModel>
 170
 171 #include "unittest/test.h"
 172
 173 KDAB_SCOPED_UNITTEST_SIMPLE( KDGantt, Constraint, "test" )
 174 {
 175     QStandardItemModel dummyModel( 100, 100 );
 176     QModelIndex idx1 = dummyModel.index( 7, 17, QModelIndex() );
 177     QModelIndex idx2 = dummyModel.index( 42, 17, QModelIndex() );
 178
 179     Constraint c1 = Constraint( QModelIndex(), QModelIndex(), Constraint::TypeSoft );
 180     Constraint c2 = Constraint( QModelIndex(), QModelIndex(), Constraint::TypeSoft );
 181     Constraint c3 = c2;
 182     Constraint c4( idx1, idx2 );
 183     Constraint c5( idx2, idx1 );
 184
 185     assertTrue( c1==c2 );
 186     assertEqual( qHash( c1 ), qHash( c2 ) );
 187     assertTrue( c1==c3 );
 188     assertEqual( qHash( c1 ), qHash( c3 ) );
 189     assertTrue( c2==c3 );
 190     assertEqual( qHash( c2 ), qHash( c3 ) );
 191
 192     assertFalse( c2==c4 );
 193     assertNotEqual( qHash( c2 ), qHash( c4 ) );
 194
 195     assertFalse( c4==c5 );
 196
 197     assertEqual( c3.type(), Constraint::TypeSoft );
 198
 199     dummyModel.removeRow( 8 );
 200     assertFalse( c4==c5 );
 201 }
 202
 203 #endif /* KDAB_NO_UNIT_TESTS */