7cc5c4f330d47060/geode
1
0
Fork 0
mirror of https://github.com/geode-sdk/geode.git synced 2024-11-26 17:36:05 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

finish Promise

Browse source
This commit is contained in:
HJfod 2024-02-26 18:27:33 +02:00
parent 463cebf0c4
commit 456c1895be
1 changed files with 137 additions and 81 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

218
loader/include/Geode/utils/Promise.hpp
View file

@ -9,9 +9,26 @@ namespace geode {
struct DefaultProgress {
std::string message;
std::optional<uint8_t> percentage;
DefaultProgress() = default;
DefaultProgress(auto msg) : message(msg) {}
DefaultProgress(auto msg, uint8_t percentage) : message(msg), percentage(percentage) {}
};
}
class PromiseCancellationToken final {
private:
std::shared_ptr<std::atomic_bool> token = std::make_shared<std::atomic_bool>(false);
template <class T, class E, class P>
friend class Promise;
public:
inline operator bool() {
return *token;
}
};
template <class T = impl::DefaultValue, class E = impl::DefaultError, class P = impl::DefaultProgress>
class PromiseEventFilter;
@ -29,82 +46,57 @@ namespace geode {
using Expect = utils::MiniFunction<void(E)>;
using Progress = utils::MiniFunction<void(P)>;
using Finally = utils::MiniFunction<void()>;
using SimpleExecutor = utils::MiniFunction<void(
Then resolve,
Expect reject
)>;
using Executor = utils::MiniFunction<void(
Then resolve,
Expect reject,
Progress progress,
PromiseCancellationToken cancellationToken
)>;
/**
* Create a Promise. Call the provided callbacks to notify the
* listener when the Promise is finished. Use the other constructor
* overloads to specify progress and handle cancellation. See the
* class description for general information about Promises
* overloads to specify progress and handle cancellation.
*
* @param threaded Whether the Promise should start executing in a new
* thread or not; if false, the Promise starts immediately executing in
* the current thread
*
* @note See the class description for general information about
* Promises
*/
Promise(utils::MiniFunction<void(Then resolve, Expect reject)>&& create)
: Promise([create](auto resolve, auto reject, auto, auto const&) {
create(resolve, reject);
}) {}
Promise(SimpleExecutor&& executor, bool threaded = true)
: Promise([executor](auto resolve, auto reject, auto, auto) {
executor(resolve, reject);
}, threaded) {}
/**
* Create a Promise. Call the provided callbacks to notify the
* listener when the Promise is finished. If the user cancels the
* Promise, this is reflected in the `cancelled` parameter; you can
* read from it, and if it's true, you can stop whatever you were doing
* and not call any of the other callbacks. See the class description
* for general information about Promises
* and not call any of the other callbacks.
*
* @param threaded Whether the Promise should start executing in a new
* thread or not; if false, the Promise starts immediately executing in
* the current thread
*
* @note See the class description for general information about
* Promises
*/
Promise(utils::MiniFunction<void(
Then resolve,
Expect reject,
Progress progress,
std::atomic_bool const& cancelled
)>&& create) : m_data(std::make_unique<Data>()) {
create(
[data = m_data](auto&& value) {
if (data->cancelled) return;
std::unique_lock<std::mutex> _(data->mutex);
bool handled = false;
if (data->thenHandler) {
Loader::get()->queueInMainThread([fun = std::move(data->thenHandler), v = std::move(value)] {
fun(v);
});
handled = true;
}
if (data->finallyHandler) {
Loader::get()->queueInMainThread([fun = std::move(data->finallyHandler)] {
fun();
});
handled = true;
}
if (!handled) {
data->result = Ok(std::move(value));
}
},
[data = m_data](auto&& error) {
if (data->cancelled) return;
std::unique_lock<std::mutex> _(data->mutex);
bool handled = false;
if (data->expectHandler) {
Loader::get()->queueInMainThread([fun = std::move(data->expectHandler), v = std::move(error)] {
fun(v);
});
handled = true;
}
if (data->finallyHandler) {
Loader::get()->queueInMainThread([fun = std::move(data->finallyHandler)] {
fun();
});
handled = true;
}
if (!handled) {
data->result = Err(std::move(error));
}
},
[data = m_data](auto&& p) {
if (data->cancelled) return;
std::unique_lock<std::mutex> _(data->mutex);
if (auto handler = data->progressHandler) {
handler(std::move(p));
}
},
m_data->cancelled
);
Promise(Executor&& executor, bool threaded = true) : m_data(std::make_shared<Data>()) {
if (threaded) {
std::thread([executor = std::move(executor), data = m_data]() mutable {
Promise::invoke_executor(std::move(executor), data);
}).detach();
}
else {
Promise::invoke_executor(std::move(executor), m_data);
}
}
/**
@ -112,13 +104,13 @@ namespace geode {
* listener at a time. If the Promise has already been resolved, the
* callback is immediately queued in the main thread
*/
Promise& then(Then handler) {
if (m_data->cancelled) return *this;
Promise& then(Then&& handler) {
if (m_data->cancellationToken) return *this;
std::unique_lock<std::mutex> _(m_data->mutex);
if (m_data->result.has_value()) {
auto v = std::move(m_data->result).value();
if (v.isOk()) {
Loader::get()->queueInMainThread([handler = std::move(handler), ok = std::move(v).unwrap()] {
if (v.index() == 0) {
Loader::get()->queueInMainThread([handler = std::move(handler), ok = std::move(std::get<0>(v))] {
handler(ok);
});
}
@ -133,13 +125,13 @@ namespace geode {
* listener at a time. If the Promise has already been resolved, the
* callback is immediately queued in the main thread
*/
Promise& expect(Expect handler) {
if (m_data->cancelled) return *this;
Promise& expect(Expect&& handler) {
if (m_data->cancellationToken) return *this;
std::unique_lock<std::mutex> _(m_data->mutex);
if (m_data->result.has_value()) {
auto v = std::move(m_data->result).value();
if (v.isErr()) {
Loader::get()->queueInMainThread([handler = std::move(handler), err = std::move(v).unwrapErr()] {
if (v.index() == 1) {
Loader::get()->queueInMainThread([handler = std::move(handler), err = std::move(std::get<1>(v))] {
handler(err);
});
}
@ -154,8 +146,8 @@ namespace geode {
* only be one listener at a time. If the Promise has already been
* resolved, nothing happens
*/
Promise& progress(Progress handler) {
if (m_data->cancelled) return *this;
Promise& progress(Progress&& handler) {
if (m_data->cancellationToken) return *this;
std::unique_lock<std::mutex> _(m_data->mutex);
if (!m_data->result.has_value()) {
m_data->progressHandler = handler;
@ -168,8 +160,8 @@ namespace geode {
* If the Promise has already been resolved, the callback is
* immediately queued in the main thread
*/
Promise& finally(Finally handler) {
if (m_data->cancelled) return *this;
Promise& finally(Finally&& handler) {
if (m_data->cancellationToken) return *this;
std::unique_lock<std::mutex> _(m_data->mutex);
if (m_data->result.has_value()) {
Loader::get()->queueInMainThread([handler = std::move(handler)] {
@ -191,16 +183,25 @@ namespace geode {
* cancel
*/
Promise& cancel() {
if (m_data->cancelled) return *this;
if (m_data->cancellationToken) return *this;
std::unique_lock<std::mutex> _(m_data->mutex);
m_data->thenHandler = nullptr;
m_data->expectHandler = nullptr;
m_data->progressHandler = nullptr;
m_data->finallyHandler = nullptr;
m_data->cancelled = true;
m_data->cancellationToken.token = true;
return *this;
}
/**
* Link this Promise to be cancelled alongside another Promise
*/
Promise& link(PromiseCancellationToken otherCancellationToken) {
if (m_data->cancellationToken) return *this;
m_data->cancellationToken = otherCancellationToken;
return *this;
}
/**
* Returns a filter for listening to this `Promise` through the Geode
* Events system. Useful for example for using `Promise`s on layers,
@ -218,12 +219,67 @@ namespace geode {
Expect expectHandler;
Progress progressHandler;
Finally finallyHandler;
std::optional<Result<T, E>> result;
std::atomic_bool cancelled = false;
std::optional<std::variant<T, E>> result;
PromiseCancellationToken cancellationToken;
};
// This has to be a shared_ptr so that the data can persist even after
// the future is destroyed, as well as to share it between resolve, reject, and the likes
std::shared_ptr<Data> m_data;
static void invoke_executor(Executor&& executor, std::shared_ptr<Data> data) {
executor(
[data](auto&& value) {
if (data->cancellationToken) return;
std::unique_lock<std::mutex> _(data->mutex);
bool handled = false;
if (data->thenHandler) {
Loader::get()->queueInMainThread([fun = std::move(data->thenHandler), v = std::move(value)] {
fun(v);
});
handled = true;
}
if (data->finallyHandler) {
Loader::get()->queueInMainThread([fun = std::move(data->finallyHandler)] {
fun();
});
handled = true;
}
if (!handled) {
data->result = std::variant<T, E>(std::in_place_index<0>, std::move(value));
}
},
[data](auto&& error) {
if (data->cancellationToken) return;
std::unique_lock<std::mutex> _(data->mutex);
bool handled = false;
if (data->expectHandler) {
Loader::get()->queueInMainThread([fun = std::move(data->expectHandler), v = std::move(error)] {
fun(v);
});
handled = true;
}
if (data->finallyHandler) {
Loader::get()->queueInMainThread([fun = std::move(data->finallyHandler)] {
fun();
});
handled = true;
}
if (!handled) {
data->result = std::variant<T, E>(std::in_place_index<1>, std::move(error));
}
},
[data](auto&& p) {
if (data->cancellationToken) return;
std::unique_lock<std::mutex> _(data->mutex);
if (auto handler = data->progressHandler) {
Loader::get()->queueInMainThread([p = std::move(p), handler]() mutable {
handler(std::move(p));
});
}
},
data->cancellationToken
);
}
};
/**