gv_fsm 0.2.10 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf5e9e3cf0f82f27179188c0a3e994b2114278d723f4df2530b59a5ee87bdb72
-  data.tar.gz: 6dda52c8b001d8043e888d139cca35939fb5682acb93c00f1e2a9a7373343b3b
+  metadata.gz: 784139036e73fde8dd29fd8cc87228b2829241cdea0a8398cdf0cbc31d4ab385
+  data.tar.gz: 4d2ec2d3506a652e9db040fc4a58eb669052813837e310a3349393763a7ba207
 SHA512:
-  metadata.gz: 3fe7b3e14362c3a35692785df7fc35b1756575499b94de2c2441828096c5d479b15bfa5736ede6d7691908f646edb7f625b385b877a53d7423a27fab41adbf6b
-  data.tar.gz: d99ed400cdc9ac9f13831952059e9b9ccd352bfd8b55f5fdc570b1667070cb6c1181ae4942e69c732eb6159639928e46f57debd3e05db969eaa99b9cc0e91a75
+  metadata.gz: b89e1ee3e0aadde8e3b36085759696ccb27701b02cd895f93b1e0007f238d7415ae93f5f19e47fad99b7002c2df28ff496044a5c805cf9d6c36f3679b96acd52
+  data.tar.gz: aa06c8df94a679aaeae10eb635a10adceacfc3e3738ed03481d75941c106da4ef91ede9a59f042f8430a62f6b4fa3acfd7d2187dc3d33fde199c11ac797c4425

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
 
@@ -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

@@ -49,7 +49,7 @@ module GV_FSM
       } <%= @prefix %>state_t;
 
       // State human-readable names
-      extern const char *state_names[];
+      extern const char *<%= @prefix %>state_names[];
       
       <% if transition_functions_list.count > 0 then %>
       // State function and state transition prototypes
@@ -110,12 +110,25 @@ module GV_FSM
       <% end %>
       #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!
 
       // GLOBALS
       // State human-readable names
-      const char *state_names[] = {<%= states_list.map {|sn| '"'+sn+'"'}.join(", ") %>};
+      const char *<%= @prefix %>state_names[] = {<%= states_list.map {|sn| '"'+sn+'"'}.join(", ") %>};
 
       // List of state functions
       <% fw = state_functions_list.max {|a, b| a.length <=> b.length}.length %>
@@ -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 %>
@@ -178,14 +196,18 @@ module GV_FSM
             break;
           default:
       <% if log == :syslog then %>
-            syslog(LOG_WARNING, "[FSM] Cannot pass from <%= s[:id] %> to %s, remaining in this state", state_names[next_state]);
+            syslog(LOG_WARNING, "[FSM] Cannot pass from <%= s[:id] %> to %s, remaining in this state", <%= @prefix %>state_names[next_state]);
       <% elsif log == :ino then %>
             Serial.print("[FSM] Cannot pass from <%= s[:id] %> to ");
-            Serial.print(state_names[next_state]);
+            Serial.print(<%= @prefix %>state_names[next_state]);
             Serial.println(", remaining in this state");
       <% 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.10"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gv_fsm
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.3.2
 platform: ruby
 authors:
 - Paolo Bosetti