hook.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 (including everything under
 * thirdparty/, and in particular the bundled StormByte-String tree and
 * the StormByte Base tree 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-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/clonable.hxx>
#include <StormByte/config/visibility.h>
 
namespace StormByte::Config {
    namespace Item {
        class Group;
    }
 
    class STORMBYTE_CONFIG_PUBLIC ReadHook: public Clonable<ReadHook, StormByte::Shared<ReadHook>> {
        public:
            ReadHook() noexcept = default;
 
            ReadHook(const ReadHook& hook) noexcept = default;
 
            ReadHook(ReadHook&& hook) noexcept = default;
 
            ReadHook& operator=(const ReadHook& hook) noexcept = default;
 
            ReadHook& operator=(ReadHook&& hook) noexcept = default;
 
            ~ReadHook() noexcept override;
 
            PointerType Clone() const override = 0;
 
            PointerType Move() override = 0;
 
            virtual void operator()(Item::Group& root) = 0;
    };
 
    class STORMBYTE_CONFIG_PUBLIC FailureHook: public Clonable<FailureHook, StormByte::Shared<FailureHook>> {
        public:
            FailureHook() noexcept = default;
 
            FailureHook(const FailureHook& hook) noexcept = default;
 
            FailureHook(FailureHook&& hook) noexcept = default;
 
            FailureHook& operator=(const FailureHook& hook) noexcept = default;
 
            FailureHook& operator=(FailureHook&& hook) noexcept = default;
 
            ~FailureHook() noexcept override;
 
            PointerType Clone() const override = 0;
 
            PointerType Move() override = 0;
 
            virtual bool operator()(const Item::Group& root) = 0;
    };
 
    using ReadHookFunction = void (*)(Item::Group&);
 
    using FailureHookFunction = bool (*)(const Item::Group&);
 
    STORMBYTE_CONFIG_PUBLIC StormByte::Shared<ReadHook> MakeReadHook(ReadHookFunction function);
 
    STORMBYTE_CONFIG_PUBLIC StormByte::Shared<FailureHook> MakeFailureHook(FailureHookFunction function);
}