FF7Save.h

Go to the documentation of this file.

//    SPDX-FileCopyrightText: 2012 - 2023 Chris Rizzitello <sithlord48@gmail.com>
//    SPDX-License-Identifier: LGPL-3.0-or-later
 
#pragma once
 
#include <QObject>
#include <cstdlib>
#include <ff7tkdata_export.h>
#include <FF7SaveInfo>
#include <FF7Save_Types>
 
class QColor;
class QDateTime;
class QFile;
class QFileInfo;
class QDomDocument;
class QTextCodec;
 
class FF7TKDATA_EXPORT FF7Save: public QObject
{
    Q_OBJECT
public:
    //Enums
    enum WORLDVEHICLE {WVEHCILE_BUGGY = 0, WVEHCILE_TBRONCO = 2, WVEHCILE_HIGHWIND = 4};
    enum WORLDCHOCOBO {WCHOCO_WILD = 0, WCHOCO_YELLOW = 2, WCHOCO_GREEN = 3, WCHOCO_BLUE = 4, WCHOCO_BLACK = 5, WCHOCO_GOLD = 6};
    enum LOVER {LOVE_BARRET, LOVE_TIFA, LOVE_AERIS, LOVE_YUFFIE};
    enum MATERIACAVE {CAVE_MIME, CAVE_HPMP, CAVE_QUADMAGIC, CAVE_KOTR};
    enum SOUNDMODE {SOUND_MONO, SOUND_STEREO};
    enum CONTROLMODE {CONTROL_NORMAL, CONTROL_CUSTOM};
    enum CURSORMODE {CURSOR_INITIAL, CURSOR_MEMORY};
    enum ATBMODE {ATB_ACTIVE, ATB_RECOMMENED, ATB_WAIT};
    enum CAMERAMODE {CAMERA_AUTO, CAMERA_FIXED};
    enum MAGICORDER {MAGIC_RAI, MAGIC_RIA, MAGIC_AIR, MAGIC_ARI, MAGIC_IRA, MAGIC_IAR};
    enum MENUITEMS {MENUITEM, MENUMAGIC, MENUMATERIA, MENUEQUIPMENT, MENUSTATUS, MENUFORM, MENULIMIT, MENUCONFIG, MENUPHS, MENUSAVE};
    enum CONTROLACTION {
        ACTION_CAMERA, ACTION_TARGET, ACTION_PAGEUP, ACTION_PAGEDOWN,
        ACTION_MENU, ACTION_OK, ACTION_CANCEL, ACTION_SWITCH,
        ACTION_HELP, ACTION_UNKNOWN1, ACTION_UNKNOWN2,
        ACTION_PAUSE, ACTION_UP, ACTION_RIGHT, ACTION_DOWN, ACTION_LEFT 
    };
 
    enum PSXBUTTON {
        BTN_L2, BTN_R2, BTN_L1, BTN_R1,
        BTN_TRIANGLE, BTN_CIRCLE, BTN_X, BTN_SQUARE,
        BTN_SELECT, BTN_UNKNOWN1, BTN_UNKNOWN2, BTN_START,
        BTN_UP, BTN_RIGHT, BTN_DOWN, BTN_LEFT 
    };
    enum KEYITEMS {
        COTTONDRESS, SATINDRESS, SILKDRESS, WIG, DYEDWIG, BLONDEWIG, GLASSTIARA, RUBYTIATA, DIAMONDTIARA, COLOGNE, FLOWERCOLOGNE, SEXYCOLOGNE, MEMBERSCARD,
        LINGERIE, MYSTERYPANTIES, BIKINIBRIEFS, PHARMACYCOUPON, DISINFECTANT, DEODORANT, DIGESTIVE, HUGEMATERIA_CONDOR, HUGEMATERIA_COREL, HUGEMATERIA_UNDERWATER,
        HUGEMATERIA_ROCKET, KEYTOANCIENTS, LETTERTOADAUGHTER, LETTERTOAWIFE, LUNARHARP, BASEMENTKEY, KEYTOSECTOR5, KEYCARD60, KEYCARD62, KEYCARD65, KEYCARD66,
        KEYCARD68, MIDGARPARTS1, MIDGARPARTS2, MIDGARPARTS3, MIDGARPARTS4, MIDGARPARTS5, PHS, GOLDTICKET, KEYSTONE, LEIATHANSCALES, GLACIERMAP, COUPON_A, COUPON_B,
        COUPON_C, BLACKMATERIA, MYTHRIL, SNOWBOARD 
    };
    //Functions
    explicit FF7Save(); 
    //File Members
 
