ConfigurationNode.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

#ifndef ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_CONFIGURATION_CONFIGURATIONNODE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_CONFIGURATION_CONFIGURATIONNODE_H_

#include <chrono>
#include <cstddef>
#include <iostream>
#include <memory>
#include <mutex>
#include <set>
#include <string>
#include <vector>

#include <rapidjson/document.h>

namespace alexaClientSDK {
namespace avsCommon {
namespace utils {
namespace configuration {

class ConfigurationNode {
public:
    static bool initialize(const std::vector<std::shared_ptr<std::istream>>& jsonStreams);

    static void uninitialize();

    static std::shared_ptr<ConfigurationNode> createRoot();

    static ConfigurationNode getRoot();

    ConfigurationNode();

    bool getBool(const std::string& key, bool* out = nullptr, bool defaultValue = false) const;

    bool getInt(const std::string& key, int* out = nullptr, int defaultValue = 0) const;

    bool getUint32(const std::string& key, uint32_t* out = nullptr, uint32_t defaultValue = 0) const;

    bool getString(const std::string& key, std::string* out = nullptr, std::string defaultValue = "") const;

    bool getStringValues(const std::string& key, std::set<std::string>* out = nullptr) const;

    template <typename InputType, typename OutputType, typename DefaultType>
    bool getDuration(
        const std::string& key,
        OutputType* out = static_cast<std::chrono::seconds>(0),
        DefaultType defaultValue = std::chrono::seconds(0)) const;

    ConfigurationNode operator[](const std::string& key) const;

    ConfigurationNode getChildNode(const char* key) const;

    operator bool() const;

    template <typename Type>
    bool getValue(
        const std::string& key,
        Type* out,
        Type defaultValue,
        bool (rapidjson::Value::*isType)() const,
        Type (rapidjson::Value::*getType)() const) const;

    std::string serialize() const;

    ConfigurationNode getArray(const std::string& key) const;

    std::size_t getArraySize() const;

    ConfigurationNode operator[](const std::size_t index) const;

private:
    ConfigurationNode(const rapidjson::Value* object);

    bool getString(const std::string& key, const char** out, const char* defaultValue) const;

    const rapidjson::Value* m_object;

    static std::mutex m_mutex;

    static rapidjson::Document m_document;

    static ConfigurationNode m_root;
};

template <typename InputType, typename OutputType, typename DefaultType>
bool ConfigurationNode::getDuration(const std::string& key, OutputType* out, DefaultType defaultValue) const {
    int temp;
    auto result = getInt(key, &temp);
    if (out) {
        *out = OutputType(result ? InputType(temp) : defaultValue);
    }
    return result;
}

template <typename Type>
bool ConfigurationNode::getValue(
    const std::string& key,
    Type* out,
    Type defaultValue,
    bool (rapidjson::Value::*isType)() const,
    Type (rapidjson::Value::*getType)() const) const {
    if (key.empty() || !m_object) {
        if (out) {
            *out = defaultValue;
        }
        return false;
    }
    auto it = m_object->FindMember(key.c_str());
    if (m_object->MemberEnd() == it || !(it->value.*isType)()) {
        if (out) {
            *out = defaultValue;
        }
        return false;
    }
    if (out) {
        *out = (it->value.*getType)();
    }
    return true;
}

}  // namespace configuration
}  // namespace utils
}  // namespace avsCommon
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_CONFIGURATION_CONFIGURATIONNODE_H_