gv_fsm 0.2.9 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19016ba84adc54b46d0c52e6dffcd4024f3626a32ada32830cdf3a8e094a3a35
-  data.tar.gz: 32f84664395d90c58da54bf5b8add1a8a06bd0f0901ffd1947b9f81e713df26e
+  metadata.gz: 16cf9c4cad02807aa41c4229aceea78be6f407c28f2a25a8b40e4395c6c7d494
+  data.tar.gz: 21f75946fb7d626d97cb87bcc44108e7fd3c01d0f8c388c08f0f3a65fb8f65c3
 SHA512:
-  metadata.gz: 5896400ccad2e6a1091f20aa32d3739bbe45c3b87fe5ed4501a4254235e3acf6a0d09561789d53686939fafa5d298de84567475a6bcca23b8c0b5375242f4f19
-  data.tar.gz: fdc81c9081b5c83e4842ce864fb4b5babcdfde5cc03936c3cad0eb64f8a078af517b3da50fea7bc1f1a8027c36b2678a16d3d537118cf1280e7b994b405a24a6
+  metadata.gz: 0eb8b28821342aaea705c4f4fceb94f5a689579934ce8da6f6e6dba06a3e902de73da42fa95019fa10a5a8dd457f7fe54a23946b5ce437d298cf88358a92c184
+  data.tar.gz: 885046a66dd9f4ac5b996ca0b28bad123b6ca21bf3983690556064f9b70ce9b2b546c0305e3148bc0ffb4692fe22b3aa0adc55dec8918d8e3b85180a902ca783

data/bin/gv_fsm

@@ -48,6 +48,10 @@ op = OptionParser.new do |parser|
     sm.syslog = false
   end
 
+  parser.on("-k", "--sigint STATE", "Install SIGINT handler that points to STATE") do |state|
+    sm.sigint = state
+  end
+
   parser.on("-h", "--help", "Prints this help") do
     puts parser
     exit
@@ -73,6 +77,11 @@ unless sm.parse(ARGV[0]) then
   exit 3
 end
 
+if sm.ino && sm.sigint then
+  STDERR.puts "ERROR: signal handler is not supported on Arduino!\n\n"
+  exit 4
+end
+
 puts "Parsed #{sm.dotfile}"
 top = sm.topology
 puts "Graph topology:"
@@ -87,11 +96,18 @@ end
 puts "Generating C functions for states: #{sm.states_list.join(", ")}."
 puts "                   for transition: #{sm.transition_functions_list.join(", ")}."
 
+if (sm.sigint) then
+  puts "Installed signal handler for SIGINT in state #{top[:sources][0]}:\n  stable states have emergency transition to state #{sm.sigint}"
+  unless top[:sinks].include? sm.sigint then
+    puts "WARNING: the state #{sm.sigint} is not a source, please check topology"
+  end
+end
 
 if options[:header] then
   name = sm.generate_h 
   puts "Generated header #{name}"
 end
+
 if options[:source] then
   name = sm.generate_c
   puts "Generated source #{name}"

data/lib/gv_fsm.rb

@@ -10,7 +10,7 @@ require File.expand_path("../version.rb", __FILE__)
 module GV_FSM
   class FSM
     attr_reader :states, :transitions, :dotfile, :prefix, :error
-    attr_accessor :project_name, :description, :cname, :syslog, :ino
+    attr_accessor :project_name, :description, :cname, :syslog, :ino, :sigint
     include GV_FSM::Templates
 
     def initialize(filename = nil)
@@ -20,6 +20,7 @@ module GV_FSM
       @error = nil
       @matrix = nil
       @nodemap = {}
+      @sigint = nil
       parse(filename) if filename
     end
 
@@ -48,7 +49,7 @@ module GV_FSM
           return nil
         end
         @matrix = Matrix.zero(n, n)
-        @description = g.name
+        @description = g.name unless @description
         i = 0
         g.each_node do |id|
           n = g.get_node(id)
@@ -85,6 +86,10 @@ module GV_FSM
         @error = "Parsing error"
         return nil
       end
