lvgl/lv_objx/lv_bar.c

/**
 * @file lv_bar.c
 * 
 */

/*********************
 *      INCLUDES
 *********************/
#include "lv_conf.h"
#if USE_LV_BAR != 0

#include <lvgl/lv_objx/lv_bar.h>
#include "../lv_draw/lv_draw.h"
#include <stdio.h>

/*********************
 *      DEFINES
 *********************/
#define LV_BAR_TXT_MAX_LENGTH	64
#define LV_BAR_DEF_FORMAT	"%d %%"
#define LV_BAR_DEF_WIDTH     (LV_DPI * 2)
#define LV_BAR_DEF_HEIGHT    (LV_DPI / 2)

/**********************
 *      TYPEDEFS
 **********************/

/**********************
 *  STATIC PROTOTYPES
 **********************/
static bool lv_bar_design(lv_obj_t * bar, const area_t * mask, lv_design_mode_t mode);

/**********************
 *  STATIC VARIABLES
 **********************/
static lv_design_f_t ancestor_design_f;

/**********************
 *      MACROS
 **********************/

/**********************
 *   GLOBAL FUNCTIONS
 **********************/

/*----------------- 
 * Create function
 *-----------------*/

/**
 * Create a bar objects
 * @param par pointer to an object, it will be the parent of the new bar
 * @param copy pointer to a bar object, if not NULL then the new object will be copied from it
 * @return pointer to the created bar
 */
lv_obj_t * lv_bar_create(lv_obj_t * par, lv_obj_t * copy)
{
    /*Create the ancestor basic object*/
    lv_obj_t * new_bar = lv_rect_create(par, copy);
    dm_assert(new_bar);

    /*Allocate the object type specific extended data*/
    lv_bar_ext_t * ext = lv_obj_alloc_ext(new_bar, sizeof(lv_bar_ext_t));
    dm_assert(ext);
    ext->min_value = 0;
    ext->max_value = 100;
    ext->act_value = 0;
    ext->format_str = NULL;
    ext->label = NULL;
    ext->style_indic = lv_style_get(LV_STYLE_PRETTY_COLOR, NULL);

    /* Save the rectangle design function.
     * It will be used in the bar design function*/
    if(ancestor_design_f == NULL) ancestor_design_f = lv_obj_get_design_f(new_bar);

    lv_obj_set_signal_f(new_bar, lv_bar_signal);
    lv_obj_set_design_f(new_bar, lv_bar_design);

    /*Init the new  bar object*/
    if(copy == NULL) {


    	ext->format_str = dm_alloc(strlen(LV_BAR_DEF_FORMAT) + 1);
    	strcpy(ext->format_str, LV_BAR_DEF_FORMAT);

    	ext->label = lv_label_create(new_bar, NULL);

    	lv_rect_set_layout(new_bar, LV_RECT_LAYOUT_CENTER);
        lv_obj_set_click(new_bar, false);
    	lv_obj_set_size(new_bar, LV_BAR_DEF_WIDTH, LV_BAR_DEF_HEIGHT);
        lv_obj_set_style(new_bar, lv_style_get(LV_STYLE_PRETTY, NULL));

    	lv_bar_set_value(new_bar, ext->act_value);
    } else {
    	lv_bar_ext_t * ext_copy = lv_obj_get_ext(copy);
    	ext->format_str = dm_alloc(strlen(ext_copy->format_str) + 1);
		strcpy(ext->format_str, ext_copy->format_str);
		ext->min_value = ext_copy->min_value;
		ext->max_value = ext_copy->max_value;
		ext->act_value = ext_copy->act_value;
        ext->style_indic = ext_copy->style_indic;
        ext->label = lv_label_create(new_bar, ext_copy->label);
        /*Refresh the style with new signal function*/
        lv_obj_refr_style(new_bar);

        lv_bar_set_value(new_bar, ext->act_value);
    }
    return new_bar;
}

/**
 * Signal function of the bar
 * @param bar pointer to a bar object
 * @param sign a signal type from lv_signal_t enum
 * @param param pointer to a signal specific variable
 */
bool lv_bar_signal(lv_obj_t * bar, lv_signal_t sign, void * param)
{
    bool valid;

    /* Include the ancient signal function */
    valid = lv_rect_signal(bar, sign, param);

    /* The object can be deleted so check its validity and then
     * make the object specific signal handling */
    if(valid != false) {
    	lv_bar_ext_t * ext = lv_obj_get_ext(bar);
        lv_style_t * style = lv_obj_get_style(bar);

    	switch(sign) {
            case LV_SIGNAL_CLEANUP:
                dm_free(ext->format_str);
                ext->format_str = NULL;
                break;
            case LV_SIGNAL_STYLE_CHG:
                lv_obj_set_style(ext->label, style);
                break;
            default:
                break;
    	    }
    }

    return valid;
}

