Added support for generating a warning when spec handles an event but does not add it in its observes list (#716)

Author: ankushdesai

Src/PCompiler/CompilerCore/DefaultTranslationErrorHandler.cs

@@ -334,5 +334,10 @@ private string DeclarationName(IPDecl method)
         {
             return method.Name.Length > 0 ? method.Name : $"at {locationResolver.GetLocation(method.SourceLocation)}";
         }
+
+        public string SpecObservesSetIncompleteWarning(ParserRuleContext ctx, PEvent ev, Machine machine)
+        {
+            return $"[!Warning!]\n[{locationResolver.GetLocation(ctx, ctx.start)}] Event {ev.Name} is not in the observes list of the spec machine {machine.Name}. The event-handler is never triggered as the event is not observed by the spec.\n[!Warning!]";
+        }
     }
 }

Src/PCompiler/CompilerCore/ITranslationErrorHandler.cs

@@ -117,5 +117,7 @@ Exception DuplicateStartState(
 
         Exception IllegalChooseSubExprType(PParser.ChooseExprContext context, PLanguageType subExprType);
         Exception IllegalFunctionUsedInSpecMachine(Function function, Machine callerOwner);
+
+        String SpecObservesSetIncompleteWarning(ParserRuleContext loc, PEvent ev, Machine machine);
     }
 }

Src/PCompiler/CompilerCore/TypeChecker/Analyzer.cs

@@ -20,7 +20,7 @@ public static Scope AnalyzeCompilationUnit(ICompilerConfiguration config,
             // Step 2: Validate machine specifications
             foreach (var machine in globalScope.Machines)
             {
-                MachineChecker.Validate(handler, machine);
+                MachineChecker.Validate(handler, machine, config);
             }
 
             // Step 3: Fill function bodies

Src/PCompiler/CompilerCore/TypeChecker/MachineChecker.cs

@@ -11,13 +11,34 @@ namespace Plang.Compiler.TypeChecker
 {
     public static class MachineChecker
     {
-        public static void Validate(ITranslationErrorHandler handler, Machine machine)
+        public static void Validate(ITranslationErrorHandler handler, Machine machine, ICompilerConfiguration job)
         {
             var startState = FindStartState(machine, handler);
             var startStatePayloadType = GetStatePayload(startState);
             Debug.Assert(startStatePayloadType.IsSameTypeAs(machine.PayloadType));
             ValidateHandlers(handler, machine);
             ValidateTransitions(handler, machine);
+            // special validation for monitors:
+            // ensure that each eventhandler is in the observe set.
+            ValidateSpecObservesList(handler, machine, job);
+        }
+
+        private static void ValidateSpecObservesList(ITranslationErrorHandler handler, Machine machine, ICompilerConfiguration job)
+        {
+            if (machine.IsSpec)
+            {
+                foreach (var state in machine.AllStates())
+                {
+                    foreach (var pair in state.AllEventHandlers)
+                    {
+                        if (!machine.Observes.Events.Contains(pair.Key))
+                        {
+                            job.Output.WriteWarning(
+                                handler.SpecObservesSetIncompleteWarning(pair.Value.SourceLocation, pair.Key, machine));
+                        }
+                    }
+                }
+            }
         }
 
         private static void ValidateHandlers(ITranslationErrorHandler handler, Machine machine)

Tst/RegressionTests/Feature1SMLevelDecls/Correct/monitorobserves/observes.p

@@ -0,0 +1,14 @@
+event e1;
+event e2;
+
+spec Invariant1 observes e1 {
+	start state Init {
+		on e2 goto Init;
+	}
+}
+
+machine Main {
+	start state Init {
+	
+	}
+}