feat: add support for modern CS7-style UDOs for both UDOs and Effects

Author: kunstmusik

ChangeLog.md

@@ -19,6 +19,14 @@ information.
 
 * Added cross-group layer selection and deletion support for audio and pattern layer panels, including coordinated shift-click selection and cleanup of empty groups.
 
+* User-Defined Opcodes and Effects now support Csound 7 modern syntax alongside classic syntax:
+  * UDOs and Effects have an explicit Classic/Modern style selector
+  * Modern style uses `opcode name(inputArgs):outputSig` declaration and function-call invocation
+  * Classic style retains traditional `opcode name, outTypes, inTypes` declaration with `xin`/`xout`
+  * Bidirectional conversion between styles preserves input argument names and type annotations
+  * Parsing and CSD import handle both single-line and multi-line modern declarations
+  * Newly created UDOs and Effects default to application setting default (new setting in Program Settings for "Default UDO/Effects Style"); existing projects load as classic for backward compatibility
+
 ### Updated
 
 * Introduced new Time Unit system encompassing time signatures, measures, new tempo ruler, and new time units:

blue-core/src/main/java/blue/mixer/Effect.java

@@ -25,6 +25,7 @@
 import blue.orchestra.blueSynthBuilder.BSBGraphicInterface;
 import blue.orchestra.blueSynthBuilder.StringChannel;
 import blue.udo.OpcodeList;
+import blue.udo.UDOStyle;
 import blue.udo.UserDefinedOpcode;
 import blue.utility.TextUtilities;
 import blue.utility.UDOUtilities;