    FF7SaveInfo::FORMAT fileDataFormat(QFile &file);
 
    bool loadFile(const QString &fileName);
 
    bool saveFile(const QString &fileName, int s = 0);
 
    bool exportFile(const QString &fileName, FF7SaveInfo::FORMAT exportFormat, int s = 0);
 
    void importSlot(int s = 0, QString fileName = "", int fileSlot = 0);
 
    void clearSlot(int s);
 
    void copySlot(int s);
 
    void pasteSlot(int s);
 
    void newGame(int s, const QString &region = QStringLiteral("NTSC-U"), const QString &fileName = QString()); //new game in slot s (over load default w/ fileName must be RAW PSX)
 
    void newGamePlus(int s, QString CharFileName, QString fileName = ""); //new game + in slot s (over load default w/ fileName must be RAW PSX
 
    bool exportCharacter(int s, int char_num, QString fileName); // Write slot[s].char[char_num] to fileName
 
    void importCharacter(int s, int char_num, QByteArray new_char); //import new_char to slot[s].char[char_num]
 
    typedef QVector< QString > SubContainer;
 
    bool fixMetaData(QString fileName = "", QString UserID = "");
 
    QByteArray generatePsSaveSignature(QByteArray data, QByteArray keySeed);
 
    QByteArray fileHeader(void);
    bool setFileHeader(QByteArray data);
 
    QByteArray slotHeader(int s); 
    bool setSlotHeader(int s, QByteArray data);
 
    QByteArray slotFooter(int s);
    bool setSlotFooter(int s, QByteArray data);
 
    QByteArray slotPsxRawData(int s);
    bool setSlotPsxRawData(int s, QByteArray data);
 
    QByteArray slotFF7Data(int s); 
    bool setSlotFF7Data(int s, QByteArray data);
    bool setSlotFF7Data(int s, const FF7SLOT &data);
 
    QList<QByteArray> slotIcon(int s); 
    QList<qint8> chocoboPens(int s);
 
    void setChocoboPen(int s, int pen, qint8 value);
 
    quint8 condorWins(int s);
 
    void setCondorWins(int s, quint8 wins);
 
    quint8 condorLosses(int s);
 
    void setCondorLosses(int s, quint8 losses);
 
    quint16 condorFunds(int s);
 
    void setCondorFunds(int s, quint16 value);
    //Field Location
 
    quint16 locationId(int s);
 
    void setLocationId(int s, quint16 locationID);
 
    quint16 mapId(int s);
 
    void setMapId(int s, quint16 mapID);
 
    qint16 locationX(int s);
 
    void setLocationX(int s, qint16 x);
 
    qint16 locationY(int s);
 
    void setLocationY(int s, qint16 y);
 
    quint16 locationT(int s);
 
    void setLocationT(int s, quint16 t);
 
    quint8 locationD(int s);
 
    void setLocationD(int s, quint8 d);
 
    quint16 craterSavePointMapID(int s);
 
    qint16 craterSavePointX(int s);
 
    qint16 craterSavePointY(int s);
 
    qint16 craterSavePointZ(int s);
 
    void setCraterSavePointMapID(int s, int value);
 
    void setCraterSavePointX(int s, int value);
 
    void setCraterSavePointY(int s, int value);
 
    void setCraterSavePointZ(int s, int value);
 
    //options
    QByteArray controllerMapping(int s);
 
    void setControllerMapping(int s, QByteArray map);
 
    quint8 controllerMapping(int s, int action);
 
