Refactor path module of bevy_reflect (#8887)

# Objective

- The `path` module was getting fairly large.
- The code in `AccessRef::read_element` and mut equivalent was very
complex and difficult to understand.
- The `ReflectPathError` had a lot of variants, and was difficult to
read.

## Solution

- Split the file in two, `access` now has its own module
- Rewrite the `read_element` methods, they were ~200 lines long, they
are now ~70 lines long — I didn't change any of the logic. It's really
just the same code, but error handling is separated.
- Split the `ReflectPathError` error
- Merge `AccessRef` and `Access`
- A few other changes that aim to reduce code complexity

### Fully detailed change list

- `Display` impl of `ParsedPath` now includes prefix dots — this allows
simplifying its implementation, and IMO `.path.to.field` is a better way
to express a "path" than `path.to.field` which could suggest we are
reading the `to` field of a variable named `path`
- Add a test to check that dot prefixes and other are correctly parsed —
Until now, no test contained a prefixing dot
- Merge `Access` and `AccessRef`, using a `Cow<'a, str>`. Generated code
seems to agree with this decision (`ParsedPath::parse` sheds 5% of
instructions)
- Remove `Access::as_ref` since there is no such thing as an `AccessRef`
anymore.
- Rename `AccessRef::to_owned` into `AccessRef::into_owned()` since it
takes ownership of `self` now.
- Add a `parse_static` that doesn't allocate new strings for named
fields!
- Add a section about path reflection in the `bevy_reflect` crate root
doc — I saw a few people that weren't aware of path reflection, so I
thought it was pertinent to add it to the root doc
- a lot of nits
- rename `index` to `offset` when it refers to offset in the path string
— There is no more confusion with the other kind of indices in this
context, also it's a common naming convention for parsing.
  - Make a dedicated enum for parsing errors
- rename the `read_element` methods to `element` — shorter, but also
`read_element_mut` was a fairly poor name
- The error values now not only contain the expected type but also the
actual type.
- Remove lifetimes that could be inferred from the `GetPath` trait
methods.

---

## Change log

- Added the `ParsedPath::parse_static` method, avoids allocating when
parsing `&'static str`.

## Migration Guide

If you were matching on the `Err(ReflectPathError)` value returned by
`GetPath` and `ParsedPath` methods, now only the parse-related errors
and the offset are publicly accessible. You can always use the
`fmt::Display` to get a clear error message, but if you need
programmatic access to the error types, please open an issue.

---------

Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Co-authored-by: Gino Valente <49806985+MrGVSV@users.noreply.github.com>

crates/bevy_reflect/src/lib.rs

@@ -229,6 +229,29 @@
 //!
 //! All primitives and simple types implement `FromReflect` by relying on their [`Default`] implementation.
 //!
+//! # Path navigation
+//!
+//! The [`GetPath`] trait allows accessing arbitrary nested fields of a [`Reflect`] type.
+//!
+//! Using `GetPath`, it is possible to use a path string to access a specific field
+//! of a reflected type.
+//!
+//! ```
+//! # use bevy_reflect::{Reflect, GetPath};
+//! #[derive(Reflect)]
+//! struct MyStruct {
+//! value: Vec<Option<u32>>
+//! }
+//!
+//! let my_struct = MyStruct {
+//! value: vec![None, None, Some(123)],
+//! };
+//! assert_eq!(
+//! my_struct.path::<u32>(".value[2].0").unwrap(),
+//! &123,
+//! );
+//! ```
+//!
 //! # Type Registration
 //!
 //! This crate also comes with a [`TypeRegistry`] that can be used to store and retrieve additional type metadata at runtime,

crates/bevy_reflect/src/path/access.rs

@@ -0,0 +1,225 @@
+use std::{borrow::Cow, fmt};
+
+use super::{AccessError, ReflectPathError};
+use crate::{Reflect, ReflectMut, ReflectRef, VariantType};
+use thiserror::Error;
+
+type InnerResult<T> = Result<Option<T>, Error<'static>>;
+
+#[derive(Debug, PartialEq, Eq, Error)]
+pub(super) enum Error<'a> {
+ #[error(
+ "the current {ty} doesn't have the {} {}",
+ access.kind(),
+ access.display_value(),
+ )]
+ Access { ty: TypeShape, access: Access<'a> },
+
+ #[error("invalid type shape: expected {expected} but found a reflect {actual}")]
+ Type {
+ expected: TypeShape,
+ actual: TypeShape,
+ },
+
+ #[error("invalid enum access: expected {expected} variant but found {actual} variant")]
+ Enum {
+ expected: TypeShape,
+ actual: TypeShape,
+ },
+}
+
+impl<'a> Error<'a> {
+ fn with_offset(self, offset: usize) -> ReflectPathError<'a> {
+ let error = AccessError(self);
+ ReflectPathError::InvalidAccess { offset, error }
+ }
+
+ fn access(ty: TypeShape, access: Access<'a>) -> Self {
+ Self::Access { ty, access }
+ }
+}
+impl Error<'static> {
+ fn bad_enum_variant(expected: TypeShape, actual: impl Into<TypeShape>) -> Self {
+ let actual = actual.into();
+ Error::Enum { expected, actual }
+ }
+ fn bad_type(expected: TypeShape, actual: impl Into<TypeShape>) -> Self {
+ let actual = actual.into();
+ Error::Type { expected, actual }
+ }
+}
+
+#[derive(Debug, Copy, Clone, PartialEq, Eq)]
+pub(super) enum TypeShape {
+ Struct,
+ TupleStruct,
+ Tuple,
+ List,
+ Array,
+ Map,
+ Enum,
+ Value,
+ Unit,
+}
+
+impl fmt::Display for TypeShape {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ let name = match self {
+ TypeShape::Struct => "struct",
+ TypeShape::TupleStruct => "tuple struct",
+ TypeShape::Tuple => "tuple",
+ TypeShape::List => "list",
+ TypeShape::Array => "array",
+ TypeShape::Map => "map",
+ TypeShape::Enum => "enum",
+ TypeShape::Value => "value",
+ TypeShape::Unit => "unit",
+ };
+ write!(f, "{name}")
+ }
+}
+impl<'a> From<ReflectRef<'a>> for TypeShape {
+ fn from(value: ReflectRef<'a>) -> Self {
+ match value {
+ ReflectRef::Struct(_) => TypeShape::Struct,
+ ReflectRef::TupleStruct(_) => TypeShape::TupleStruct,
+ ReflectRef::Tuple(_) => TypeShape::Tuple,
+ ReflectRef::List(_) => TypeShape::List,
+ ReflectRef::Array(_) => TypeShape::Array,
+ ReflectRef::Map(_) => TypeShape::Map,
+ ReflectRef::Enum(_) => TypeShape::Enum,
+ ReflectRef::Value(_) => TypeShape::Value,
+ }
+ }
+}
+impl From<VariantType> for TypeShape {
+ fn from(value: VariantType) -> Self {
+ match value {
+ VariantType::Struct => TypeShape::Struct,
+ VariantType::Tuple => TypeShape::Tuple,
+ VariantType::Unit => TypeShape::Unit,
+ }
+ }
+}
+
+/// A singular element access within a path.
+///
+/// Can be applied to a `dyn Reflect` to get a reference to the targeted element.
+#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
+pub(super) enum Access<'a> {
+ Field(Cow<'a, str>),
+ FieldIndex(usize),
+ TupleIndex(usize),
+ ListIndex(usize),
+}
+
+impl fmt::Display for Access<'_> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match self {
+ Access::Field(field) => write!(f, ".{field}"),
+ Access::FieldIndex(index) => write!(f, "#{index}"),
+ Access::TupleIndex(index) => write!(f, ".{index}"),
+ Access::ListIndex(index) => write!(f, "[{index}]"),
+ }
+ }
+}
+
+impl<'a> Access<'a> {
+ pub(super) fn into_owned(self) -> Access<'static> {
+ match self {
+ Self::Field(value) => Access::Field(value.to_string().into()),
+ Self::FieldIndex(value) => Access::FieldIndex(value),
+ Self::TupleIndex(value) => Access::TupleIndex(value),
+ Self::ListIndex(value) => Access::ListIndex(value),
+ }
+ }
+
+ fn display_value(&self) -> &dyn fmt::Display {
+ match self {
+ Self::Field(value) => value,
+ Self::FieldIndex(value) | Self::TupleIndex(value) | Self::ListIndex(value) => value,
+ }
+ }
+ fn kind(&self) -> &'static str {
+ match self {
+ Self::Field(_) => "field",
+ Self::FieldIndex(_) => "field index",
+ Self::TupleIndex(_) | Self::ListIndex(_) => "index",
+ }
+ }
+
+ pub(super) fn element<'r>(
+ &self,
+ base: &'r dyn Reflect,
+ offset: usize,
+ ) -> Result<&'r dyn Reflect, ReflectPathError<'a>> {
+ let ty = base.reflect_ref().into();
+ self.element_inner(base)
+ .and_then(|maybe| maybe.ok_or(Error::access(ty, self.clone())))
+ .map_err(|err| err.with_offset(offset))
+ }
+
+ fn element_inner<'r>(&self, base: &'r dyn Reflect) -> InnerResult<&'r dyn Reflect> {
+ use ReflectRef::*;
+ match (self, base.reflect_ref()) {
+ (Self::Field(field), Struct(struct_ref)) => Ok(struct_ref.field(field.as_ref())),
+ (Self::Field(field), Enum(enum_ref)) => match enum_ref.variant_type() {
+ VariantType::Struct => Ok(enum_ref.field(field.as_ref())),
+ actual => Err(Error::bad_enum_variant(TypeShape::Struct, actual)),
+ },
+ (&Self::FieldIndex(index), Struct(struct_ref)) => Ok(struct_ref.field_at(index)),
+ (&Self::FieldIndex(index), Enum(enum_ref)) => match enum_ref.variant_type() {
+ VariantType::Struct => Ok(enum_ref.field_at(index)),
+ actual => Err(Error::bad_enum_variant(TypeShape::Struct, actual)),
+ },
+ (&Self::TupleIndex(index), TupleStruct(tuple)) => Ok(tuple.field(index)),
+ (&Self::TupleIndex(index), Tuple(tuple)) => Ok(tuple.field(index)),
+ (&Self::TupleIndex(index), Enum(enum_ref)) => match enum_ref.variant_type() {
+ VariantType::Tuple => Ok(enum_ref.field_at(index)),
+ actual => Err(Error::bad_enum_variant(TypeShape::Tuple, actual)),
+ },
+ (&Self::ListIndex(index), List(list)) => Ok(list.get(index)),
+ (&Self::ListIndex(index), Array(list)) => Ok(list.get(index)),
+ (&Self::ListIndex(_), actual) => Err(Error::bad_type(TypeShape::List, actual)),
+ (_, actual) => Err(Error::bad_type(TypeShape::Struct, actual)),
+ }
+ }
+
+ pub(super) fn element_mut<'r>(
+ &self,
+ base: &'r mut dyn Reflect,
+ offset: usize,
+ ) -> Result<&'r mut dyn Reflect, ReflectPathError<'a>> {
+ let ty = base.reflect_ref().into();
+ self.element_inner_mut(base)
+ .and_then(|maybe| maybe.ok_or(Error::access(ty, self.clone())))
+ .map_err(|err| err.with_offset(offset))
+ }
+
+ fn element_inner_mut<'r>(&self, base: &'r mut dyn Reflect) -> InnerResult<&'r mut dyn Reflect> {
+ use ReflectMut::*;
+ let base_shape: TypeShape = base.reflect_ref().into();
+ match (self, base.reflect_mut()) {
+ (Self::Field(field), Struct(struct_mut)) => Ok(struct_mut.field_mut(field.as_ref())),
+ (Self::Field(field), Enum(enum_mut)) => match enum_mut.variant_type() {
+ VariantType::Struct => Ok(enum_mut.field_mut(field.as_ref())),
+ actual => Err(Error::bad_enum_variant(TypeShape::Struct, actual)),
+ },
+ (&Self::FieldIndex(index), Struct(struct_mut)) => Ok(struct_mut.field_at_mut(index)),
+ (&Self::FieldIndex(index), Enum(enum_mut)) => match enum_mut.variant_type() {
+ VariantType::Struct => Ok(enum_mut.field_at_mut(index)),
+ actual => Err(Error::bad_enum_variant(TypeShape::Struct, actual)),
+ },
+ (&Self::TupleIndex(index), TupleStruct(tuple)) => Ok(tuple.field_mut(index)),
+ (&Self::TupleIndex(index), Tuple(tuple)) => Ok(tuple.field_mut(index)),
+ (&Self::TupleIndex(index), Enum(enum_mut)) => match enum_mut.variant_type() {
+ VariantType::Tuple => Ok(enum_mut.field_at_mut(index)),
+ actual => Err(Error::bad_enum_variant(TypeShape::Tuple, actual)),
+ },
+ (&Self::ListIndex(index), List(list)) => Ok(list.get_mut(index)),
+ (&Self::ListIndex(index), Array(list)) => Ok(list.get_mut(index)),
+ (&Self::ListIndex(_), _) => Err(Error::bad_type(TypeShape::List, base_shape)),
+ (_, _) => Err(Error::bad_type(TypeShape::Struct, base_shape)),
+ }
+ }
+}