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

Adding support for Throwable error result types in Kotlin #741

Merged
merged 9 commits into from
Dec 9, 2024
Merged

Adding support for Throwable error result types in Kotlin #741

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d410799
Adding support for returning opaques as the error type of a result, a…
Dec 6, 2024
b42dea5
adding same support for throwable structs
Dec 6, 2024
4b00a85
clippy
Dec 6, 2024
221d862
fixing multiple inheritance
Dec 6, 2024
0e8a247
moooore clippy
Dec 6, 2024
8e99fb0
test fix
Dec 6, 2024
4e87935
new error log
Dec 6, 2024
c4309da
making custom `error` attribute
Dec 7, 2024
1b08ce5
clippy
Dec 7, 2024
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
32 changes: 30 additions & 2 deletions core/src/hir/attrs.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ pub struct Attrs {
/// This attribute does not participate in inheritance and must always
/// be specified on individual methods
pub special_method: Option<SpecialMethod>,
/// This user-defined type can be used as the error type in a Result.
pub custom_errors: bool,

/// From #[diplomat::demo()]. Created from [`crate::ast::attrs::Attrs::demo_attrs`].
/// List of attributes specific to automatic demo generation.
Expand Down Expand Up @@ -349,9 +351,16 @@ impl Attrs {
continue;
}
}
} else if path == "error" {
if !support.custom_errors {
maybe_error_unsupported(auto_found, "error", backend, errors);
continue;
}
auto_used = true;
this.custom_errors = true;
} else {
errors.push(LoweringError::Other(format!(
"Unknown diplomat attribute {path}: expected one of: `disable, rename, namespace, constructor, stringifier, comparison, named_constructor, getter, setter, indexer`"
"Unknown diplomat attribute {path}: expected one of: `disable, rename, namespace, constructor, stringifier, comparison, named_constructor, getter, setter, indexer, error`"
)));
}
if auto_found && !auto_used {
Expand All @@ -361,7 +370,7 @@ impl Attrs {
}
} else {
errors.push(LoweringError::Other(format!(
"Unknown diplomat attribute {path:?}: expected one of: `disable, rename, namespace, constructor, stringifier, comparison, named_constructor, getter, setter, indexer`"
"Unknown diplomat attribute {path:?}: expected one of: `disable, rename, namespace, constructor, stringifier, comparison, named_constructor, getter, setter, indexer, error`"
)));
}
}
Expand Down Expand Up @@ -458,6 +467,7 @@ impl Attrs {
rename,
abi_rename,
special_method,
custom_errors,
demo_attrs: _,
} = &self;

Expand Down Expand Up @@ -745,6 +755,17 @@ impl Attrs {
)));
}
}

if *custom_errors
&& !matches!(
context,
AttributeContext::Type(..) | AttributeContext::Trait(..)
)
{
errors.push(LoweringError::Other(
"`error` can only be used on types".to_string(),
));
}
}

pub(crate) fn for_inheritance(&self, context: AttrInheritContext) -> Attrs {
Expand Down Expand Up @@ -773,6 +794,8 @@ impl Attrs {
abi_rename: Default::default(),
// Never inherited
special_method: None,
// Not inherited
custom_errors: false,
demo_attrs: Default::default(),
}
}
Expand Down Expand Up @@ -849,6 +872,8 @@ pub struct BackendAttrSupport {
pub callbacks: bool,
/// Allowing traits
pub traits: bool,
/// Marking a user-defined type as being a valid error result type.
pub custom_errors: bool,
}

