Add implicit property name converter annotations for built-in renderers

Author: HT154

pkl-core/src/main/java/org/pkl/core/runtime/JsonModule.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright © 2024-2025 Apple Inc. and the Pkl project authors. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.pkl.core.runtime;
+
+import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
+import java.net.URI;
+
+public final class JsonModule extends StdLibModule {
+  private static final VmTyped instance = VmUtils.createEmptyModule();
+
+  static {
+    loadModule(URI.create("pkl:json"), instance);
+  }
+
+  public static VmTyped getModule() {
+    return instance;
+  }
+
+  public static VmClass getPropertyClass() {
+    return PropertyClass.instance;
+  }
+
+  private static final class PropertyClass {
+    static final VmClass instance = loadClass("Property");
+  }
+
+  @TruffleBoundary
+  private static VmClass loadClass(String className) {
+    var theModule = getModule();
+    return (VmClass) VmUtils.readMember(theModule, Identifier.get(className));
+  }
+}

pkl-core/src/main/java/org/pkl/core/runtime/JsonnetModule.java

@@ -1,5 +1,5 @@
 /*
- * Copyright © 2024 Apple Inc. and the Pkl project authors. All rights reserved.
+ * Copyright © 2024-2025 Apple Inc. and the Pkl project authors. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -29,6 +29,10 @@ public static VmTyped getModule() {
     return instance;
   }
 
+  public static VmClass getPropertyClass() {
+    return PropertyClass.instance;
+  }
+
   public static VmClass getImportStrClass() {
     return ImportStrClass.instance;
   }
@@ -37,6 +41,10 @@ public static VmClass getExtVarClass() {
     return ExtVarClass.instance;
   }
 
+  private static final class PropertyClass {
+    static final VmClass instance = loadClass("Property");
+  }
+
   private static final class ImportStrClass {
     static final VmClass instance = loadClass("ImportStr");
   }

pkl-core/src/main/java/org/pkl/core/runtime/ModuleCache.java

@@ -92,16 +92,20 @@ public synchronized VmTyped getOrLoad(
           return BaseModule.getModule();
         case "Benchmark":
           return BenchmarkModule.getModule();
-        case "pklbinary":
-          return PklBinaryModule.getModule();
+        case "json":
+          return JsonModule.getModule();
         case "jsonnet":
           return JsonnetModule.getModule();
         case "math":
           return MathModule.getModule();
+        case "pklbinary":
+          return PklBinaryModule.getModule();
         case "platform":
           return PlatformModule.getModule();
         case "project":
           return ProjectModule.getModule();
+        case "protobuf":
+          return ProtobufModule.getModule();
         case "reflect":
           return ReflectModule.getModule();
         case "release":
@@ -115,6 +119,8 @@ public synchronized VmTyped getOrLoad(
           return TestModule.getModule();
         case "xml":
           return XmlModule.getModule();
+        case "yaml":
+          return YamlModule.getModule();
         default:
           if (!STDLIB_MODULE_URIS.contains(moduleKey.getUri())) {
             var stdlibModules = String.join("\n", Release.current().standardLibrary().modules());

pkl-core/src/main/java/org/pkl/core/runtime/ProtobufModule.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright © 2024-2025 Apple Inc. and the Pkl project authors. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.pkl.core.runtime;
+
+import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
+import java.net.URI;
+
+public final class ProtobufModule extends StdLibModule {
+  private static final VmTyped instance = VmUtils.createEmptyModule();
+
+  static {
+    loadModule(URI.create("pkl:protobuf"), instance);
+  }
+
+  public static VmTyped getModule() {
+    return instance;
+  }
+
+  public static VmClass getPropertyClass() {
+    return PropertyClass.instance;
+  }
+
+  private static final class PropertyClass {
+    static final VmClass instance = loadClass("Property");
+  }
+
+  @TruffleBoundary
+  private static VmClass loadClass(String className) {
+    var theModule = getModule();
+    return (VmClass) VmUtils.readMember(theModule, Identifier.get(className));
+  }
+}

pkl-core/src/main/java/org/pkl/core/runtime/XmlModule.java

@@ -1,5 +1,5 @@
 /*
- * Copyright © 2024 Apple Inc. and the Pkl project authors. All rights reserved.
+ * Copyright © 2024-2025 Apple Inc. and the Pkl project authors. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -29,6 +29,10 @@ public static VmTyped getModule() {
     return instance;
   }
 
+  public static VmClass getPropertyClass() {
+    return PropertyClass.instance;
+  }
+
   public static VmClass getInlineClass() {
     return InlineClass.instance;
   }
@@ -41,6 +45,10 @@ public static VmClass getCDataClass() {
     return CDataClass.instance;
   }
 
+  private static final class PropertyClass {
+    static final VmClass instance = loadClass("Property");
+  }
+
   private static final class InlineClass {
     static final VmClass instance = loadClass("Inline");
   }

pkl-core/src/main/java/org/pkl/core/runtime/YamlModule.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright © 2024-2025 Apple Inc. and the Pkl project authors. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.pkl.core.runtime;
+
+import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
+import java.net.URI;
+
+public final class YamlModule extends StdLibModule {
+  private static final VmTyped instance = VmUtils.createEmptyModule();
+
+  static {
+    loadModule(URI.create("pkl:yaml"), instance);
+  }
+
+  public static VmTyped getModule() {
+    return instance;
+  }
+
+  public static VmClass getPropertyClass() {
+    return PropertyClass.instance;
+  }
+
+  private static final class PropertyClass {
+    static final VmClass instance = loadClass("Property");
+  }
+
+  @TruffleBoundary
+  private static VmClass loadClass(String className) {
+    var theModule = getModule();
+    return (VmClass) VmUtils.readMember(theModule, Identifier.get(className));
+  }
+}

pkl-core/src/main/java/org/pkl/core/stdlib/PklConverter.java

@@ -22,8 +22,12 @@
 import org.pkl.core.util.Pair;
 
 public final class PklConverter implements VmValueConverter<Object> {
+  private interface AnnotationConverter {
+    VmPair convert(String property, VmTyped annotation, Object value);
+  }
+
   private final Map<VmClass, VmFunction> typeConverters;
-  private final Map<VmClass, VmFunction> annotationConverters;
+  private final Map<VmClass, AnnotationConverter> annotationConverters;
   private final Pair<Object[], VmFunction>[] pathConverters;
 
   private final @Nullable VmFunction stringConverter;
@@ -46,13 +50,17 @@ public final class PklConverter implements VmValueConverter<Object> {
   private final @Nullable VmFunction classConverter;
   private final @Nullable VmFunction typeAliasConverter;
 
-  public PklConverter(VmMapping converters, VmMapping annotationConverters) {
+  private PklConverter(
+      VmMapping converters,
+      VmMapping annotationConverters,
+      @Nullable VmClass propertyNameAnnotation) {
     // As of 0.18, `converters` is forced by the mapping type check,
     // but let's not rely on this implementation detail.
     converters.force(false, false);
     annotationConverters.force(false, false);
     typeConverters = createTypeConverters(converters);
-    this.annotationConverters = createAnnotationConverters(annotationConverters);
+    this.annotationConverters =
+        createAnnotationConverters(annotationConverters, propertyNameAnnotation);
     pathConverters = createPathConverters(converters);
 
     stringConverter = typeConverters.get(BaseModule.getStringClass());
@@ -76,18 +84,27 @@ public PklConverter(VmMapping converters, VmMapping annotationConverters) {
     typeAliasConverter = typeConverters.get(BaseModule.getTypeAliasClass());
   }
 
-  public static final PklConverter NOOP = new PklConverter(VmMapping.empty(), VmMapping.empty());
+  public static final PklConverter NOOP =
+      new PklConverter(VmMapping.empty(), VmMapping.empty(), null);
+
+  public static PklConverter fromRenderer(VmTyped renderer, VmClass propertyNameAnnotation) {
+    var converters = (VmMapping) VmUtils.readMember(renderer, Identifier.CONVERTERS);
+    var annotationConverters =
+        (VmMapping) VmUtils.readMember(renderer, Identifier.ANNOTATION_CONVERTERS);
+    return new PklConverter(converters, annotationConverters, propertyNameAnnotation);
+  }
 
   public static PklConverter fromRenderer(VmTyped renderer) {
     var converters = (VmMapping) VmUtils.readMember(renderer, Identifier.CONVERTERS);
     var annotationConverters =
         (VmMapping) VmUtils.readMember(renderer, Identifier.ANNOTATION_CONVERTERS);
-    return new PklConverter(converters, annotationConverters);
+    return new PklConverter(converters, annotationConverters, null);
   }
 
   public static PklConverter fromParser(VmTyped parser) {
     var converters = (VmMapping) VmUtils.readMember(parser, Identifier.CONVERTERS);
-    return new PklConverter(converters, VmMapping.empty()); // no annotation converters in parsers
+    return new PklConverter(
+        converters, VmMapping.empty(), null); // no annotation converters in parsers
   }
 
   @Override
@@ -204,7 +221,7 @@ public Pair<Identifier, Object> convertProperty(
       if (converter == null) {
         continue;
       }
-      var nameVal = (VmPair) converter.apply(name.toString(), annotation, value);
+      var nameVal = converter.convert(name.toString(), annotation, value);
       name = Identifier.get((String) nameVal.getFirst());
       value = nameVal.getSecond();
     }
@@ -225,14 +242,26 @@ private Map<VmClass, VmFunction> createTypeConverters(VmMapping converters) {
     return result;
   }
 
-  private Map<VmClass, VmFunction> createAnnotationConverters(VmMapping annotationConverters) {
-    var result = new HashMap<VmClass, VmFunction>();
+  private Map<VmClass, AnnotationConverter> createAnnotationConverters(
+      VmMapping annotationConverters, @Nullable VmClass propertyNameAnnotation) {
+    var result = new HashMap<VmClass, AnnotationConverter>();
     annotationConverters.iterateMemberValues(
         (key, member, value) -> {
           assert value != null; // forced in ctor
-          result.put((VmClass) key, (VmFunction) value);
+          result.put(
+              (VmClass) key,
+              (name, annotation, val) ->
+                  (VmPair) ((VmFunction) value).apply(name, annotation, val));
           return true;
         });
+
+    if (propertyNameAnnotation != null && !result.containsKey(propertyNameAnnotation)) {
+      result.put(
+          propertyNameAnnotation,
+          (name, annotation, val) ->
+              new VmPair(VmUtils.readMember(annotation, Identifier.NAME), val));
+    }
+
     return result;
   }
 
@@ -270,11 +299,11 @@ private Pair<Object[], VmFunction>[] createPathConverters(VmMapping converters)
     return findConverterByType(typeConverters, clazz);
   }
 
-  private @Nullable VmFunction findAnnotationConverter(VmClass clazz) {
+  private @Nullable AnnotationConverter findAnnotationConverter(VmClass clazz) {
     return findConverterByType(annotationConverters, clazz);
   }
 
-  private @Nullable VmFunction findConverterByType(Map<VmClass, VmFunction> bag, VmClass clazz) {
+  private <T> @Nullable T findConverterByType(Map<VmClass, T> bag, VmClass clazz) {
     for (var current = clazz; current != null; current = current.getSuperclass()) {
       var found = bag.get(current);
       if (found != null) return found;

pkl-core/src/main/java/org/pkl/core/stdlib/base/JsonRendererNodes.java

@@ -52,7 +52,11 @@ protected String eval(VmTyped self, Object value) {
   private static JsonRenderer createRenderer(VmTyped self, StringBuilder builder) {
     var indent = (String) VmUtils.readMember(self, Identifier.INDENT);
     var omitNullProperties = (boolean) VmUtils.readMember(self, Identifier.OMIT_NULL_PROPERTIES);
-    return new JsonRenderer(builder, indent, PklConverter.fromRenderer(self), omitNullProperties);
+    return new JsonRenderer(
+        builder,
+        indent,
+        PklConverter.fromRenderer(self, JsonModule.getPropertyClass()),
+        omitNullProperties);
   }
 
   private static final class JsonRenderer extends AbstractStringRenderer {

pkl-core/src/main/java/org/pkl/core/stdlib/base/YamlRendererNodes.java

@@ -35,6 +35,7 @@
 import org.pkl.core.runtime.VmSet;
 import org.pkl.core.runtime.VmTyped;
 import org.pkl.core.runtime.VmUtils;
+import org.pkl.core.runtime.YamlModule;
 import org.pkl.core.stdlib.AbstractStringRenderer;
 import org.pkl.core.stdlib.ExternalMethod1Node;
 import org.pkl.core.stdlib.PklConverter;
@@ -72,7 +73,7 @@ private static YamlRenderer createRenderer(VmTyped self, StringBuilder builder)
     return new YamlRenderer(
         builder,
         " ".repeat(indentWidth),
-        PklConverter.fromRenderer(self),
+        PklConverter.fromRenderer(self, YamlModule.getPropertyClass()),
         omitNullProperties,
         mode,
         isStream);

pkl-core/src/main/java/org/pkl/core/stdlib/jsonnet/RendererNodes.java

@@ -47,7 +47,11 @@ private static Renderer createRenderer(VmTyped self, StringBuilder builder) {
     var indent = (String) VmNull.unwrap(VmUtils.readMember(self, Identifier.INDENT));
     if (indent == null) indent = "";
     var omitNullProperties = (boolean) VmUtils.readMember(self, Identifier.OMIT_NULL_PROPERTIES);
-    return new Renderer(builder, indent, omitNullProperties, PklConverter.fromRenderer(self));
+    return new Renderer(
+        builder,
+        indent,
+        omitNullProperties,
+        PklConverter.fromRenderer(self, JsonnetModule.getPropertyClass()));
   }
 
   public abstract static class renderDocument extends ExternalMethod1Node {