+      if (self.sigint && !states.find {|s| s[:id] == self.sigint}) then
+        @error = "Missing SIGINT state #{self.sigint}"
+        return nil
+      end
       return graph
     end
 

data/lib/templates.rb

@@ -23,8 +23,8 @@ module GV_FSM
 
     HH =<<~EOH
       <% if !@ino then %>
-      #ifndef <%= @cname.upcase %>_H
-      #define <%= @cname.upcase %>_H
+      #ifndef <%= File::basename(@cname).upcase %>_H
+      #define <%= File::basename(@cname).upcase %>_H
       #include <stdlib.h>
       <% else %>
       #include <arduino.h>
@@ -92,7 +92,7 @@ module GV_FSM
       <% end %>
 
       // state manager
-      <%= @prefix %>state_t <%= @prefix %>run_state(<%= @prefix %>state_t cur_state, state_data_t *data);
+      <%= @prefix %>state_t <%= @prefix %>run_state(<%= @prefix %>state_t cur_state, <%= @prefix %>state_data_t *data);
       
       <% if !@ino then %>
       #endif
@@ -108,8 +108,21 @@ module GV_FSM
       <% else %>
       <% if @syslog then log = :ino end %>
       <% end %>
-      #include "<%= @cname %>.h"
+      #include "<%= File::basename(@cname) %>.h"
       
+      <% if sigint then %>// Install signal handler: 
+      // SIGINT requests a transition to state <%= self.sigint %>
+      #include <signal.h>
+      static int _exit_request = 0;
+      static void signal_handler(int signal) {
+        if (signal == SIGINT) {
+          _exit_request = 1;<% if log == :syslog then %>
+          syslog(LOG_WARNING, "[FSM] SIGINT transition to <%= sigint %>");<% elsif log == :ino then %>
+          Serial.println("[FSM] SIGINT transition to <%= sigint %>");<% end %>
+        }
+      }
+
+      <% end %>
       <% placeholder = "Your Code Here" %>
       // SEARCH FOR <%= placeholder %> FOR CODE INSERTION POINTS!
 
@@ -153,6 +166,7 @@ module GV_FSM
       // |_|  \\__,_|_| |_|\\___|\\__|_|\\___/|_| |_|___/
       //                                             
       <% dest = destinations.dup %>
+      <% topo = self.topology %>
       <% @states.each do |s| %>
       <% stable = true if dest[s[:id]].include? s[:id] %>
       <% dest[s[:id]].map! {|n| (@prefix+"STATE_"+n).upcase} %>
@@ -161,9 +175,13 @@ module GV_FSM
       end %>
       // Function to be executed in state <%= s[:id] %>
       // valid return states: <%= dest[s[:id]].join(", ") %>
+      <% if sigint && stable && topo[:sources][0] != s[:id] then %>
+      // SIGINT triggers an emergency transition to <%= self.sigint %>
+      <% end %>
       <%= @prefix %>state_t <%= s[:function] %>(<%= @prefix %>state_data_t *data) {
         <%= @prefix %>state_t next_state = <%= dest[s[:id]].first %>;
-
+        <% if sigint && topo[:sources][0] == s[:id] then %>signal(SIGINT, signal_handler); 
+        <% end %>
       <% if log == :syslog then %>
         syslog(LOG_INFO, "[FSM] In state <%= s[:id] %>");
       <% elsif log == :ino then %>
@@ -186,6 +204,10 @@ module GV_FSM
       <% end %>
             next_state = <%= @prefix.upcase %>NO_CHANGE;
         }
+        <% if sigint && stable && topo[:sources][0] != s[:id] then %>
+        // SIGINT transition override
+        if (_exit_request) next_state = <%= (@prefix+"STATE_"+self.sigint ).upcase %>;
+        <% end %>
         return next_state;
       }
 
@@ -282,4 +304,4 @@ module GV_FSM
       <% end %>
     EOC
   end
-end
+end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module GV_FSM
-  VERSION = "0.2.9"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gv_fsm
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.3.1
 platform: ruby
 authors:
 - Paolo Bosetti
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-12 00:00:00.000000000 Z
+date: 2022-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-graphviz