feat: Properties

compiler/plc_ast/src/ast.rs

@@ -63,6 +63,40 @@
     pub location: SourceLocation,
 }
 
+#[derive(Debug, PartialEq, Clone)]
+pub struct Property {
+    pub name: String,
+    pub name_location: SourceLocation,
+    pub parent_kind: PouType,
+    pub parent_name: String,
+    pub parent_name_location: SourceLocation,
+    pub datatype: DataTypeDeclaration,
+    pub implementations: Vec<PropertyImplementation>,
+}
+
+#[derive(Debug, PartialEq, Clone)]
+pub struct PropertyImplementation {
+    pub kind: PropertyKind,
+    pub location: SourceLocation,
+    pub variable_blocks: Vec<VariableBlock>,
+    pub body: Vec<AstNode>,
+}
+
+#[derive(Debug, PartialEq, Clone, Copy)]
+pub enum PropertyKind {
+    Get,
+    Set,
+}
+
+impl std::fmt::Display for PropertyKind {
+    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+        match self {
+            PropertyKind::Get => write!(f, "get"),
+            PropertyKind::Set => write!(f, "set"),
+        }
+    }
+}
+
 #[derive(Debug, PartialEq, Eq)]
 pub enum PolymorphismMode {
     None,
@@ -269,7 +303,7 @@
     BuiltIn,
 }
 
-#[derive(Debug, PartialEq, Eq)]
+#[derive(Debug, PartialEq, Eq, Clone, Copy)]
 pub enum AccessModifier {
     Private,
     Public,
@@ -287,6 +321,9 @@
     Method {
         /// The parent of this method, i.e. a function block, class or an interface
         parent: String,
+
+        /// The fully qualified name of the property this GET or SET method represents
+        property: Option<String>,
     },
     Init,
     ProjectInit,
@@ -310,7 +347,7 @@
 impl PouType {
     /// returns Some(owner_class) if this is a `Method` or otherwhise `None`
     pub fn get_optional_owner_class(&self) -> Option<String> {
-        if let PouType::Method { parent } = self {
+        if let PouType::Method { parent, .. } = self {
             Some(parent.clone())
         } else {
             None
@@ -320,6 +357,10 @@
     pub fn is_function_method_or_init(&self) -> bool {
         matches!(self, PouType::Function | PouType::Init | PouType::ProjectInit | PouType::Method { .. })
     }
+
+    pub fn is_stateful(&self) -> bool {
+        matches!(self, PouType::FunctionBlock | PouType::Program | PouType::Class)
+    }
 }
 
 #[derive(Debug, PartialEq, Clone)]
@@ -352,6 +393,7 @@
     pub interfaces: Vec<Interface>,
     pub user_types: Vec<UserTypeDeclaration>,
     pub file_name: String,
+    pub properties: Vec<Property>,
 }
 
 impl CompilationUnit {
@@ -364,6 +406,7 @@
             interfaces: Vec::new(),
             user_types: Vec::new(),
             file_name: file_name.to_string(),
+            properties: Vec::new(),
         }
     }
 
@@ -395,6 +438,9 @@
     Global,
     InOut,
     External,
+
+    /// A compiler internal variable block representing all properties defined within a stateful POU
+    Property,
 }
 
 impl Display for VariableBlockType {
@@ -407,6 +453,7 @@
             VariableBlockType::Global => write!(f, "Global"),
             VariableBlockType::InOut => write!(f, "InOut"),
             VariableBlockType::External => write!(f, "External"),
+            VariableBlockType::Property => write!(f, "Property"),
         }
     }
 }
@@ -417,7 +464,7 @@
     ByRef,
 }
 
-#[derive(PartialEq)]
+#[derive(PartialEq, Clone)]
 pub struct VariableBlock {
     pub access: AccessModifier,
     pub constant: bool,
@@ -438,6 +485,19 @@
         self.variables = variables;
         self
     }
+
+    /// Creates a new (internal) variable block with a block type of [`Property`]
+    pub fn property(variables: Vec<Variable>) -> VariableBlock {
+        VariableBlock {
+            access: AccessModifier::Internal,
+            constant: false,
+            retain: false,
+            variables,
+            variable_block_type: VariableBlockType::Property,
+            linkage: LinkageType::Internal,
+            location: SourceLocation::internal(),
+        }
+    }
 }
 
 impl Default for VariableBlock {
@@ -1300,7 +1360,7 @@
         assert_eq!(PouType::FunctionBlock.to_string(), "FunctionBlock");
         assert_eq!(PouType::Action.to_string(), "Action");
         assert_eq!(PouType::Class.to_string(), "Class");
-        assert_eq!(PouType::Method { parent: "...".to_string() }.to_string(), "Method");
+        assert_eq!(PouType::Method { parent: String::new(), property: None }.to_string(), "Method");
     }
 
     #[test]
@@ -1496,11 +1556,12 @@
     }
 
     /// creates a new Identifier
