task.h

Go to the documentation of this file.

#pragma once

 
// allow-include-after-namespace
 
#include "fl/stl/functional.h"  // IWYU pragma: keep
#include "fl/stl/string.h"
#include "fl/system/trace.h"
#include "fl/task/promise.h"  // IWYU pragma: keep
#include "fl/stl/shared_ptr.h"
#include "fl/stl/cstddef.h"
#include "fl/stl/noexcept.h"
 
namespace fl {
namespace task {
 
enum class TaskType {
    kEveryMs,
    kAtFramerate,
    kBeforeFrame,
    kAfterFrame,
    kCoroutine
};
 
// Forward declarations
class ITaskImpl;
class Coroutine;  // IWYU pragma: keep

struct CoroutineConfig {
    optional<TracePoint> trace;  // where this object was created, optional.
    function<void()> func;
    string name = "task";
    size_t stack_size = 4096;
    u8 priority = 5;
    optional<int> core_id;  
};

class Handle {
public:
 
    // Default constructor
    Handle() FL_NOEXCEPT = default;
 
    // Copy and Move semantics (now possible with shared_ptr)
    Handle(const Handle&) FL_NOEXCEPT = default;
    Handle& operator=(const Handle&) FL_NOEXCEPT = default;
    Handle(Handle&&) FL_NOEXCEPT = default;
    Handle& operator=(Handle&&) FL_NOEXCEPT = default;
 
    // Constructor from impl - public because ITaskImpl is only forward-declared
    // in the header, making this effectively private to external consumers
    explicit Handle(shared_ptr<ITaskImpl> impl) FL_NOEXCEPT;
 
    // Fluent API
    Handle& then(function<void()> on_then) FL_NOEXCEPT;
    Handle& catch_(function<void(const Error&)> on_catch) FL_NOEXCEPT;
    Handle& cancel() FL_NOEXCEPT;
 
    // Getters
    int id() const FL_NOEXCEPT;
    bool has_then() const FL_NOEXCEPT;
    bool has_catch() const FL_NOEXCEPT;
    string trace_label() const FL_NOEXCEPT;
    TaskType type() const FL_NOEXCEPT;
    int interval_ms() const FL_NOEXCEPT;
    void set_interval_ms(int interval_ms) FL_NOEXCEPT;
    u32 last_run_time() const FL_NOEXCEPT;
    void set_last_run_time(u32 time) FL_NOEXCEPT;
    bool ready_to_run(u32 current_time) const FL_NOEXCEPT;
    bool is_valid() const FL_NOEXCEPT;
    bool isCoroutine() const FL_NOEXCEPT;
 
    // Coroutine control (only valid if isCoroutine() == true)
    void stop() FL_NOEXCEPT;
    bool isRunning() const FL_NOEXCEPT;
 
private:
    friend class Scheduler;
 
    // Internal methods for Scheduler (friend access only)
    void _set_id(int id) FL_NOEXCEPT;
    int _id() const FL_NOEXCEPT;
    bool _is_canceled() const FL_NOEXCEPT;
    bool _ready_to_run(u32 current_time) const FL_NOEXCEPT;
    bool _ready_to_run_frame_task(u32 current_time) const FL_NOEXCEPT;
    void _set_last_run_time(u32 time) FL_NOEXCEPT;
    bool _has_then() const FL_NOEXCEPT;
    void _execute_then() FL_NOEXCEPT;
    void _execute_catch(const Error& error) FL_NOEXCEPT;
    TaskType _type() const FL_NOEXCEPT;
    string _trace_label() const FL_NOEXCEPT;
 
    shared_ptr<ITaskImpl> mImpl;
};
 
// Free function builders (were static methods on class fl::task)
Handle every_ms(int interval_ms) FL_NOEXCEPT;
Handle every_ms(int interval_ms, const TracePoint& trace) FL_NOEXCEPT;
 
Handle at_framerate(int fps) FL_NOEXCEPT;
Handle at_framerate(int fps, const TracePoint& trace) FL_NOEXCEPT;
 
// For most cases you want after_frame() instead of before_frame(), unless you
// are doing operations that need to happen right before the frame is rendered.
// Most of the time for ui stuff (button clicks, etc) you want after_frame(), so it
// can be available for the next iteration of loop().
Handle before_frame() FL_NOEXCEPT;
Handle before_frame(const TracePoint& trace) FL_NOEXCEPT;
 
// Example: auto t = fl::task::after_frame().then([]() {...}
Handle after_frame() FL_NOEXCEPT;
Handle after_frame(const TracePoint& trace) FL_NOEXCEPT;
// Example: auto t = fl::task::after_frame([]() {...}
Handle after_frame(function<void()> on_then) FL_NOEXCEPT;
Handle after_frame(function<void()> on_then, const TracePoint& trace) FL_NOEXCEPT;
Handle coroutine(const CoroutineConfig& config) FL_NOEXCEPT;
 
// Static coroutine control
void exit_current() FL_NOEXCEPT;

class Coroutine;  // IWYU pragma: keep
 
} // namespace task
} // namespace fl