Merge pull request #141 from Rustfahrtagentur/pat/review_model

WilstonOreo · web-flow · commit e34debe6f639 · 2025-06-07T11:39:32.000+02:00
Pat/review model
diff --git a/builtin/algorithm/mod.rs b/builtin/algorithm/mod.rs
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
 use microcad_core::BooleanOp;
-use microcad_lang::{modeltree::*, resolve::*, src_ref::*, syntax::*, value::*};
+use microcad_lang::{model_tree::*, resolve::*, src_ref::*, syntax::*, value::*};
 
 /// Creates a node containing a difference algorithm
 fn difference() -> Symbol {
diff --git a/builtin/geo2d/circle.rs b/builtin/geo2d/circle.rs
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
 use microcad_core::*;
-use microcad_lang::{eval::*, modeltree::*, rc::*, src_ref::*, syntax::*, ty::*};
+use microcad_lang::{eval::*, model_tree::*, rc::*, src_ref::*, syntax::*, ty::*};
 
 /// Builtin definition for a 2D circle
 #[derive(Debug)]
diff --git a/builtin/geo2d/rect.rs b/builtin/geo2d/rect.rs
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
 use microcad_core::*;
-use microcad_lang::{eval::*, modeltree::*, rc::*, src_ref::*, syntax::*, ty::*};
+use microcad_lang::{eval::*, model_tree::*, rc::*, src_ref::*, syntax::*, ty::*};
 
 #[derive(Debug)]
 pub struct Rect {
diff --git a/builtin/geo3d/cube.rs b/builtin/geo3d/cube.rs
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
 use microcad_core::*;
-use microcad_lang::{eval::*, modeltree::*, rc::*, src_ref::*, syntax::*, ty::Type};
+use microcad_lang::{eval::*, model_tree::*, rc::*, src_ref::*, syntax::*, ty::Type};
 
 /// The builtin cube primitive, defined by its size in the x, y, and z dimensions.
 #[derive(Debug)]
diff --git a/builtin/geo3d/cylinder.rs b/builtin/geo3d/cylinder.rs
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
 use microcad_core::*;
-use microcad_lang::{eval::*, modeltree::*, rc::*, src_ref::*, syntax::*, ty::Type};
+use microcad_lang::{eval::*, model_tree::*, rc::*, src_ref::*, syntax::*, ty::Type};
 /// The built-in cylinder primitive, defined by an bottom radius, top radius and height.
 /// The cylinder is oriented along the z-axis.
 #[derive(Debug)]
diff --git a/builtin/geo3d/sphere.rs b/builtin/geo3d/sphere.rs
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
 use microcad_core::*;
-use microcad_lang::{eval::*, modeltree::*, rc::*, src_ref::*, syntax::*, ty::Type};
+use microcad_lang::{eval::*, model_tree::*, rc::*, src_ref::*, syntax::*, ty::Type};
 
 /// The builtin sphere primitive, defined by its radius.
 #[derive(Debug)]
diff --git a/builtin/transform/rotate.rs b/builtin/transform/rotate.rs
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
 use microcad_core::*;
-use microcad_lang::{eval::*, modeltree::*, src_ref::*, syntax::*, ty::*};
+use microcad_lang::{eval::*, model_tree::*, src_ref::*, syntax::*, ty::*};
 
 /// Builtin definition for a 2D circle
 #[derive(Debug)]
diff --git a/builtin/transform/translate.rs b/builtin/transform/translate.rs
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
 use microcad_core::*;
-use microcad_lang::{eval::*, modeltree::*, src_ref::*, syntax::*, ty::*};
+use microcad_lang::{eval::*, model_tree::*, src_ref::*, syntax::*, ty::*};
 
 /// Builtin definition for a 2D circle
 #[derive(Debug)]
diff --git a/lang/builtin/attributes.rs b/lang/builtin/attributes.rs
@@ -3,7 +3,7 @@
 
 //! Built-in metadata.
 
-use crate::{diag::*, eval::*, modeltree::*, syntax::*, ty::*, value::*};
+use crate::{diag::*, eval::*, model_tree::*, syntax::*, ty::*, value::*};
 
 /// Create built-in tag [`MetadataItem`].
 pub fn tag(id: &Identifier) -> EvalResult<Option<MetadataItem>> {
diff --git a/lang/eval/attribute.rs b/lang/eval/attribute.rs
@@ -1,7 +1,7 @@
 // Copyright © 2025 The µcad authors <info@ucad.xyz>
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
-use crate::{eval::*, modeltree::*, syntax::*};
+use crate::{eval::*, model_tree::*, syntax::*};
 
 use thiserror::Error;
 
diff --git a/lang/eval/builtin.rs b/lang/eval/builtin.rs
@@ -3,7 +3,7 @@
 
 //! Builtin function evaluation entity
 
-use crate::{eval::*, modeltree::*, syntax::*};
+use crate::{eval::*, model_tree::*, syntax::*};
 
 /// Builtin function type
 pub type BuiltinFn = dyn Fn(&CallArgumentValueList, &mut Context) -> EvalResult<Value>;
diff --git a/lang/eval/expression.rs b/lang/eval/expression.rs
@@ -1,7 +1,7 @@
 // Copyright © 2024-2025 The µcad authors <info@ucad.xyz>
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
-use crate::{eval::*, modeltree::*};
+use crate::{eval::*, model_tree::*};
 
 impl Eval for ListExpression {
     fn eval(&self, context: &mut Context) -> EvalResult<Value> {
@@ -162,7 +162,7 @@ impl Eval for Nested {
             node_stack.push(nodes);
         }
 
-        Ok(Value::Nodes(ObjectNodes::from_node_stack(&node_stack)))
+        Ok(Value::Nodes(ModelNodes::from_node_stack(&node_stack)))
     }
 }
 
diff --git a/lang/eval/init.rs b/lang/eval/init.rs
@@ -1,7 +1,7 @@
 // Copyright © 2024-2025 The µcad authors <info@ucad.xyz>
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
-use crate::{eval::*, modeltree::*, syntax::*};
+use crate::{eval::*, model_tree::*, syntax::*};
 
 impl InitDefinition {
     /// Evaluate a call to the init definition
diff --git a/lang/eval/part.rs b/lang/eval/part.rs
@@ -3,7 +3,7 @@
 
 //! Part definition syntax element evaluation
 
-use crate::{eval::*, modeltree::*, rc::*, syntax::*};
+use crate::{eval::*, model_tree::*, rc::*, syntax::*};
 
 impl PartDefinition {
     /// Find a matching initializer for call argument list
@@ -76,7 +76,7 @@ impl CallTrait for PartDefinition {
     /// Consider the `part a(b: Scalar) { }`.
     /// Calling the part `a([1.0, 2.0])` results in two nodes with `b = 1.0` and `b = 2.0`, respectively.
     fn call(&self, args: &CallArgumentValueList, context: &mut Context) -> EvalResult<Value> {
-        let mut nodes = ObjectNodes::default();
+        let mut nodes = ModelNodes::default();
 
         match self.find_matching_initializer(args, context) {
             Some((init, multi_args)) => {
diff --git a/lang/eval/statement.rs b/lang/eval/statement.rs
@@ -1,7 +1,7 @@
 // Copyright © 2025 The µcad authors <info@ucad.xyz>
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
-use crate::{eval::*, modeltree::*};
+use crate::{eval::*, model_tree::*};
 
 impl Eval for Assignment {
     fn eval(&self, context: &mut Context) -> EvalResult<Value> {
diff --git a/lang/lib.rs b/lang/lib.rs
@@ -15,7 +15,7 @@
 pub mod builtin;
 pub mod diag;
 pub mod eval;
-pub mod modeltree;
+pub mod model_tree;
 pub mod ord_map;
 pub mod parse;
 pub mod parser;
diff --git a/lang/model_tree/element.rs b/lang/model_tree/element.rs
@@ -3,7 +3,7 @@
 
 //! Element of a [`ModelNode`]
 
-use crate::modeltree::*;
+use crate::model_tree::*;
 use strum::IntoStaticStr;
 
 /// Inner of a node
diff --git a/lang/model_tree/metadata.rs b/lang/model_tree/metadata.rs
diff --git a/lang/model_tree/mod.rs b/lang/model_tree/mod.rs
@@ -247,7 +247,7 @@ impl ModelNode {
     /// Append a multiple nodes as children.
     ///
     /// Return self.
-    pub fn append_children(&self, nodes: ObjectNodes) -> Self {
+    pub fn append_children(&self, nodes: ModelNodes) -> Self {
         for node in nodes.iter() {
             self.append(node.clone())
         }
@@ -327,9 +327,9 @@ impl std::fmt::Display for ModelNode {
 
 /// Object node multiplicities.
 #[derive(Debug, Default, Clone, PartialEq)]
-pub struct ObjectNodes(Vec<ModelNode>);
+pub struct ModelNodes(Vec<ModelNode>);
 
-impl ObjectNodes {
+impl ModelNodes {
     /// Returns the first node if there is exactly one node in the list.
     pub fn single_node(&self) -> Option<ModelNode> {
         match self.0.len() {
@@ -371,7 +371,7 @@ impl ObjectNodes {
     ///       d0
     ///     c2
     ///       d0
-    pub fn from_node_stack(node_stack: &[ObjectNodes]) -> Self {
+    pub fn from_node_stack(node_stack: &[ModelNodes]) -> Self {
         match node_stack.len() {
             0 => panic!("Node stack must not be empty"),
             1 => {}
@@ -421,7 +421,7 @@ impl ObjectNodes {
     }
 
     /// Merge two lists of [`ObjectNode`] into one by concatenation.
-    pub fn merge(lhs: ObjectNodes, rhs: ObjectNodes) -> Self {
+    pub fn merge(lhs: ModelNodes, rhs: ModelNodes) -> Self {
         lhs.iter()
             .chain(rhs.iter())
             .cloned()
@@ -438,27 +438,27 @@ impl ObjectNodes {
     }
 }
 
-impl std::ops::Deref for ObjectNodes {
+impl std::ops::Deref for ModelNodes {
     type Target = Vec<ModelNode>;
 
     fn deref(&self) -> &Self::Target {
         &self.0
     }
 }
 
-impl std::ops::DerefMut for ObjectNodes {
+impl std::ops::DerefMut for ModelNodes {
     fn deref_mut(&mut self) -> &mut Self::Target {
         &mut self.0
     }
 }
 
-impl From<Vec<ModelNode>> for ObjectNodes {
+impl From<Vec<ModelNode>> for ModelNodes {
     fn from(value: Vec<ModelNode>) -> Self {
         Self(value)
     }
 }
 
-impl std::fmt::Display for ObjectNodes {
+impl std::fmt::Display for ModelNodes {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
         for node in self.iter() {
             node.fmt(f)?;
@@ -497,7 +497,7 @@ fn node_nest() {
     //       d0
     //     c2
     //       d0
-    let nodes = ObjectNodes::from_node_stack(&nodes);
+    let nodes = ModelNodes::from_node_stack(&nodes);
     assert_eq!(nodes.len(), 2); // Contains a0 and a1 as root
 
     for node in nodes.iter() {
diff --git a/lang/model_tree/object/mod.rs b/lang/model_tree/object/mod.rs
diff --git a/lang/model_tree/object/object_builder.rs b/lang/model_tree/object/object_builder.rs
@@ -3,7 +3,7 @@
 
 //! Object builder module
 
-use crate::{eval::*, modeltree::*};
+use crate::{eval::*, model_tree::*};
 
 /// Object builder to build up a [ModelNode] with an object element.
 #[derive(Default)]
@@ -12,7 +12,7 @@ pub struct ObjectBuilder {
     object: Object,
 
     /// Children to be placed in the node.
-    children: ObjectNodes,
+    children: ModelNodes,
 
     /// Metadata for the object node.
     metadata: Metadata,
@@ -59,7 +59,7 @@ impl ObjectBuilder {
     }
 
     /// Append child nodes to this object node.
-    pub fn append_children(&mut self, nodes: &mut ObjectNodes) -> &mut Self {
+    pub fn append_children(&mut self, nodes: &mut ModelNodes) -> &mut Self {
         (*self.children).append(nodes);
         self
     }
diff --git a/lang/model_tree/object/object_properties.rs b/lang/model_tree/object/object_properties.rs
diff --git a/lang/model_tree/transformation.rs b/lang/model_tree/transformation.rs
@@ -3,7 +3,7 @@
 
 //! Algorithm
 
-use crate::modeltree::*;
+use crate::model_tree::*;
 use microcad_core::*;
 
 /// Algorithm trait.
diff --git a/lang/syntax/body.rs b/lang/syntax/body.rs
@@ -3,7 +3,7 @@
 
 //! Body syntax element.
 
-use crate::{eval::*, modeltree::*, resolve::*, src_ref::*, syntax::*, value::*};
+use crate::{eval::*, model_tree::*, resolve::*, src_ref::*, syntax::*, value::*};
 
 /// A body is a list of statements inside `{}` brackets.
 #[derive(Clone, Debug, Default)]
diff --git a/lang/syntax/call/mod.rs b/lang/syntax/call/mod.rs
@@ -11,7 +11,7 @@ pub use call_argument::*;
 pub use call_argument_list::*;
 pub use method_call::*;
 
-use crate::{modeltree::*, src_ref::*, syntax::*, value::*};
+use crate::{model_tree::*, src_ref::*, syntax::*, value::*};
 
 /// Call of a function or init.
 #[derive(Clone, Debug, Default)]
diff --git a/lang/syntax/statement/assignment_statement.rs b/lang/syntax/statement/assignment_statement.rs
@@ -3,7 +3,7 @@
 
 //! Assignment statement syntax elements
 
-use crate::{modeltree::*, src_ref::*, syntax::*};
+use crate::{model_tree::*, src_ref::*, syntax::*};
 
 /// An assignment statement, e.g. `#[aux] s = sphere(3.0mm);`.
 #[derive(Clone, Debug)]
@@ -64,7 +64,7 @@ impl Eval for AssignmentStatement {
 
 impl AssignmentStatement {
     /// Try to evaluate the assignment into nodes.
-    pub fn try_eval_to_nodes(&self, context: &mut Context) -> EvalResult<ObjectNodes> {
+    pub fn try_eval_to_nodes(&self, context: &mut Context) -> EvalResult<ModelNodes> {
         let value = self
             .assignment
             .expression
diff --git a/lang/value/mod.rs b/lang/value/mod.rs
@@ -28,7 +28,7 @@ pub use unnamed_tuple::*;
 pub use value_error::*;
 pub use value_list::*;
 
-use crate::{modeltree::*, src_ref::*, syntax::*, ty::*};
+use crate::{model_tree::*, src_ref::*, syntax::*, ty::*};
 use microcad_core::*;
 
 pub(crate) type ValueResult<Type = Value> = std::result::Result<Type, ValueError>;
@@ -68,7 +68,7 @@ pub enum Value {
     /// A tuple of unnamed items.
     UnnamedTuple(UnnamedTuple),
     /// A node in the render tree.
-    Nodes(ObjectNodes),
+    Nodes(ModelNodes),
 }
 
 impl Value {
@@ -90,10 +90,10 @@ impl Value {
     }
 
     /// Fetch nodes from this value.
-    pub fn fetch_nodes(self) -> ObjectNodes {
+    pub fn fetch_nodes(self) -> ModelNodes {
         match self {
             Self::Nodes(n) => n,
-            _ => ObjectNodes::default(),
+            _ => ModelNodes::default(),
         }
     }
 
@@ -386,9 +386,9 @@ impl std::ops::BitOr for Value {
 
     fn bitor(self, rhs: Self) -> Self::Output {
         match (self, rhs) {
-            (Value::Nodes(lhs), Value::Nodes(rhs)) => Ok(Value::from_single_node(
-                ObjectNodes::merge(lhs, rhs).union(),
-            )),
+            (Value::Nodes(lhs), Value::Nodes(rhs)) => {
+                Ok(Value::from_single_node(ModelNodes::merge(lhs, rhs).union()))
+            }
             (lhs, rhs) => Err(ValueError::InvalidOperator(format!("{lhs} | {rhs}"))),
         }
     }
@@ -488,8 +488,8 @@ impl_try_from!(Bool => bool);
 impl_try_from!(String => String);
 impl_try_from!(Color => Color);
 
-impl From<ObjectNodes> for Value {
-    fn from(nodes: ObjectNodes) -> Self {
+impl From<ModelNodes> for Value {
+    fn from(nodes: ModelNodes) -> Self {
         match nodes.len() {
             0 => Value::None,
             _ => Value::Nodes(nodes),
diff --git a/tests/lib.rs b/tests/lib.rs
@@ -121,8 +121,8 @@ fn part_implicit_init_call() {
 
     assert_eq!(nodes.len(), 1, "There should be one node");
 
-    fn check_node_property_b(node: &modeltree::ModelNode, value: f64) {
-        if let modeltree::Element::Object(ref object) = *node.borrow().element() {
+    fn check_node_property_b(node: &model_tree::ModelNode, value: f64) {
+        if let model_tree::Element::Object(ref object) = *node.borrow().element() {
             assert_eq!(
                 object
                     .get_property_value(&Identifier(Refer::none("b".into())))
@@ -169,8 +169,8 @@ fn part_explicit_init_call() {
     };
 
     // Helper function to check if the object node contains a property radius with specified value
-    fn check_node_property_radius(node: &modeltree::ModelNode, value: f64) {
-        if let modeltree::Element::Object(ref object) = *node.borrow().element() {
+    fn check_node_property_radius(node: &model_tree::ModelNode, value: f64) {
+        if let model_tree::Element::Object(ref object) = *node.borrow().element() {
             log::trace!("Object: {object}");
             assert_eq!(
                 object
diff --git a/tools/cli/main.rs b/tools/cli/main.rs
