StopToken.h

Go to the documentation of this file.

//-
// =============================================================================
// Copyright 2024 Autodesk, Inc. All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license
// agreement provided at the time of installation or download, or which
// otherwise accompanies this software in either electronic or hard copy form.
// =============================================================================
 
//+
 
 
#ifndef AMINO_CORE_STOP_TOKEN_H
#define AMINO_CORE_STOP_TOKEN_H
 
#include <Amino/Core/CoreExport.h>
 
#include <Amino/Core/StopTokenFwd.h>
 
#include <Amino/Core/internal/PImpl.h>
#include <Amino/Core/internal/StopCallbackDetails.h>
 
#define AMINO_API AMINO_CORE_SHARED_DECL
namespace Amino {
 
//=============================================================================
// CLASS NoStopState_t
//=============================================================================
 
struct NoStopState_t {
    explicit NoStopState_t() = default;
};
 
//=============================================================================
// CLASS StopToken
//=============================================================================
 
class StopToken {
public:
    AMINO_API StopToken() noexcept;
 
    AMINO_API StopToken(StopToken&& o) noexcept;
 
    AMINO_API StopToken(StopToken const& o);
 
    AMINO_API ~StopToken();
 
    AMINO_API StopToken& operator=(StopToken&& o) noexcept;
 
    AMINO_API StopToken& operator=(StopToken const& o);
 
    friend bool operator==(StopToken const& lhs, StopToken const& rhs) {
        return lhs.internal_equals(rhs);
    }
    friend bool operator!=(StopToken const& lhs, StopToken const& rhs) {
        return !lhs.internal_equals(rhs);
    }
 
    AMINO_API bool stopRequested() const;
 
    AMINO_API bool stopPossible() const;
 
private:
 
    AMINO_API bool internal_equals(StopToken const& o) const;
 
    Internal::PImpl<StopToken, 1> m_impl;
 
};
 
//=============================================================================
// CLASS StopSource
//=============================================================================
 
class StopSource {
public:
    AMINO_API StopSource();
 
    AMINO_API explicit StopSource(NoStopState_t) noexcept;
 
    AMINO_API StopSource(StopSource&& o) noexcept;
 
    AMINO_API StopSource(StopSource const& o);
 
    AMINO_API ~StopSource();
 
    AMINO_API StopSource& operator=(StopSource&& o) noexcept;
 
    AMINO_API StopSource& operator=(StopSource const& o);
 
    friend bool operator==(StopSource const& lhs, StopSource const& rhs) {
        return lhs.internal_equals(rhs);
    }
    friend bool operator!=(StopSource const& lhs, StopSource const& rhs) {
        return !lhs.internal_equals(rhs);
    }
 
    AMINO_API StopToken getToken() const noexcept;
 
    AMINO_API void requestStop() noexcept;
 
    AMINO_API bool stopRequested() const;
 
    AMINO_API bool stopPossible() const;
 
private:
 
    AMINO_API bool internal_equals(StopSource const& o) const;
 
    Internal::PImpl<StopSource, 1> m_impl;
 
};
 
//==============================================================================
// CLASS StopCallback
//==============================================================================
 
template <typename Callback>
class StopCallback : private Internal::StopCallbackImpl<Callback> {
public:
    template <typename C>
    StopCallback(StopToken const& token, C&& cb)
        : Internal::StopCallbackImpl<Callback>{token, std::forward<C>(cb)} {}
 
    template <typename C>
    StopCallback(StopToken&& token, C&& cb)
        : Internal::StopCallbackImpl<Callback>{
              std::move(token), std::forward<C>(cb)} {}
 
    StopCallback(StopCallback const&)                = delete;
    StopCallback(StopCallback&&) noexcept            = delete;
    StopCallback& operator=(StopCallback const&)     = delete;
    StopCallback& operator=(StopCallback&&) noexcept = delete;
 
    ~StopCallback() = default;
};
 
//------------------------------------------------------------------------------
//
template <typename Callback>
StopCallback(StopToken const&, Callback) -> StopCallback<Callback>;
template <typename Callback>
StopCallback(StopToken&&, Callback) -> StopCallback<Callback>;
 
} // namespace Amino
#undef AMINO_API
 
#endif