impl BackendAttrSupport {
Expand All @@ -875,6 +900,7 @@ impl BackendAttrSupport {
option: true,
callbacks: true,
traits: true,
custom_errors: true,
}
}
}
Expand Down Expand Up @@ -1007,6 +1033,7 @@ impl AttributeValidator for BasicAttributeValidator {
option,
callbacks,
traits,
custom_errors,
} = self.support;
match value {
"namespacing" => namespacing,
Expand All @@ -1029,6 +1056,7 @@ impl AttributeValidator for BasicAttributeValidator {
"option" => option,
"callbacks" => callbacks,
"traits" => traits,
"custom_errors" => custom_errors,
_ => {
return Err(LoweringError::Other(format!(
"Unknown supports = value found: {value}"
Expand Down
4 changes: 4 additions & 0 deletions core/src/hir/snapshots/diplomat_core__hir__elision__tests__elision_in_struct.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
source: core/src/hir/elision.rs
assertion_line: 536
expression: method
---
Method {
Expand Down Expand Up @@ -44,6 +45,7 @@ Method {
pattern: None,
},
special_method: None,
custom_errors: false,
demo_attrs: DemoInfo {
generate: false,
default_constructor: false,
Expand Down Expand Up @@ -97,6 +99,7 @@ Method {
pattern: None,
},
special_method: None,
custom_errors: false,
demo_attrs: DemoInfo {
generate: false,
default_constructor: false,
Expand All @@ -123,6 +126,7 @@ Method {
pattern: None,
},
special_method: None,
custom_errors: false,
demo_attrs: DemoInfo {
generate: false,
default_constructor: false,
Expand Down
11 changes: 11 additions & 0 deletions core/src/hir/snapshots/diplomat_core__hir__elision__tests__simple_mod.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
source: core/src/hir/elision.rs
assertion_line: 473
expression: tcx
---
TypeContext {
Expand Down Expand Up @@ -47,6 +48,7 @@ TypeContext {
pattern: None,
},
special_method: None,
custom_errors: false,
demo_attrs: DemoInfo {
generate: false,
default_constructor: false,
Expand Down Expand Up @@ -104,6 +106,7 @@ TypeContext {
pattern: None,
},
special_method: None,
custom_errors: false,
demo_attrs: DemoInfo {
generate: false,
default_constructor: false,
Expand Down Expand Up @@ -149,6 +152,7 @@ TypeContext {
pattern: None,
},
special_method: None,
custom_errors: false,
demo_attrs: DemoInfo {
generate: false,
default_constructor: false,
Expand All @@ -172,6 +176,7 @@ TypeContext {
pattern: None,
},
special_method: None,
custom_errors: false,
demo_attrs: DemoInfo {
generate: false,
default_constructor: false,
Expand Down Expand Up @@ -236,6 +241,7 @@ TypeContext {
pattern: None,
},
special_method: None,
custom_errors: false,
demo_attrs: DemoInfo {
generate: false,
default_constructor: false,
Expand Down Expand Up @@ -295,6 +301,7 @@ TypeContext {
pattern: None,
},
special_method: None,
custom_errors: false,
demo_attrs: DemoInfo {
generate: false,
default_constructor: false,
Expand Down Expand Up @@ -333,6 +340,7 @@ TypeContext {
pattern: None,
},
special_method: None,
custom_errors: false,
demo_attrs: DemoInfo {
generate: false,
default_constructor: false,
Expand Down Expand Up @@ -372,6 +380,7 @@ TypeContext {
pattern: None,
},
special_method: None,
custom_errors: false,
demo_attrs: DemoInfo {
generate: false,
default_constructor: false,
Expand All @@ -395,6 +404,7 @@ TypeContext {
pattern: None,
},
special_method: None,
custom_errors: false,
demo_attrs: DemoInfo {
generate: false,
default_constructor: false,
Expand Down Expand Up @@ -441,6 +451,7 @@ TypeContext {
pattern: None,
},
special_method: None,
custom_errors: false,
demo_attrs: DemoInfo {
generate: false,
default_constructor: false,
Expand Down
4 changes: 2 additions & 2 deletions core/src/hir/type_context.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ impl TypeContext {
)
}

pub fn all_traits<'tcx>(&'tcx self) -> impl Iterator<Item = (TraitId, &TraitDef)> {
pub fn all_traits<'tcx>(&'tcx self) -> impl Iterator<Item = (TraitId, &'tcx TraitDef)> {
self.traits
.iter()
.enumerate()
Expand Down Expand Up @@ -203,7 +203,7 @@ impl TypeContext {
pub(super) fn from_ast_without_validation<'ast>(
env: &'ast Env,
attr_validator: impl AttributeValidator + 'static,
) -> Result<(LoweringContext, Self), Vec<ErrorAndContext>> {
) -> Result<(LoweringContext<'ast>, Self), Vec<ErrorAndContext>> {
let mut ast_out_structs = SmallVec::<[_; 16]>::new();
let mut ast_structs = SmallVec::<[_; 16]>::new();
let mut ast_opaques = SmallVec::<[_; 16]>::new();
Expand Down
2 changes: 1 addition & 1 deletion example/kotlin/somelib/src/main/kotlin/dev/diplomattest/somelib/DataProvider.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ class DataProvider internal constructor (
if (returnVal.isOk == 1.toByte()) {
return Unit.ok()
} else {
return Unit.err()
return Unit.primitive_err()
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion example/kotlin/somelib/src/main/kotlin/dev/diplomattest/somelib/FixedDecimal.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ class FixedDecimal internal constructor (
val returnString = DW.writeToString(write)
return returnString.ok()
} else {
return Unit.err()
return Unit.primitive_err()
}
}

Expand Down
2 changes: 1 addition & 1 deletion example/kotlin/somelib/src/main/kotlin/dev/diplomattest/somelib/FixedDecimalFormatter.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ class FixedDecimalFormatter internal constructor (
CLEANER.register(returnOpaque, FixedDecimalFormatter.FixedDecimalFormatterCleaner(handle, FixedDecimalFormatter.lib));
return returnOpaque.ok()
} else {
return Unit.err()
return Unit.primitive_err()
}
}
}
Expand Down
6 changes: 5 additions & 1 deletion example/kotlin/somelib/src/main/kotlin/dev/diplomattest/somelib/Lib.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,10 +331,14 @@ internal fun <T> T.ok(): Result<T> {
return Result.success(this)
}

internal fun <T, E> E.err(): Result<T> {
internal fun <T, E> E.primitive_err(): Result<T> {
return Result.failure(RuntimeException("Received error $this"))
}

internal fun <T> Throwable.err(): Result<T> {
return Result.failure(this)
}

internal class ResultPointerUnitUnion: Union() {
@JvmField
internal var ok: Pointer = Pointer(0)
Expand Down
2 changes: 1 addition & 1 deletion feature_tests/kotlin/somelib/src/main/kotlin/dev/diplomattest/somelib/ErrorStruct.kt
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 5 additions & 1 deletion feature_tests/kotlin/somelib/src/main/kotlin/dev/diplomattest/somelib/Lib.kt
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion feature_tests/kotlin/somelib/src/main/kotlin/dev/diplomattest/somelib/MyZst.kt
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion feature_tests/kotlin/somelib/src/main/kotlin/dev/diplomattest/somelib/OptionString.kt
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 6 additions & 6 deletions feature_tests/kotlin/somelib/src/main/kotlin/dev/diplomattest/somelib/ResultOpaque.kt
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading