Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Improve generated interface function name to obtain the actual type #595

Merged
merged 3 commits into from
Jun 4, 2024
Merged

Improve generated interface function name to obtain the actual type #595

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
335b515
Improve interface function name
tmadlener May 6, 2024
31643d0
Fix occurences of getValue in tests
tmadlener May 6, 2024
67d378c
Update documentation
tmadlener May 23, 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
4 changes: 2 additions & 2 deletions doc/datamodel_syntax.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,10 +177,10 @@ bool same = (energyType == cluster); // <-- true (comparisons work as expected)
bool isCluster = energyType.isA<ExampleCluster>(); // <-- true
bool isHit = energyType.isA<ExampleHit>(); // <-- false

auto newCluster = energyType.getValue<ExampleCluster>(); // <-- "cast back" to original type
auto newCluster = energyType.as<ExampleCluster>(); // <-- "cast back" to original type

// "Casting" only works if the types match. Otherwise there will be an exception
auto newHit = energyType.getValue<ExampleHit>(); // <-- exception
auto newHit = energyType.as<ExampleHit>(); // <-- exception
```

## Global options
Expand Down
10 changes: 8 additions & 2 deletions python/templates/Interface.h.jinja2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,16 +131,22 @@ public:

/// Get the contained value as the concrete type it was put in. This will
/// throw a std::runtime_error if T is not the type of the currently held
/// value. Use holds to check beforehand if necessary template<typename T>
/// value. Use isA to check beforehand if necessary
template<typename T>
T getValue() const {
T as() const {
if (!isA<T>()) {
throw std::runtime_error("Cannot get value as object currently holds another type");
}
// We can safely cast here since we check types before
return static_cast<Model<T>*>(m_self.get())->m_value;
}

template<typename T>
[[deprecated("Use 'as' instead.")]]
T getValue() const {
return as<T>();
}

friend bool operator==(const {{ class.bare_type }}& lhs, const {{ class.bare_type }}& rhs) {
return lhs.m_self->equal(rhs.m_self.get());
}
Expand Down
12 changes: 6 additions & 6 deletions tests/unittests/interface_types.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,14 +73,14 @@ TEST_CASE("InterfaceType from immutable", "[interface-types][basics]") {
WrapperT wrapper{hit};
REQUIRE(wrapper.isA<ExampleHit>());
REQUIRE_FALSE(wrapper.isA<ExampleCluster>());
REQUIRE(wrapper.getValue<ExampleHit>() == hit);
REQUIRE(wrapper.as<ExampleHit>() == hit);
REQUIRE(wrapper == hit);

ExampleCluster cluster{};
wrapper = cluster;
REQUIRE(wrapper.isA<ExampleCluster>());
REQUIRE(wrapper.getValue<ExampleCluster>() == cluster);
REQUIRE_THROWS_AS(wrapper.getValue<ExampleHit>(), std::runtime_error);
REQUIRE(wrapper.as<ExampleCluster>() == cluster);
REQUIRE_THROWS_AS(wrapper.as<ExampleHit>(), std::runtime_error);
REQUIRE(wrapper != hit);
}

Expand All @@ -91,7 +91,7 @@ TEST_CASE("InterfaceType from mutable", "[interface-types][basics]") {
WrapperT wrapper{hit};
REQUIRE(wrapper.isA<ExampleHit>());
REQUIRE_FALSE(wrapper.isA<ExampleCluster>());
REQUIRE(wrapper.getValue<ExampleHit>() == hit);
REQUIRE(wrapper.as<ExampleHit>() == hit);
REQUIRE(wrapper == hit);
// Comparison also work against the immutable classes
ExampleHit immutableHit = hit;
Expand All @@ -100,8 +100,8 @@ TEST_CASE("InterfaceType from mutable", "[interface-types][basics]") {
MutableExampleCluster cluster{};
wrapper = cluster;
REQUIRE(wrapper.isA<ExampleCluster>());
REQUIRE(wrapper.getValue<ExampleCluster>() == cluster);
REQUIRE_THROWS_AS(wrapper.getValue<ExampleHit>(), std::runtime_error);
REQUIRE(wrapper.as<ExampleCluster>() == cluster);
REQUIRE_THROWS_AS(wrapper.as<ExampleHit>(), std::runtime_error);
REQUIRE(wrapper != hit);
}

Expand Down