-    pub fn create_identifier<T>(name: &str, location: T, id: AstId) -> AstNode
+    pub fn create_identifier<T, U>(name: T, location: U, id: AstId) -> AstNode
     where
-        T: Into<SourceLocation>,
+        T: Into<String>,
+        U: Into<SourceLocation>,
     {
-        AstNode::new(AstStatement::Identifier(name.to_string()), id, location.into())
+        AstNode::new(AstStatement::Identifier(name.into()), id, location.into())
     }
 
     pub fn create_unary_expression(

compiler/plc_diagnostics/src/diagnostics.rs

@@ -30,17 +30,17 @@ pub enum Severity {
 #[derive(Debug)]
 pub struct Diagnostic {
     /// The Description of the error being reported.
-    message: String,
+    pub message: String,
     /// Primary location where the diagnostic occurred
-    primary_location: SourceLocation,
+    pub primary_location: SourceLocation,
     /// Seconday locations relevant to the diagnostics
-    secondary_locations: Option<Vec<SourceLocation>>,
+    pub secondary_locations: Option<Vec<SourceLocation>>,
     /// Error code for reference in the documentation
-    error_code: &'static str,
+    pub error_code: &'static str,
     /// Children of the current diagnostic
-    sub_diagnostics: Vec<Diagnostic>,
+    pub sub_diagnostics: Vec<Diagnostic>,
     /// If the diagnostic is caused by an error, this field contains the original error
-    internal_error: Option<anyhow::Error>,
+    pub internal_error: Option<anyhow::Error>,
 }
 
 impl std::error::Error for Diagnostic {

compiler/plc_diagnostics/src/diagnostics/diagnostics_registry.rs

@@ -191,7 +191,7 @@ lazy_static! {
         E087,   Error,      include_str!("./error_codes/E087.md"),
         E088,   Error,      include_str!("./error_codes/E088.md"),
         E089,   Error,      include_str!("./error_codes/E089.md"),
-        E090,   Warning,    include_str!("./error_codes/E090.md"), // Incompatible reference Assignment
+        E090,   Warning,    include_str!("./error_codes/E090.md"),  // Incompatible reference Assignment
         E091,   Warning,    include_str!("./error_codes/E091.md"),
         E092,   Info,       include_str!("./error_codes/E092.md"),
         E093,   Warning,    include_str!("./error_codes/E093.md"),
@@ -215,6 +215,9 @@ lazy_static! {
         E111,   Error,      include_str!("./error_codes/E111.md"),  // Duplicate interface methods with different signatures
         E112,   Error,      include_str!("./error_codes/E112.md"),  // Incomplete interface implementation
         E113,   Warning,    include_str!("./error_codes/E113.md"),  // Interface default method implementation
+        E114,   Error,      include_str!("./error_codes/E114.md"),  // Property in unsupported POU type
+        E115,   Error,      include_str!("./error_codes/E115.md"),  // Property defined in non-supported variable block
+        E116,   Error,      include_str!("./error_codes/E116.md"),  // Property with invalid number of GET and/or SET blocks
     );
 }
 

compiler/plc_diagnostics/src/diagnostics/error_codes/E114.md

@@ -0,0 +1,15 @@
+# Property defined in non-stateful POU type
+
+Properties may only be defined in stateful POUs such as a `PROGRAM`,`CLASS` or `FUNCTION_BLOCK`.
+
+Errouneus code example:
+```
+FUNCTION foo
+    // Invalid definition
+    PROPERTY bar : DINT
+        GET
+            bar := 42;
+        END_GET
+    END_PROPERTY
+END_FUNCTION
+```

compiler/plc_diagnostics/src/diagnostics/error_codes/E115.md

@@ -0,0 +1,15 @@
+# Property defined in non-supported variable block
+
+Properties only allow for variable blocks of type `VAR`.
+
+Errouneus code example:
+```
+FUNCTION foo
+    PROPERTY bar : DINT 
+        GET
+            VAR         /* ... */   END_VAR
+            VAR_INPUT   /* ... */   END_VAR // Invalid
+        END_GET
+    END_PROPERTY
+END_FUNCTION
+```

compiler/plc_diagnostics/src/diagnostics/error_codes/E116.md

@@ -0,0 +1,24 @@
+# Property with invalid number of GET and/or SET blocks
+
+Properties must be non empty and at most contain one block of type GET or SET. 
+
+Errouneus code example:
+```
+FUNCTION foo
+    PROPERTY bar : DINT 
+        // Invalid, empty (no GET or SET block)
+    END_PROPERTY
+
+    PROPERTY baz : DINT 
+        // Invalid, two GET blocks
+        GET END_GET
+        GET END_GET
+    END_PROPERTY
+
+    PROPERTY qux : DINT 
+        // Invalid, two SET blocks
+        SET END_SET
+        SET END_SET
+    END_PROPERTY
+END_FUNCTION
+```