progress_bar.h

Go to the documentation of this file.

/*
 * Copyright (C) 2019 Inria
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#ifndef PROGRESS_BAR_H
#define PROGRESS_BAR_H
 
#include <stdlib.h>
#include <inttypes.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef CONFIG_PROGRESS_BAR_LENGTH
#define CONFIG_PROGRESS_BAR_LENGTH                     (25U)
#endif
 
#ifndef CONFIG_PROGRESS_BAR_FULL_CHARACTER
#define CONFIG_PROGRESS_BAR_FULL_CHARACTER             "█"
#endif
 
#ifndef CONFIG_PROGRESS_BAR_EMPTY_CHARACTER
#define CONFIG_PROGRESS_BAR_EMPTY_CHARACTER            " "
#endif
 
#ifndef CONFIG_PROGRESS_BAR_PREFIX_CHARACTER
#define CONFIG_PROGRESS_BAR_PREFIX_CHARACTER           "|"
#endif
 
#ifndef CONFIG_PROGRESS_BAR_SUFFIX_CHARACTER
#define CONFIG_PROGRESS_BAR_SUFFIX_CHARACTER           "|"
#endif
 
#ifndef CONFIG_PROGRESS_BAR_PREFIX_MAX_LENGTH
#define CONFIG_PROGRESS_BAR_PREFIX_MAX_LENGTH          (32U)
#endif
 
#ifndef CONFIG_PROGRESS_BAR_SUFFIX_MAX_LENGTH
#define CONFIG_PROGRESS_BAR_SUFFIX_MAX_LENGTH          (32U)
#endif
 
typedef struct {
    uint8_t value;
    char prefix[CONFIG_PROGRESS_BAR_PREFIX_MAX_LENGTH];
    char suffix[CONFIG_PROGRESS_BAR_SUFFIX_MAX_LENGTH];
} progress_bar_t;
 
void progress_bar_print(char *prefix, char *suffix, uint8_t value);
 
void progress_bar_update(progress_bar_t *progress_bar);
 
void progress_bar_prepare_multi(uint8_t len);
 
void progress_bar_update_multi(progress_bar_t *progress_bar_list, uint8_t len);
 
#ifdef __cplusplus
}
#endif
 
#endif /* PROGRESS_BAR_H */