/*=====================
 * Setter functions
 *====================*/

/**
 * Set a new value on the bar
 * @param bar pointer to a bar object
 * @param value new value
 */
void lv_bar_set_value(lv_obj_t * bar, int16_t value)
{
	lv_bar_ext_t * ext = lv_obj_get_ext(bar);
	ext->act_value = value > ext->max_value ? ext->max_value : value;
    ext->act_value = ext->act_value < ext->min_value ? ext->min_value : ext->act_value;

	char buf[LV_BAR_TXT_MAX_LENGTH];
	sprintf(buf, ext->format_str, ext->act_value);
	lv_label_set_text(ext->label, buf);

	lv_obj_inv(bar);
}

/**
 * Set minimum and the maximum values of a  bar
 * @param bar pointer to he bar object
 * @param min minimum value
 * @param max maximum value
 */
void lv_bar_set_range(lv_obj_t * bar, int16_t min, int16_t max)
{
	lv_bar_ext_t * ext = lv_obj_get_ext(bar);
	ext->max_value = max;
	ext->max_value = max;
	if(ext->act_value > max) {
		ext->act_value = max;
		lv_bar_set_value(bar, ext->act_value);
	}
	lv_obj_inv(bar);
}

/**
 * Set format string for the label of the bar
 * @param bar pointer to bar object
 * @param format a printf-like format string with one number (e.g. "Loading (%d)")
 */
void lv_bar_set_format_str(lv_obj_t * bar, const char * format)
{
	lv_bar_ext_t * ext = lv_obj_get_ext(bar);
	dm_free(ext->format_str);
	ext->format_str = dm_alloc(strlen(format) + 1);
	strcpy(ext->format_str, format);
	lv_bar_set_value(bar, ext->act_value);
}

/**
 * Set the style of bar indicator
 * @param bar pointer to a bar obeject
 * @param style pointer to a style
 */
void lv_bar_set_style_indic(lv_obj_t * bar, lv_style_t * style)
{
    lv_bar_ext_t * ext = lv_obj_get_ext(bar);

    ext->style_indic = style;

    lv_obj_inv(bar);
}

/*=====================
 * Getter functions
 *====================*/

/**
 * Get the value of a bar
 * @param bar pointer to a bar object
 * @return the value of the bar
 */
int16_t lv_bar_get_value(lv_obj_t * bar)
{
	lv_bar_ext_t * ext = lv_obj_get_ext(bar);
	return ext->act_value;
}

/**
 * Get the style of bar indicator
 * @param bar pointer to a bar object
 * @return pointer to the bar indicator style
 */
lv_style_t * lv_bar_get_style_indic(lv_obj_t * bar)
{
    lv_bar_ext_t * ext = lv_obj_get_ext(bar);

    if(ext->style_indic == NULL) return lv_obj_get_style(bar);

    return ext->style_indic;
}

/**********************
 *   STATIC FUNCTIONS
 **********************/


/**
 * Handle the drawing related tasks of the bars
 * @param bar pointer to an object
 * @param mask the object will be drawn only in this area
 * @param mode LV_DESIGN_COVER_CHK: only check if the object fully covers the 'mask_p' area
 *                                  (return 'true' if yes)
 *             LV_DESIGN_DRAW: draw the object (always return 'true')
 *             LV_DESIGN_DRAW_POST: drawing after every children are drawn
 * @param return true/false, depends on 'mode'
 */
static bool lv_bar_design(lv_obj_t * bar, const area_t * mask, lv_design_mode_t mode)
{
	if(ancestor_design_f == NULL) return false;

    if(mode == LV_DESIGN_COVER_CHK) {
    	/*Return false if the object is not covers the mask_p area*/
    	return  ancestor_design_f(bar, mask, mode);
    } else if(mode == LV_DESIGN_DRAW_MAIN) {
		ancestor_design_f(bar, mask, mode);

		lv_bar_ext_t * ext = lv_obj_get_ext(bar);
		area_t bar_area;
		area_cpy(&bar_area, &bar->cords);

		cord_t w = lv_obj_get_width(bar);
        cord_t h = lv_obj_get_height(bar);

		if(w >= h) {
		    bar_area.x2 = (int32_t) ((int32_t)w * ext->act_value) / (ext->max_value - ext->min_value);
            bar_area.x2 += bar_area.x1;
		} else {
		    bar_area.y1 = (int32_t) ((int32_t)h * ext->act_value) / (ext->max_value - ext->min_value);
            bar_area.y1 = bar_area.y2 - bar_area.y1;
		}

		/*Draw the main bar*/
		lv_style_t * style_indic = lv_bar_get_style_indic(bar);
        lv_draw_rect(&bar_area, mask, style_indic);
    }
    return true;
}

#endif