FileContext.h

Go to the documentation of this file.

/***************************************************************************
    kwave/FileContext.h  -  Context of a Loaded File
                             -------------------
    begin                : 2009-12-31
    copyright            : (C) 2009 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 KWAVE_FILE_CONTEXT_H
#define KWAVE_FILE_CONTEXT_H

#include "config.h"

#include <QtGlobal>
#include <QAtomicInt>
#include <QElapsedTimer>
#include <QList>
#include <QObject>
#include <QPointer>
#include <QString>
#include <QTimer>
#include <QUrl>

#include "libkwave/MetaDataList.h"
#include "libkwave/Sample.h"

class QApplication;
class QMdiSubWindow;
class QSize;
class QTextStream;
class QWidget;

class QUrl;

namespace Kwave
{

    class App;
    class MainWidget;
    class Parser;
    class PluginManager;
    class SignalManager;
    class TopWidget;
    class Zoomable;

    class Q_DECL_EXPORT FileContext: public QObject
    {
        Q_OBJECT
    public:
        explicit FileContext(Kwave::App &app);

        virtual ~FileContext();

        bool init(Kwave::TopWidget *top_widget);

        bool createMainWidget(const QSize &preferred_size);

        void setParent(Kwave::TopWidget *top_widget);

        Kwave::App           &app() const { return m_application; }

        QWidget              *mainWidget() const;

        Kwave::SignalManager *signalManager() const;

        Kwave::PluginManager *pluginManager() const;

        Kwave::Zoomable *zoomable() const;

        inline bool isEmpty() const { return m_main_widget.isNull(); }

        inline bool isActive() const { return m_active; }

        bool isInUse() const;

        QString signalName() const;

        inline int instanceNr() const { return m_instance_nr; }

        QString windowCaption(bool with_modified) const;

        int loadBatch(const QUrl &url);

        int saveFile();

        int saveFileAs(const QString &filename, bool selection = false);

        bool closeFile();

    protected:
        friend class App;
        friend class TopWidget;
        friend class UsageGuard;

        void use();

        void release();

    signals:

        void sigStatusBarMessage(const QString &message, unsigned int ms);

        void sigZoomChanged(Kwave::FileContext *context, double zoom);

        void sigMetaDataChanged(Kwave::MetaDataList meta_data);

        void sigSelectionChanged(sample_index_t offset, sample_index_t length);

        void sigUndoRedoInfo(const QString &undo, const QString &redo);

        void sigVisibleRangeChanged(sample_index_t offset,
                                    sample_index_t visible,
                                    sample_index_t total);

        void sigModified();

        void destroyed(Kwave::FileContext *context);

    public slots:

        int executeCommand(const QString &command);

    private slots:

        void contextSwitched(Kwave::FileContext *context);

        void forwardZoomChanged(double zoom);

        void updatePlaybackPos(sample_index_t offset);

        void metaDataChanged(Kwave::MetaDataList meta_data);

        void selectionChanged(sample_index_t offset, sample_index_t length);

        void setUndoRedoInfo(const QString &undo, const QString &redo);

        void visibleRangeChanged(sample_index_t offset,
                                 sample_index_t visible,
                                 sample_index_t total);

        void modifiedChanged();

        void processDelayedCommand();

    private:

        class UsageGuard
        {
        public:
            explicit UsageGuard(Kwave::FileContext *context)
                :m_context(context)
            {
                if (m_context) m_context->use();
            }

            virtual ~UsageGuard()
            {
                if (m_context) m_context->release();
                m_context = Q_NULLPTR;
            }

        private:
            QPointer<Kwave::FileContext> m_context;
        };

    private:

        void activated();

        void statusBarMessage(const QString &msg, unsigned int ms);

        int parseCommands(QTextStream &stream);

        void enqueueCommand(unsigned int delay, const QString &command);

        int revert();

        int delegateCommand(const char *plugin,
                            Kwave::Parser &parser,
                            unsigned int param_count);

    private:

        QAtomicInt m_use_count;

        Kwave::App &m_application;

        QPointer<Kwave::TopWidget> m_top_widget;

        QPointer<Kwave::MainWidget> m_main_widget;

        QPointer<Kwave::SignalManager> m_signal_manager;

        QPointer<Kwave::PluginManager> m_plugin_manager;

        bool m_active;

        double m_last_zoom;

        sample_index_t m_last_playback_pos;

        QString m_last_status_message_text;

        QElapsedTimer m_last_status_message_timer;

        unsigned int m_last_status_message_ms;

        QString m_last_undo;

        QString m_last_redo;

        int m_instance_nr;

        QTimer m_delayed_command_timer;

        QList< QPair<unsigned int, QString> > m_delayed_command_queue;

    };

}

#endif /* KWAVE_FILE_CONTEXT_H */

//***************************************************************************
//***************************************************************************