progress_info.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2022, 2025 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense

 
#ifndef __UTILS_PROGRESS_INFO_H__
#define __UTILS_PROGRESS_INFO_H__
 
#include <atomic>
#include <mutex>
#include <string>
#include <utility>
 
#include "utils/debug.h"


class ProgressInfo
{
 
public:
  enum Status
  {
    PENDING_START,
    PENDING_CANCELLATION,
    RUNNING,
    COMPLETED,
  };
 
  enum CompletionType
  {
    CANCELLED,
    HAS_WARNING,
    HAS_ERROR,
    SUCCESS,
  };
 
  Status get_status () const { return status_; };
 
  CompletionType get_completion_type () const
  {
    z_return_val_if_fail (status_ == COMPLETED, HAS_ERROR);
    return completion_type_;
  }

  void request_cancellation ();

  void mark_completed (CompletionType type, const utils::Utf8String &msg);

  utils::Utf8String get_message () const { return completion_str_; }

  std::tuple<double, utils::Utf8String> get_progress ()
  {
    std::scoped_lock guard (m_);
 
    return std::make_tuple (progress_, progress_str_);
  }

  void update_progress (double progress, const utils::Utf8String &msg);
 
  bool pending_cancellation () const
  {
    return status_ == PENDING_CANCELLATION;
  };
 
private:
  double progress_{};

  Status status_{};

  CompletionType completion_type_{};

  utils::Utf8String completion_str_;

  utils::Utf8String progress_str_;

  // utils::Utf8String label_done_str;

  std::mutex m_;
};

 
#endif