Prepare for rust update (#1523)

* run clippy and update code after rust update

* run cargo check on tests

* run cargo clippy fix on tests

* accept changes in xml tests because of the diagnostic box wrapper

* update rust to 1.90, set the version by parameter

Author: ghaith

.devcontainer/Dockerfile

@@ -1,5 +1,5 @@
-# FROM mcr.microsoft.com/vscode/devcontainers/rust:latest
-FROM ghcr.io/plc-lang/rust-llvm:latest
+ARG RUST_LLVM_VERSION=latest
+FROM ghcr.io/plc-lang/rust-llvm:${RUST_LLVM_VERSION}
 
 # Avoid warnings by switching to noninteractive
 ENV DEBIAN_FRONTEND=noninteractive

.github/workflows/windows.yml

@@ -14,7 +14,7 @@ jobs:
     name: Windows Build
     runs-on: windows-2022
     env:
-      toolchain-version: 1.83.0
+      toolchain-version: 1.90.0
       llvm-version: 14.0.6
     steps:
 

Dockerfile

@@ -1,4 +1,5 @@
-FROM ghcr.io/plc-lang/rust-llvm:latest
+ARG RUST_LLVM_VERSION=latest
+FROM ghcr.io/plc-lang/rust-llvm:${RUST_LLVM_VERSION}
 
 # Allow invoking `plc` from anywhere
 ENV PLCLOC="/opt/rusty"

compiler/plc_ast/src/ast.rs

@@ -584,7 +584,7 @@ impl Variable {
 #[derive(Clone, PartialEq)]
 pub enum DataTypeDeclaration {
     Reference { referenced_type: String, location: SourceLocation },
-    Definition { data_type: DataType, location: SourceLocation, scope: Option<String> },
+    Definition { data_type: Box<DataType>, location: SourceLocation, scope: Option<String> },
     Aggregate { referenced_type: String, location: SourceLocation },
 }
 
@@ -637,7 +637,7 @@ impl DataTypeDeclaration {
             DataTypeDeclaration::Reference { .. } => Some(self.clone()),
 
             DataTypeDeclaration::Definition { data_type, .. } => {
-                if let DataType::PointerType { referenced_type, .. } = data_type {
+                if let DataType::PointerType { referenced_type, .. } = data_type.as_ref() {
                     return referenced_type.get_inner_pointer_ty();
                 }
 

compiler/plc_ast/src/pre_processor.rs

@@ -61,7 +61,8 @@ pub fn pre_process(unit: &mut CompilationUnit, mut id_provider: IdProvider) {
                     if let DataTypeDeclaration::Definition { mut data_type, location, scope } = *datatype {
                         data_type.set_name(type_name);
                         add_nested_datatypes(name, &mut data_type, &mut new_types, &location);
-                        let data_type = UserTypeDeclaration { data_type, initializer: None, location, scope };
+                        let data_type =
+                            UserTypeDeclaration { data_type: *data_type, initializer: None, location, scope };
                         new_types.push(data_type);
                     }
                 }
@@ -311,11 +312,12 @@ fn preprocess_return_type(pou: &mut Pou, types: &mut Vec<UserTypeDeclaration>) {
                 referenced_type: type_name.clone(),
                 location: return_type.get_location(),
             };
-            let datatype = std::mem::replace(&mut pou.return_type, Some(type_ref));
+            let datatype = pou.return_type.replace(type_ref);
             if let Some(DataTypeDeclaration::Definition { mut data_type, location, scope }) = datatype {
                 data_type.set_name(type_name);
                 add_nested_datatypes(pou.name.as_str(), &mut data_type, types, &location);
-                let data_type = UserTypeDeclaration { data_type, initializer: None, location, scope };
+                let data_type =
+                    UserTypeDeclaration { data_type: *data_type, initializer: None, location, scope };
                 types.push(data_type);
             }
         }
@@ -325,7 +327,11 @@ fn preprocess_return_type(pou: &mut Pou, types: &mut Vec<UserTypeDeclaration>) {
 fn should_generate_implicit(datatype: &DataTypeDeclaration) -> bool {
     match datatype {
         DataTypeDeclaration::Reference { .. } | DataTypeDeclaration::Aggregate { .. } => false,
-        DataTypeDeclaration::Definition { data_type: DataType::VarArgs { .. }, .. } => false,
+        DataTypeDeclaration::Definition { data_type, .. }
+            if matches!(data_type.as_ref(), DataType::VarArgs { .. }) =>
+        {
+            false
+        }
         DataTypeDeclaration::Definition { .. } => true,
     }
 }
@@ -346,7 +352,7 @@ fn pre_process_variable_data_type(
         // create index entry
         add_nested_datatypes(new_type_name.as_str(), &mut data_type, types, &location);
         data_type.set_name(new_type_name);
-        types.push(UserTypeDeclaration { data_type, initializer: None, location, scope });
+        types.push(UserTypeDeclaration { data_type: *data_type, initializer: None, location, scope });
     }
     //make sure it gets generated
 }
@@ -370,13 +376,18 @@ fn add_nested_datatypes(
     {
         data_type.set_name(new_type_name.clone());
         add_nested_datatypes(new_type_name.as_str(), &mut data_type, types, &inner_location);
-        types.push(UserTypeDeclaration { data_type, initializer: None, location: location.clone(), scope });
+        types.push(UserTypeDeclaration {
+            data_type: *data_type,
+            initializer: None,
+            location: location.clone(),
+            scope,
+        });
     }
 }
 
 fn replace_generic_type_name(dt: &mut DataTypeDeclaration, generics: &FxHashMap<String, String>) {
     match dt {
-        DataTypeDeclaration::Definition { data_type, .. } => match data_type {
+        DataTypeDeclaration::Definition { data_type, .. } => match data_type.as_mut() {
             DataType::ArrayType { referenced_type, .. }
             | DataType::PointerType { referenced_type, .. }
             | DataType::VarArgs { referenced_type: Some(referenced_type), .. } => {

compiler/plc_diagnostics/src/diagnostics.rs

@@ -1,4 +1,7 @@
-use std::fmt::Display;
+use std::{
+    fmt::Display,
+    ops::{Deref, DerefMut},
+};
 
 use serde::{Deserialize, Serialize};
 
@@ -29,6 +32,11 @@ pub enum Severity {
 /// Diagnostic severity can be overridden when being reported.
 #[derive(Debug)]
 pub struct Diagnostic {
+    pub inner: Box<DiagnosticsInner>,
+}
+
+#[derive(Debug)]
+pub struct DiagnosticsInner {
     /// The Description of the error being reported.
     pub message: String,
     /// Primary location where the diagnostic occurred
@@ -43,6 +51,20 @@ pub struct Diagnostic {
     pub internal_error: Option<anyhow::Error>,
 }
 
+impl Deref for Diagnostic {
+    type Target = DiagnosticsInner;
+
+    fn deref(&self) -> &Self::Target {
+        &self.inner
+    }
+}
+
+impl DerefMut for Diagnostic {
+    fn deref_mut(&mut self) -> &mut Self::Target {
+        &mut self.inner
+    }
+}
+
 impl std::error::Error for Diagnostic {
     fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
         self.internal_error.as_ref().and_then(|it| it.source())
@@ -58,14 +80,15 @@ impl From<std::io::Error> for Diagnostic {
 /// Builder for Diagnostics
 impl Diagnostic {
     pub fn new(message: impl Into<String>) -> Self {
-        Diagnostic {
+        let inner = DiagnosticsInner {
             message: message.into(),
             primary_location: SourceLocation::undefined(),
             secondary_locations: Default::default(),
             error_code: "E001", //Default error if none specified
             sub_diagnostics: Default::default(),
             internal_error: Default::default(),
-        }
+        };
+        Self { inner: Box::new(inner) }
     }
 
     pub fn with_location<T>(mut self, location: T) -> Self

compiler/plc_xml/src/model/snapshots/plc_xml__model__fbd__tests__recursive_sink_source_connections_are_an_error.snap

@@ -4,45 +4,51 @@ expression: err
 ---
 [
     Diagnostic {
-        message: "Sink is connected to itself. Found the following recursion: connection2 -> connection1 -> connection2",
-        primary_location: SourceLocation {
-            span: Block {
-                local_id: 6,
-                execution_order: None,
-                inner_range: None,
+        inner: DiagnosticsInner {
+            message: "Sink is connected to itself. Found the following recursion: connection2 -> connection1 -> connection2",
+            primary_location: SourceLocation {
+                span: Block {
+                    local_id: 6,
+                    execution_order: None,
+                    inner_range: None,
+                },
             },
+            secondary_locations: None,
+            error_code: "E085",
+            sub_diagnostics: [],
+            internal_error: None,
         },
-        secondary_locations: None,
-        error_code: "E085",
-        sub_diagnostics: [],
-        internal_error: None,
     },
     Diagnostic {
-        message: "Sink is connected to itself. Found the following recursion: connection2 -> connection1 -> connection2",
-        primary_location: SourceLocation {
-            span: Block {
-                local_id: 6,
-                execution_order: None,
-                inner_range: None,
+        inner: DiagnosticsInner {
+            message: "Sink is connected to itself. Found the following recursion: connection2 -> connection1 -> connection2",
+            primary_location: SourceLocation {
+                span: Block {
+                    local_id: 6,
+                    execution_order: None,
+                    inner_range: None,
+                },
             },
+            secondary_locations: None,
+            error_code: "E085",
+            sub_diagnostics: [],
+            internal_error: None,
         },
-        secondary_locations: None,
-        error_code: "E085",
-        sub_diagnostics: [],
-        internal_error: None,
     },
     Diagnostic {
-        message: "Sink is connected to itself. Found the following recursion: connection1 -> connection2 -> connection1",
-        primary_location: SourceLocation {
-            span: Block {
-                local_id: 5,
-                execution_order: None,
-                inner_range: None,
+        inner: DiagnosticsInner {
+            message: "Sink is connected to itself. Found the following recursion: connection1 -> connection2 -> connection1",
+            primary_location: SourceLocation {
+                span: Block {
+                    local_id: 5,
+                    execution_order: None,
+                    inner_range: None,
+                },
             },
+            secondary_locations: None,
+            error_code: "E085",
+            sub_diagnostics: [],
+            internal_error: None,
         },
-        secondary_locations: None,
-        error_code: "E085",
-        sub_diagnostics: [],
-        internal_error: None,
     },
 ]

compiler/plc_xml/src/model/snapshots/plc_xml__model__fbd__tests__unassociated_sink_removed_from_model_with_error.snap

@@ -4,17 +4,19 @@ expression: err
 ---
 [
     Diagnostic {
-        message: "Expected a corresponding source-connection mark for sink 'connection1', but could not find one.",
-        primary_location: SourceLocation {
-            span: Block {
-                local_id: 3,
-                execution_order: None,
-                inner_range: None,
+        inner: DiagnosticsInner {
+            message: "Expected a corresponding source-connection mark for sink 'connection1', but could not find one.",
+            primary_location: SourceLocation {
+                span: Block {
+                    local_id: 3,
+                    execution_order: None,
+                    inner_range: None,
+                },
             },
+            secondary_locations: None,
+            error_code: "E086",
+            sub_diagnostics: [],
+            internal_error: None,
         },
-        secondary_locations: None,
-        error_code: "E086",
-        sub_diagnostics: [],
-        internal_error: None,
     },
 ]

compiler/plc_xml/src/model/snapshots/plc_xml__model__fbd__tests__unconnected_source_has_no_effect.snap

@@ -4,17 +4,19 @@ expression: err
 ---
 [
     Diagnostic {
-        message: "Source 'connection1' is not connected.",
-        primary_location: SourceLocation {
-            span: Block {
-                local_id: 3,
-                execution_order: None,
-                inner_range: None,
+        inner: DiagnosticsInner {
+            message: "Source 'connection1' is not connected.",
+            primary_location: SourceLocation {
+                span: Block {
+                    local_id: 3,
+                    execution_order: None,
+                    inner_range: None,
+                },
             },
+            secondary_locations: None,
+            error_code: "E084",
+            sub_diagnostics: [],
+            internal_error: None,
         },
-        secondary_locations: None,
-        error_code: "E084",
-        sub_diagnostics: [],
-        internal_error: None,
     },
 ]

compiler/plc_xml/src/xml_parser.rs

@@ -48,7 +48,7 @@ where
     fn visit(reader: &mut Reader, tag: Option<BytesStart>) -> Result<Self, Error>;
 }
 
-pub(crate) fn visit(content: &str) -> Result<Project, Error> {
+pub(crate) fn visit(content: &str) -> Result<Project<'_>, Error> {
     let mut reader = Reader::new(content);
     reader.trim_text(true).expand_empty_elements(true);
     let mut project = Project::default();