ConfigFile.h

/*
 * Copyright (c) 2021, 2022 G. R. McDorman
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
 
#pragma once
 
#include <optional>
#include <vector>
 
#include <ArduinoJson.h>
 
namespace grmcdorman::device
{
    class Device;
 
    class ConfigFile
    {
    public:
        ConfigFile(): ConfigFile("/config.json")
        {
        }
 
        explicit ConfigFile(const char *explicit_path): path(explicit_path)
        {
        }
 
        const char *get_path() const
        {
            return path;
        }
 
        void save(const std::vector<Device *> &devices);
 
        bool load(const std::vector<Device *> &devices);
 
        void save(DynamicJsonDocument &json);
 
        std::optional<DynamicJsonDocument> load();
 
    private:
        const char *path;       
    };
}