log_tag_config.h

Go to the documentation of this file.

/*
 * Copyright 2022 MusicScience37 (Kenta Kabashima)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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.
 */
#pragma once
 
#include <utility>
 
#include "num_collect/base/exception.h"
#include "num_collect/base/index_type.h"
#include "num_collect/logging/log_level.h"
#include "num_collect/logging/sinks/default_log_sink.h"
#include "num_collect/logging/sinks/log_sink.h"
 
namespace num_collect::logging {
 
class log_tag_config {
public:
    log_tag_config() = default;
 
    [[nodiscard]] auto sink() const noexcept -> const sinks::log_sink& {
        return sink_;
    }
 
    auto sink(sinks::log_sink val) -> log_tag_config& {
        sink_ = std::move(val);
        return *this;
    }
 
    [[nodiscard]] auto output_log_level() const noexcept -> log_level {
        return output_log_level_;
    }
 
    auto output_log_level(log_level val) -> log_tag_config& {
        switch (val) {
        case log_level::trace:
        case log_level::debug:
        case log_level::iteration:
        case log_level::summary:
        case log_level::info:
        case log_level::warning:
        case log_level::error:
        case log_level::critical:
        case log_level::off:
            break;
        default:
            throw invalid_argument("Invalid log level.");
        }
        output_log_level_ = val;
        return *this;
    }
 
    [[nodiscard]] auto output_log_level_in_child_iterations() const noexcept
        -> log_level {
        return output_log_level_in_child_iterations_;
    }
 
    auto output_log_level_in_child_iterations(log_level val)
        -> log_tag_config& {
        switch (val) {
        case log_level::trace:
        case log_level::debug:
        case log_level::iteration:
        case log_level::summary:
        case log_level::info:
        case log_level::warning:
        case log_level::error:
        case log_level::critical:
        case log_level::off:
            break;
        default:
            throw invalid_argument("Invalid log level.");
        }
        output_log_level_in_child_iterations_ = val;
        return *this;
    }
 
    [[nodiscard]] auto iteration_output_period() const noexcept -> index_type {
        return iteration_output_period_;
    }
 
    auto iteration_output_period(index_type val) -> log_tag_config& {
        if (val <= 0) {
            throw invalid_argument(
                "iteration_output_period must be a positive integer.");
        }
        iteration_output_period_ = val;
        return *this;
    }
 
    [[nodiscard]] auto iteration_label_period() const noexcept -> index_type {
        return iteration_label_period_;
    }
 
    auto iteration_label_period(index_type val) -> log_tag_config& {
        if (val <= 0) {
            throw invalid_argument(
                "iteration_label_period must be a positive integer.");
        }
        iteration_label_period_ = val;
        return *this;
    }
 
private:
    sinks::log_sink sink_{sinks::get_default_log_sink()};
 
    log_level output_log_level_{log_level::info};
 
    log_level output_log_level_in_child_iterations_{log_level::info};
 
    static constexpr index_type default_iteration_output_period = 10;
 
    index_type iteration_output_period_{default_iteration_output_period};
 
    static constexpr index_type default_iteration_label_period = 20;
 
    index_type iteration_label_period_{default_iteration_label_period};
};
 
}  // namespace num_collect::logging