From 8754d4d8bebfcda38e6bea87f2ca5208ccf705f9 Mon Sep 17 00:00:00 2001 From: Gabor Kiss-Vamosi Date: Fri, 2 Feb 2024 19:25:20 +0100 Subject: [PATCH] refactor(image): rename align to inner_align (#5560) --- demos/benchmark/lv_demo_benchmark.c | 2 +- lvgl.h | 3 +- src/libs/barcode/lv_barcode.c | 2 +- src/{lv_api_map.h => lv_api_map_v8.h} | 8 ++-- src/lv_api_map_v9_0.h | 48 +++++++++++++++++++++++ src/widgets/image/lv_image.c | 8 ++-- src/widgets/image/lv_image.h | 4 +- tests/src/test_cases/test_snapshot.c | 2 +- tests/src/test_cases/widgets/test_image.c | 24 ++++++------ 9 files changed, 75 insertions(+), 26 deletions(-) rename src/{lv_api_map.h => lv_api_map_v8.h} (99%) create mode 100644 src/lv_api_map_v9_0.h diff --git a/demos/benchmark/lv_demo_benchmark.c b/demos/benchmark/lv_demo_benchmark.c index 1a9ed2bd7..3f9d4d255 100644 --- a/demos/benchmark/lv_demo_benchmark.c +++ b/demos/benchmark/lv_demo_benchmark.c @@ -78,7 +78,7 @@ static void moving_wallpaper_cb(void) lv_obj_t * img = lv_img_create(lv_screen_active()); lv_obj_set_size(img, lv_pct(150), lv_pct(150)); lv_image_set_src(img, &img_benchmark_cogwheel_rgb); - lv_image_set_align(img, LV_IMAGE_ALIGN_TILE); + lv_image_set_inner_align(img, LV_IMAGE_ALIGN_TILE); shake_anim(img, - lv_display_get_vertical_resolution(NULL) / 3); } diff --git a/lvgl.h b/lvgl.h index 1bde0e318..f8062e89d 100644 --- a/lvgl.h +++ b/lvgl.h @@ -115,7 +115,8 @@ extern "C" { #include "src/drivers/lv_drivers.h" -#include "src/lv_api_map.h" +#include "src/lv_api_map_v8.h" +#include "src/lv_api_map_v9_0.h" #include "src/core/lv_global.h" /********************* diff --git a/src/libs/barcode/lv_barcode.c b/src/libs/barcode/lv_barcode.c index 9ec4e14a5..3121a5293 100644 --- a/src/libs/barcode/lv_barcode.c +++ b/src/libs/barcode/lv_barcode.c @@ -188,7 +188,7 @@ static void lv_barcode_constructor(const lv_obj_class_t * class_p, lv_obj_t * ob barcode->light_color = lv_color_white(); barcode->scale = 1; barcode->direction = LV_DIR_HOR; - lv_image_set_align(obj, LV_IMAGE_ALIGN_TILE); + lv_image_set_inner_align(obj, LV_IMAGE_ALIGN_TILE); } static void lv_barcode_destructor(const lv_obj_class_t * class_p, lv_obj_t * obj) diff --git a/src/lv_api_map.h b/src/lv_api_map_v8.h similarity index 99% rename from src/lv_api_map.h rename to src/lv_api_map_v8.h index b69504a4f..dfd3c4284 100644 --- a/src/lv_api_map.h +++ b/src/lv_api_map_v8.h @@ -1,10 +1,10 @@ /** - * @file lv_api_map.h + * @file lv_api_map_v8.h * */ -#ifndef LV_API_MAP_H -#define LV_API_MAP_H +#ifndef LV_API_MAP_V8_H +#define LV_API_MAP_V8_H #ifdef __cplusplus extern "C" { @@ -263,4 +263,4 @@ static inline void lv_obj_move_background(lv_obj_t * obj) } /*extern "C"*/ #endif -#endif /*LV_API_MAP_H*/ +#endif /*LV_API_MAP_V8_H*/ diff --git a/src/lv_api_map_v9_0.h b/src/lv_api_map_v9_0.h new file mode 100644 index 000000000..0626f0da3 --- /dev/null +++ b/src/lv_api_map_v9_0.h @@ -0,0 +1,48 @@ +/** + * @file lv_api_map_v9_0.h + * + */ + +#ifndef LV_API_MAP_V9_0_H +#define LV_API_MAP_V9_0_H + +#ifdef __cplusplus +extern "C" { +#endif + +/********************* + * INCLUDES + *********************/ +#include "../lvgl.h" + +/********************* + * DEFINES + *********************/ + +/********************** + * TYPEDEFS + **********************/ + +/********************** + * GLOBAL PROTOTYPES + **********************/ + +/********************** + * MACROS + **********************/ +#define lv_image_set_align lv_image_set_inner_align +#define lv_image_get_align lv_image_get_inner_align + +/********************** + * MACROS + **********************/ + +/********************** + * DEPRECATED FUNCTIONS + **********************/ + +#ifdef __cplusplus +} /*extern "C"*/ +#endif + +#endif /*LV_API_MAP_V9_0_H*/ diff --git a/src/widgets/image/lv_image.c b/src/widgets/image/lv_image.c index 401b5bcb7..8d96435da 100644 --- a/src/widgets/image/lv_image.c +++ b/src/widgets/image/lv_image.c @@ -84,8 +84,8 @@ static const lv_property_ops_t properties[] = { }, { .id = LV_PROPERTY_IMAGE_ALIGN, - .setter = lv_image_set_align, - .getter = lv_image_get_align, + .setter = lv_image_set_inner_align, + .getter = lv_image_get_inner_align, }, }; #endif @@ -413,7 +413,7 @@ void lv_image_set_antialias(lv_obj_t * obj, bool antialias) lv_obj_invalidate(obj); } -void lv_image_set_align(lv_obj_t * obj, lv_image_align_t align) +void lv_image_set_inner_align(lv_obj_t * obj, lv_image_align_t align) { LV_ASSERT_OBJ(obj, MY_CLASS); @@ -522,7 +522,7 @@ bool lv_image_get_antialias(lv_obj_t * obj) return img->antialias ? true : false; } -lv_image_align_t lv_image_get_align(lv_obj_t * obj) +lv_image_align_t lv_image_get_inner_align(lv_obj_t * obj) { LV_ASSERT_OBJ(obj, MY_CLASS); diff --git a/src/widgets/image/lv_image.h b/src/widgets/image/lv_image.h index ee04914de..f02696d67 100644 --- a/src/widgets/image/lv_image.h +++ b/src/widgets/image/lv_image.h @@ -228,7 +228,7 @@ void lv_image_set_antialias(lv_obj_t * obj, bool antialias); * @note if image_align is `LV_IMAGE_ALIGN_STRETCH` or `LV_IMAGE_ALIGN_FIT` * rotation, scale and pivot will be overwritten and controlled internally. */ -void lv_image_set_align(lv_obj_t * obj, lv_image_align_t align); +void lv_image_set_inner_align(lv_obj_t * obj, lv_image_align_t align); /*===================== * Getter functions @@ -312,7 +312,7 @@ bool lv_image_get_antialias(lv_obj_t * obj); * @param obj pointer to an image object * @return element of @ref lv_image_align_t */ -lv_image_align_t lv_image_get_align(lv_obj_t * obj); +lv_image_align_t lv_image_get_inner_align(lv_obj_t * obj); /********************** * MACROS diff --git a/tests/src/test_cases/test_snapshot.c b/tests/src/test_cases/test_snapshot.c index 94c49fc68..6b45cc00d 100644 --- a/tests/src/test_cases/test_snapshot.c +++ b/tests/src/test_cases/test_snapshot.c @@ -49,7 +49,7 @@ void test_snapshot_take_snapshot_immidiately_after_obj_create(void) TEST_ASSERT_EQUAL_SCREENSHOT("snapshot_0.png"); lv_obj_center(img_obj); - lv_image_set_align(img_obj, LV_IMAGE_ALIGN_CENTER); + lv_image_set_inner_align(img_obj, LV_IMAGE_ALIGN_CENTER); lv_image_set_rotation(img_obj, 450); TEST_ASSERT_EQUAL_SCREENSHOT("snapshot_1.png"); diff --git a/tests/src/test_cases/widgets/test_image.c b/tests/src/test_cases/widgets/test_image.c index d90b03668..52069169d 100644 --- a/tests/src/test_cases/widgets/test_image.c +++ b/tests/src/test_cases/widgets/test_image.c @@ -184,7 +184,7 @@ void test_image_normal_align(void) img = img_create(); lv_obj_set_size(img, 200, 120); lv_obj_set_pos(img, 30 + (i % 3) * 260, 40 + (i / 3) * 150); - lv_image_set_align(img, aligns[i]); + lv_image_set_inner_align(img, aligns[i]); } TEST_ASSERT_EQUAL_SCREENSHOT("widgets/image_normal_align.png"); @@ -204,7 +204,7 @@ void test_image_normal_align_offset(void) img = img_create(); lv_obj_set_size(img, 200, 120); lv_obj_set_pos(img, 30 + (i % 3) * 260, 40 + (i / 3) * 150); - lv_image_set_align(img, aligns[i]); + lv_image_set_inner_align(img, aligns[i]); lv_image_set_offset_x(img, 15); lv_image_set_offset_y(img, 20); } @@ -229,7 +229,7 @@ void test_image_transform_align(void) lv_image_set_scale_x(img, 300); lv_image_set_scale_y(img, 200); lv_image_set_rotation(img, 200); - lv_image_set_align(img, aligns[i]); + lv_image_set_inner_align(img, aligns[i]); } TEST_ASSERT_EQUAL_SCREENSHOT("widgets/image_transform_align.png"); @@ -249,7 +249,7 @@ void test_image_transform_align_offset(void) img = img_create(); lv_obj_set_size(img, 200, 120); lv_obj_set_pos(img, 30 + (i % 3) * 260, 40 + (i / 3) * 150); - lv_image_set_align(img, aligns[i]); + lv_image_set_inner_align(img, aligns[i]); lv_image_set_offset_x(img, 15); lv_image_set_offset_y(img, 20); lv_image_set_scale_x(img, 300); @@ -275,7 +275,7 @@ void test_image_stretch(void) img = img_create(); lv_obj_set_size(img, w_array[i / 3], h_array[i % 3]); lv_obj_set_pos(img, 30 + (i % 3) * 260, 40 + (i / 3) * 150); - lv_image_set_align(img, LV_IMAGE_ALIGN_STRETCH); + lv_image_set_inner_align(img, LV_IMAGE_ALIGN_STRETCH); } TEST_ASSERT_EQUAL_SCREENSHOT("widgets/image_stretch.png"); @@ -287,29 +287,29 @@ void test_image_tile(void) img = img_create(); lv_obj_set_size(img, 350, LV_SIZE_CONTENT); - lv_image_set_align(img, LV_IMAGE_ALIGN_TILE); + lv_image_set_inner_align(img, LV_IMAGE_ALIGN_TILE); lv_obj_set_pos(img, 20, 20); img = img_create(); lv_obj_set_size(img, LV_SIZE_CONTENT, 150); - lv_image_set_align(img, LV_IMAGE_ALIGN_TILE); + lv_image_set_inner_align(img, LV_IMAGE_ALIGN_TILE); lv_obj_set_pos(img, 420, 20); img = img_create(); lv_obj_set_size(img, LV_SIZE_CONTENT, LV_SIZE_CONTENT); - lv_image_set_align(img, LV_IMAGE_ALIGN_TILE); + lv_image_set_inner_align(img, LV_IMAGE_ALIGN_TILE); lv_obj_set_pos(img, 20, 220); lv_image_set_offset_x(img, -20); lv_image_set_offset_y(img, 20); img = img_create(); lv_obj_set_size(img, 150, 150); - lv_image_set_align(img, LV_IMAGE_ALIGN_TILE); + lv_image_set_inner_align(img, LV_IMAGE_ALIGN_TILE); lv_obj_set_pos(img, 220, 220); img = img_create(); lv_obj_set_size(img, 150, 150); - lv_image_set_align(img, LV_IMAGE_ALIGN_TILE); + lv_image_set_inner_align(img, LV_IMAGE_ALIGN_TILE); lv_obj_set_pos(img, 420, 220); lv_image_set_offset_x(img, -2000); lv_image_set_offset_y(img, 2000); @@ -321,7 +321,7 @@ void test_image_ignore_transformation_settings_when_stretched(void) { lv_obj_t * img = img_create(); lv_obj_set_size(img, 200, 300); - lv_image_set_align(img, LV_IMAGE_ALIGN_STRETCH); + lv_image_set_inner_align(img, LV_IMAGE_ALIGN_STRETCH); lv_image_set_rotation(img, 100); lv_image_set_pivot(img, 200, 300); @@ -344,7 +344,7 @@ void test_image_ignore_transformation_settings_when_tiled(void) { lv_obj_t * img = img_create(); lv_obj_set_size(img, 200, 300); - lv_image_set_align(img, LV_IMAGE_ALIGN_TILE); + lv_image_set_inner_align(img, LV_IMAGE_ALIGN_TILE); lv_image_set_rotation(img, 100); lv_image_set_pivot(img, 200, 300);