Skip to content
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

Non-functional miscellaneous improvements #1445

Merged
merged 11 commits into from
Jun 27, 2022
Merged

Non-functional miscellaneous improvements #1445

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
caacd6a
Make `extraDependencies` from `InlineDependency` class private
david-perez Jun 7, 2022
80e4d6c
Miscellaneous improvements to `RustTypes.kt`
david-perez Jun 7, 2022
9905e05
Remove dead code from `RuntimeTypes.kt`
david-perez Jun 7, 2022
2b231e8
Style change in `RuntimeTypes.kt`
david-perez Jun 7, 2022
f1b44e6
Miscellaneous improvements to `SymbolVisitor.kt`
david-perez Jun 7, 2022
a9992f1
Miscellaneous improvements to `BuilderGenerator.kt`
david-perez Jun 7, 2022
f6043cb
Miscellaneous improvements to `TestHelpers.kt`
david-perez Jun 7, 2022
eeee68f
Add docs to `headers_for_prefix` function
david-perez Jun 7, 2022
7fecff6
Fix patch in `BuilderGenerator.kt`
david-perez Jun 7, 2022
64a557d
Merge branch 'main' into davidpz/miscellaneous-improvements
Velfi Jun 9, 2022
8f4d209
Merge remote-tracking branch 'upstream/main' into davidpz/miscellaneo…
david-perez Jun 27, 2022
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
2 changes: 1 addition & 1 deletion codegen/src/main/kotlin/software/amazon/smithy/rust/codegen/rustlang/CargoDependency.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ sealed class RustDependency(open val name: String) : SymbolDependencyContainer {
class InlineDependency(
name: String,
val module: RustModule,
val extraDependencies: List<RustDependency> = listOf(),
private val extraDependencies: List<RustDependency> = listOf(),
val renderer: (RustWriter) -> Unit
) : RustDependency(name) {
override fun version(): String {
Expand Down
34 changes: 15 additions & 19 deletions codegen/src/main/kotlin/software/amazon/smithy/rust/codegen/rustlang/RustTypes.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,11 +91,11 @@ sealed class RustType {
}

data class Reference(val lifetime: kotlin.String?, override val member: RustType) : RustType(), Container {
override val name: kotlin.String = member.name
override val name = member.name
}

data class Option(override val member: RustType) : RustType(), Container {
override val name: kotlin.String = "Option"
override val name = "Option"
override val namespace = "std::option"

/** Convert `Option<T>` to `Option<&T>` **/
Expand All @@ -105,7 +105,7 @@ sealed class RustType {
}

data class Box(override val member: RustType) : RustType(), Container {
override val name: kotlin.String = "Box"
override val name = "Box"
override val namespace = "std::boxed"
}

Expand All @@ -115,7 +115,7 @@ sealed class RustType {
}

data class Vec(override val member: RustType) : RustType(), Container {
override val name: kotlin.String = "Vec"
override val name = "Vec"
override val namespace = "std::vec"
}

Expand Down Expand Up @@ -148,25 +148,21 @@ fun RustType.asArgumentType(fullyQualified: Boolean = true): String {
}

/** Format this Rust type so that it may be used as an argument type in a function definition */
fun RustType.asArgumentValue(name: String): String {
return when (this) {
is RustType.String,
is RustType.Box -> "$name.into()"
fun RustType.asArgumentValue(name: String) =
when (this) {
is RustType.String, is RustType.Box -> "$name.into()"
else -> name
}
}

/**
* For a given name, generate an `Argument` data class containing pre-formatted strings for using this type when
* writing a Rust function
* writing a Rust function.
*/
fun RustType.asArgument(name: String): Argument {
return Argument(
"$name: ${this.asArgumentType()}",
this.asArgumentValue(name),
this.render(),
)
}
fun RustType.asArgument(name: String) = Argument(
"$name: ${this.asArgumentType()}",
this.asArgumentValue(name),
this.render(),
)

/**
* Render this type, including references and generic parameters.
Expand Down Expand Up @@ -270,7 +266,7 @@ fun RustType.isCopy(): Boolean = when (this) {
}

/**
* Meta information about a Rust construction (field, struct, or enum)
* Meta information about a Rust construction (field, struct, or enum).
*/
data class RustMetadata(
val derives: Attribute.Derives = Attribute.Derives.Empty,
Expand All @@ -292,7 +288,7 @@ data class RustMetadata(
return this
}

fun renderVisibility(writer: RustWriter): RustMetadata {
private fun renderVisibility(writer: RustWriter): RustMetadata {
if (public) {
writer.writeInline("pub ")
}
Expand Down
6 changes: 1 addition & 5 deletions codegen/src/main/kotlin/software/amazon/smithy/rust/codegen/smithy/RuntimeTypes.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,6 @@ data class RuntimeType(val name: String?, val dependency: RustDependency?, val n
val Display = stdfmt.member("Display")
val From = RuntimeType("From", dependency = null, namespace = "std::convert")
val TryFrom = RuntimeType("TryFrom", dependency = null, namespace = "std::convert")
val Infallible = RuntimeType("Infallible", dependency = null, namespace = "std::convert")
val PartialEq = std.member("cmp::PartialEq")
val StdError = RuntimeType("Error", dependency = null, namespace = "std::error")
val String = RuntimeType("String", dependency = null, namespace = "std::string")
Expand Down Expand Up @@ -235,17 +234,14 @@ data class RuntimeType(val name: String?, val dependency: RustDependency?, val n
val HttpRequestBuilder = Http("request::Builder")
val HttpResponseBuilder = Http("response::Builder")

val Hyper = CargoDependency.Hyper.asType()

fun eventStreamReceiver(runtimeConfig: RuntimeConfig): RuntimeType =
RuntimeType(
"Receiver",
dependency = CargoDependency.SmithyHttp(runtimeConfig),
"aws_smithy_http::event_stream"
)

fun jsonErrors(runtimeConfig: RuntimeConfig) =
forInlineDependency(InlineDependency.jsonErrors(runtimeConfig))
fun jsonErrors(runtimeConfig: RuntimeConfig) = forInlineDependency(InlineDependency.jsonErrors(runtimeConfig))

val IdempotencyToken by lazy { forInlineDependency(InlineDependency.idempotencyToken()) }

Expand Down
47 changes: 23 additions & 24 deletions codegen/src/main/kotlin/software/amazon/smithy/rust/codegen/smithy/SymbolVisitor.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,9 @@ fun Symbol.mapRustType(f: (RustType) -> RustType): Symbol {
/** Set the symbolLocation for this symbol builder */
fun Symbol.Builder.locatedIn(symbolLocation: SymbolLocation): Symbol.Builder {
val currentRustType = this.build().rustType()
check(currentRustType is RustType.Opaque) { "Only Opaque can have their namespace updated" }
check(currentRustType is RustType.Opaque) {
"Only `Opaque` can have their namespace updated"
}
val newRustType = currentRustType.copy(namespace = "crate::${symbolLocation.namespace}")
return this.definitionFile("src/${symbolLocation.filename}")
.namespace("crate::${symbolLocation.namespace}", "::")
Expand Down Expand Up @@ -156,6 +158,18 @@ fun SymbolProvider.wrapOptional(member: MemberShape, value: String): String = va
*/
fun SymbolProvider.toOptional(member: MemberShape, value: String): String = value.letIf(!toSymbol(member).isOptional()) { "Some($value)" }

/**
* Services can rename their contained shapes. See https://awslabs.github.io/smithy/1.0/spec/core/model.html#service
* specifically, `rename`
*/
fun Shape.contextName(serviceShape: ServiceShape?): String {
return if (serviceShape != null) {
id.getName(serviceShape)
} else {
id.name
}
}

/**
* Base converter from `Shape` to `Symbol`. Shapes are the direct contents of the `Smithy` model. `Symbols` carry information
* about Rust types, namespaces, dependencies, metadata as well as other information required to render a symbol.
Expand All @@ -176,18 +190,6 @@ class SymbolVisitor(
return shape.accept(this)
}

/**
* Services can rename their contained shapes. See https://awslabs.github.io/smithy/1.0/spec/core/model.html#service
* specifically, `rename`
*/
private fun Shape.contextName(): String {
return if (serviceShape != null) {
id.getName(serviceShape)
} else {
id.name
}
}

/**
* Return the name of a given `enum` variant. Note that this refers to `enum` in the Smithy context
* where enum is a trait that can be applied to [StringShape] and not in the Rust context of an algebraic data type.
Expand Down Expand Up @@ -246,7 +248,8 @@ class SymbolVisitor(
override fun doubleShape(shape: DoubleShape): Symbol = simpleShape(shape)
override fun stringShape(shape: StringShape): Symbol {
return if (shape.hasTrait<EnumTrait>()) {
symbolBuilder(shape, RustType.Opaque(shape.contextName().toPascalCase())).locatedIn(Models).build()
val rustType = RustType.Opaque(shape.contextName(serviceShape).toPascalCase())
symbolBuilder(shape, rustType).locatedIn(Models).build()
} else {
simpleShape(shape)
}
Expand Down Expand Up @@ -293,7 +296,7 @@ class SymbolVisitor(
return symbolBuilder(
shape,
RustType.Opaque(
shape.contextName()
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is fine—operations can't be renamed which is why the no-arg method exists

shape.contextName(serviceShape)
.replaceFirstChar { it.uppercase() }
)
)
Expand All @@ -313,7 +316,7 @@ class SymbolVisitor(
val isError = shape.hasTrait<ErrorTrait>()
val isInput = shape.hasTrait<SyntheticInputTrait>()
val isOutput = shape.hasTrait<SyntheticOutputTrait>()
val name = shape.contextName().toPascalCase().letIf(isError && config.codegenConfig.renameExceptions) {
val name = shape.contextName(serviceShape).toPascalCase().letIf(isError && config.codegenConfig.renameExceptions) {
it.replace("Exception", "Error")
}
val builder = symbolBuilder(shape, RustType.Opaque(name))
Expand All @@ -326,7 +329,7 @@ class SymbolVisitor(
}

override fun unionShape(shape: UnionShape): Symbol {
val name = shape.contextName().toPascalCase()
val name = shape.contextName(serviceShape).toPascalCase()
val builder = symbolBuilder(shape, RustType.Opaque(name)).locatedIn(Models)

return builder.build()
Expand Down Expand Up @@ -363,9 +366,7 @@ private const val SHAPE_KEY = "shape"
private const val SYMBOL_DEFAULT = "symboldefault"
private const val RENAMED_FROM_KEY = "renamedfrom"

fun Symbol.Builder.rustType(rustType: RustType): Symbol.Builder {
return this.putProperty(RUST_TYPE_KEY, rustType)
}
fun Symbol.Builder.rustType(rustType: RustType): Symbol.Builder = this.putProperty(RUST_TYPE_KEY, rustType)

fun Symbol.Builder.renamedFrom(name: String): Symbol.Builder {
return this.putProperty(RENAMED_FROM_KEY, name)
Expand All @@ -374,9 +375,7 @@ fun Symbol.Builder.renamedFrom(name: String): Symbol.Builder {
fun Symbol.renamedFrom(): String? = this.getProperty(RENAMED_FROM_KEY, String::class.java).orNull()

fun Symbol.defaultValue(): Default = this.getProperty(SYMBOL_DEFAULT, Default::class.java).orElse(Default.NoDefault)
fun Symbol.Builder.setDefault(default: Default): Symbol.Builder {
return this.putProperty(SYMBOL_DEFAULT, default)
}
fun Symbol.Builder.setDefault(default: Default): Symbol.Builder = this.putProperty(SYMBOL_DEFAULT, default)

/**
* Type representing the default value for a given type. (eg. for Strings, this is `""`)
Expand Down Expand Up @@ -414,7 +413,7 @@ fun Symbol.extractSymbolFromOption(): Symbol = this.mapRustType { it.stripOuter<
fun Symbol.isRustBoxed(): Boolean = rustType().stripOuter<RustType.Option>() is RustType.Box

// Symbols should _always_ be created with a Rust type & shape attached
fun Symbol.rustType(): RustType = this.getProperty(RUST_TYPE_KEY, RustType::class.java).get()
fun Symbol.rustType(): RustType = this.expectProperty(RUST_TYPE_KEY, RustType::class.java)
fun Symbol.shape(): Shape = this.expectProperty(SHAPE_KEY, Shape::class.java)

/**
Expand Down
Loading