lmms/include/ResourceItem.h

/*
 * ResourceItem.h - header file for ResourceItem
 *
 * Copyright (c) 2009 Tobias Doerffel <tobydox/at/users.sourceforge.net>
 *
 * This file is part of Linux MultiMedia Studio - http://lmms.sourceforge.net
 *
 * 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.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program (see COPYING); if not, write to the
 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301 USA.
 *
 */

#ifndef _RESOURCE_ITEM_H
#define _RESOURCE_ITEM_H

#include <QtCore/QByteArray>
#include <QtCore/QDateTime>

#include "ResourceProvider.h"

class ResourceTreeItem;


class ResourceItem
{
public:
	enum BaseDirectories
	{
		BaseRoot,
		BaseWorkingDir,
		BaseDataDir,
		BaseHome,
		BaseURL,
		NumBaseDirectories
	} ;
	typedef BaseDirectories BaseDirectory;

	enum Types
	{
		TypeUnknown,
		TypeDirectory,
		TypeSample,
		TypeSoundFont,
		TypePreset,
		TypePluginSpecificPreset,
		TypeProject,
		TypeMidiFile,
		TypeForeignProject,
		TypePlugin,
		TypeImage,
		NumTypes
	} ;
	typedef Types Type;

	ResourceItem( ResourceProvider * _provider,
			const QString & _name,
			Type _type,
			BaseDirectory _base_dir = BaseWorkingDir,
			const QString & _path = QString::null,
			const QString & _hash = QString::null,
			const QString & _tags = QString::null,
			int _size = -1,
			const QDateTime & _last_mod = QDateTime() );


	const ResourceProvider * provider( void ) const
	{
		return m_provider;
	}

	const QString & name( void ) const
	{
		return m_name;
	}

	inline int nameHash( void ) const
	{
		return m_nameHash;
	}

	Type type( void ) const
	{
		return m_type;
	}

	const QString & path( void ) const
	{
		return m_path;
	}

	BaseDirectory baseDir( void ) const
	{
		return m_baseDir;
	}

	QString fullPath( void ) const
	{
		return getBaseDirectory( m_baseDir, this ) + m_path;
	}

	QString fullName( void ) const
	{
		return fullPath() + name();
	}

	QString fullRelativeName( void ) const
	{
		return path() + name();
	}

	const QString & hash( void ) const
	{
		return m_hash;
	}

	int size( void ) const
	{
		return m_size;
	}

	bool isShippedResource( void ) const
	{
		return baseDir() == BaseDataDir;
	}

	bool isLocalResource( void ) const
	{
		return m_provider->isLocal();
	}

	const QString & tags( void ) const
	{
		return m_tags;
	}

	bool isValid( void ) const
	{
		return m_type != TypeUnknown && !m_name.isEmpty();
	}

	void setTreeItem( ResourceTreeItem * _ti )
	{
		m_treeItem = _ti;
	}

	ResourceTreeItem * treeItem( void )
	{
		return m_treeItem;
	}

	const ResourceTreeItem * treeItem( void ) const
	{
		return m_treeItem;
	}

	const QDateTime & lastMod( void ) const
	{
		return m_lastMod;
	}

	void setLastMod( const QDateTime & _date )
	{
		m_lastMod = _date;
	}

	int realSize( void ) const
	{
		return m_provider->dataSize( this );
	}

	QByteArray fetchData( int _maxSize = -1 ) const
	{
		return m_provider->fetchData( this );
	}

	void reload( void );

	bool operator==( const ResourceItem & _other ) const;

	// rates equality with given item
	int equalityLevel( const ResourceItem & _other ) const;

	Type guessType( void ) const;

	static QString getBaseDirectory( BaseDirectory _bd,
					const ResourceItem * _item = NULL );


private:
	void init( void );

	ResourceProvider * m_provider;
	QString m_name;
	int m_nameHash;
	Type m_type;
	BaseDirectory m_baseDir;
	QString m_path;
	QString m_hash;
	int m_size;
	QDateTime m_lastMod;
	QString m_tags;

	ResourceTreeItem * m_treeItem;

} ;


#endif