Added screenshot feature

[clinton/Virtual-Jaguar-Rx.git] / src / gui / filepicker.cpp

//
// filepicker.cpp - A ROM chooser
//
// by James Hammons
// (C) 2010 Underground Software
//
// JLH = James Hammons <jlhamm@acm.org>
// JPM = Jean-Paul Mari <djipi.mari@gmail.com>
//
// Who  When        What
// ---  ----------  -------------------------------------------------------------
// JLH  01/22/2010  Created this file
// JLH  02/06/2010  Modified to use Qt model/view framework
// JLH  03/08/2010  Added large cart view and info text
// JPM  06/16/2016  ELF format support
//

#include "filepicker.h"

#include "file.h"
#include "filedb.h"
#include "filelistmodel.h"
#include "filethread.h"
#include "imagedelegate.h"
#include "settings.h"
//#include "types.h"

/*
Our strategy here is like so:
Look at the files in the directory pointed to by ROMPath.
For each file in the directory, take the CRC32 of it and compare it to the CRC
in the romList[]. If there's a match, put it in a list and note it's index value
in romList for future reference.

When constructing the list, use the index to pull up an image of the cart and
put that in the list. User picks from a graphical image of the cart.

Ideally, the label will go into the archive along with the ROM image, but that's
for the future...
Maybe box art, screenshots will go as well...

I'm thinking compatibility info should be displayed as well... Just to stop the
inevitable stupid questions from people too lazy to do basic research for themselves.


Data strategy:

- Should keep a QImage of the blank cart with blank label
- Should keep a QImage of the blank cart? (For overpainting the ROMs label)
- Should we have a special Alpine image? Floppy image (for COF/ABS)?

- Need some way of keeping track of cart size and compatibility info
  [compat info needs to be BAD DUMP or % of what works]
- Need to properly scale the thumbnails images in the list
*/

