vabstractconverter.h

Go to the documentation of this file.

/***************************************************************************
 **  @file   vabstractconverter.h
 **  @author Douglas S Caskey
 **  @date   Dec 27, 2022
 **
 **  @copyright
 **  Copyright (C) 2017 - 2022 Seamly, LLC
 **  https://github.com/fashionfreedom/seamly2d
 **
 **  @brief
 **  Seamly2D 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.
 **
 **  Seamly2D 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 Seamly2D. If not, see <http://www.gnu.org/licenses/>.
 **************************************************************************/
 
/************************************************************************
 **
 **  @file   vabstractconverter.h
 **  @author Roman Telezhynskyi <dismine(at)gmail.com>
 **  @date   10 12, 2014
 **
 **  @brief
 **  @copyright
 **  This source code is part of the Valentina project, a pattern making
 **  program, whose allow create and modeling patterns of clothing.
 **  Copyright (C) 2014 Valentina project
 **  <https://bitbucket.org/dismine/valentina> All Rights Reserved.
 **
 **  Valentina 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.
 **
 **  Valentina 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 Valentina.  If not, see <http://www.gnu.org/licenses/>.
 **
 *************************************************************************/
 
#ifndef VABSTRACTCONVERTER_H
#define VABSTRACTCONVERTER_H
 
#include <qcompilerdetection.h>
 
#if !defined(Q_OS_OSX) && !defined(Q_OS_WIN) && defined(Q_CC_GNU)
#include <sys/sysmacros.h>
#endif
 
#include <QCoreApplication>
#include <QString>
#include <QTemporaryFile>
#include <QtGlobal>
 
#include "vdomdocument.h"
 
template <class Key, class T> class QMap;
 
#define CONVERTER_VERSION_CHECK(major, minor, patch) ((major<<16)|(minor<<8)|(patch))
 
class VAbstractConverter :public VDomDocument
{
    Q_DECLARE_TR_FUNCTIONS(VAbstractConverter)
public:
    explicit        VAbstractConverter(const QString &fileName);
    virtual        ~VAbstractConverter() Q_DECL_EQ_DEFAULT;
 
    QString         Convert();
 
    int             GetCurrentFormatVarsion() const;
    QString         GetVersionStr() const;
 
    static int      GetVersion(const QString &version);
 
protected:
    int             m_ver;
    QString         m_convertedFileName;
 
    void            ValidateInputFile(const QString &currentSchema) const;
    Q_NORETURN void InvalidVersion(int ver) const;
    void            Save();
    void            SetVersion(const QString &version);
 
    virtual int     MinVer() const =0;
    virtual int     MaxVer() const =0;
 
    virtual QString MinVerStr() const =0;
    virtual QString MaxVerStr() const =0;
 
    virtual QString XSDSchema(int ver) const =0;
    virtual void    ApplyPatches() =0;
    virtual void    DowngradeToCurrentMaxVersion() =0;
 
    virtual bool    IsReadOnly() const =0;
 
    void            Replace(QString &formula, const QString &newName, int position,
                            const QString &token, int &bias) const;
    void            CorrectionsPositions(int position, int bias, QMap<int, QString> &tokens) const;
    static void     BiasTokens(int position, int bias, QMap<int, QString> &tokens);
 
private:
    Q_DISABLE_COPY(VAbstractConverter)
 
    QTemporaryFile  m_tmpFile;
 
    static void     ValidateVersion(const QString &version);
 
    void            ReserveFile() const;
 
    /**
     *  \brief Removes version number from \arg fileName
     *
     *  It removes both, "old style" ie. "(v0.6.0)" and new style "v060" patterns.
     */
    static QString  removeVersionNumber(const QString& fileName);
 
    /** \brief Removes single or repeated '.bak' extension (as long as it is at the end of \arg fileName) */
    static QString  removeBakExtension(const QString& fileName);
};
 
#endif // VABSTRACTCONVERTER_H