/***************************************************************************
         MemoryPlugin.h  -  setup of Kwave's memory management
                             -------------------
    begin                : Sun Aug 05 2001
    copyright            : (C) 2001 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 MEMORY_PLUGIN_H
#define MEMORY_PLUGIN_H

#include "config.h"
#include <QObject>
#include <QString>

#include "libkwave/Plugin.h"

class QStringlist;
namespace Kwave
{

    class PluginContext;

    /**
     * Setup plugin for Kwave's memory manager.
     */
    class MemoryPlugin: public Kwave::Plugin
    {
	Q_OBJECT

    public:

	/**
	 * Constructor
	 * @param parent reference to our plugin manager
	 * @param args argument list [unused]
	 */
	MemoryPlugin(QObject *parent, const QVariantList &args);

	/** Destructor */
        virtual ~MemoryPlugin() Q_DECL_OVERRIDE;

	/**
	 * Gets called when the plugin is first loaded.
	 */
        virtual void load(QStringList &params) Q_DECL_OVERRIDE;

	/** @see Kwave::Plugin::setup() */
        virtual QStringList *setup(QStringList &previous_params)
            Q_DECL_OVERRIDE;

    protected:

	/**
	 * Interpretes a given parameter list and sets up internal
	 * parameters accordingly.
	 * @param params reference to a QStringList with parameters
	 * @return 0 if ok, or an error code if failed
	 */
	int interpreteParameters(QStringList &params);

	/**
	 * Applies the current settings by passing them to
	 * Kwave's global MemoryManager
	 */
	void applySettings();

    private:

	/** If true, the physical memory is limited */
	bool m_physical_limited;

	/**
	 * Maximum amount of physical memory [MB]. Only of interest if
	 * m_physical_limited is set to true, otherwise reflects the
	 * user's last setting.
	 */
	unsigned int m_physical_limit;

	/** If true, virtual memory is enabled */
	bool m_virtual_enabled;

	/**
	 * If true, virtual memory is limited. Only of interest if
	 * m_virtual_enabled is set to true, otherwise reflects the
	 * user's last setting.
	 */
	bool m_virtual_limited;

	/**
	 * Maximum amount of virtual memory [MB]. Only of interest if
	 * m_virtual_enabled and m_virtual_limited are set to true, otherwise
	 * reflects the user's last setting.
	 */
	unsigned int m_virtual_limit;

	/** Directory for page files. Default = /tmp */
	QString m_virtual_directory;

	/**
	 * Maximum amount of memory [MB] available for undo/redo
	 */
	unsigned int m_undo_limit;

    };
}

#endif /* MEMORY_PLUGIN_H */

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