Skip to content

DataFrameSchema.generateCode() #1230

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 2, 2025
Merged

DataFrameSchema.generateCode() #1230

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions core/api/core.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2401,7 +2401,12 @@ public final class org/jetbrains/kotlinx/dataframe/api/GatherKt {
public final class org/jetbrains/kotlinx/dataframe/api/GenerateCodeKt {
public static final fun generateCode (Lorg/jetbrains/kotlinx/dataframe/DataFrame;Ljava/lang/String;ZZLorg/jetbrains/kotlinx/dataframe/codeGen/MarkerVisibility;)Ljava/lang/String;
public static synthetic fun generateCode$default (Lorg/jetbrains/kotlinx/dataframe/DataFrame;Ljava/lang/String;ZZLorg/jetbrains/kotlinx/dataframe/codeGen/MarkerVisibility;ILjava/lang/Object;)Ljava/lang/String;
public static final fun generateCodeForSchema (Lorg/jetbrains/kotlinx/dataframe/schema/DataFrameSchema;Ljava/lang/String;ZZLorg/jetbrains/kotlinx/dataframe/codeGen/MarkerVisibility;)Ljava/lang/String;
public static synthetic fun generateCodeForSchema$default (Lorg/jetbrains/kotlinx/dataframe/schema/DataFrameSchema;Ljava/lang/String;ZZLorg/jetbrains/kotlinx/dataframe/codeGen/MarkerVisibility;ILjava/lang/Object;)Ljava/lang/String;
public static final fun generateDataClassesForSchema (Lorg/jetbrains/kotlinx/dataframe/schema/DataFrameSchema;Ljava/lang/String;ZLorg/jetbrains/kotlinx/dataframe/codeGen/MarkerVisibility;ZLorg/jetbrains/kotlinx/dataframe/codeGen/NameNormalizer;)Ljava/lang/String;
public static synthetic fun generateDataClassesForSchema$default (Lorg/jetbrains/kotlinx/dataframe/schema/DataFrameSchema;Ljava/lang/String;ZLorg/jetbrains/kotlinx/dataframe/codeGen/MarkerVisibility;ZLorg/jetbrains/kotlinx/dataframe/codeGen/NameNormalizer;ILjava/lang/Object;)Ljava/lang/String;
public static final fun generateInterfaces (Lorg/jetbrains/kotlinx/dataframe/DataFrame;Ljava/lang/String;)Ljava/lang/String;
public static final fun generateInterfacesForSchema (Lorg/jetbrains/kotlinx/dataframe/schema/DataFrameSchema;Ljava/lang/String;)Ljava/lang/String;
public static final fun getDefault (Lorg/jetbrains/kotlinx/dataframe/codeGen/NameNormalizer$Companion;)Lorg/jetbrains/kotlinx/dataframe/codeGen/NameNormalizer;
public static final fun toCodeString (Ljava/lang/String;)Ljava/lang/String;
}
Expand Down
77 changes: 60 additions & 17 deletions core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/generateCode.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,70 @@ import org.jetbrains.kotlinx.dataframe.codeGen.CodeGenerator
import org.jetbrains.kotlinx.dataframe.codeGen.MarkerVisibility
import org.jetbrains.kotlinx.dataframe.codeGen.NameNormalizer
import org.jetbrains.kotlinx.dataframe.impl.codeGen.from
import org.jetbrains.kotlinx.dataframe.schema.DataFrameSchema

// region DataFrame

public inline fun <reified T> DataFrame<T>.generateCode(
fields: Boolean = true,
extensionProperties: Boolean = true,
): CodeString {
val name = markerName<T>()
return generateCode(name, fields, extensionProperties)
}
): CodeString =
schema().generateCode(
markerName = markerName<T>(),
fields = fields,
extensionProperties = extensionProperties,
)

public fun <T> DataFrame<T>.generateCode(
markerName: String,
fields: Boolean = true,
extensionProperties: Boolean = true,
visibility: MarkerVisibility = MarkerVisibility.IMPLICIT_PUBLIC,
): CodeString =
schema().generateCode(
markerName = markerName,
fields = fields,
extensionProperties = extensionProperties,
visibility = visibility,
)

public inline fun <reified T> DataFrame<T>.generateInterfaces(): CodeString =
schema().generateInterfaces(
markerName = markerName<T>(),
)

public inline fun <reified T> DataFrame<T>.generateDataClasses(
markerName: String? = null,
extensionProperties: Boolean = false,
visibility: MarkerVisibility = MarkerVisibility.IMPLICIT_PUBLIC,
useFqNames: Boolean = false,
nameNormalizer: NameNormalizer = NameNormalizer.default,
): CodeString =
schema().generateDataClasses(
name = markerName ?: markerName<T>(),
extensionProperties = extensionProperties,
visibility = visibility,
useFqNames = useFqNames,
nameNormalizer = nameNormalizer,
)

public fun <T> DataFrame<T>.generateInterfaces(markerName: String): CodeString =
schema().generateInterfaces(markerName = markerName)

// endregion

// region DataFrameSchema

@JvmName("generateCodeForSchema")
public fun DataFrameSchema.generateCode(
markerName: String,
fields: Boolean = true,
extensionProperties: Boolean = true,
visibility: MarkerVisibility = MarkerVisibility.IMPLICIT_PUBLIC,
): CodeString {
val codeGen = CodeGenerator.create()
return codeGen.generate(
schema = schema(),
schema = this,
name = markerName,
fields = fields,
extensionProperties = extensionProperties,
Expand All @@ -31,23 +77,25 @@ public fun <T> DataFrame<T>.generateCode(
).code.declarations.toCodeString()
}

public inline fun <reified T> DataFrame<T>.generateInterfaces(): CodeString =
@JvmName("generateInterfacesForSchema")
public fun DataFrameSchema.generateInterfaces(markerName: String): CodeString =
generateCode(
markerName = markerName,
fields = true,
extensionProperties = false,
)

public inline fun <reified T> DataFrame<T>.generateDataClasses(
markerName: String? = null,
@JvmName("generateDataClassesForSchema")
public fun DataFrameSchema.generateDataClasses(
name: String,
extensionProperties: Boolean = false,
visibility: MarkerVisibility = MarkerVisibility.IMPLICIT_PUBLIC,
useFqNames: Boolean = false,
nameNormalizer: NameNormalizer = NameNormalizer.default,
): CodeString {
val name = markerName ?: markerName<T>()
val codeGen = CodeGenerator.create(useFqNames)
return codeGen.generate(
schema = schema(),
schema = this,
name = name,
fields = true,
extensionProperties = extensionProperties,
Expand All @@ -58,6 +106,8 @@ public inline fun <reified T> DataFrame<T>.generateDataClasses(
).code.declarations.toCodeString()
}

// endregion

@PublishedApi
internal inline fun <reified T> markerName(): String =
if (T::class.isAbstract) {
Expand All @@ -66,13 +116,6 @@ internal inline fun <reified T> markerName(): String =
"DataEntry"
}

public fun <T> DataFrame<T>.generateInterfaces(markerName: String): CodeString =
generateCode(
markerName = markerName,
fields = true,
extensionProperties = false,
)

/**
* Converts delimited 'my_name', 'my name', etc., String to camelCase 'myName'
*/
Expand Down