DataFileAbstract.h

/***************************************************************************
 *   Copyright (C) 2023.2024 by Stefan Kebekus                             *
 *   stefan.kebekus@gmail.com                                              *
 *                                                                         *
 *   This program 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.                                   *
 *                                                                         *
 *   This program 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 this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
 
#pragma once
 
#include <QFileDevice>
#include <QFile>
#include <QObject>
#include <QSharedPointer>
 
namespace FileFormats
{

 
class DataFileAbstract
{
 
public:
    DataFileAbstract() = default;
    ~DataFileAbstract() = default;
 
 
    //
    // Getter methods
    //

    [[nodiscard]] bool isValid() const { return m_error.isEmpty(); }

    [[nodiscard]] QString error() const { return m_error; }

    [[nodiscard]] QStringList warnings() const { return m_warnings; }
 
 
 
    //
    // Methods
    //

    [[nodiscard]] static QSharedPointer<QFile> openFileURL(const QString& fileName);

    [[nodiscard]] static bool saveFileAtomically(const QString& path, const QByteArray& data, QString* error = nullptr, QFileDevice::Permissions permissions = {});
 
protected:
    void addWarning(const QString& warning) { m_warnings += warning; }
    void setError(const QString& newError) { m_error = newError; }
 
private:
    QString m_error;
    QStringList m_warnings;
};
 
} // namespace FileFormats