    void setControllerMapping(int s, int action, int button);
 
    quint16 options(int s);
 
    void setOptions(int s, int opt);
 
    bool soundMode(int s);
 
    void setSoundMode(int s, int mode);
 
    void setSoundMode(int s, bool mode);
    bool controlMode(int s);
    void setControlMode(int s, int mode);
    void setControlMode(int s, bool mode);
    bool cursorMode(int s);
    void setCursorMode(int s, int mode);
    void setCursorMode(int s, bool mode);
    int atbMode(int s);
    void setAtbMode(int s, int mode);
    bool cameraMode(int s);
    void setCameraMode(int s, int mode);
    void setCameraMode(int s, bool mode);
    int magicOrder(int s);
    void setMagicOrder(int s, int order);
    bool battleHelp(int s);
    void setBattleHelp(int s, bool shown);
    int battleSpeed(int s);
    void setBattleSpeed(int s, int speed);
    int battleMessageSpeed(int s);
    void setBattleMessageSpeed(int s, int speed);
    int messageSpeed(int s);
    void setMessageSpeed(int s, int speed);
    bool fieldHelp(int s);
    void setFieldHelp(int s, bool shown);
    bool battleTargets(int s);
    void setBattleTargets(int s, bool shown);
 
    quint8 specialBattleWins(int s);
    void setSpecialBattleWins(int s, int wins);
 
