// Copyright (C) 2015,2017 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

#ifndef DUID_CONFIG_PARSER_H
#define DUID_CONFIG_PARSER_H

#include <cc/data.h>
#include <cc/simple_parser.h>
#include <stdint.h>
#include <string>

namespace isc {
namespace dhcp {

/// @brief Parser for server DUID configuration.
///
/// This parser currently supports the following DUID types:
/// - DUID-LLT,
/// - DUID-EN
/// - DUID-LL
///
/// @todo Add support for DUID-UUID in the parser.
class DUIDConfigParser : public isc::data::SimpleParser {
public:
    /// @brief Parses DUID configuration.
    ///
    /// @param cfg parsed DUID configuration will be stored here
    /// @param duid_configuration Data element holding a map representing
    /// DUID configuration.
    ///
    /// @throw DhcpConfigError If the configuration is invalid.
    void parse(const CfgDUIDPtr& cfg, isc::data::ConstElementPtr duid_configuration);
private:

    /// @brief Validate and set DUID type.
    ///
    /// @param cfg parsed information will be stored here
    /// @param duid_type DUID type in textual format.
    void setType(const CfgDUIDPtr& cfg, const std::string& duid_type) const;

    /// @brief Validate and set identifier.
    ///
    /// @param cfg parsed information will be stored here
    /// @param identifier Identifier.
    void setIdentifier(const CfgDUIDPtr& cfg, const std::string& identifier) const;

    /// @brief Validate and set hardware type.
    ///
    /// @param cfg parsed information will be stored here
    /// @param htype Hardware type.
    void setHType(const CfgDUIDPtr& cfg, const int64_t htype) const;

    /// @brief Validate and set time value.
    ///
    /// @param cfg parsed information will be stored here
    /// @param new_time Time value to be used for DUID.
    void setTime(const CfgDUIDPtr& cfg, const int64_t new_time) const;

    /// @brief Validate and set enterprise id.
    ///
    /// @param cfg parsed information will be stored here
    /// @param enterprise_id Enterprise id.
    void setEnterpriseId(const CfgDUIDPtr& cfg, const int64_t enterprise_id) const;

    /// @brief Set persistence flag.
    ///
    /// @param cfg parsed information will be stored here
    /// @param persist A boolean value indicating if the server
    /// identifier should be stored on the disk (if true) or
    /// not (if false).
    void setPersist(const CfgDUIDPtr& cfg, const bool persist);

    /// @brief Verifies if the specified parameter is in range.
    ///
    /// Each numeric value must be in range of [0 .. max_value], where
    /// max_value is a maximum value for the numeric type used for this
    /// parameter.
    ///
    /// @param parameter_name Parameter name.
    /// @tparam Numeric type of the specified parameter.
    template<typename NumericType>
    void checkRange(const std::string& parameter_name,
                    const int64_t parameter_value) const;
};

}
} // end of namespace isc

#endif // DUID_CONFIG_PARSER_H