//could use Window as well...
//FilePickerWindow::FilePickerWindow(QWidget * parent/*= 0*/): QWidget(parent, Qt::Dialog)
FilePickerWindow::FilePickerWindow(QWidget * parent/*= 0*/): QWidget(parent, Qt::Window),
	currentFile("")
{
	if (!vjs.softTypeDebugger)
	{
		setWindowTitle(tr("Insert Cartridge..."));
	}
	else
	{
		setWindowTitle(tr("Load executable file..."));
	}

//is there any reason why this must be cast as a QAbstractListModel? No
//Also, need to think about data structure for the model...
	model = new FileListModel;
	fileList = new QListView;
	fileList->setModel(model);
//	fileList->setItemDelegate(new ImageDelegate(this));
	fileList->setItemDelegate(new ImageDelegate());
#if 0
	//nope.
//	fileList->setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOn);
//	fileList->setSizePolicy(QSizePolicy::Fixed, QSizePolicy::Expanding);
//small problem with this is that it doesn't take scrollbar into account...
QSize sbSize = fileList->verticalScrollBar()->minimumSizeHint();
printf("VSB minimumSizeHint: %u, %u\n", sbSize.width(), sbSize.height());
QSize sbSize2 = fileList->verticalScrollBar()->sizeHint();
printf("VSB sizeHint: %u, %u\n", sbSize2.width(), sbSize2.height());
QRect sbRect = fileList->verticalScrollBar()->normalGeometry();
printf("VSB normalGeometry: %u, %u\n", sbRect.width(), sbRect.height());
QSize sbSize3 = fileList->verticalScrollBar()->size();
printf("VSB size: %u, %u\n", sbSize3.width(), sbSize3.height());
//	int sbWidth = fileList->verticalScrollBar()->width();
	int sbWidth = fileList->verticalScrollBar()->size().width();
	fileList->setFixedWidth((488/4) + 4 + sbWidth);//ick
#else
	// This sets it to the "too large size" as the minimum!
	QScrollBar * vsb = new QScrollBar(Qt::Vertical, this);
//	int sbWidth = vsb->size().width();
//	printf("VSB size width: %u\n", sbWidth);
	int sbWidth2 = vsb->sizeHint().width();
//	printf("VSB sizeHint width: %u\n", sbWidth2);
//	int sbWidth3 = vsb->minimumSize().width();
//	printf("VSB minimum width: %u\n", sbWidth3);
//	int sbWidth4 = vsb->frameSize().width();
//	printf("VSB frame width: %u\n", sbWidth4);
	delete vsb;

//	fileList->setFixedWidth((488/4) + 4);
	int sbWidth5 = fileList->frameWidth();
//	printf("List frame width: %u, (diff=%d)\n", sbWidth5, sbWidth5 - ((488/4) + 4));
//	int sbWidth6 = fileList->sizeHint().width();
//	printf("List sizeHint width: %u\n", sbWidth6);
//	int sbWidth7 = fileList->minimumSize().width();
//	printf("List minimum width: %u\n", sbWidth7);
//	int sbWidth8 = fileList->minimumSizeHint().width();
//	printf("List minimum hint width: %u\n", sbWidth8);
////	fileList->setSizePolicy(QSizePolicy::Minimum, QSizePolicy::Preferred);
////	fileList->verticalScrollBar()->setSizePolicy(QSizePolicy::Minimum, QSizePolicy::Preferred);
	// (488/4) + 4 is the width of the object in the filelistmodel. Dunno why the QListView
	// isn't picking that up. :-(
	// 488/4 + 4 = 126
	// 126 + 17 + 4 = 147 <-- correct width
	fileList->setFixedWidth((488/4) + 4 + sbWidth2 + sbWidth5 + 1);//ick
//	fileList->setFixedWidth((488/4) + 4 + 17 + 4);//sbWidth);//ick

//	fileList->setSpacing(4);
	fileList->setUniformItemSizes(true);
#endif

//	QVBoxLayout * layout = new QVBoxLayout;
	QHBoxLayout * layout = new QHBoxLayout;
	setLayout(layout);
	layout->addWidget(fileList);

	// Weird note: This layout has to be added *before* putting anything into it...
	QVBoxLayout * vLayout = new QVBoxLayout;
	layout->addLayout(vLayout);

	cartImage = new QLabel;
	QImage cartImg(":/res/cart-blank.png");
	QPainter painter(&cartImg);
	painter.drawPixmap(23, 87, QPixmap(":/res/label-blank.png"));
	painter.end();
	cartImage->setPixmap(QPixmap::fromImage(cartImg));
	cartImage->setMargin(4);
	vLayout->addWidget(cartImage);

	title = new QLabel(QString(tr("<h2>...</h2>")));
	title->setMargin(6);
	title->setAlignment(Qt::AlignCenter);
//no.
//title->setFixedWidth(cartImage->width());
//title->setSizePolicy(QSizePolicy::Minimum, QSizePolicy::Preferred);
//YESH!!!!
	title->setFixedWidth(cartImage->sizeHint().width());
	vLayout->addWidget(title);

	QHBoxLayout * dataLayout = new QHBoxLayout;
	vLayout->addLayout(dataLayout);

	QLabel * labels = new QLabel(QString(tr(
		"<b>Type: </b><br>"
		"<b>CRC32: </b><br>"
		"<b>Compatibility: </b><br>"
		"<b>Notes:</b>"
	)));
	labels->setAlignment(Qt::AlignRight);
	labels->setSizePolicy(QSizePolicy::Minimum, QSizePolicy::Preferred);
	dataLayout->addWidget(labels);
	data = new QLabel(QString(tr(
		"?MB Cartridge<br>"
		"00000000<br>"
		"?<br>"
		"?"
	)));
	data->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Preferred);
	dataLayout->addWidget(data);

//#warning "!!! Icon size for pushbutton is tiny !!!"
	insertCart = new QPushButton(this);
	insertCart->setIconSize(QSize(40, 40));
	insertCart->setIcon(QIcon(":/res/insert.png"));
	insertCart->setDefault(true);				// We want this button to be the default
	insertCart->setSizePolicy(QSizePolicy::Minimum, QSizePolicy::Preferred);
	dataLayout->addWidget(insertCart);

	fileThread = new FileThread(this);
//	connect(fileThread, SIGNAL(FoundAFile(unsigned long)), this, SLOT(AddFileToList(unsigned long)));
//	connect(fileThread, SIGNAL(FoundAFile2(unsigned long, QString, QImage *, unsigned long)), this, SLOT(AddFileToList2(unsigned long, QString, QImage *, unsigned long)));
	connect(fileThread, SIGNAL(FoundAFile3(unsigned long, QString, QImage *,
		unsigned long, bool, unsigned long, unsigned long)), this,
		SLOT(AddFileToList3(unsigned long, QString, QImage *, unsigned long,
		bool, unsigned long, unsigned long)));