    //Phs/Menu
    bool phsVisible(int s, int who);
    void setPhsVisible(int s, int who, bool checked);
    quint16 phsVisible(int s);
    void setPhsVisible(int s, quint16 phs_visible);
    bool phsAllowed(int s, int who);
    quint16 phsAllowed(int s);
    void setPhsAllowed(int s, int who, bool checked);
    void setPhsAllowed(int s, quint16 phs_visible);
    bool menuVisible(int s, int index);
    void setMenuVisible(int s, int index, bool checked);
    quint16 menuVisible(int s);
    void setMenuVisible(int s, quint16 menu_visible);
    bool menuLocked(int s, int index);
    void setMenuLocked(int s, int index, bool checked);
    quint16 menuLocked(int s);
    void setMenuLocked(int s, quint16 menu_visible);
    //item info
    quint16 item(int s, int item_num); //return raw ff7item
    QList<quint16> items(int s);// return all items
    void setItems(int s, QList<quint16> items);
    void setItem(int s, int item_num, quint16 rawitem);
    void setItem(int s, int item_num, quint16 new_id, quint8 new_qty);
    //materia get/set
    bool materiaCave(int s, MATERIACAVE cave);
    void setMateriaCave(int s, MATERIACAVE cave, bool isEmpty);
    quint8 partyMateriaId(int s, int mat_num);
    qint32 partyMateriaAp(int s, int mat_num);
    quint8 stolenMateriaId(int s, int mat_num);
    qint32 stolenMateriaAp(int s, int mat_num);
    void setPartyMateria(int s, int mat_num, quint8 id, qint32 ap);
    void setStolenMateria(int s, int mat_num, quint8 id, qint32 ap);
    //Description Stuff.
    quint32 descTime(int s);
    void setDescTime(int s, quint32 new_time);
    QString descName(int s);//return the name in the description
    void setDescName(int s, QString new_name); // desc name = new_name
    QString descLocation(int s);//return the location string used in the description
    void setDescLocation(int s, QString new_desc_location);//write new desc location string called from setLocation
    quint8 descLevel(int s);
    void setDescLevel(int s, int new_level);
    quint8 descParty(int s, int char_num);
    void setDescParty(int s, int char_num, quint8 new_id);
    quint16 descCurHP(int s);
    void setDescCurHP(int s, quint16 new_curHP);
    quint16 descMaxHP(int s);
    void setDescMaxHP(int s, quint16 new_maxHP);
    quint16 descCurMP(int s);
    void setDescCurMP(int s, quint16 new_curMP);
    quint16 descMaxMP(int s);
    void setDescMaxMP(int s, quint16 new_maxMP);
    quint32 descGil(int s);
    void setDescGil(int s, quint32 new_gil);
    //Dialog Colors
    QColor dialogColorUL(int s);
    QColor dialogColorUR(int s);
    QColor dialogColorLL(int s);
    QColor dialogColorLR(int s);
    void setDialogColorUL(int s, QColor color);
    void setDialogColorUR(int s, QColor color);
    void setDialogColorLL(int s, QColor color);
    void setDialogColorLR(int s, QColor color);
    // String Functions.
    QString chocoName(int s, int choco_num); //return choco_num's name.
    void setChocoName(int s, int choco_num, QString new_name); //write choco_num 's new_name to slot s
    QString location(int s);// return save location string
    void setLocation(int s, QString new_location);//set save location string to new_location
    quint32 gil(int s);
    void setGil(int s, quint32 gil);
    quint16 gp(int s);
    void setGp(int s, int gp);
    quint16 battles(int s);
    void setBattles(int s, int battles);
    quint16 runs(int s);
    void setRuns(int s, int runs);
    quint8 party(int s, int pos);
    void setParty(int s, int pos, int new_id);
    qint8 chocoboPen(int s, int pos);
    void setChocoboPen(int s, int pos, int type);
    bool seenPandorasBox(int s);
    void setSeenPandorasBox(int s, bool seen);
    //Mini Game Stuff
    quint8 love(int s, bool battle, LOVER who);
    void setLove(int s, bool battle, LOVER who, quint8 love);
    quint16 speedScore(int s, int rank);
    void setSpeedScore(int s, int rank, quint16 score);
    quint16 bikeHighScore(int s);
    void setBikeHighScore(int s, quint16 score);
    QString snowboardTime(int s, int course);
    void setSnowboardTime(int s, int course, QString time);
    quint8 snowboardScore(int s, int course);
    void setSnowboardScore(int s, int course, quint8 score);
    quint32 countdownTimer(int s);
    void setCountdownTimer(int s, quint32 time);
    //Char Releated Functions
    FF7CHAR character(int s, int char_num); //Return Full Char
    quint8 charID(int s, int char_num); //Return Char ID
    quint8 charLevel(int s, int char_num); //Return Char Level
    quint8 charStr(int s, int char_num);
    quint8 charVit(int s, int char_num);
    quint8 charMag(int s, int char_num);
    quint8 charSpi(int s, int char_num);
    quint8 charDex(int s, int char_num);
    quint8 charLck(int s, int char_num);
    quint8 charStrBonus(int s, int char_num);
    quint8 charVitBonus(int s, int char_num);
    quint8 charMagBonus(int s, int char_num);
    quint8 charSpiBonus(int s, int char_num);
    quint8 charDexBonus(int s, int char_num);
    quint8 charLckBonus(int s, int char_num);
    qint8 charLimitLevel(int s, int char_num);
    quint8 charLimitBar(int s, int char_num);
    QString charName(int s, int char_num); //Return Char name
    quint8 charWeapon(int s, int char_num);
    quint8 charArmor(int s, int char_num);
    quint8 charAccessory(int s, int char_num);
    quint8 charFlag(int s, int char_num, int flag_num);
    quint16 charLimits(int s, int char_num); //Return Char ID
    quint16 charKills(int s, int char_num); //Return Char Level
    quint16 charTimesLimitUsed(int s, int char_num, int level);
    quint16 charCurrentHp(int s, int char_num);
    quint16 charBaseHp(int s, int char_num);
    quint16 charCurrentMp(int s, int char_num);
    quint16 charBaseMp(int s, int char_num);
    quint8 charUnknown(int s, int char_num, int unknown_num);
    quint16 charMaxHp(int s, int char_num);
    quint16 charMaxMp(int s, int char_num);
    quint32 charCurrentExp(int s, int char_num);
    quint32 charNextExp(int s, int char_num);
    quint8 charMateriaId(int s, int who, int mat_num);
    qint32 charMateriaAp(int s, int who, int mat_num);
    void setCharacter(int s, int char_num, const FF7CHAR &new_char);
    void setCharID(int s, int char_num, qint8 new_id);
    void setCharLevel(int s, int char_num, qint8 new_level);
    void setCharStr(int s, int char_num, quint8 str);
    void setCharVit(int s, int char_num, quint8 vit);
    void setCharMag(int s, int char_num, quint8 mag);
    void setCharSpi(int s, int char_num, quint8 spi);
    void setCharDex(int s, int char_num, quint8 dex);
    void setCharLck(int s, int char_num, quint8 lck);
    void setCharStrBonus(int s, int char_num, quint8 strbonus);
    void setCharVitBonus(int s, int char_num, quint8 vitbonus);
    void setCharMagBonus(int s, int char_num, quint8 magbonus);
    void setCharSpiBonus(int s, int char_num, quint8 spibonus);
    void setCharDexBonus(int s, int char_num, quint8 dexbonus);
    void setCharLckBonus(int s, int char_num, quint8 lckbonus);
    void setCharLimitLevel(int s, int char_num, qint8 limitlevel);
    void setCharLimitBar(int s, int char_num, quint8 limitbar);
    void setCharName(int s, int char_num, QString new_name); //write char_num 's new_name to slot s
    void setCharWeapon(int s, int char_num, quint8 weapon);
    void setCharArmor(int s, int char_num, quint8 armor);
    void setCharAccessory(int s, int char_num, quint8 accessory);
    void setCharFlag(int s, int char_num, int flag_num, quint8 flag_value);
    void setCharLimits(int s, int char_num, quint16 new_limits);
    void setCharKills(int s, int char_num, quint16 kills);
    void setCharTimeLimitUsed(int s, int char_num, int level, quint16 timesused);
    void setCharCurrentHp(int s, int char_num, quint16 curHp);
    void setCharBaseHp(int s, int char_num, quint16 baseHp);
    void setCharCurrentMp(int s, int char_num, quint16 curMp);
    void setCharBaseMp(int s, int char_num, quint16 baseMp);
    void setCharUnknown(int s, int char_num, int unknown_num, quint8 value);
    void setCharMaxHp(int s, int char_num, quint16 maxHp);
    void setCharMaxMp(int s, int char_num, quint16 maxMp);
    void setCharCurrentExp(int s, int char_num, quint32 exp);
    void setCharNextExp(int s, int char_num, quint32 next);
    void setCharMateria(int s, int who, int mat_num, quint8 id, qint32 ap);
    void setCharMateria(int s, int who, int mat_num, materia mat);
    //chocobo Stuff.
    QList<FF7CHOCOBO> chocobos(int s);
    QList<quint16> chocobosStaminas(int s);
    QList<QString> chocobosNames(int s);
    QList<bool> chocoboCantMates(int s);
    qint8 stablesOwned(int s);
    qint8 stablesOccupied(int s);
    qint8 stableMask(int s);
    void setStablesOwned(int s, qint8 value);
    void setStablesOccupied(int s, qint8 value);
    void setStableMask(int s, qint8 value);
    FF7CHOCOBO chocobo(int s, int chocoSlot);
    quint16 chocoStamina(int s, int chocoSlot);
    quint16 chocoSpeed(int s, int chocoSlot);
    quint16 chocoMaxSpeed(int s, int chocoSlot);
    quint16 chocoSprintSpeed(int s, int chocoSlot);
    quint16 chocoMaxSprintSpeed(int s, int chocoSlot);
    quint8 chocoSex(int s, int chocoSlot);
    quint8 chocoType(int s, int chocoSlot);
    quint8 chocoCoop(int s, int chocoSlot);
    quint8 chocoAccel(int s, int chocoSlot);
    quint8 chocoIntelligence(int s, int chocoSlot);
    quint8 chocoRaceswon(int s, int chocoSlot);
    quint8 chocoPCount(int s, int chocoSlot);
    quint8 chocoPersonality(int s, int chocoSlot);
    bool chocoCantMate(int s, int chocoSlot);
    void setChocoStamina(int s, int chocoSlot, quint16 stamina);
    void setChocoSpeed(int s, int chocoSlot, quint16 speed);
    void setChocoMaxSpeed(int s, int chocoSlot, quint16 maxspeed);
    void setChocoSprintSpeed(int s, int chocoSlot, quint16 sprintSpeed);
    void setChocoMaxSprintSpeed(int s, int chocoSlot, quint16 maxsprintSpeed);
    void setChocoSex(int s, int chocoSlot, quint8 value);
    void setChocoType(int s, int chocoSlot, quint8 value);
    void setChocoCoop(int s, int chocoSlot, quint8 value);
    void setChocoAccel(int s, int chocoSlot, quint8 value);
    void setChocoIntelligence(int s, int chocoSlot, quint8 value);
    void setChocoRaceswon(int s, int chocoSlot, quint8 value);
    void setChocoPCount(int s, int chocoSlot, quint8 value);
    void setChocoPersonality(int s, int chocoSlot, quint8 value);
    void setChocoCantMate(int s, int chocoSlot, bool cantMate);
    // Return File Info
    int lenFile(void);//Return File length.
    int lenFileHeader(void);//Return File Header length
    int lenCoreSave(void);//Return Slot length (data portion)
    int lenSlotHeader(void);//Return slot header length
    int lenSlotFooter(void);//Return slot footer length
    int lenSlot(void);//Return Slot length
    int numberOfSlots(void);//Return number of slots in the file_footer_dex
    QString fileName(void);//return loaded filename
    void setFileModified(bool, int s); //file changed toggle, with slot called
    void setRegion(int s, const QString &region);
    bool isFileModified(void);//has the file changed since load
    bool isSlotModified(int s);//has slot[s] changed since load.
    bool isSlotEmpty(int s);//is Slot s empty
    bool isFF7(int s);//valid ff7 slot?
    bool isPAL(int s);//PAL SLOT?
    bool isNTSC(int s);//NTSC SLOT??
    bool isJPN(int s);//is a Japanese File
    QString region(int s);// region string of slot s
    //Set Needed Info Stuffs
 
