SelectionTracker.h

Go to the documentation of this file.

/***************************************************************************
     SelectionTracker.h  -  tracker for selection changes
                             -------------------
    begin                : Tue Feb 25 2014
    copyright            : (C) 2014 by Thomas Eschenbacher
    email                : Thomas.Eschenbacher@gmx.de
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef SELECTION_TRACKER_H
#define SELECTION_TRACKER_H

#include "config.h"

#include <QtGlobal>
#include <QList>
#include <QObject>
#include <QPointer>
#include <QUuid>

#include "libkwave/Sample.h"
#include "libkwave/SignalManager.h"
#include "libkwave/undo/UndoAction.h"
#include "libkwave/undo/UndoHandler.h"

namespace Kwave
{

    class Track;
    class UndoTransaction;

    class Q_DECL_EXPORT SelectionTracker: public QObject,
                                          private Kwave::UndoHandler
    {
        Q_OBJECT
    public:
        SelectionTracker(Kwave::SignalManager *signal,
                         sample_index_t offset,
                         sample_index_t length,
                         const QList<unsigned int> *tracks);

        virtual ~SelectionTracker() Q_DECL_OVERRIDE;

        QList<QUuid> allTracks();

        void selectRange(QList<QUuid> tracks,
                         sample_index_t offset, sample_index_t length);

        sample_index_t offset() const { return m_offset; }

        sample_index_t length() const { return m_length; }

        sample_index_t first() const { return m_offset; }

        sample_index_t last() const {
            return m_offset + ((m_length) ? (m_length - 1) : 0);
        }

    signals:

        void sigTrackInserted(const QUuid &uuid);

        void sigTrackDeleted(const QUuid &uuid);

        void sigOffsetChanged(sample_index_t offset);

        void sigLengthChanged(sample_index_t length);

        void sigInvalidated(const QUuid *track,
                            sample_index_t first,
                            sample_index_t last);

    private slots:

        void slotTrackInserted(unsigned int index, Kwave::Track *track);

        void slotTrackDeleted(unsigned int index, Kwave::Track *track);

        void slotSamplesInserted(unsigned int track, sample_index_t offset,
                                 sample_index_t length);

        void slotSamplesDeleted(unsigned int track, sample_index_t offset,
                                sample_index_t length);

        void slotSamplesModified(unsigned int track, sample_index_t offset,
                                 sample_index_t length);

    protected:

        virtual bool saveUndoData(Kwave::UndoTransaction &undo) Q_DECL_OVERRIDE;

    private:

        class Q_DECL_EXPORT Undo: public Kwave::UndoAction
        {
        public:

            explicit Undo(Kwave::SelectionTracker *selection);

            virtual ~Undo() Q_DECL_OVERRIDE;

            virtual QString description() Q_DECL_OVERRIDE;

            virtual qint64 undoSize() Q_DECL_OVERRIDE;

            virtual qint64 redoSize() Q_DECL_OVERRIDE;

            virtual bool store(Kwave::SignalManager &manager) Q_DECL_OVERRIDE;

            virtual Kwave::UndoAction *undo(Kwave::SignalManager &manager,
                                            bool with_redo) Q_DECL_OVERRIDE;

            virtual bool containsModification() const Q_DECL_OVERRIDE {
                return false;
            }

            virtual void dump(const QString &indent) Q_DECL_OVERRIDE {
                qDebug("%s%s", DBG(indent), DBG(description()));
            }

        private:

            QPointer<Kwave::SelectionTracker> m_tracker;

            QList<QUuid> m_tracks;

            sample_index_t m_offset;

            sample_index_t m_length;

        };

    private:

        QPointer<Kwave::SignalManager> m_signal;

        sample_index_t m_offset;

        sample_index_t m_length;

        QList<QUuid> m_tracks;

        bool m_selection_only;

        QMutex m_lock;
    };
}

#endif /* SELECTION_TRACKER_H */