// Let's defer this to the main window, so we can have some control over when this is done.
//	fileThread->Go();
/*
New sizes: 373x172 (label), 420x340 (cart)
*/

//	QItemSelectionModel * ism = fileList->selectionModel();
//	connect(ism, SIGNAL(currentChanged(const QModelIndex &, const QModelIndex &)), this, SLOT(UpdateSelection(const QModelIndex &, const QModelIndex &)));
	connect(fileList->selectionModel(), SIGNAL(currentChanged(const QModelIndex &, const QModelIndex &)), this, SLOT(UpdateSelection(const QModelIndex &, const QModelIndex &)));

	connect(insertCart, SIGNAL(clicked()), this, SLOT(LoadButtonPressed()));

	connect(fileList, SIGNAL(doubleClicked(const QModelIndex &)), this, SLOT(CatchDoubleClick(const QModelIndex &)));

//	connect(fileList, SIGNAL(doubleClicked()), this, SLOT(LoadButtonPressed()));
// This returns:
// Object::connect: No such signal QListView::QAbstractItemView::doubleClicked() in src/gui/filepicker.cpp:203
//can't do this, nothing's rendered yet...
//setFixedWidth(width());
}

void FilePickerWindow::keyPressEvent(QKeyEvent * e)
{
	if (e->key() == Qt::Key_Escape)
	{
		hide();
		emit(FilePickerHiding());
	}
	else if (e->key() == Qt::Key_Return)
		LoadButtonPressed();
}

void FilePickerWindow::CatchDoubleClick(const QModelIndex &)
{
	LoadButtonPressed();
}

QString FilePickerWindow::GetSelectedPrettyName(void)
{
	return prettyFilename;
}

void FilePickerWindow::ScanSoftwareFolder(bool allow/*= false*/)
{
	// "allow" is whether or not to allow scanning for unknown software.
	model->ClearData();
	fileThread->Go(allow);
}

//
// This slot gets called by the FileThread's run() function when it finds a
// match in the filesystem to a ROM on our CRC list.
//
void FilePickerWindow::AddFileToList(unsigned long index)
{
printf("FilePickerWindow: Found match [%s]...\n", romList[index].name);
	// NOTE: The model *ignores* what you send it, so this is crap. !!! FIX !!! [DONE, somewhat]
//	model->AddData(QIcon(":/res/generic.png"));
//	model->AddData(index);
}

void FilePickerWindow::AddFileToList2(unsigned long index, QString str, QImage * img, unsigned long size)
{
if (index != 0xFFFFFFFF)
	printf("FilePickerWindow(2): Found match [%s]...\n", romList[index].name);

	if (img)
	{
		model->AddData(index, str, *img, size);
//It would be better to pass the pointer into the model though...
		delete img;
	}
	else
		model->AddData(index, str, QImage(), size);
}

void FilePickerWindow::AddFileToList3(unsigned long index, QString str, QImage * img, unsigned long size, bool haveUniversalHeader, unsigned long fileType, unsigned long crc)
{
//if (index != 0xFFFFFFFF)
//	printf("FilePickerWindow(3): Found match [%s]...\n", romList[index].name);

	if (img)
	{
		model->AddData(index, str, *img, size, haveUniversalHeader, fileType, crc);
//It would be better to pass the pointer into the model though...
		delete img;
	}
	else
		model->AddData(index, str, QImage(), size, haveUniversalHeader, fileType, crc);
}

void FilePickerWindow::LoadButtonPressed(void)
{
	// TODO: Get the text of the current selection, call the MainWin slot for loading
	emit(RequestLoad(currentFile));
	hide();
}