@@ -39,6 +40,7 @@
 
 public class Effect implements Automatable {
 
+    private UDOStyle style = UDOStyle.MODERN;
     private int numIns = 2;
     private int numOuts = 2;
     private BSBGraphicInterface graphicInterface;
@@ -64,6 +66,7 @@ private Effect(boolean init) {
     }
 
     public Effect(Effect effect) {
+        style = effect.style;
         numIns = effect.numIns;
         numOuts = effect.numOuts;
         code = effect.code;
@@ -82,12 +85,16 @@ public UserDefinedOpcode generateUDO(OpcodeList udoList) {
                 opcodeList, udoList);
 
         UserDefinedOpcode udo = new UserDefinedOpcode();
+        udo.style = style;
 
         BSBCompilationUnit bsbUnit = new BSBCompilationUnit();
         graphicInterface.setupForCompilation(bsbUnit);
 
         StringBuilder buffer = new StringBuilder();
-        buffer.append(getXinText()).append("\n");
+
+        if (style == UDOStyle.CLASSIC) {
+            buffer.append(getXinText()).append("\n");
+        }
 
         buffer.append(bsbUnit.replaceBSBValues(code)).append("\n");
 
@@ -102,21 +109,36 @@ public UserDefinedOpcode generateUDO(OpcodeList udoList) {
 
         udo.codeBody = udoCode;
 
-        udo.inTypes = getSigTypes(numIns);
-        udo.outTypes = getSigTypes(numOuts);
+        if (style == UDOStyle.MODERN) {
+            udo.inputArguments = getInputArguments();
+            udo.outTypes = getCommaSeparatedSigTypes(numOuts);
+            udo.inTypes = "";
+        } else {
+            udo.inputArguments = "";
+            udo.outTypes = getSigTypes(numOuts);
+            udo.inTypes = getSigTypes(numIns);
+        }
 
         return udo;
     }
 
     public static Effect loadFromXML(Element data) throws Exception {
         Effect effect = new Effect(false);
+        effect.style = UDOStyle.CLASSIC;
 
         Elements nodes = data.getElements();
 
         while (nodes.hasMoreElements()) {
             Element node = nodes.next();
             String nodeName = node.getName();
             switch (nodeName) {
+                case "style" -> {
+                    try {
+                        effect.style = UDOStyle.valueOf(node.getTextString());
+                    } catch (IllegalArgumentException e) {
+                        effect.style = UDOStyle.CLASSIC;
+                    }
+                }
                 case "name" ->
                     effect.setName(node.getTextString());
                 case "enabled" ->
@@ -161,6 +183,7 @@ public static Effect loadFromXML(Element data) throws Exception {
     public Element saveAsXML() {
         Element retVal = new Element("effect");
 
+        retVal.addElement("style").setText(style.name());
         retVal.addElement("name").setText(name);
         retVal.addElement(XMLUtilities.writeBoolean("enabled", enabled));
         retVal.addElement(XMLUtilities.writeInt("numIns", numIns));
@@ -174,6 +197,17 @@ public Element saveAsXML() {
         return retVal;
     }
 
+    public UDOStyle getStyle() {
+        return style;
+    }
+
+    public void setStyle(UDOStyle style) {
+        UDOStyle oldVal = this.style;
+        this.style = style;
+        firePropertyChangeEvent(new PropertyChangeEvent(this, "style",
+                oldVal, style));
+    }
+
     public boolean isEnabled() {
         return enabled;
     }
@@ -291,6 +325,31 @@ public String toString() {
     // return editPanel;
     // }
 
+    private String getCommaSeparatedSigTypes(int num) {
+        if (num == 0) {
+            return "";
+        }
+        StringBuilder buffer = new StringBuilder();
+        for (int i = 0; i < num; i++) {
+            if (i > 0) {
+                buffer.append(", ");
+            }
+            buffer.append("a");
+        }
+        return buffer.toString();
+    }
+
+    private String getInputArguments() {
+        StringBuilder buffer = new StringBuilder();
+        for (int i = 0; i < numIns; i++) {
+            if (i > 0) {
+                buffer.append(", ");
+            }
+            buffer.append("ain").append(i + 1);
+        }
+        return buffer.toString();
+    }
+
     private String getXinText() {
         StringBuilder buffer = new StringBuilder();
 

blue-core/src/main/java/blue/mixer/MixerNode.java

@@ -3,6 +3,7 @@
 import blue.CompileData;
 import blue.automation.Parameter;
 import blue.udo.OpcodeList;
+import blue.udo.UDOStyle;
 import blue.udo.UserDefinedOpcode;
 import blue.utility.MusicFunctions;
 import blue.utility.NumberUtilities;
@@ -380,9 +381,15 @@ private static void applyEffects(EffectsChain chain, OpcodeList udos,
                         udos.addOpcode(udo);
                     }
 
-                    buffer.append(signalChannels).append("\t");
-                    buffer.append(effectName).append("\t");
-                    buffer.append(signalChannels).append("\n");
+                    if (effect.getStyle() == UDOStyle.MODERN) {
+                        buffer.append(signalChannels).append(" = ");
+                        buffer.append(effectName).append("(");
+                        buffer.append(signalChannels).append(")\n");
+                    } else {
+                        buffer.append(signalChannels).append("\t");
+                        buffer.append(effectName).append("\t");
+                        buffer.append(signalChannels).append("\n");
+                    }
                 }
             } else if (obj instanceof Send send) {
 

blue-core/src/main/java/blue/udo/UDOStyle.java

@@ -0,0 +1,6 @@
+package blue.udo;
+
+public enum UDOStyle {
+    CLASSIC,
+    MODERN
+}

blue-core/src/main/java/blue/udo/UserDefinedOpcode.java

@@ -19,6 +19,7 @@
  */
 package blue.udo;
 
+import blue.utility.UDOUtilities;
 import electric.xml.Element;
 import electric.xml.Elements;
 
@@ -31,10 +32,14 @@ public class UserDefinedOpcode {
 
     public transient String commentText = null;
 
+    public UDOStyle style = UDOStyle.CLASSIC;
+
     public String outTypes = "";
 
     public String inTypes = "";
 
+    public String inputArguments = "";
+
     public String codeBody = "";
 
     public String comments = "";
@@ -44,8 +49,10 @@ public UserDefinedOpcode() {
 
     public UserDefinedOpcode(UserDefinedOpcode udo) {
         opcodeName = udo.opcodeName;
+        style = udo.style;
         outTypes = udo.outTypes;
         inTypes = udo.inTypes;
+        inputArguments = udo.inputArguments;
         codeBody = udo.codeBody;
         comments = udo.comments;
     }
@@ -64,35 +71,63 @@ public static UserDefinedOpcode loadFromXML(Element data) {
                 val = "";
             }
             switch (node.getName()) {
+                case "style" -> {
+                    try {
+                        retVal.style = UDOStyle.valueOf(val);
+                    } catch (IllegalArgumentException e) {
+                        retVal.style = UDOStyle.CLASSIC;
+                    }
+                }
                 case "opcodeName" ->
                     retVal.opcodeName = val;
                 case "outTypes" ->
                     retVal.outTypes = val;
                 case "inTypes" ->
                     retVal.inTypes = val;
+                case "inputArguments" ->
+                    retVal.inputArguments = val;
                 case "codeBody" ->
                     retVal.codeBody = val;
                 case "comments" ->
                     retVal.comments = val;
             }
         }
 
+        if (retVal.style == UDOStyle.MODERN) {
+            retVal.inTypes = "";
+            retVal.outTypes = UDOUtilities.normalizeModernOutTypes(retVal.outTypes);
+        } else {
+            retVal.inputArguments = "";
+            retVal.outTypes = UDOUtilities.normalizeClassicOutTypes(retVal.outTypes);
+        }
+
         return retVal;
     }
 
     public electric.xml.Element saveAsXML() {
         Element retVal = new Element("udo");
 
+        retVal.addElement("style").setText(style.name());
         retVal.addElement("opcodeName").setText(opcodeName);
-        retVal.addElement("outTypes").setText(outTypes);
-        retVal.addElement("inTypes").setText(inTypes);
+        retVal.addElement("outTypes").setText(style == UDOStyle.MODERN
+                ? UDOUtilities.getModernOutTypesDisplay(outTypes)
+                : outTypes);
+        if (style == UDOStyle.MODERN) {
+            retVal.addElement("inputArguments").setText(inputArguments);
+        } else {
+            retVal.addElement("inTypes").setText(inTypes);
+        }
         retVal.addElement("codeBody").setText(codeBody);
         retVal.addElement("comments").setText(comments);
 
         return retVal;
     }
 
     public String generateCode() {
+        if (style == UDOStyle.MODERN) {
+            return generateModernCode();
+        }
+
         StringBuilder buffer = new StringBuilder();
 
         buffer.append("\topcode ").append(opcodeName);
@@ -123,6 +158,67 @@ public String generateCode() {
 
     }
 
+    private String generateModernCode() {
+        StringBuilder buffer = new StringBuilder();
+
+        buffer.append("opcode ").append(opcodeName);
+        buffer.append("(").append(inputArguments).append(")");
+        buffer.append(":").append(UDOUtilities.getModernOutputSignature(outTypes));
+
+        if (commentText != null) {
+            buffer.append(" ; ").append(commentText);
+        }
+
+        String formattedCodeBody = indentModernCodeBody(codeBody);
+        if (!formattedCodeBody.isEmpty()) {
+            buffer.append("\n").append(formattedCodeBody);
+        }
+
+        buffer.append("\nendop");
+
+        return buffer.toString();
+    }
+
+    private String indentModernCodeBody(String source) {
+        if (source == null || source.isEmpty()) {
+            return "";
+        }
+
+        String trimmedSource = trimTrailingLineBreaks(source);
+        if (trimmedSource.isEmpty()) {
+            return "";
+        }
+
+        String[] lines = trimmedSource.split("\n", -1);
+        StringBuilder buffer = new StringBuilder();
+
+        for (int i = 0; i < lines.length; i++) {
+            if (i > 0) {
+                buffer.append("\n");
+            }
+
+            if (!lines[i].isEmpty()) {
+                buffer.append("    ");
+            }
+            buffer.append(lines[i]);
+        }
+
+        return buffer.toString();
+    }
+
+    private String trimTrailingLineBreaks(String source) {
+        int endIndex = source.length();
+        while (endIndex > 0) {
+            char currentChar = source.charAt(endIndex - 1);
+            if (currentChar != '\n' && currentChar != '\r') {
+                break;
+            }
+            endIndex--;
+        }
+
+        return source.substring(0, endIndex);
+    }
+
     @Override
     public String toString() {
         return opcodeName;
@@ -158,8 +254,23 @@ public boolean isEquivalent(UserDefinedOpcode udo) {
         if (udo == null) {
             return false;
         }
-        return (this.inTypes.equals(udo.inTypes)
-                && this.outTypes.equals(udo.outTypes) && this.codeBody
-                .equals(udo.codeBody));
+        String thisOutTypes = this.style == UDOStyle.MODERN
+                ? UDOUtilities.normalizeModernOutTypesForComparison(
+                        this.outTypes)
+                : UDOUtilities.normalizeClassicOutTypes(this.outTypes);
+        String otherOutTypes = udo.style == UDOStyle.MODERN
+                ? UDOUtilities.normalizeModernOutTypesForComparison(
+                        udo.outTypes)
+                : UDOUtilities.normalizeClassicOutTypes(udo.outTypes);
+
+        if (this.style != udo.style || !thisOutTypes.equals(otherOutTypes)
+                || !this.codeBody.equals(udo.codeBody)) {
+            return false;
+        }
+
+        return switch (this.style) {
+            case MODERN -> this.inputArguments.equals(udo.inputArguments);
+            case CLASSIC -> this.inTypes.equals(udo.inTypes);
+        };
     }
 }