feat: add settings api (lc-soft#191) (lc-soft#211)

BREAKING CHANGE: LCUIDisplay_EnablePaintFlashing() has been removed.

- Add API for retrieving and modifying global settings
- Utilize this API in the codebase
- Add event for when global settings are changed
- Add event handler for updating the frame rate cap
- Add event handler to notify paint flashing changes
- Add unit tests

Fixes lc-soft#192

Co-authored-by: James Duong <jduong@dremio.com>

build/windows/LCUI/LCUI.vcxproj

@@ -324,6 +324,7 @@
     <ClInclude Include="..\..\..\include\LCUI\platform\windows\windows_events.h" />
     <ClInclude Include="..\..\..\include\LCUI\platform\windows\windows_keyboard.h" />
     <ClInclude Include="..\..\..\include\LCUI\platform\windows\windows_mouse.h" />
+    <ClInclude Include="..\..\..\include\LCUI\settings.h" />
     <ClInclude Include="..\..\..\include\LCUI\surface.h" />
     <ClInclude Include="..\..\..\include\LCUI\thread.h" />
     <ClInclude Include="..\..\..\include\LCUI\timer.h" />
@@ -423,6 +424,7 @@
     <ClCompile Include="..\..\..\src\platform\windows\windows_ime.c" />
     <ClCompile Include="..\..\..\src\platform\windows\windows_keyboard.c" />
     <ClCompile Include="..\..\..\src\platform\windows\windows_mouse.c" />
+    <ClCompile Include="..\..\..\src\settings.c" />
     <ClCompile Include="..\..\..\src\util\charset.c" />
     <ClCompile Include="..\..\..\src\util\object.c" />
     <ClCompile Include="..\..\..\src\util\strlist.c" />

build/windows/LCUI/LCUI.vcxproj.filters

@@ -123,6 +123,9 @@
     <ClInclude Include="..\..\..\include\LCUI\thread.h">
       <Filter>头文件\LCUI</Filter>
     </ClInclude>
+    <ClInclude Include="..\..\..\include\LCUI\settings.h">
+      <Filter>头文件\LCUI</Filter>
+    </ClInclude>
     <ClInclude Include="..\..\..\include\LCUI\surface.h">
       <Filter>头文件\LCUI</Filter>
     </ClInclude>
@@ -440,6 +443,9 @@
     <ClCompile Include="..\..\..\src\display.c">
       <Filter>源文件</Filter>
     </ClCompile>
+    <ClCompile Include="..\..\..\src\settings.c">
+      <Filter>源文件</Filter>
+    </ClCompile>
     <ClCompile Include="..\..\..\src\timer.c">
       <Filter>源文件</Filter>
     </ClCompile>

build/windows/LCUITest/LCUITest.vcxproj

@@ -193,6 +193,7 @@
     <ClCompile Include="..\..\..\test\test_image_reader.c" />
     <ClCompile Include="..\..\..\test\test_linkedlist.c" />
     <ClCompile Include="..\..\..\test\test_object.c" />
+    <ClCompile Include="..\..\..\test\test_settings.c" />
     <ClCompile Include="..\..\..\test\test_string.c" />
     <ClCompile Include="..\..\..\test\test_strpool.c" />
     <ClCompile Include="..\..\..\test\test_textedit.c" />

build/windows/LCUITest/LCUITest.vcxproj.filters

@@ -21,6 +21,9 @@
     <ClCompile Include="..\..\..\test\test.c">
       <Filter>源文件</Filter>
     </ClCompile>
+    <ClCompile Include="..\..\..\test\test_settings.c">
+      <Filter>源文件</Filter>
+    </ClCompile>
     <ClCompile Include="..\..\..\test\test_string.c">
       <Filter>源文件</Filter>
     </ClCompile>

build/windows/LCUIUWP/LCUIUWP.vcxproj

@@ -69,6 +69,7 @@
     <ClInclude Include="..\..\..\include\LCUI\main.h" />
     <ClInclude Include="..\..\..\include\LCUI\painter.h" />
     <ClInclude Include="..\..\..\include\LCUI\platform.h" />
+    <ClInclude Include="..\..\..\include\LCUI\settings.h" />
     <ClInclude Include="..\..\..\include\LCUI\surface.h" />
     <ClInclude Include="..\..\..\include\LCUI\thread.h" />
     <ClInclude Include="..\..\..\include\LCUI\timer.h" />
@@ -162,6 +163,7 @@
     <ClCompile Include="..\..\..\src\keyboard.c" />
     <ClCompile Include="..\..\..\src\main.c" />
     <ClCompile Include="..\..\..\src\painter.c" />
+    <ClCompile Include="..\..\..\src\settings.c" />
     <ClCompile Include="..\..\..\src\thread\win32\cond.c" />
     <ClCompile Include="..\..\..\src\thread\win32\mutex.c" />
     <ClCompile Include="..\..\..\src\thread\win32\thread.c">

build/windows/LCUIUWP/LCUIUWP.vcxproj.filters

@@ -111,6 +111,9 @@
     <ClInclude Include="..\..\..\include\LCUI\thread.h">
       <Filter>头文件\LCUI</Filter>
     </ClInclude>
+    <ClInclude Include="..\..\..\include\LCUI\settings.h">
+      <Filter>头文件\LCUI</Filter>
+    </ClInclude>
     <ClInclude Include="..\..\..\include\LCUI\surface.h">
       <Filter>头文件\LCUI</Filter>
     </ClInclude>
@@ -377,6 +380,9 @@
     <ClCompile Include="..\..\..\src\display.c">
       <Filter>源文件</Filter>
     </ClCompile>
+    <ClCompile Include="..\..\..\src\settings.c">
+      <Filter>源文件</Filter>
+    </ClCompile>
     <ClCompile Include="..\..\..\src\timer.c">
       <Filter>源文件</Filter>
     </ClCompile>

include/LCUI/Makefile.am

@@ -4,7 +4,7 @@ SUBDIRS=font draw gui util
 # Headers which are installed to support the library
 INSTINCLUDES=LCUI.h types.h painter.h display.h graph.h draw.h \
 font.h surface.h ime.h input.h thread.h util.h timer.h main.h cursor.h \
-image.h worker.h
+image.h settings.h worker.h
 EXTRA_DIST=platform.h \
 platform/linux/linux_display.h \
 platform/linux/linux_events.h \

include/LCUI/display.h

@@ -116,9 +116,7 @@ LCUI_API size_t LCUIDisplay_Render(void);
 /** 呈现渲染后的内容 */
 LCUI_API void LCUIDisplay_Present(void);
 
-LCUI_API void LCUIDisplay_EnablePaintFlashing(LCUI_BOOL enable);
-
-    /** 设置显示区域的尺寸，仅在窗口化、全屏模式下有效 */
+/** 设置显示区域的尺寸，仅在窗口化、全屏模式下有效 */
 LCUI_API void LCUIDisplay_SetSize(int width, int height);
 
 /** 获取屏幕宽度 */

include/LCUI/main.h

@@ -53,6 +53,7 @@ enum LCUI_SysEventType {
 	LCUI_PAINT,
 	LCUI_WIDGET,
 	LCUI_QUIT, /**< 在 LCUI 退出前触发的事件 */
+	LCUI_SETTINGS_CHANGE,
 	LCUI_USER = 100 /**< 用户事件，可以把这个当成系统事件与用户事件的分界 */
 };
 
@@ -203,7 +204,7 @@ LCUI_API void LCUI_RunFrame(void);
 
 LCUI_API void LCUI_RunFrameWithProfile(LCUI_FrameProfile profile);
 
-    /* 新建一个主循环 */
+/* 新建一个主循环 */
 LCUI_API LCUI_MainLoop LCUIMainLoop_New(void);
 
 /* 运行目标循环 */

include/LCUI/settings.h

@@ -0,0 +1,55 @@
+/*
+ * settings.h -- Functions for accessing and modifying global settings.
+ *
+ * Copyright (c) 2020, James Duong <duong.james@gmail.com> All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ *   * Redistributions of source code must retain the above copyright notice,
+ *     this list of conditions and the following disclaimer.
+ *   * Redistributions in binary form must reproduce the above copyright
+ *     notice, this list of conditions and the following disclaimer in the
+ *     documentation and/or other materials provided with the distribution.
+ *   * Neither the name of LCUI nor the names of its contributors may be used
+ *     to endorse or promote products derived from this software without
+ *     specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef LCUI_SETTINGS_H
+#define LCUI_SETTINGS_H
+
+LCUI_BEGIN_HEADER
+
+typedef struct LCUI_SettingsRec_ {
+	int frame_rate_cap;
+	int parallel_rendering_threads;
+	LCUI_BOOL record_profile;
+	LCUI_BOOL fps_meter;
+	LCUI_BOOL paint_flashing;
+} LCUI_SettingsRec, *LCUI_Settings;
+
+/* Initialize settings with the current global settings. */
+LCUI_API void Settings_Init(LCUI_Settings settings);
+
+/* Update global settings with the given input. */
+LCUI_API void LCUI_ApplySettings(LCUI_Settings settings);
+
+/* Reset global settings to their defaults. */
+LCUI_API void LCUI_ResetSettings(void);
+
+LCUI_END_HEADER
+
+#endif

src/Makefile.am

@@ -2,7 +2,7 @@ AUTOMAKE_OPTIONS=foreign
 AM_CFLAGS = -I$(abs_top_srcdir)/include $(CODE_COVERAGE_CFLAGS)
 
 LCUI_LDFLAGS = -version-info 2:0:0
-LCUI_SOURCES = graph.c ime.c cursor.c worker.c main.c timer.c painter.c display.c keyboard.c
+LCUI_SOURCES = graph.c ime.c cursor.c worker.c main.c timer.c painter.c display.c keyboard.c settings.c
 LCUI_LIBADD = thread/libthread.la util/libutil.la platform/libplatform.la \
 image/libimage.la draw/libdraw.la gui/libgui.la font/libfont.la \
 font/in-core/libfont_incore.la $(PACKAGE_LIBS)

src/display.c

@@ -44,6 +44,8 @@
 #include <LCUI/thread.h>
 #include <LCUI/display.h>
 #include <LCUI/platform.h>
+#include <LCUI/settings.h>
+#include <LCUI/main.h>
 #ifdef LCUI_DISPLAY_H
 #include LCUI_DISPLAY_H
 #endif
@@ -53,16 +55,6 @@
 #define DEFAULT_WIDTH	800
 #define DEFAULT_HEIGHT	600
 
-#ifdef USE_OPENMP
-/**
- * Parallel rendering threads
- * We recommend that you set it to half the number of CPU logical cores
- */
-#define PARALLEL_RENDERING_THREADS 4
-#else
-#define PARALLEL_RENDERING_THREADS 1
-#endif
-
 typedef struct FlashRectRec_ {
 	int64_t paint_time;
 	LCUI_Rect rect;
@@ -85,11 +77,12 @@ typedef struct SurfaceRecordRec_ {
 static struct LCUI_DisplayModule {
 	unsigned width, height;
 	LCUI_BOOL active;
-	LCUI_BOOL enable_paint_flashing;
 	LCUI_DisplayMode mode;
 	LinkedList surfaces;
 	LinkedList rects;
 	LCUI_DisplayDriver driver;
+	LCUI_SettingsRec settings;
+	int settings_change_handler_id;
 } display;
 
 /* clang-format on */
@@ -113,8 +106,13 @@ static void OnDestroySurfaceRecord(void *data)
 	free(record);
 }
 
+static void OnSettingsChangeEvent(LCUI_SysEvent e, void *arg)
+{
+	Settings_Init(&display.settings);
+}
+
 static size_t LCUIDisplay_RenderFlashRect(SurfaceRecord record,
-					FlashRect flash_rect)
+					  FlashRect flash_rect)
 {
 	size_t count;
 	int64_t period;
@@ -202,7 +200,8 @@ static void GetRenderingLayerSize(int *width, int *height)
 
 	*width = (int)(LCUIDisplay_GetWidth() * scale);
 	*height = (int)(LCUIDisplay_GetHeight() * scale);
-	*height = max(200, *height / PARALLEL_RENDERING_THREADS + 1);
+	*height =
+	    max(200, *height / display.settings.parallel_rendering_threads + 1);
 }
 
 static void SurfaceRecord_DumpRects(SurfaceRecord record, LinkedList *rects)
@@ -221,12 +220,14 @@ static void SurfaceRecord_DumpRects(SurfaceRecord record, LinkedList *rects)
 	LCUI_Rect rect;
 	LCUI_Rect *sub_rect;
 	DirtyLayer layer;
-	DirtyLayerRec layers[PARALLEL_RENDERING_THREADS];
+	DirtyLayerRec *layers;
 	LinkedListNode *node;
 
 	GetRenderingLayerSize(&layer_width, &layer_height);
 	max_dirty = (int)(0.8 * layer_width * layer_height);
-	for (i = 0; i < PARALLEL_RENDERING_THREADS; ++i) {
+	layers = malloc(sizeof(DirtyLayerRec) *
+			display.settings.parallel_rendering_threads);
+	for (i = 0; i < display.settings.parallel_rendering_threads; ++i) {
 		layer = &layers[i];
 		layer->diry = 0;
 		layer->rect.y = i * layer_height;
@@ -238,7 +239,8 @@ static void SurfaceRecord_DumpRects(SurfaceRecord record, LinkedList *rects)
 	sub_rect = malloc(sizeof(LCUI_Rect));
 	for (LinkedList_Each(node, &record->rects)) {
 		rect = *(LCUI_Rect *)node->data;
-		for (i = 0; i < PARALLEL_RENDERING_THREADS; ++i) {
+		for (i = 0; i < display.settings.parallel_rendering_threads;
+		     ++i) {
 			layer = &layers[i];
 			if (layer->diry >= max_dirty) {
 				continue;
@@ -257,7 +259,7 @@ static void SurfaceRecord_DumpRects(SurfaceRecord record, LinkedList *rects)
 			}
 		}
 	}
-	for (i = 0; i < PARALLEL_RENDERING_THREADS; ++i) {
+	for (i = 0; i < display.settings.parallel_rendering_threads; ++i) {
 		layer = &layers[i];
 		if (layer->diry >= max_dirty) {
 			RectList_AddEx(rects, &layer->rect, FALSE);
@@ -268,6 +270,7 @@ static void SurfaceRecord_DumpRects(SurfaceRecord record, LinkedList *rects)
 	}
 	RectList_Clear(&record->rects);
 	free(sub_rect);
+	free(layers);
 }
 
 static size_t LCUIDisplay_RenderSurfaceRect(SurfaceRecord record,
@@ -288,7 +291,7 @@ static size_t LCUIDisplay_RenderSurfaceRect(SurfaceRecord record,
 		  omp_get_num_threads(), paint->rect.x, paint->rect.y,
 		  paint->rect.width, paint->rect.height);
 	count = Widget_Render(record->widget, paint);
-	if (display.enable_paint_flashing) {
+	if (display.settings.paint_flashing) {
 		LCUIDisplay_AppendFlashRects(record, &paint->rect);
 	}
 	if (display.mode != LCUI_DMODE_SEAMLESS) {
@@ -622,11 +625,6 @@ int LCUIDisplay_GetMode(void)
 	return display.mode;
 }
 
-void LCUIDisplay_EnablePaintFlashing(LCUI_BOOL enable)
-{
-	display.enable_paint_flashing = enable;
-}
-
 /** 设置显示区域的尺寸，仅在窗口化、全屏模式下有效 */
 void LCUIDisplay_SetSize(int width, int height)
 {
@@ -948,6 +946,10 @@ int LCUI_InitDisplay(LCUI_DisplayDriver driver)
 	display.active = TRUE;
 	display.width = DEFAULT_WIDTH;
 	display.height = DEFAULT_HEIGHT;
+	Settings_Init(&display.settings);
+	display.settings_change_handler_id = LCUI_BindEvent(
+	    LCUI_SETTINGS_CHANGE, OnSettingsChangeEvent, NULL, NULL);
+
 	LinkedList_Init(&display.rects);
 	LinkedList_Init(&display.surfaces);
 	if (!display.driver) {
@@ -984,5 +986,7 @@ int LCUI_FreeDisplay(void)
 	if (display.driver) {
 		LCUI_DestroyDisplayDriver(display.driver);
 	}
+	LCUI_UnbindEvent(display.settings_change_handler_id);
+	display.settings_change_handler_id = -1;
 	return 0;
 }