    char psx_block_type(int s);//mask of psx slot (used by index)
    void setPsx_block_type(int s, char block_type);
    quint8 psx_block_next(int s);// if using more then one block return location of next block
    void setPsx_block_next(int s, int next);
    quint8 psx_block_size(int s);//how many blocks save uses.
    void setPsx_block_size(int s, int blockSize);
    void fix_pc_bytemask(int s);// update so last slot is shown selected on load (must be public to set to currently viewed slot).
    //more data members
    QByteArray unknown(int s, int z);
    bool setUnknown(int s, int z, QByteArray data);
    quint16 steps(int s);
    void setSteps(int s, int steps);
    quint8 churchProgress(int s);
    void setChurchProgress(int s, int progress);
    quint8 donProgress(int s);
    void setDonProgress(int s, int progress);
    quint16 battlePoints(int s);
    void setBattlePoints(int s, quint16);
    quint32 time(int s);
    void setTime(int s, quint32 new_time);
    void setDisc(int s, int disc);
    quint8 disc(int s);
    quint16 mainProgress(int s);
    void setMainProgress(int s, int mProgress);
    QByteArray keyItems(int s);
    bool setKeyItems(int s, QByteArray data);
    bool keyItem(int s, int keyItem);
    void setKeyItem(int s, int keyItem, bool pickedUp);
    bool itemMask1(int s, int bit);
    void setItemMask1(int s, int bit, bool pickedUp);
    bool bmProgress1(int s, int bit);
    void setBmProgress1(int s, int bit, bool isTrue);
    void setBmProgress1(int s, int value);
    bool bmProgress2(int s, int bit);
    void setBmProgress2(int s, int bit, bool isTrue);
    void setBmProgress2(int s, int value);
    bool bmProgress3(int s, int bit);
    void setBmProgress3(int s, int bit, bool isTrue);
    void setBmProgress3(int s, int value);
    bool midgarTrainFlags(int s, int bit);
    void setMidgarTrainFlags(int s, int bit, bool isTrue);
    void setMidgarTrainFlags(int s, int value);
    bool turtleParadiseFlyerSeen(int s, int flyer);
    quint8 turtleParadiseFlyersSeen(int s);
    void setTurtleParadiseFlyerSeen(int s, int flyer, bool seen);
    void setTurtleParadiseFlyersSeen(int s, quint8 flyersSeen);
    bool startBombingMission(int s);
    void setStartBombingMission(int s, bool isTrue);
    quint32 uWeaponHp(int s);
    void setUWeaponHp(int s, int hp);
    bool killedEmeraldWeapon(int s);
    void setKilledEmeraldWeapon(int s, bool isTrue);
    bool killedRubyWeapon(int s);
    void setKilledRubyWeapon(int s, bool isTrue);
    quint8 tutSave(int s);
    void setTutSave(int s, int value);
    bool canFightNinjaInForest(int s);
    void setCanFightNinjaInForest(int s, bool isTrue);
    quint8 tutSub(int s);
    bool tutSub(int s, int bit);
    void setTutSub(int s, int bit, bool isTrue);
    void setTutSub(int s, int value);
 
