mirror of
https://github.com/apple/pkl.git
synced 2026-02-25 20:04:59 +01:00
73264e8fd1
This enables defining declarative key and/or value transformations in cases where neither `Class`- nor path-based converters can be applied gracefully. It is also the only way to express transforming the resulting property names in `Typed` objects without applying a converter to the entire containing type, which is cumbersome at best. SPICE: https://github.com/apple/pkl-evolution/pull/26
61 lines
2.2 KiB
Plaintext
61 lines
2.2 KiB
Plaintext
//===----------------------------------------------------------------------===//
|
|
// 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.
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
/// A renderer for [Protocol Buffers](https://developers.google.com/protocol-buffers).
|
|
/// Note: This module is _experimental_ and not ready for production use.
|
|
@ModuleInfo { minPklVersion = "0.31.0" }
|
|
module pkl.protobuf
|
|
|
|
import "pkl:reflect"
|
|
|
|
/// A renderer for [Protocol Buffers](https://developers.google.com/protocol-buffers).
|
|
/// Note: This class is _experimental_ and not ready for production use.
|
|
///
|
|
/// As of this release, only Protocol Buffers' text format is supported.
|
|
///
|
|
/// The [Property] annotation can be used to change how a property name renders into Protobuf.
|
|
///
|
|
/// Example:
|
|
/// ```
|
|
/// import "pkl:protobuf"
|
|
///
|
|
/// @protobuf.Property { name = "wing_span" }
|
|
/// wingSpan: Int
|
|
/// ```
|
|
class Renderer extends ValueRenderer {
|
|
/// The characters to use for indenting output.
|
|
///
|
|
/// Defaults to two spaces.
|
|
indent: String = " "
|
|
|
|
external function renderDocument(value: Any): String
|
|
|
|
external function renderValue(value: Any): String
|
|
|
|
/// Returns the canonical name for [type].
|
|
external function renderType(type: reflect.Type): String
|
|
}
|
|
|
|
/// Annotate properties of classes and modules with this class to override how a [Renderer]
|
|
/// interprets a property's name.
|
|
@Since { version = "0.31.0" }
|
|
class Property extends ConvertProperty {
|
|
/// The new name to use for the annotated property when rendered by [Renderer].
|
|
name: String
|
|
|
|
render = (prop, renderer) -> if (renderer is Renderer) Pair(name, prop.value) else prop
|
|
}
|