Lgp.h

Go to the documentation of this file.

/****************************************************************************/
//    copyright 2009 - 2021  Arzel Jérôme <myst6re@gmail.com>               //
//    copyright 2019  Chris Rizzitello <sithlord48@gmail.com>               //
//                                                                          //
//    This file is part of FF7tk                                            //
//                                                                          //
//    FF7tk 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 3 of the License, or     //
//    (at your option) any later version.                                   //
//                                                                          //
//    FF7tk 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.                          //
/****************************************************************************/
/*
 * This file may contains some code (especially the conflict part)
 * inspired from LGP/UnLGP tool written by Aali.
 * http://forums.qhimm.com/index.php?topic=8641.0
 */
#pragma once
 
#include "Archive.h"
#include "ff7tkformats_export.h"
 
#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0))
#define QMultiHashIterator QHashIterator
#endif
 
class LgpHeaderEntry;
class LgpToc;
class Lgp;
 
class FF7TKFORMATS_EXPORT LgpIterator
{
    friend class Lgp;
public:
    explicit LgpIterator(const Lgp &lgp);
    bool hasNext() const;
    void next();
    void toBack();
    void toFront();
    QIODevice *file();
    QIODevice *modifiedFile();
    const QString &fileName() const;
    const QString &fileDir() const;
    QString filePath() const;
private:
    LgpIterator(LgpToc *toc, QFile *lgp);
    QMultiHashIterator<quint16, LgpHeaderEntry *> it;
    QFile *_lgp;
};
 
class FF7TKFORMATS_EXPORT Lgp : public Archive
{
    friend class LgpIterator;
public:
    enum LgpError {
        NoError,
        ReadError,
        WriteError,
        OpenError,
        OpenTempError,
        AbortError,
        RemoveError,
        RenameError,
        PositionError,
        ResizeError,
        PermissionsError,
        CopyError,
        InvalidError,
        FileNotFoundError
    };
 
    Lgp();
    explicit Lgp(const QString &name);
    explicit Lgp(QFile *device);
    virtual ~Lgp() override;
    void clear() override;
    QStringList fileList() const override;
    int fileCount() const override;
    LgpIterator iterator();
    bool fileExists(const QString &filePath) const override;
    QIODevice *file(const QString &filePath) override;
    QIODevice *modifiedFile(const QString &filePath) override;
    bool setFile(const QString &filePath, QIODevice *data) override;
    bool addFile(const QString &filePath, QIODevice *data) override;
    bool removeFile(const QString &filePath) override;
    bool isNameValid(const QString &filePath) const override;
    bool renameFile(const QString &filePath, const QString &newFilePath) override;
    const QString &companyName();
    void setCompanyName(const QString &companyName);
    const QString &productName();
    void setProductName(const QString &productName);
    bool pack(const QString &destination=QString(), ArchiveObserver *observer = nullptr) override;
    LgpError error() const;
    void unsetError();
private:
    Q_DISABLE_COPY(Lgp)
    bool openHeader() override;
    bool openCompanyName();
    bool openProductName();
    LgpHeaderEntry *headerEntry(const QString &filePath) const;
    void setError(LgpError error, const QString &errorString = QString());
    static QByteArray readAll(QIODevice *d, bool *ok);
 
    QString _companyName;
    LgpToc *_files;
    QString _productName;
    LgpError _error;
 
};