#587 #591 interim support for single file i18n output.

Author: davetcc

.idea/modules.xml

@@ -24,6 +24,15 @@ In any fork, please ensure all text up to here is left unaltered.
 
 ## Documentation
 
+```
+    _____       __  __                  
+   / / / |_ ___|  \/  | ___ _ __  _   _ 
+  / / /| __/ __| |\/| |/ _ \ '_ \| | | |
+ / / / | || (__| |  | |  __/ | | | |_| |
+/_/_/   \__\___|_|  |_|\___|_| |_|\__,_|
+documentation
+```
+
 * [UI user guide, getting started and other documentation](https://www.thecoderscorner.com/products/arduino-libraries/tc-menu/)
 * [TcMenu API Examples and Project Starters repository](https://github.com/TcMenu/tcmenu-examples-starters)
 * [Full API embedded documentation](https://www.thecoderscorner.com/ref-docs/tcmenu/html/index.html)

README.md

@@ -6,18 +6,35 @@
 
 package com.thecoderscorner.menu.domain;
 
+import com.thecoderscorner.menu.domain.build.MenuTreeBuilder;
+import com.thecoderscorner.menu.domain.util.MenuItemHelper;
+
+import java.util.Objects;
+
 /**
  * Constructs an AnalogMenuItem using the standard builder pattern. It is possible to either build
  * an item from scratch, or start with an existing item and make changes.
  */
 public class AnalogMenuItemBuilder extends MenuItemBuilder<AnalogMenuItemBuilder, AnalogMenuItem> {
 
+    private final MenuTreeBuilder possibleBuilder;
+    private final int defVal;
     private String unit;
     private int maxValue;
     private int divisor;
     private int offset;
     private int step;
 
+    public AnalogMenuItemBuilder(MenuTreeBuilder possibleBuilder, int defVal) {
+        this.possibleBuilder = possibleBuilder;
+        this.defVal = defVal;
+    }
+
+    public AnalogMenuItemBuilder() {
+        this.possibleBuilder = null;
+        defVal = 0;
+    }
+
     @Override
     AnalogMenuItemBuilder getThis() {
         return this;
@@ -58,6 +75,17 @@ public AnalogMenuItemBuilder withExisting(AnalogMenuItem other) {
         return getThis();
     }
 
+    /**
+     * Should only be called if this builder was created with a MenuTreeBuilder
+     * @return the actual builder
+     */
+    public MenuTreeBuilder endItem() {
+        AnalogMenuItem analogMenuItem = menuItem();
+        Objects.requireNonNull(possibleBuilder).rawPushItem(analogMenuItem);
+        MenuItemHelper.setMenuState(analogMenuItem, defVal, possibleBuilder.asTree());
+        return possibleBuilder;
+    }
+
     public AnalogMenuItem menuItem() {
         return new AnalogMenuItem(this.name, this.variableName, this.id, this.eepromAddr, this.functionName, this.maxValue,
                                   this.offset, this.divisor, this.step, this.unit, readOnly, localOnly, visible, staticDataInRAM);

api/tcMenuJavaApi/src/main/java/com/thecoderscorner/menu/domain/AnalogMenuItemBuilder.java

@@ -1,16 +1,33 @@
 package com.thecoderscorner.menu.domain;
 
+import com.thecoderscorner.menu.domain.build.MenuTreeBuilder;
+import com.thecoderscorner.menu.domain.util.MenuItemHelper;
+
+import java.util.Objects;
+
 /**
  * Builds an extensible version of enum that should be used when the number of choices is larger, the choices are in
  * eeprom, or you need more control at runtime of the choices using the builder pattern.
  */
 public class ScrollChoiceMenuItemBuilder extends MenuItemBuilder<ScrollChoiceMenuItemBuilder, ScrollChoiceMenuItem> {
+    private final MenuTreeBuilder menuTreeBuilder;
+    private final int defVal;
     private int itemWidth;
     private int eepromOffset;
     private int numEntries;
     private ScrollChoiceMenuItem.ScrollChoiceMode choiceMode = ScrollChoiceMenuItem.ScrollChoiceMode.ARRAY_IN_EEPROM;
     private String variable;
 
+    public ScrollChoiceMenuItemBuilder(MenuTreeBuilder menuTreeBuilder, int defVal) {
+        this.menuTreeBuilder = menuTreeBuilder;
+        this.defVal = defVal;
+    }
+ 
+    public ScrollChoiceMenuItemBuilder() {
+        this.menuTreeBuilder = null;
+        this.defVal = 0;
+    }
+
     @Override
     ScrollChoiceMenuItemBuilder getThis() {
         return this;
@@ -51,6 +68,17 @@ public ScrollChoiceMenuItemBuilder withExisting(ScrollChoiceMenuItem item) {
         return getThis();
     }
 
+    /**
+     * Should only be called if this builder was created with a MenuTreeBuilder
+     * @return the actual builder
+     */
+    public MenuTreeBuilder endItem() {
+        var item = menuItem();
+        Objects.requireNonNull(menuTreeBuilder).rawPushItem(item);
+        MenuItemHelper.setMenuState(item, defVal, menuTreeBuilder.asTree());
+        return menuTreeBuilder;
+    }
+
     public ScrollChoiceMenuItem menuItem() {
         return new ScrollChoiceMenuItem(name, variableName, id, eepromAddr, functionName, itemWidth, eepromOffset, numEntries, choiceMode,
                 variable, readOnly, localOnly, visible, staticDataInRAM);

api/tcMenuJavaApi/src/main/java/com/thecoderscorner/menu/domain/ScrollChoiceMenuItemBuilder.java

@@ -0,0 +1,29 @@
+package com.thecoderscorner.menu.domain.build;
+
+public class CallbackDefinition {
+    private final String callback;
+
+    private CallbackDefinition(String callback) {
+        this.callback = callback;
+    }
+
+    public static CallbackDefinition noCallback() {
+        return new CallbackDefinition("");
+    }
+
+    public static CallbackDefinition functionCb(String callback) {
+        if(callback == null) throw new IllegalArgumentException("Callback cannot be null");
+        if(callback.endsWith("RtCall")) throw new IllegalArgumentException("Not function callback as ends with RtCall");
+        return new CallbackDefinition(callback);
+    }
+
+    public static CallbackDefinition rtCall(String callback) {
+        if(callback == null) throw new IllegalArgumentException("Callback cannot be null");
+        if(callback.endsWith("RtCall")) throw new IllegalArgumentException("We already add RtCall");
+        return new CallbackDefinition(callback + "RtCall");
+    }
+
+    public String cbText() {
+        return callback;
+    }
+}

api/tcMenuJavaApi/src/main/java/com/thecoderscorner/menu/domain/build/CallbackDefinition.java

@@ -0,0 +1,38 @@
+package com.thecoderscorner.menu.domain.build;
+
+public class LargeNumberDefinition {
+    private final int decPlaces;
+    private final int digitsAllowed;
+    private final boolean neg;
+
+    private LargeNumberDefinition(int decPlaces, int digitsAllowed, boolean neg) {
+        this.decPlaces = decPlaces;
+        this.digitsAllowed = digitsAllowed;
+        this.neg = neg;
+    }
+
+    public int getDecPlaces() {
+        return decPlaces;
+    }
+
+    public int getDigitsAllowed() {
+        return digitsAllowed;
+    }
+
+    public boolean isNeg() {
+        return neg;
+    }
+
+    public static LargeNumberDefinition allowingNegative(int digitsAllowed, int decPlaces) {
+        return new LargeNumberDefinition(decPlaces, digitsAllowed, true);
+    }
+    public static LargeNumberDefinition positiveOnly(int digitsAllowed, int decPlaces) {
+        return new LargeNumberDefinition(decPlaces, digitsAllowed, false);
+    }
+    public static LargeNumberDefinition intAllowingNegative(int digitsAllowed) {
+        return new LargeNumberDefinition(0, digitsAllowed, true);
+    }
+    public static LargeNumberDefinition intPositiveOnly(int digitsAllowed) {
+        return new LargeNumberDefinition(0, digitsAllowed, false);
+    }
+}

api/tcMenuJavaApi/src/main/java/com/thecoderscorner/menu/domain/build/LargeNumberDefinition.java

@@ -0,0 +1,5 @@
+package com.thecoderscorner.menu.domain.build;
+
+public enum MenuBuilderFlag {
+    LOCAL_ONLY, HIDDEN, READ_ONLY, STATIC_IN_RAM, SECURED
+}