Generate enum classes #10
+1,073
−43
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,270 @@ | ||
| /* | ||
| * Copyright 2025 Google LLC | ||
| * | ||
| * 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 | ||
| * | ||
| * http://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 com.google.fhir.codegen | ||
|
|
||
| import com.google.fhir.codegen.schema.CodeSystem | ||
| import com.google.fhir.codegen.schema.Concept | ||
| import com.google.fhir.codegen.schema.ValueSet | ||
| import com.google.fhir.codegen.schema.isValueSystemSupported | ||
| import com.google.fhir.codegen.schema.sanitizeKDoc | ||
| import com.google.fhir.codegen.schema.toPascalCase | ||
| import com.squareup.kotlinpoet.ClassName | ||
| import com.squareup.kotlinpoet.FunSpec | ||
| import com.squareup.kotlinpoet.KModifier | ||
| import com.squareup.kotlinpoet.PropertySpec | ||
| import com.squareup.kotlinpoet.TypeSpec | ||
| import com.squareup.kotlinpoet.asTypeName | ||
|
|
||
| /** | ||
| * Generates a [TypeSpec] for [Enum] class representation of FHIR data. The `Enum` class is | ||
| * generated using information derived from the [ValueSet] and [CodeSystem] terminology resources. | ||
| * Each generated enum class will contain the methods for retrieving the code, system, display and | ||
| * definition of each `Enum` class constant. | ||
| */ | ||
| object EnumTypeSpecGenerator { | ||
ellykits marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| fun generate( | ||
| enumClassName: String, | ||
| valueSet: ValueSet, | ||
| codeSystemMap: Map<String, CodeSystem>, | ||
| ): TypeSpec? { | ||
| val fhirEnum = generateEnum(valueSet, codeSystemMap) | ||
| if (fhirEnum == null || fhirEnum.constants.isEmpty()) return null | ||
| val typeSpec = | ||
| TypeSpec.enumBuilder(enumClassName) | ||
| .apply { | ||
| fhirEnum.description?.sanitizeKDoc()?.let { addKdoc(it) } | ||
| primaryConstructor( | ||
| FunSpec.constructorBuilder().addParameter("code", String::class).build() | ||
|
There was a problem hiding this comment. question: should the enum values just include system, display, and definition fields? There was a problem hiding this comment. For now, this is implemented similarly to the HAPI structures in Java. They include the most useful information that can be obtained from the enum class. There was a problem hiding this comment. Hmmm what I mean here is that your enum classes only include code e.g.: But what about including other values, so that you don't have to generate those values in the functions: which I find to be quite cumbersome There was a problem hiding this comment. Oh, I see. We can include the system, its always-present display is not. |
||
| ) | ||
|
|
||
| fhirEnum.constants.forEach { | ||
| addEnumConstant( | ||
| it.name, | ||
| TypeSpec.anonymousClassBuilder() | ||
| .apply { | ||
| if (!it.definition.isNullOrBlank()) addKdoc("%L", it.definition.sanitizeKDoc()) | ||
| addSuperclassConstructorParameter("%S", it.code) | ||
| } | ||
| .build(), | ||
| ) | ||
| .addProperty( | ||
| PropertySpec.builder("code", String::class, KModifier.PRIVATE) | ||
| .initializer("code") | ||
| .build() | ||
| ) | ||
| } | ||
| addFunction( | ||
| FunSpec.builder("toString") | ||
| .addModifiers(KModifier.OVERRIDE) | ||
| .addStatement("return code") | ||
| .returns(String::class) | ||
| .build() | ||
| ) | ||
| .addFunction( | ||
| FunSpec.builder("getCode") | ||
| .addModifiers(KModifier.PUBLIC) | ||
| .returns(String::class) | ||
| .addStatement("return code") | ||
| .build() | ||
| ) | ||
|
|
||
| addFunction(createPropertyAccessorFunction("getSystem", fhirEnum.constants) { it.system }) | ||
|
|
||
| addFunction( | ||
| createPropertyAccessorFunction("getDisplay", fhirEnum.constants) { it.display } | ||
| ) | ||
| addFunction( | ||
| createPropertyAccessorFunction("getDefinition", fhirEnum.constants) { it.definition } | ||
| ) | ||
|
|
||
| addType( | ||
| TypeSpec.companionObjectBuilder() | ||
| .addFunction( | ||
| FunSpec.builder("fromCode") | ||
| .addParameter("code", String::class) | ||
| .returns(ClassName.bestGuess(enumClassName)) | ||
| .beginControlFlow("return when (code)") | ||
| .apply { | ||
| fhirEnum.constants.forEach { addStatement("%S -> %L", it.code, it.name) } | ||
| addStatement( | ||
| "else -> throw IllegalArgumentException(\"Unknown code \$code for enum %L\")", | ||
| enumClassName, | ||
| ) | ||
| } | ||
| .endControlFlow() | ||
| .build() | ||
| ) | ||
| .build() | ||
| ) | ||
| } | ||
| .build() | ||
| return typeSpec | ||
| } | ||
|
|
||
| private fun createPropertyAccessorFunction( | ||
| functionName: String, | ||
| constants: List<FhirEnumConstant>, | ||
| propertySelector: (FhirEnumConstant) -> String?, | ||
| ): FunSpec { | ||
| return FunSpec.builder(functionName) | ||
| .addModifiers(KModifier.PUBLIC) | ||
| .returns(String::class.asTypeName().copy(nullable = true)) | ||
| .apply { | ||
| val constantsWithValue = constants.filter { propertySelector(it) != null } | ||
| if (constantsWithValue.isEmpty()) { | ||
| addStatement("return null") | ||
| } else { | ||
| beginControlFlow("return when (this)") | ||
| constantsWithValue.forEach { constant -> | ||
| propertySelector(constant)?.let { addStatement("%L -> %S", constant.name, it) } | ||
| } | ||
| addStatement("else -> null") | ||
| endControlFlow() | ||
| } | ||
| } | ||
| .build() | ||
| } | ||
|
|
||
| /** | ||
| * Instantiate a [FhirEnum] to facilitate the generation of Kotlin enum classes. The enum | ||
| * constants are derived from concepts defined in a `ValueSet`, a `CodeSystem`, or both. When both | ||
| * are provided, the constants are generated by intersecting the concepts from the `ValueSet` and | ||
| * the `CodeSystem`. If only one is provided, the constants are based solely on that source. Any | ||
| * nested concepts are flattened, transformed, and included in the resulting enum constants. | ||
| * | ||
| * NOTE: This excludes all systems that equals "http://unitsofmeasure.org" or start with "urn", | ||
| * e.g. urn:ietf:bcp:13, urn:ietf:bcp:47,urn:iso:std:iso:4217 typically used for MIMETypes, | ||
| * Currency Code etc. | ||
| */ | ||
| fun generateEnum(valueSet: ValueSet, codeSystemMap: Map<String, CodeSystem>): FhirEnum? { | ||
| return valueSet.compose | ||
| ?.include | ||
| ?.filter { it.isValueSystemSupported() } | ||
| ?.let { | ||
| val enumConstants = mutableListOf<FhirEnumConstant>() | ||
| for (include in it) { | ||
| val system = include.system!! | ||
| val codeSystem = codeSystemMap[system] | ||
|
|
||
| generateEnumConstants( | ||
| system = system, | ||
| codeSystemConcepts = codeSystem?.concept, | ||
| valueSetConcepts = include.concept, | ||
| enumConstants = enumConstants, | ||
| ) | ||
| } | ||
| return FhirEnum(valueSet.description, enumConstants) | ||
| } | ||
| } | ||
|
|
||
| private fun generateEnumConstants( | ||
| system: String, | ||
| codeSystemConcepts: List<Concept>?, | ||
| valueSetConcepts: List<Concept>?, | ||
| enumConstants: MutableList<FhirEnumConstant>, | ||
| ) { | ||
| if (!codeSystemConcepts.isNullOrEmpty() && !valueSetConcepts.isNullOrEmpty()) { | ||
| val expectedCodesSet = valueSetConcepts.mapTo(hashSetOf()) { it.code } | ||
| generateNestedEnumConstants(valueSetConcepts, system, enumConstants, expectedCodesSet) | ||
| } else if (!valueSetConcepts.isNullOrEmpty() && codeSystemConcepts.isNullOrEmpty()) { | ||
| generateNestedEnumConstants(valueSetConcepts, system, enumConstants, null) | ||
| } else if (!codeSystemConcepts.isNullOrEmpty() && valueSetConcepts.isNullOrEmpty()) { | ||
| generateNestedEnumConstants(codeSystemConcepts, system, enumConstants, null) | ||
| } | ||
| } | ||
|
|
||
| private fun generateNestedEnumConstants( | ||
| concepts: List<Concept>, | ||
| system: String, | ||
| enumConstants: MutableList<FhirEnumConstant>, | ||
| expectedCodesSet: Set<String>?, | ||
| ) { | ||
| val arrayDeque: ArrayDeque<Concept> = ArrayDeque(concepts) | ||
|
|
||
| while (arrayDeque.isNotEmpty()) { | ||
| val currenConcept = arrayDeque.removeFirst() | ||
| val name = currenConcept.code.formatEnumConstantName() | ||
| val include = expectedCodesSet?.contains(currenConcept.code) != false | ||
| if (name.isNotBlank() && include) { | ||
| val fhirEnumConstant = | ||
| FhirEnumConstant( | ||
| code = currenConcept.code, | ||
| system = system, | ||
| name = name, | ||
| display = currenConcept.display, | ||
| definition = currenConcept.definition, | ||
| ) | ||
| enumConstants.add(fhirEnumConstant) | ||
| } | ||
| if (!currenConcept.concept.isNullOrEmpty() && include) { | ||
| arrayDeque.addAll(currenConcept.concept) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Transforms a FHIR code into a valid Kotlin enum constant name. | ||
| * | ||
| * This function applies a series of transformations to ensure the resulting name follows Kotlin | ||
| * naming conventions and is a valid identifier. The transformations are applied in the following | ||
| * order: | ||
| * 1. For URLs (strings starting with "http"), extract only the last segment after the final dot | ||
| * Example: "http://hl7.org/fhirpath/System.DateTime" → "DateTime" | ||
| * 2. For special characters (>, <, >=, etc.), map them to descriptive names Example: ">" → | ||
| * "GreaterThan", "<" → "LessThan" | ||
| * 3. Replace all remaining non-alphanumeric characters with underscores Example: "some-value.123" | ||
| * → "some_value_123" | ||
| * 4. If the string starts with a digit, prefix it with an underscore to make it a valid | ||
| * identifier Example: "123test" → "_123test" | ||
| * 5. Apply PascalCase to each segment between underscores while preserving the underscores | ||
| * Example: "test_value" → "Test_Value" | ||
| * | ||
| * @return A valid Kotlin enum constant name | ||
| */ | ||
| private fun String.formatEnumConstantName(): String { | ||
|
|
||
| if (startsWith("http")) return substringAfterLast(".") | ||
|
|
||
| when (this) { | ||
| ">" -> return "GreaterThan" | ||
| "<" -> return "LessThan" | ||
| ">=" -> return "GreaterOrEquals" | ||
| "<=" -> return "LessOrEquals" | ||
| "<>", | ||
| "!=" -> return "NotEquals" | ||
| "=" -> return "Equals" | ||
| "*" -> return "Multiply" | ||
| "+" -> return "Plus" | ||
| "-" -> return "Minus" | ||
| "/" -> return "Divide" | ||
| "%" -> return "Percent" | ||
| } | ||
|
|
||
| val withUnderscores = this.replace(Regex("[^a-zA-Z0-9]"), "_") | ||
|
|
||
| val prefixed = | ||
| if (withUnderscores.isNotEmpty() && withUnderscores[0].isDigit()) { | ||
| "_$withUnderscores" | ||
| } else { | ||
| withUnderscores | ||
| } | ||
|
|
||
| val parts = prefixed.split("_") | ||
| return parts.joinToString("_") { part -> if (part.isEmpty()) "" else part.toPascalCase() } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe create a separate table - since this whole table is about structure definitions, backbone elements and choice of data types are also structure definitions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
actually i think this shoudl totally be a separate section:
Mapping FHIR value sets to Kotlin