cmake:bugfix generate config.h contain ; characters will be handled incorrectly

[xuxin930]

Summary

Issue

; is treated as a list separator in CMake.
when setting a configuration similar to the following,
an error will occur when generating config.h

CONFIG_LV_TXT_BREAK_CHARS " ,.;:-_)]}"

Caution

This header file is completely wrong from line 237 onwards

Reason

This is because the file(STRING) function will read the wrong .config value line.
and string(REGEX REPLACE) will also incorrectly handle lines containing ; .

Solution

I changed the reading process to parse the entire .config as a big string.
parse each line character by character.
when there is a special character ; , it is treated as a list and finally spliced.

Impact

Testing

CI build

[xuxin930]

Hi @anchao @XuNeo
please help review whether this is correct 🙏

[XuNeo]

I have tested with lvgl v9 and it works!

[acassis]

@xuxin930 nice description of a problem and its solution! Kudos!!!

[anchao]

Is there any other way? This implementation seems complex and ugly，have you tried this config in zephyr build system？

[anchao]

This issue not caused by ';' character, which should be foreach() treated close bracket ']' as a regular expression:
https://stackoverflow.com/questions/26057678/escape-characters-in-a-semicolon-separated-list-in-cmake
https://cmake.org/pipermail/cmake/2016-March/063030.html

@xuxin930 try this patch to check if there is any improvement.

diff --git a/cmake/nuttx_mkconfig.cmake b/cmake/nuttx_mkconfig.cmake
index fc040eb840..88353e2042 100644
--- a/cmake/nuttx_mkconfig.cmake
+++ b/cmake/nuttx_mkconfig.cmake
@@ -92,7 +92,11 @@ file(APPEND ${CONFIG_H}
 file(APPEND ${CONFIG_H} "#define CONFIG_BASE_DEFCONFIG \"${BASE_DEFCONFIG}\"\n")
 
 file(STRINGS ${CMAKE_BINARY_DIR}/.config ConfigContents)
+STRING(REGEX REPLACE "\\[" "__OPEN_BRACKET__" ConfigContents "${ConfigContents}")
+STRING(REGEX REPLACE "\\]" "__CLOSE_BRACKET__" ConfigContents "${ConfigContents}")
 foreach(NameAndValue ${ConfigContents})
+  STRING(REGEX REPLACE "__OPEN_BRACKET__" "[" NameAndValue "${NameAndValue}")
+  STRING(REGEX REPLACE "__CLOSE_BRACKET__" "]" NameAndValue "${NameAndValue}")
   string(REGEX REPLACE "^[ ]+" "" NameAndValue ${NameAndValue})
   string(REGEX MATCH "^CONFIG[^=]+" NAME ${NameAndValue})
   # skip BASE_DEFCONFIG here as it is handled above

[xuxin930]

This issue not caused by ';' character, which should be foreach() treated close bracket ']' as a regular expression: https://stackoverflow.com/questions/26057678/escape-characters-in-a-semicolon-separated-list-in-cmake https://cmake.org/pipermail/cmake/2016-March/063030.html

@xuxin930 try this patch to check if there is any improvement.

@anchao Yes! 👍
I changed the solution and modified other methods of reading config to ensure consistency.
Unfortunately🙁, CMake does NOT provide calls like proxy functions or wrapper functions.
I can only use marco to replace them.

[xuxin930]

@xuxin930 nice description of a problem and its solution! Kudos!!!

@acassis thank you very much for your encouragement, I will continue to be as clear as possible when dealing with issues