tfFIO.h

/*******************************************************************************
 * This file is part of Tissue Forge.
 * Copyright (c) 2022-2024 T.J. Sego
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser 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 Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * 
 ******************************************************************************/
 
#ifndef _SOURCE_IO_TFFIO_H_
#define _SOURCE_IO_TFFIO_H_
 
 
#include "tf_io.h"
 
 
namespace TissueForge::io {
 

    CPPAPI_FUNC(std::string) toStr(IOElement &fileElement, const MetaData &metaData);

    CPPAPI_FUNC(std::string) toStr(IOElement &fileElement);

    CPPAPI_FUNC(IOElement) fromStr(const std::string &str, const MetaData &metaData);

    CPPAPI_FUNC(IOElement) fromStr(const std::string &str);

    template <typename T>
    std::string toString(const T &dataElement, const MetaData &metaData) {
        IOElement fe = IOElement::create();
        if(toFile<T>(dataElement, metaData, fe) != S_OK) 
            return "";
        return toStr(fe, metaData);
    }

    template <typename T>
    std::string toString(const T &dataElement) {
        return toString(dataElement, MetaData());
    }

    template <typename T>
    T fromString(const std::string &str, const MetaData &metaData) { 
        IOElement fe = fromStr(str, metaData);
        T de;
        fromFile<T>(fe, metaData, &de);
        return de;
    }

    template <typename T>
    T fromString(const std::string &str) {
        return fromString<T>(str, MetaData());
    }

    struct CAPI_EXPORT FIOImportSummary {

        std::unordered_map<unsigned int, unsigned int> particleIdMap;

        std::unordered_map<unsigned int, unsigned int> particleTypeIdMap;
 
    };
 

    struct FIOModule {

        virtual std::string moduleName() = 0;

        virtual HRESULT toFile(const MetaData &metaData, IOElement &fileElement) = 0;

        virtual HRESULT fromFile(const MetaData &metaData, const IOElement &fileElement) = 0;

        void registerIOModule();

        void load();
 
    };
 

    struct CAPI_EXPORT FIO {

        static const std::string KEY_TYPE;

        static const std::string KEY_VALUE;

        static const std::string KEY_ROOT;

        static const std::string KEY_METADATA;

        static const std::string KEY_SIMULATOR;

        static const std::string KEY_UNIVERSE;

        static const std::string KEY_MODULES;

        inline static FIOImportSummary *importSummary = NULL;

        static IOElement generateIORootElement();

        static HRESULT releaseIORootElement();

        static HRESULT getCurrentIORootElement(IOElement *el);

        static IOElement fromFile(const std::string &loadFilePath);

        static HRESULT fromFile(const std::string &loadFilePath, IOElement &el);

        static HRESULT toFile(const std::string &saveFilePath);

        static std::string toString();

        static void registerModule(const std::string moduleName, FIOModule *module);

        static void loadModule(const std::string moduleName);

        static bool hasImport();
 
    private:
        
        inline static std::unordered_map<std::string, FIOModule*> *modules = NULL;
 
    };
 
};
 
#endif // _SOURCE_IO_TFFIO_H_