From 969609f3e3a12077ec45b030a2d1284c27894173 Mon Sep 17 00:00:00 2001 From: rusefillc Date: Sun, 9 May 2021 13:16:05 -0400 Subject: [PATCH] gen_config.sh code duplication #2451 docs --- .../src/com/rusefi/ConfigDefinition.java | 8 ++++++++ .../src/com/rusefi/output/CHeaderConsumer.java | 4 ++++ 2 files changed, 12 insertions(+) diff --git a/java_tools/configuration_definition/src/com/rusefi/ConfigDefinition.java b/java_tools/configuration_definition/src/com/rusefi/ConfigDefinition.java index c445dfb060..62f57b2aec 100644 --- a/java_tools/configuration_definition/src/com/rusefi/ConfigDefinition.java +++ b/java_tools/configuration_definition/src/com/rusefi/ConfigDefinition.java @@ -35,6 +35,9 @@ public class ConfigDefinition { private static final String KEY_C_FSIO_NAMES = "-c_fsio_names"; private static final String KEY_C_FSIO_STRING = "-c_fsio_strings"; private static final String KEY_C_DEFINES = "-c_defines"; + /** + * @see CHeaderConsumer#withC_Defines + */ private static final String KEY_WITH_C_DEFINES = "-with_c_defines"; private static final String KEY_JAVA_DESTINATION = "-java_destination"; private static final String KEY_ROMRAIDER_DESTINATION = "-romraider_destination"; @@ -46,6 +49,11 @@ public class ConfigDefinition { public static final String KEY_CACHE_ZIP_FILE = "-cache_zip_file"; private static final String KEY_ZERO_INIT = "-initialize_to_zero"; private static final String KEY_BOARD_NAME = "-board"; + /** + * This flag controls if we assign default zero value (useful while generating structures used for class inheritance) + * versus not assigning default zero value like we need for non-class headers + * This could be related to configuration header use-case versus "live data" (not very alive idea) use-case + */ public static boolean needZeroInit = true; public static String definitionInputFile = null; diff --git a/java_tools/configuration_definition/src/com/rusefi/output/CHeaderConsumer.java b/java_tools/configuration_definition/src/com/rusefi/output/CHeaderConsumer.java index e85a83c38f..751ab8217e 100644 --- a/java_tools/configuration_definition/src/com/rusefi/output/CHeaderConsumer.java +++ b/java_tools/configuration_definition/src/com/rusefi/output/CHeaderConsumer.java @@ -12,6 +12,10 @@ import static com.rusefi.ConfigDefinition.EOL; * Configuration consumer which writes C header file */ public class CHeaderConsumer extends BaseCHeaderConsumer { + /** + * looks like sometimes we want to not include "define XXX value" into generated C headers + * TODO: document the use-case better + */ public static boolean withC_Defines; private final LazyFile cHeader;