2015-09-01 06:35:33 +02:00
// Copyright 2015 Citra Emulator Project
// Licensed under GPLv2 or any later version
// Refer to the license.txt file included.
# pragma once
2018-09-02 16:53:06 +02:00
# include <algorithm>
2018-08-11 00:12:26 +02:00
# include <array>
2018-08-21 02:36:36 +02:00
# include <map>
2018-09-02 16:53:06 +02:00
# include <string>
2018-08-29 15:42:53 +02:00
# include <unordered_map>
2018-08-06 19:36:05 +02:00
# include <utility>
2018-09-02 16:53:06 +02:00
2018-08-29 15:42:53 +02:00
# include <QCoreApplication>
2016-04-13 23:04:05 +02:00
# include <QImage>
2018-08-29 15:42:53 +02:00
# include <QObject>
2015-09-01 06:35:33 +02:00
# include <QStandardItem>
# include <QString>
2018-09-02 16:53:06 +02:00
# include "common/common_types.h"
2018-08-29 15:42:53 +02:00
# include "common/logging/log.h"
2016-09-18 02:38:01 +02:00
# include "common/string_util.h"
2018-08-31 18:21:34 +02:00
# include "yuzu/ui_settings.h"
2018-01-16 19:05:21 +01:00
# include "yuzu/util/util.h"
2016-04-13 23:04:05 +02:00
/**
* Gets the default icon ( for games without valid SMDH )
* @ param large If true , returns large icon ( 48 x48 ) , otherwise returns small icon ( 24 x24 )
* @ return QPixmap default icon
*/
2018-07-28 18:32:16 +02:00
static QPixmap GetDefaultIcon ( u32 size ) {
2016-04-13 23:04:05 +02:00
QPixmap icon ( size , size ) ;
icon . fill ( Qt : : transparent ) ;
return icon ;
}
2015-09-01 06:35:33 +02:00
class GameListItem : public QStandardItem {
public :
2018-08-06 18:58:46 +02:00
GameListItem ( ) = default ;
explicit GameListItem ( const QString & string ) : QStandardItem ( string ) { }
2015-09-01 06:35:33 +02:00
} ;
/**
* A specialization of GameListItem for path values .
* This class ensures that for every full path value it holds , a correct string representation
* of just the filename ( with no extension ) will be displayed to the user .
2016-10-20 16:26:59 +02:00
* If this class receives valid SMDH data , it will also display game icons and titles .
2015-09-01 06:35:33 +02:00
*/
class GameListItemPath : public GameListItem {
public :
static const int FullPathRole = Qt : : UserRole + 1 ;
2016-04-13 23:04:05 +02:00
static const int TitleRole = Qt : : UserRole + 2 ;
2016-12-15 10:55:03 +01:00
static const int ProgramIdRole = Qt : : UserRole + 3 ;
2018-07-28 18:32:16 +02:00
static const int FileTypeRole = Qt : : UserRole + 4 ;
2015-09-01 06:35:33 +02:00
2018-08-06 18:58:46 +02:00
GameListItemPath ( ) = default ;
2018-07-28 18:32:16 +02:00
GameListItemPath ( const QString & game_path , const std : : vector < u8 > & picture_data ,
2018-08-11 00:07:43 +02:00
const QString & game_name , const QString & game_type , u64 program_id ) {
2015-09-01 06:35:33 +02:00
setData ( game_path , FullPathRole ) ;
2018-07-28 18:32:16 +02:00
setData ( game_name , TitleRole ) ;
2016-12-15 10:55:03 +01:00
setData ( qulonglong ( program_id ) , ProgramIdRole ) ;
2018-07-28 18:32:16 +02:00
setData ( game_type , FileTypeRole ) ;
2018-08-11 00:15:06 +02:00
const u32 size = UISettings : : values . icon_size ;
2018-07-28 18:32:16 +02:00
QPixmap picture ;
2018-08-11 00:15:06 +02:00
if ( ! picture . loadFromData ( picture_data . data ( ) , static_cast < u32 > ( picture_data . size ( ) ) ) ) {
2018-07-28 18:32:16 +02:00
picture = GetDefaultIcon ( size ) ;
2018-08-11 00:15:06 +02:00
}
2018-07-28 18:32:16 +02:00
picture = picture . scaled ( size , size ) ;
setData ( picture , Qt : : DecorationRole ) ;
2015-09-01 06:35:33 +02:00
}
2016-04-13 23:04:05 +02:00
QVariant data ( int role ) const override {
if ( role = = Qt : : DisplayRole ) {
2015-09-01 06:35:33 +02:00
std : : string filename ;
2016-09-18 02:38:01 +02:00
Common : : SplitPath ( data ( FullPathRole ) . toString ( ) . toStdString ( ) , nullptr , & filename ,
nullptr ) ;
2018-07-28 18:32:16 +02:00
2018-08-11 00:12:26 +02:00
const std : : array < QString , 4 > row_data { {
2018-07-28 18:32:16 +02:00
QString : : fromStdString ( filename ) ,
data ( FileTypeRole ) . toString ( ) ,
QString : : fromStdString ( fmt : : format ( " 0x{:016X} " , data ( ProgramIdRole ) . toULongLong ( ) ) ) ,
data ( TitleRole ) . toString ( ) ,
2018-08-11 00:12:26 +02:00
} } ;
2018-07-28 18:32:16 +02:00
2018-08-11 00:12:26 +02:00
const auto & row1 = row_data . at ( UISettings : : values . row_1_text_id ) ;
const auto & row2 = row_data . at ( UISettings : : values . row_2_text_id ) ;
2018-07-28 18:32:16 +02:00
if ( row1 . isEmpty ( ) | | row1 = = row2 )
return row2 ;
if ( row2 . isEmpty ( ) )
return row1 ;
return row1 + " \n " + row2 ;
2015-09-01 06:35:33 +02:00
}
2018-08-11 00:12:26 +02:00
return GameListItem : : data ( role ) ;
2015-09-01 06:35:33 +02:00
}
} ;
2018-08-29 15:42:53 +02:00
class GameListItemCompat : public GameListItem {
Q_DECLARE_TR_FUNCTIONS ( GameListItemCompat )
public :
static const int CompatNumberRole = Qt : : UserRole + 1 ;
GameListItemCompat ( ) = default ;
explicit GameListItemCompat ( const QString & compatiblity ) {
struct CompatStatus {
QString color ;
const char * text ;
const char * tooltip ;
} ;
// clang-format off
static const std : : map < QString , CompatStatus > status_data = {
{ " 0 " , { " #5c93ed " , QT_TR_NOOP ( " Perfect " ) , QT_TR_NOOP ( " Game functions flawless with no audio or graphical glitches, all tested functionality works as intended without \n any workarounds needed. " ) } } ,
{ " 1 " , { " #47d35c " , QT_TR_NOOP ( " Great " ) , QT_TR_NOOP ( " Game functions with minor graphical or audio glitches and is playable from start to finish. May require some \n workarounds. " ) } } ,
{ " 2 " , { " #94b242 " , QT_TR_NOOP ( " Okay " ) , QT_TR_NOOP ( " Game functions with major graphical or audio glitches, but game is playable from start to finish with \n workarounds. " ) } } ,
{ " 3 " , { " #f2d624 " , QT_TR_NOOP ( " Bad " ) , QT_TR_NOOP ( " Game functions, but with major graphical or audio glitches. Unable to progress in specific areas due to glitches \n even with workarounds. " ) } } ,
{ " 4 " , { " #FF0000 " , QT_TR_NOOP ( " Intro/Menu " ) , QT_TR_NOOP ( " Game is completely unplayable due to major graphical or audio glitches. Unable to progress past the Start \n Screen. " ) } } ,
{ " 5 " , { " #828282 " , QT_TR_NOOP ( " Won't Boot " ) , QT_TR_NOOP ( " The game crashes when attempting to startup. " ) } } ,
{ " 99 " , { " #000000 " , QT_TR_NOOP ( " Not Tested " ) , QT_TR_NOOP ( " The game has not yet been tested. " ) } } } ;
// clang-format on
auto iterator = status_data . find ( compatiblity ) ;
if ( iterator = = status_data . end ( ) ) {
LOG_WARNING ( Frontend , " Invalid compatibility number {} " , compatiblity . toStdString ( ) ) ;
return ;
}
CompatStatus status = iterator - > second ;
setData ( compatiblity , CompatNumberRole ) ;
setText ( QObject : : tr ( status . text ) ) ;
setToolTip ( QObject : : tr ( status . tooltip ) ) ;
setData ( CreateCirclePixmapFromColor ( status . color ) , Qt : : DecorationRole ) ;
}
bool operator < ( const QStandardItem & other ) const override {
return data ( CompatNumberRole ) < other . data ( CompatNumberRole ) ;
}
} ;
2015-09-01 06:35:33 +02:00
/**
* A specialization of GameListItem for size values .
* This class ensures that for every numerical size value it holds ( in bytes ) , a correct
* human - readable string representation will be displayed to the user .
*/
class GameListItemSize : public GameListItem {
public :
static const int SizeRole = Qt : : UserRole + 1 ;
2018-08-06 18:58:46 +02:00
GameListItemSize ( ) = default ;
explicit GameListItemSize ( const qulonglong size_bytes ) {
2015-09-01 06:35:33 +02:00
setData ( size_bytes , SizeRole ) ;
}
2016-09-18 02:38:01 +02:00
void setData ( const QVariant & value , int role ) override {
2015-09-01 06:35:33 +02:00
// By specializing setData for SizeRole, we can ensure that the numerical and string
// representations of the data are always accurate and in the correct format.
if ( role = = SizeRole ) {
qulonglong size_bytes = value . toULongLong ( ) ;
GameListItem : : setData ( ReadableByteSize ( size_bytes ) , Qt : : DisplayRole ) ;
GameListItem : : setData ( value , SizeRole ) ;
} else {
GameListItem : : setData ( value , role ) ;
}
}
/**
* This operator is , in practice , only used by the TreeView sorting systems .
2016-09-18 02:38:01 +02:00
* Override it so that it will correctly sort by numerical value instead of by string
* representation .
2015-09-01 06:35:33 +02:00
*/
2016-09-18 02:38:01 +02:00
bool operator < ( const QStandardItem & other ) const override {
2015-09-01 06:35:33 +02:00
return data ( SizeRole ) . toULongLong ( ) < other . data ( SizeRole ) . toULongLong ( ) ;
}
} ;
2018-09-07 22:08:08 +02:00
inline auto FindMatchingCompatibilityEntry (
const std : : unordered_map < std : : string , std : : pair < QString , QString > > & compatibility_list ,
u64 program_id ) {
return std : : find_if (
compatibility_list . begin ( ) , compatibility_list . end ( ) ,
[ program_id ] ( const std : : pair < std : : string , std : : pair < QString , QString > > & element ) {
std : : string pid = fmt : : format ( " {:016X} " , program_id ) ;
return element . first = = pid ;
} ) ;
}