StormByte 3.0.0
C++26 foundation of the StormByte suite
Loading...
Searching...
No Matches
callback.hxx
Go to the documentation of this file.
1/*
2 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
3 *
4 * This is the base for StormByte Suite libraries.
5 *
6 * StormByte original source is dual-licensed:
7 *
8 * 1. GNU Lesser General Public License v3.0 (or later)
9 * You may redistribute and/or modify this file under the terms of the
10 * GNU Lesser General Public License as published by the Free Software
11 * Foundation, either version 3 of the License, or (at your option)
12 * any later version.
13 *
14 * 2. Commercial license
15 * Alternatively, this file may be used under the terms of a commercial
16 * license agreement with the copyright holder
17 * (David C. Manuelda <StormByte@gmail.com>).
18 *
19 * Both licenses apply only to original StormByte source in this repository.
20 * They do not cover other StormByte modules or any third-party material
21 * shipped with this repository (including everything under thirdparty/),
22 * which remains under its own license.
23 *
24 * Neither license grants any patent rights. Any patent licenses required
25 * to use this software or third-party components must be obtained separately
26 * from the patent holders.
27 *
28 * StormByte is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU Lesser General Public License for more details.
32 *
33 * You should have received a copy of the GNU Lesser General Public License
34 * version 3 along with StormByte. If not, see
35 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
36 *
37 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
38 */
39
40#pragma once
41
45
50namespace StormByte {
55 namespace Safe {
68 public:
72 using Invoke = Status (*)(void*, const String&) noexcept;
73
77 using Clone = void* (*)(const void*) noexcept;
78
82 using Release = void (*)(void*) noexcept;
83
92 Callback(void* context, Invoke invoke, Clone clone, Release release);
93
99 Callback(const Callback& other) = default;
100
107 Callback& operator=(const Callback& other) = default;
108
113 Callback(Callback&& other) noexcept;
114
120 Callback& operator=(Callback&& other) noexcept;
121
125 ~Callback() noexcept;
126
131 bool HasValue() const noexcept;
132
138 Status Call(const String& value) const noexcept;
139
140 private:
141 Detail::Owner m_owner;
142 Invoke m_invoke;
143 };
144 }
145
150 namespace Type {
154 template<>
155 struct IsMaybeSafe<Safe::Callback>: std::true_type {};
156 }
157}
~Callback() noexcept
Invoke the creator-module release callback.
void *(*)(const void *) noexcept Clone
Clone the callback context in its creator module; null reports failure.
Definition callback.hxx:77
Callback(void *context, Invoke invoke, Clone clone, Release release)
Adopt a non-null context with non-null callbacks.
void(*)(void *) noexcept Release
Release the context in its creator module exactly once.
Definition callback.hxx:82
Callback(const Callback &other)=default
Deep-copy the context through its creator-module callback.
Status Call(const String &value) const noexcept
Invoke with borrowed UTF-8 text.
bool HasValue() const noexcept
Test whether a context is held.
Callback & operator=(Callback &&other) noexcept
Release old context and transfer.
Status(*)(void *, const String &) noexcept Invoke
Invoke with owned context and borrowed text.
Definition callback.hxx:72
Callback & operator=(const Callback &other)=default
Deep-copy the context with the strong guarantee.
Callback(Callback &&other) noexcept
Transfer context; source becomes empty.
Owned UTF-8 text.
Definition string.hxx:113
Private helpers.
Owned values that cross a DLL without the caller's CRT.
Detail::Owner Owner
Public name for opaque state ownership through provider callbacks.
Definition owner.hxx:162
Status
Result of a collection operation; exceptions never leave its owner callback.
Definition owner.hxx:59
Root namespace of the StormByte suite.
Octet count. Defined in byte_size.hxx. Forwarded so Type::Numeral can name it.
Recognizes types whose DLL-boundary safety depends on documented provider requirements.
Definition safe.hxx:262
#define STORMBYTE_PUBLIC
Definition visibility.h:52