//
// This slot gets called when the QListView gets clicked on. Updates
// the cart graphic and accompanying text.
//
void FilePickerWindow::UpdateSelection(const QModelIndex & current, const QModelIndex &/*previous*/)
{
#if 0
	QString s = current.model()->data(current, Qt::EditRole).toString();
	unsigned long i = current.model()->data(current, Qt::DisplayRole).toUInt();
	QImage label = current.model()->data(current, Qt::DecorationRole).value<QImage>();
//	printf("FPW: %s\n", s.toAscii().data());
	unsigned long fileSize = current.model()->data(current, Qt::WhatsThisRole).toUInt();
#else
//	QString s = current.model()->data(current, FLM_FILENAME).toString();
	currentFile = current.model()->data(current, FLM_FILENAME).toString();
	unsigned long i = current.model()->data(current, FLM_INDEX).toUInt();
	QImage label = current.model()->data(current, FLM_LABEL).value<QImage>();
	unsigned long fileSize = current.model()->data(current, FLM_FILESIZE).toUInt();
	bool haveUniversalHeader = current.model()->data(current, FLM_UNIVERSALHDR).toBool();
	unsigned long fileType = current.model()->data(current, FLM_FILETYPE).toUInt();
	uint32_t crc = (uint32_t)current.model()->data(current, FLM_CRC).toUInt();
//	printf("FPW: %s\n", s.toAscii().data());
	bool haveUnknown = (i == 0xFFFFFFFF ? true : false);
#endif

	// Disallow loading completely unknown files, but allow all others.
	insertCart->setEnabled(haveUnknown && (fileType == JST_NONE) ? false : true);
//hm.
//currentFile = s;

//373x172 is label size...
//365x168 now...
	if (!label.isNull())
	{
/*
	QImage cartImg(":/res/cart-blank.png");
	QPainter painter(&cartImg);
	painter.drawPixmap(23, 87, QPixmap(":/res/label-blank.png"));
	painter.end();
	cartSmall = cartImg.scaled(488/4, 395/4, Qt::IgnoreAspectRatio, Qt::SmoothTransformation);
*/
		QImage cart(":/res/cart-blank.png");
		QPainter painter(&cart);
//Though this should probably be done when this is loaded, instead of every time here...
//QImage scaledImg = label.scaled(373, 172, Qt::IgnoreAspectRatio, Qt::SmoothTransformation);
//painter.drawPixmap(23, 87, QPixmap::fromImage(scaledImg));
		// Now, looks like it is...
//		painter.drawPixmap(23, 87, QPixmap::fromImage(label));
		painter.drawPixmap(27, 89, QPixmap::fromImage(label));
//		painter.drawPixmap(23, 87, 373, 172, QPixmap::fromImage(label));

// Well, heck. This should be done to the label *before* we get here.
		painter.drawPixmap(27, 89, QPixmap::fromImage(QImage(":/res/upper-left.png")));
		painter.drawPixmap(27+355, 89, QPixmap::fromImage(QImage(":/res/upper-right.png")));

		painter.end();
		cartImage->setPixmap(QPixmap::fromImage(cart));
	}
	else
	{
		// We should try to be intelligent with our updates here, and only redraw when
		// we're going from a selection with a label to a selection without. Now, we
		// redraw regardless.
		QImage cart;

// We now have to sources of data for the passed in files:
// - The file DB
// - The file type detection
// This means we have to be mindful of what's passed back by that stuff.
// We can assume that if it wasn't found in the DB, then the fileType
// should be valid.
// The DB takes precedence over the fileType.
		if ((!haveUnknown && (romList[i].flags & FF_ROM))
			|| (haveUnknown && (fileType == JST_ROM) && !haveUniversalHeader))
		{
			cart = QImage(":/res/cart-blank.png");
			QPainter painter(&cart);
			painter.drawPixmap(27, 89, QPixmap::fromImage(QImage(":/res/label-blank.png")));
			painter.end();
		}
		else if ((!haveUnknown && (romList[i].flags & FF_ALPINE))
			|| (haveUnknown
				&& ((fileType == JST_ALPINE) || ((fileType == JST_ROM) && haveUniversalHeader))))
		{
			if (haveUniversalHeader)
				cart = QImage(":/res/skunkboard-file.png");
			else
				cart = QImage(":/res/alpine-file.png");
		}
		else if (haveUnknown && (fileType == JST_ELF32))
		{
			cart = QImage(":/res/ELF-file.png");
		}
		else if (haveUnknown && (fileType == JST_ABS_TYPE1 || fileType == JST_ABS_TYPE2
			|| fileType == JST_JAGSERVER) || fileType == JST_WTFOMGBBQ)
		{
			cart = QImage(":/res/homebrew-file.png");
		}
		else
			cart = QImage(":/res/unknown-file.png");

		cartImage->setPixmap(QPixmap::fromImage(cart));
	}

//1048576
//2097152
//4194304
	if (!haveUnknown)
		prettyFilename = romList[i].name;
	else
	{
		int lastSlashPos = currentFile.lastIndexOf('/');
		prettyFilename = "\"" + currentFile.mid(lastSlashPos + 1) + "\"";
	}

	// Ensure that the title isn't longer than the width of the dialog...
#if 1
	title->setText(QString("<h2>%1</h2>").arg(prettyFilename));
#else
	// This doesn't work...
	QFontMetrics metrics(title->font());
	QString elidedText = metrics.elidedText(QString("<h2>%1</h2>").arg(prettyFilename), Qt::ElideRight, title->sizeHint().width());
	title->setText(elidedText);
#endif

//Kludge for now, we'll have to fix this later...
// So let's fix it now!
	QString fileTypeString, crcString, notes, compatibility;

#if 0
	if (!haveUnknown)
	{
		if (romList[i].flags & FF_ROM)
			fileTypeString = QString(tr("%1MB Cartridge")).arg(fileSize / 1048576);
		else if (romList[i].flags & FF_ALPINE)
			fileTypeString = QString(tr("%1MB Alpine ROM")).arg(fileSize / 1048576);
		else
			fileTypeString = QString(tr("*** UNKNOWN *** (%1 bytes)")).arg(fileSize);
	}
#else
	if ((!haveUnknown && (romList[i].flags & FF_ROM))
		|| (haveUnknown && (fileType == JST_ROM) && !haveUniversalHeader))
		fileTypeString = QString(tr("%1MB Cartridge")).arg(fileSize / 1048576);
	else if ((!haveUnknown && (romList[i].flags & FF_ALPINE))
		|| (haveUnknown
				&& ((fileType == JST_ALPINE) || ((fileType == JST_ROM) && haveUniversalHeader))))
	{
		if (haveUniversalHeader)
			fileTypeString = QString(tr("%1MB Alpine ROM w/Universal Header"));
		else
			fileTypeString = QString(tr("%1MB Alpine ROM"));

		fileTypeString = fileTypeString.arg((fileSize + 8192) / 1048576);
	}
	else if (haveUnknown && (fileType == JST_ELF32))
		fileTypeString = QString(tr("ELF 32bits Executable (%1 bytes)")).arg(fileSize);
	else if (haveUnknown && (fileType == JST_ABS_TYPE1 || fileType == JST_ABS_TYPE2))
		fileTypeString = QString(tr("ABS/COF Executable (%1 bytes)")).arg(fileSize);
	else if (haveUnknown && (fileType == JST_JAGSERVER))
		fileTypeString = QString(tr("Jaguar Server Executable (%1 bytes)")).arg(fileSize);
	else
		fileTypeString = QString(tr("*** UNKNOWN *** (%1 bytes)")).arg(fileSize);
#endif

//	crcString = QString("%1").arg(romList[i].crc32, 8, 16, QChar('0')).toUpper();
	crcString = QString("%1").arg(crc, 8, 16, QChar('0')).toUpper();

	if (!haveUnknown && (romList[i].flags & FF_NON_WORKING))
		compatibility = "DOES NOT WORK";
	else
		compatibility = "Unknown";

	// This is going to need some formatting love before long...
	if (!haveUnknown && (romList[i].flags & FF_BAD_DUMP))
		notes = "<b>BAD DUMP</b>";

//	if (haveUniversalHeader)
//		notes += " Universal Header detected";

	if (!haveUnknown && (romList[i].flags & FF_REQ_BIOS))
		notes += " Requires BIOS";

	if (!haveUnknown && (romList[i].flags & FF_REQ_DSP))
		notes += " Requires DSP";

	if (!haveUnknown && (romList[i].flags & FF_VERIFIED))
		notes += " <i>(Verified)</i>";

	data->setText(QString("%1<br>%2<br>%3<br>%4")
		.arg(fileTypeString).arg(crcString).arg(compatibility).arg(notes));
}

/*
    Super Duper Awesome Guy (World)

         Type: 4MB Cartridge
        CRC32: FEDCBA98
Compatibility: DOES NOT WORK
        Notes: Universal Header detected; Requires DSP


    Stupid Homebrew Game That Sux

         Type: ABS/COF Executable (43853 bytes)
        CRC32: 76543210
Compatibility: Unknown
        Notes: $4000 Load, $4000 Run


    Action Hopscotch Plus (Prototype)

         Type: 2MB Alpine ROM
        CRC32: 44889921
Compatibility: 80% (or ****)
        Notes: EEPROM available
*/