gmio/src/gmio_core/task_control.c

#include "task_control.h"

#include <math.h>
#include <string.h>

/*! \var gmio_bool_t (*gmio_task_control::handle_progress_func)(void*, uint8_t)
 *
 *  Frequent example of hook functions is update of a UI progress bar
 *
 *  The return value is important : it is used as an interruption request status. If GMIO_TRUE then
 *  the current task can continue, otherwise it should abort as soon as possible.
 */


/*! \details Basically the same as :
 *  \code
 *    ctrl->handle_progress_func(ctrl->cookie, progress_pc)
 *  \endcode
 */
gmio_bool_t gmio_task_control_handle_progress(gmio_task_control_t* ctrl, uint8_t progress_pc)
{
  if (ctrl != NULL && ctrl->handle_progress_func != NULL)
    return ctrl->handle_progress_func(ctrl->cookie, progress_pc);
  return 1;
}

/*! \details \p value is assumed to be relative to the interval (range) defined by
 * [ \p range_min , \p range_max ]
 */
uint8_t gmio_percentage(size_t range_min, size_t range_max, size_t value)
{
  if (value >= range_max)
    return 100;
  else if (value <= range_min)
    return 0;
  else if (range_min < range_max)
    return (value * 100) / (range_max - range_min);
  return 0;
}