Libraries/ConfigDB/src/include/ConfigDB/Format.h

Go to the documentation of this file.

/****
 * ConfigDB/Format.h
 *
 * Copyright 2024 mikee47 <mike@sillyhouse.net>
 *
 * This file is part of the ConfigDB Library
 *
 * This library 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, version 3 or later.
 *
 * This library 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 library.
 * If not, see <https://www.gnu.org/licenses/>.
 *
 ****/
 
#pragma once
 
#include <Data/Stream/ReadWriteStream.h>
#include "Status.h"
#include "StoreRef.h"
 
namespace ConfigDB
{
class Database;
class Store;
class Object;
 
class ImportStream : public ReadWriteStream
{
public:
    virtual Status getStatus() const = 0;
};
 
struct ExportOptions {
    bool useName{false};
 
    bool asObject{false};
 
    bool pretty{false};
};
 
class ExportStream : public IDataSourceStream
{
public:
    virtual Status getStatus() const = 0;
};
 
class Format
{
public:
    virtual std::unique_ptr<ExportStream> createExportStream(Database& db, const ExportOptions& options = {}) const = 0;
 
    virtual std::unique_ptr<ExportStream> createExportStream(StoreRef store, const Object& object,
                                                             const ExportOptions& options = {}) const = 0;
 
    virtual size_t exportToStream(const Object& object, Print& output, const ExportOptions& options = {}) const = 0;
 
    virtual size_t exportToStream(Database& database, Print& output, const ExportOptions& options = {}) const = 0;
 
    virtual std::unique_ptr<ImportStream> createImportStream(Database& db) const = 0;
 
    virtual std::unique_ptr<ImportStream> createImportStream(StoreUpdateRef& store, Object& object) const = 0;
 
    virtual Status importFromStream(Object& object, Stream& source) const = 0;
 
    virtual Status importFromStream(Database& database, Stream& source) const = 0;
 
    virtual String getFileExtension() const = 0;
 
    virtual MimeType getMimeType() const = 0;
};
 
} // namespace ConfigDB