generic.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
 *
 * This file is part of StormByte-Crypto.
 *
 * StormByte-Crypto 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-Crypto source in this
 * repository. They do not cover other StormByte modules or any third-party
 * material shipped with this repository (including everything under
 * thirdparty/, in particular Crypto++, bundled libbzip2, the StormByte-Buffer
 * tree and the StormByte suite it vendors), which 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-Crypto 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-Crypto. 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/buffer/consumer.hxx>
#include <StormByte/safe/clonable.hxx>
#include <StormByte/crypto/typedefs.hxx>
#include <StormByte/crypto/visibility.h>
#include <StormByte/type_traits.hxx>
 
#include <span>
 
namespace StormByte {
    namespace Crypto {
        namespace Compressor {
            enum class Type {
                Bzip2,  
                Zlib    
            };
 
            class STORMBYTE_CRYPTO_PUBLIC Generic: public StormByte::Safe::Clonable<Generic> {
                public:
                    Generic(const Generic& other) = default;
 
                    Generic(Generic&& other) noexcept = default;
 
                    virtual ~Generic() noexcept;
 
                    Generic& operator=(const Generic& other) = default;
 
                    Generic& operator=(Generic&& other) noexcept = default;
                    inline bool Compress(const std::span<const std::byte> input, Buffer::WriteOnly& output) const noexcept {
                        return DoCompress(input, output);
                    }
 
                    template<StormByte::Type::ByteInputRange Range>
                    bool Compress(const Range& input, Buffer::WriteOnly& output) const {
                        StormByte::BinaryData data;
                        for (const auto value: input) {
                            data.emplace_back(static_cast<std::byte>(value));
                        }
                        return Compress(std::span<const std::byte>(data), output);
                    }
 
                    inline bool Compress(const Buffer::ReadOnly& input, Buffer::WriteOnly& output) const noexcept {
                        return DoCompress(const_cast<Buffer::ReadOnly&>(input), output, ReadMode::Copy);
                    }
 
                    inline bool Compress(Buffer::ReadOnly& input, Buffer::WriteOnly& output) const noexcept {
                        return DoCompress(input, output, ReadMode::Move);
                    }
 
                    inline Buffer::Consumer Compress(Buffer::Consumer consumer, ReadMode mode = ReadMode::Move) const noexcept {
                        return DoCompress(consumer, mode);
                    }
                    inline bool Decompress(const std::span<const std::byte> input, Buffer::WriteOnly& output) const noexcept {
                        return DoDecompress(input, output);
                    }
 
                    template<StormByte::Type::ByteInputRange Range>
                    bool Decompress(const Range& input, Buffer::WriteOnly& output) const {
                        StormByte::BinaryData data;
                        for (const auto value: input) {
                            data.emplace_back(static_cast<std::byte>(value));
                        }
                        return Decompress(std::span<const std::byte>(data), output);
                    }
 
                    inline bool Decompress(const Buffer::ReadOnly& input, Buffer::WriteOnly& output) const noexcept {
                        return DoDecompress(const_cast<Buffer::ReadOnly&>(input), output, ReadMode::Copy);
                    }
 
                    inline bool Decompress(Buffer::ReadOnly& input, Buffer::WriteOnly& output) const noexcept {
                        return DoDecompress(input, output, ReadMode::Move);
                    }
 
                    inline Buffer::Consumer Decompress(Buffer::Consumer consumer, ReadMode mode = ReadMode::Move) const noexcept {
                        return DoDecompress(consumer, mode);
                    }
                    unsigned short Level() const noexcept {
                        return m_level;
                    }
 
                    inline enum Type Type() const noexcept {
                        return m_type;
                    }
 
                protected:
                    enum Type m_type;           
                    unsigned short m_level = 0; 
 
                    inline Generic(enum Type type, unsigned short level = 5):
                        m_type(type), m_level(level) {}
 
                private:
                    virtual bool DoCompress(std::span<const std::byte> input, Buffer::WriteOnly& output) const noexcept = 0;
 
                    bool DoCompress(Buffer::ReadOnly& input, Buffer::WriteOnly& output, ReadMode mode) const noexcept;
 
                    virtual Buffer::Consumer DoCompress(Buffer::Consumer consumer, ReadMode mode) const noexcept = 0;
 
                    virtual bool DoDecompress(std::span<const std::byte> input, Buffer::WriteOnly& output) const noexcept = 0;
 
                    bool DoDecompress(Buffer::ReadOnly& input, Buffer::WriteOnly& output, ReadMode mode) const noexcept;
 
                    virtual Buffer::Consumer DoDecompress(Buffer::Consumer consumer, ReadMode mode) const noexcept = 0;
            };
 
            STORMBYTE_CRYPTO_PUBLIC Generic::PointerType Create(Type type, unsigned short level) noexcept;
        }
    }
}