    bool yuffieUnlocked(int s);
 
    void setYuffieUnlocked(int s, bool isUnlocked);
 
    bool vincentUnlocked(int s);
 
    void setVincentUnlocked(int s, bool isUnlocked);
 
    bool worldChocobo(int s, int bit);
    void setWorldChocobo(int s, int bit, bool isTrue);
    bool worldVehicle(int s, int bit);
    void setWorldVehicle(int s, int bit, bool isTrue);
    //World Coords
    quint32 worldCoordsLeader(int s, bool firstChunk);
    int worldCoordsLeaderX(int s);
    int worldCoordsLeaderID(int s);
    int worldCoordsLeaderAngle(int s);
    int worldCoordsLeaderY(int s);
    int worldCoordsLeaderZ(int s);
    void setWorldCoordsLeader(int s, bool firstChunk, int value);
    void setWorldCoordsLeaderX(int s, int value);
    void setWorldCoordsLeaderID(int s, int value);
    void setWorldCoordsLeaderAngle(int s, int value);
    void setWorldCoordsLeaderY(int s, int value);
    void setWorldCoordsLeaderZ(int s, int value);
    quint32 worldCoordsTc(int s, bool firstChunk);
    int worldCoordsTcX(int s);
    int worldCoordsTcID(int s);
    int worldCoordsTcAngle(int s);
    int worldCoordsTcY(int s);
    int worldCoordsTcZ(int s);
    void setWorldCoordsTc(int s, bool firstChunk, int value);
    void setWorldCoordsTcX(int s, int value);
    void setWorldCoordsTcID(int s, int value);
    void setWorldCoordsTcAngle(int s, int value);
    void setWorldCoordsTcY(int s, int value);
    void setWorldCoordsTcZ(int s, int value);
    quint32 worldCoordsBh(int s, bool firstChunk);
    int worldCoordsBhX(int s);
    int worldCoordsBhID(int s);
    int worldCoordsBhAngle(int s);
    int worldCoordsBhY(int s);
    int worldCoordsBhZ(int s);
    void setWorldCoordsBh(int s, bool firstChunk, int value);
    void setWorldCoordsBhX(int s, int value);
    void setWorldCoordsBhID(int s, int value);
    void setWorldCoordsBhAngle(int s, int value);
    void setWorldCoordsBhY(int s, int value);
    void setWorldCoordsBhZ(int s, int value);
    quint32 worldCoordsSub(int s, bool firstChunk);
    int worldCoordsSubX(int s);
    int worldCoordsSubID(int s);
    int worldCoordsSubAngle(int s);
    int worldCoordsSubY(int s);
    int worldCoordsSubZ(int s);
    void setWorldCoordsSub(int s, bool firstChunk, int value);
    void setWorldCoordsSubX(int s, int value);
    void setWorldCoordsSubID(int s, int value);
    void setWorldCoordsSubAngle(int s, int value);
    void setWorldCoordsSubY(int s, int value);
    void setWorldCoordsSubZ(int s, int value);
    quint32 worldCoordsWchoco(int s, bool firstChunk);
    int worldCoordsWchocoX(int s);
    int worldCoordsWchocoID(int s);
    int worldCoordsWchocoAngle(int s);
    int worldCoordsWchocoY(int s);
    int worldCoordsWchocoZ(int s);
    void setWorldCoordsWchoco(int s, bool firstChunk, int value);
    void setWorldCoordsWchocoX(int s, int value);
    void setWorldCoordsWchocoID(int s, int value);
    void setWorldCoordsWchocoAngle(int s, int value);
    void setWorldCoordsWchocoY(int s, int value);
    void setWorldCoordsWchocoZ(int s, int value);
    quint32 worldCoordsDurw(int s, bool firstChunk);
    int worldCoordsDurwX(int s);
    int worldCoordsDurwID(int s);
    int worldCoordsDurwAngle(int s);
    int worldCoordsDurwY(int s);
    int worldCoordsDurwZ(int s);
    void setWorldCoordsDurw(int s, bool firstChunk, int value);
    void setWorldCoordsDurwX(int s, int value);
    void setWorldCoordsDurwID(int s, int value);
    void setWorldCoordsDurwAngle(int s, int value);
    void setWorldCoordsDurwY(int s, int value);
    void setWorldCoordsDurwZ(int s, int value);
    void setSaveNumber(int s, int saveNum);
 
