progress_bar.h

Go to the documentation of this file.

/*
Copyright (C) 2025 The University of Notre Dame
This software is distributed under the GNU General Public License.
See the file COPYING for details.
*/
 
#ifndef PROGRESS_BAR_H
#define PROGRESS_BAR_H
 
#include "list.h"
#include "timestamp.h"
#include <time.h>
#include <stdint.h>
 
struct ProgressBarPart {
        char *label;
        uint64_t total;
        uint64_t current;
};
 
struct ProgressBar {
    /* User-facing interval in seconds; internal comparisons use *_us. */
    double update_interval_sec;
    char *label;
    struct list *parts;
    /* Timestamps in microseconds. */
    timestamp_t start_time_us;
    timestamp_t last_draw_time_us;
    timestamp_t update_interval_us;
    int has_drawn_once;
};
 
/* Progress Bar Part API */
 
struct ProgressBar *progress_bar_init(const char *label);
 
void progress_bar_set_update_interval(struct ProgressBar *bar, double update_interval_sec);
 
struct ProgressBarPart *progress_bar_create_part(const char *label, uint64_t total);
 
void progress_bar_bind_part(struct ProgressBar *bar, struct ProgressBarPart *part);
 
void progress_bar_set_part_total(struct ProgressBar *bar, struct ProgressBarPart *part, uint64_t new_total);
 
void progress_bar_update_part(struct ProgressBar *bar, struct ProgressBarPart *part, uint64_t increment);
 
void progress_bar_set_start_time(struct ProgressBar *bar, timestamp_t start_time);
 
void progress_bar_finish(struct ProgressBar *bar);
 
void progress_bar_delete(struct ProgressBar *bar);
 
#endif