/* -----------------------------------------------------------------------------
 * Copyright 2022 Massachusetts Institute of Technology.
 * All Rights Reserved
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  1. Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright notice,
 *     this list of conditions and the following disclaimer in the documentation
 *     and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Research was sponsored by the United States Air Force Research Laboratory and
 * the United States Air Force Artificial Intelligence Accelerator and was
 * accomplished under Cooperative Agreement Number FA8750-19-2-1000. The views
 * and conclusions contained in this document are those of the authors and should
 * not be interpreted as representing the official policies, either expressed or
 * implied, of the United States Air Force or the U.S. Government. The U.S.
 * Government is authorized to reproduce and distribute reprints for Government
 * purposes notwithstanding any copyright notation herein.
 * -------------------------------------------------------------------------- */
#pragma once

#include <filesystem>
#include <memory>
#include <optional>
#include <string>
#include <unordered_map>

#include "spark_dsg/spark_dsg_fwd.h"

namespace spark_dsg::io {

// Define file extensions and types.
inline const std::string JSON_EXTENSION = ".json";
inline const std::string BSON_EXTENSION = ".bson";
inline const std::string BINARY_EXTENSION = ".sparkdsg";
enum class FileType { JSON, BINARY, NONE, UNKNOWN };

/**
 * @brief Identify the file type of a given filepath.
 * @param filepath The complete filepath to identify.
 */
FileType identifyFileType(const std::filesystem::path& filepath);

/**
 * @brief Verify that the file extension of a given filepath is valid. If no extension
 * is provided, default to binary.
 * @param filepath The complete filepath to verify.
 * @throws std::runtime_error if the extension is invalid.
 * @return The file type of the resulting filepath.
 */
FileType verifyFileExtension(std::filesystem::path& filepath);

/**
 * @brief Save a DynamicSceneGraph to a JSON file.
 * @param graph The graph to save.
 * @param filepath The filepath including extension to save to.
 * @param include_mesh If true, save the mesh data for each node.
 */
void saveDsgJson(const DynamicSceneGraph& graph,
                 const std::filesystem::path& filepath,
                 bool include_mesh = false);

/**
 * @brief Load a DynamicSceneGraph from a JSON file.
 * @param filepath The filepath including extension to load from.
 * @return A pointer to the loaded graph or nullptr if loading failed.
 */
std::shared_ptr<DynamicSceneGraph> loadDsgJson(const std::filesystem::path& filepath);

/**
 * @brief Save a DynamicSceneGraph to a file in binary serialization.
 * @param graph The graph to save.
 * @param filepath The filepath including extension to save to.
 * @param include_mesh If true, save the mesh data for each node.
 */
void saveDsgBinary(const DynamicSceneGraph& graph,
                   const std::filesystem::path& filepath,
                   bool include_mesh = false);

/**
 * @brief Load a DynamicSceneGraph from a file in binary serialization.
 * @param filepath The filepath including extension to load from.
 * @return A pointer to the loaded graph or nullptr if loading failed.
 */
std::shared_ptr<DynamicSceneGraph> loadDsgBinary(const std::filesystem::path& filepath);

}  // namespace spark_dsg::io
