fix: add the end keyword as a debug statement

Breakpoints can now be placed on end keywords, including end if,
end_while and pou_ends.

There's still an issue with stopping on the end_if after an else.

Author: ghaith

compiler/plc_ast/src/ast.rs

@@ -79,6 +79,7 @@ pub struct PropertyImplementation {
     pub location: SourceLocation,
     pub variable_blocks: Vec<VariableBlock>,
     pub body: Vec<AstNode>,
+    pub end_location: SourceLocation,
 }
 
 #[derive(Debug, PartialEq, Clone, Copy)]
@@ -290,6 +291,7 @@ pub struct Implementation {
     pub statements: Vec<AstNode>,
     pub location: SourceLocation,
     pub name_location: SourceLocation,
+    pub end_location: SourceLocation,
     pub overriding: bool,
     pub generic: bool,
     pub access: Option<AccessModifier>,
@@ -1442,23 +1444,30 @@ impl AstFactory {
         blocks: Vec<ConditionalBlock>,
         else_block: Vec<AstNode>,
         location: SourceLocation,
+        end_location: SourceLocation,
         id: AstId,
     ) -> AstNode {
         AstNode {
-            stmt: AstStatement::ControlStatement(AstControlStatement::If(IfStatement { blocks, else_block })),
+            stmt: AstStatement::ControlStatement(AstControlStatement::If(IfStatement {
+                blocks,
+                else_block,
+                end_location,
+            })),
             location,
             id,
         }
     }
 
     ///  creates a new for loop statement
+    #[allow(clippy::too_many_arguments)]
     pub fn create_for_loop(
         counter: AstNode,
         start: AstNode,
         end: AstNode,
         by_step: Option<AstNode>,
         body: Vec<AstNode>,
         location: SourceLocation,
+        end_location: SourceLocation,
         id: AstId,
     ) -> AstNode {
         AstNode {
@@ -1468,6 +1477,7 @@ impl AstFactory {
                 end: Box::new(end),
                 by_step: by_step.map(Box::new),
                 body,
+                end_location,
             })),
             location,
             id,
@@ -1479,12 +1489,14 @@ impl AstFactory {
         condition: AstNode,
         body: Vec<AstNode>,
         location: SourceLocation,
+        end_location: SourceLocation,
         id: AstId,
     ) -> AstNode {
         AstNode {
             stmt: AstStatement::ControlStatement(AstControlStatement::WhileLoop(LoopStatement {
                 condition: Box::new(condition),
                 body,
+                end_location,
             })),
             id,
             location,
@@ -1496,12 +1508,14 @@ impl AstFactory {
         condition: AstNode,
         body: Vec<AstNode>,
         location: SourceLocation,
+        end_location: SourceLocation,
         id: AstId,
     ) -> AstNode {
         AstNode {
             stmt: AstStatement::ControlStatement(AstControlStatement::RepeatLoop(LoopStatement {
                 condition: Box::new(condition),
                 body,
+                end_location,
             })),
             id,
             location,
@@ -1514,13 +1528,15 @@ impl AstFactory {
         case_blocks: Vec<ConditionalBlock>,
         else_block: Vec<AstNode>,
         location: SourceLocation,
+        end_location: SourceLocation,
         id: AstId,
     ) -> AstNode {
         AstNode {
             stmt: AstStatement::ControlStatement(AstControlStatement::Case(CaseStatement {
                 selector: Box::new(selector),
                 case_blocks,
                 else_block,
+                end_location,
             })),
             id,
             location,

compiler/plc_ast/src/control_statements.rs

@@ -1,11 +1,14 @@
 use std::fmt::Debug;
 
+use plc_source::source_location::SourceLocation;
+
 use crate::ast::AstNode;
 
 #[derive(Debug, Clone, PartialEq)]
 pub struct IfStatement {
     pub blocks: Vec<ConditionalBlock>,
     pub else_block: Vec<AstNode>,
+    pub end_location: SourceLocation,
 }
 
 #[derive(Debug, Clone, PartialEq)]
@@ -15,20 +18,23 @@ pub struct ForLoopStatement {
     pub end: Box<AstNode>,
     pub by_step: Option<Box<AstNode>>,
     pub body: Vec<AstNode>,
+    pub end_location: SourceLocation,
 }
 
 #[derive(Debug, Clone, PartialEq)]
 /// used for While and Repeat loops
 pub struct LoopStatement {
     pub condition: Box<AstNode>,
     pub body: Vec<AstNode>,
+    pub end_location: SourceLocation,
 }
 
 #[derive(Debug, Clone, PartialEq)]
 pub struct CaseStatement {
     pub selector: Box<AstNode>,
     pub case_blocks: Vec<ConditionalBlock>,
     pub else_block: Vec<AstNode>,
+    pub end_location: SourceLocation,
 }
 
 #[derive(Debug, Clone, PartialEq)]

compiler/plc_driver/src/tests/snapshots/plc_driver__tests__multi_files__multiple_files_in_different_locations_with_debug_info.snap

@@ -15,11 +15,11 @@ entry:
   call void @llvm.dbg.declare(metadata i16* %main, metadata !14, metadata !DIExpression()), !dbg !16
   store i16 0, i16* %main, align 2
   call void @mainProg(%mainProg* @mainProg_instance), !dbg !17
-  %main_ret = load i16, i16* %main, align 2, !dbg !17
-  ret i16 %main_ret, !dbg !17
+  %main_ret = load i16, i16* %main, align 2, !dbg !18
+  ret i16 %main_ret, !dbg !18
 }
 
-declare !dbg !18 void @mainProg(%mainProg*)
+declare !dbg !19 void @mainProg(%mainProg*)
 
 ; Function Attrs: nofree nosync nounwind readnone speculatable willreturn
 declare void @llvm.dbg.declare(metadata, metadata, metadata) #0
@@ -47,9 +47,10 @@ attributes #0 = { nofree nosync nounwind readnone speculatable willreturn }
 !15 = !DIBasicType(name: "INT", size: 16, encoding: DW_ATE_signed, flags: DIFlagPublic)
 !16 = !DILocation(line: 2, column: 13, scope: !10)
 !17 = !DILocation(line: 10, column: 4, scope: !10)
-!18 = distinct !DISubprogram(name: "mainProg", linkageName: "mainProg", scope: !2, file: !2, line: 2, type: !19, scopeLine: 5, flags: DIFlagPublic, spFlags: DISPFlagDefinition, unit: !7, retainedNodes: !4)
-!19 = !DISubroutineType(flags: DIFlagPublic, types: !20)
-!20 = !{null, !3}
+!18 = !DILocation(line: 11, column: 4, scope: !10)
+!19 = distinct !DISubprogram(name: "mainProg", linkageName: "mainProg", scope: !2, file: !2, line: 2, type: !20, scopeLine: 5, flags: DIFlagPublic, spFlags: DISPFlagDefinition, unit: !7, retainedNodes: !4)
+!20 = !DISubroutineType(flags: DIFlagPublic, types: !21)
+!21 = !{null, !3}
 
 ; ModuleID = 'lib/file2.st'
 source_filename = "lib/file2.st"

compiler/plc_driver/src/tests/snapshots/plc_driver__tests__multi_files__multiple_files_with_debug_info.snap

@@ -15,11 +15,11 @@ entry:
   call void @llvm.dbg.declare(metadata i16* %main, metadata !14, metadata !DIExpression()), !dbg !16
   store i16 0, i16* %main, align 2
   call void @mainProg(%mainProg* @mainProg_instance), !dbg !17
-  %main_ret = load i16, i16* %main, align 2, !dbg !17
-  ret i16 %main_ret, !dbg !17
+  %main_ret = load i16, i16* %main, align 2, !dbg !18
+  ret i16 %main_ret, !dbg !18
 }
 
-declare !dbg !18 void @mainProg(%mainProg*)
+declare !dbg !19 void @mainProg(%mainProg*)
 
 ; Function Attrs: nofree nosync nounwind readnone speculatable willreturn
 declare void @llvm.dbg.declare(metadata, metadata, metadata) #0
@@ -47,9 +47,10 @@ attributes #0 = { nofree nosync nounwind readnone speculatable willreturn }
 !15 = !DIBasicType(name: "INT", size: 16, encoding: DW_ATE_signed, flags: DIFlagPublic)
 !16 = !DILocation(line: 2, column: 13, scope: !10)
 !17 = !DILocation(line: 10, column: 4, scope: !10)
-!18 = distinct !DISubprogram(name: "mainProg", linkageName: "mainProg", scope: !2, file: !2, line: 2, type: !19, scopeLine: 5, flags: DIFlagPublic, spFlags: DISPFlagDefinition, unit: !7, retainedNodes: !4)
-!19 = !DISubroutineType(flags: DIFlagPublic, types: !20)
-!20 = !{null, !3}
+!18 = !DILocation(line: 11, column: 4, scope: !10)
+!19 = distinct !DISubprogram(name: "mainProg", linkageName: "mainProg", scope: !2, file: !2, line: 2, type: !20, scopeLine: 5, flags: DIFlagPublic, spFlags: DISPFlagDefinition, unit: !7, retainedNodes: !4)
+!20 = !DISubroutineType(flags: DIFlagPublic, types: !21)
+!21 = !{null, !3}
 
 ; ModuleID = 'file2.st'
 source_filename = "file2.st"