comment.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
 *
 * This file is part of StormByte-Config.
 *
 * StormByte-Config original source is dual-licensed:
 *
 * 1. GNU Lesser General Public License v3.0 (or later)
 *    You may redistribute and/or modify this file under the terms of the
 *    GNU Lesser General Public License as published by the Free Software
 *    Foundation, either version 3 of the License, or (at your option)
 *    any later version.
 *
 * 2. Commercial license
 *    Alternatively, this file may be used under the terms of a commercial
 *    license agreement with the copyright holder
 *    (David C. Manuelda <StormByte@gmail.com>).
 *
 * Both licenses apply only to original StormByte-Config source in this
 * repository. They do not cover other StormByte modules or any third-party
 * material shipped with this repository. The bundled StormByte Base tree
 * under thirdparty/ remains under its own license.
 *
 * Neither license grants any patent rights. Any patent licenses required
 * to use this software or third-party components must be obtained separately
 * from the patent holders.
 *
 * StormByte-Config is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with StormByte-Config. If not, see
 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
 *
 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
 */
 
#pragma once
 
#include <StormByte/config/item/base.hxx>
#include <StormByte/config/visibility.h>
#include <StormByte/safe/string.hxx>
 
#include <string_view>
#include <utility>
 
namespace StormByte::Config::Item {
    template<CommentType T>
    class STORMBYTE_CONFIG_PUBLIC Comment final: public Base {
        public:
            static constexpr bool CommentTag = true;
 
            Comment(const StormByte::Safe::String& comment): Base(), m_text(comment) {}
 
            Comment(StormByte::Safe::String&& comment): Base(), m_text(std::move(comment)) {}
 
            Comment(const char* comment): Base(), m_text(StormByte::Safe::String(comment)) {}
 
            Comment(const Comment& base) = default;
 
            Comment(Comment&& base) noexcept = default;
 
            Comment& operator=(const Comment& base) = default;
 
            Comment& operator=(Comment&& base) noexcept = default;
 
            ~Comment() noexcept override;
 
            bool Equals(const Base& other) const noexcept override;
 
            StormByte::Safe::String Serialize(const int& indent_level) const noexcept override;
 
            constexpr Item::Type Type() const noexcept override {
                return Item::Type::Comment;
            }
 
            constexpr StormByte::Config::Item::CommentType CommentType() const noexcept {
                return T;
            }
 
            constexpr std::string_view CommentTypeToString() const noexcept {
                return Item::TypeToString(T);
            }
 
            StormByte::Safe::String& Text() noexcept {
                return m_text;
            }
 
            const StormByte::Safe::String& Text() const noexcept {
                return m_text;
            }
 
            PointerType Clone() const override {
                return MakePointer<Comment<T>>(*this);
            }
 
            PointerType Move() override {
                return MakePointer<Comment<T>>(std::move(*this));
            }
 
        private:
            StormByte::Safe::String m_text; 
    };
 
    template<>
    STORMBYTE_CONFIG_PUBLIC Comment<CommentType::SingleLineBash>::~Comment() noexcept;
 
    template<>
    STORMBYTE_CONFIG_PUBLIC Comment<CommentType::SingleLineC>::~Comment() noexcept;
 
    template<>
    STORMBYTE_CONFIG_PUBLIC Comment<CommentType::MultiLineC>::~Comment() noexcept;
 
    template<>
    STORMBYTE_CONFIG_PUBLIC bool Comment<CommentType::SingleLineBash>::Equals(const Base& other) const noexcept;
 
    template<>
    STORMBYTE_CONFIG_PUBLIC bool Comment<CommentType::SingleLineC>::Equals(const Base& other) const noexcept;
 
    template<>
    STORMBYTE_CONFIG_PUBLIC bool Comment<CommentType::MultiLineC>::Equals(const Base& other) const noexcept;
 
    template<>
    STORMBYTE_CONFIG_PUBLIC StormByte::Safe::String Comment<CommentType::SingleLineBash>::Serialize(const int& indent_level) const noexcept;
 
    template<>
    STORMBYTE_CONFIG_PUBLIC StormByte::Safe::String Comment<CommentType::SingleLineC>::Serialize(const int& indent_level) const noexcept;
 
    template<>
    STORMBYTE_CONFIG_PUBLIC StormByte::Safe::String Comment<CommentType::MultiLineC>::Serialize(const int& indent_level) const noexcept;
 
    extern template class STORMBYTE_CONFIG_PUBLIC Comment<CommentType::SingleLineBash>;
    extern template class STORMBYTE_CONFIG_PUBLIC Comment<CommentType::SingleLineC>;
    extern template class STORMBYTE_CONFIG_PUBLIC Comment<CommentType::MultiLineC>;
}