    bool subMiniGameVictory(int s);
    void setSubMiniGameVictory(int s, bool won);
 
    bool playedPianoOnFlashback(int s);
 
    void setPlayedPianoOnFlashback(int s, bool played);
 
    quint8 chocoboRating(int s, int stable);
 
    void setChocoboRating(int s, int stable, int rating);
    QList<quint8> chocoboRatings(int s);
 
    QString psxDesc(int s);
 
    void setPsxDesc(QString newDesc, int s);
 
    inline int unknown_zmax()
    {
        return 48; //Number of "z" vars.
    }
 
    void setFormat(FF7SaveInfo::FORMAT newFormat);
 
    FF7SaveInfo::FORMAT format();
 
    bool isBufferSlotPopulated();
signals:
    void fileChanged(bool);
private:
    bool exportPCFormat(const QString &fileName, FF7SaveInfo::FORMAT exportFormat);
 
    bool exportVMCFormat(const QString &fileName, FF7SaveInfo::FORMAT exportFormat);
 
    bool exportSlot(const QString &fileName, FF7SaveInfo::FORMAT exportFormat, int s);
 
    QString md5sum(QString fileName, QString UserID);
 
    QString fileblock(const QString &fileName);
    QString filetimestamp(QString fileName);
    void checksumSlots();
    quint16 ff7Checksum(int s);
    void fix_psv_header(int s, int blocks = 1);
    void fix_pge_header(int s);
    void fix_pda_header(int s);
    void fix_psx_header(int s);
    void fix_vmp_header(void);
    void fix_vmc_header(void);
    void vmcRegionEval(int s);
    //data members
    FF7SLOT buffer_slot;// hold a buffer slot
    FF7SLOT slot[15]; //core slot data.
    FF7HEADFOOT hf[15]; //slot header and footer.
    FF7SaveInfo::FORMAT fileFormat = FF7SaveInfo::FORMAT::UNKNOWN;
    QByteArray _bufferFileHeader;
    QByteArray _fileHeader;
    bool slotChanged[15];
    bool fileHasChanged;
    QString buffer_region; // hold the buffers region data.
    QList<QString> SG_Region_String;
    QString filename;//opened file
    QVector< SubContainer > parseXML(const QString &fileName, const QString &metadataPath, const QString &UserID);
    QVector< SubContainer > createMetadata(const QString &fileName, const QString &UserID);
 
    inline static const auto allDigetRegEx = QRegularExpression(QStringLiteral("^\\d+$"));
    inline static const QString invalidRegion = QStringLiteral("\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000");
};