gv_fsm 0.2.2 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3579818099a2f3e8d172c9534af08877f3e4b27f4fc09f9c9aa77c6275256ce3
-  data.tar.gz: 5b4acdd1da41b63fbac514f2a481766c5b5c08ba34881ef708d11871910e8d0d
+  metadata.gz: 1706418c51873674098f304fe267d662d211728675db2ca78687efcb49b2ba95
+  data.tar.gz: 991b5f7b6d1173d4e08a9635ebbce25f654c88521a913ce7514a51e09cd1d3fd
 SHA512:
-  metadata.gz: 5f481dacfc667927287eecc1b5f901fd915a593ab533b6de35f573e0cb1b66219c5cd37e24f9c54095e1049f8a7f3f67094530338a9c653cbb72585d1ccbcdf3
-  data.tar.gz: 4b835c1bc4f03a6d80e37f64f219b0801756ffaeeedbd7da20f53ffbc428b48efd92ac075c189b5379d30ef125ebaf4417e259b0729d1c9e9ac0a94db08b3e14
+  metadata.gz: 3f2d8954ab0a5a009bd5cf6b31ca7d6927a680681e81dbd3a70d0aaa598234b8c71e91098c6e1aa011244ec05973611184b9c22bbbd28d32a1ff90e7e89350f9
+  data.tar.gz: 0b8d6e7a3fe3fe9434d3d58371b38edf5a82651cd9b9fdffec415c531ee0deaea6418ddce70520d19c20d4e83f044c9e51cb5bb53964827b9eaae762621d59e9

data/bin/gv_fsm

@@ -28,7 +28,7 @@ op = OptionParser.new do |parser|
     sm.cname = f
   end
 
-  parser.on("-h", "--header-only", "Only generate header file") do
+  parser.on("-e", "--header-only", "Only generate header file") do
     options[:source] = false
   end
 
@@ -44,7 +44,7 @@ op = OptionParser.new do |parser|
     sm.ino = true
   end
 
-  parser.on("-l", "--no-syslog", "Omit syslog calls in stub functions") do
+  parser.on("-l", "--no-log", "Omit log calls in stub functions") do
     sm.syslog = false
   end
 
@@ -60,28 +60,40 @@ op.parse!
 unless ARGV[0]
   STDERR.puts "ERROR: I need the path to a Graphviz file!\n\n"
   STDERR.puts op
-  exit
+  exit 1
 end
-unless File.extname(ARGV[0]) == ".dot"
+if !File.extname(ARGV[0]) == ".dot" or !File.exist? ARGV[0] then
   STDERR.puts "ERROR: #{ARGV[0]} does not look like a Graphviz file!\n\n"
   STDERR.puts op
-  exit
+  exit 2
 end
 
-sm.parse(ARGV[0])
+unless sm.parse(ARGV[0]) then
+  puts "Error parsing the file #{ARGV[0]}: #{sm.error}"
+  exit 3
+end
 
-puts "Parsed #{sm.dotfile}.\nGenerating C stub for states: #{sm.states_list.join(", ")}."
-if sm.ino then
-  sm.generate_ino
-  puts "Generated .ino file #{sm.cname}.ino"
-else
-  if options[:header] then
-    sm.generate_h 
-    puts "Generated header #{sm.cname}.h"
-  end
-  if options[:source] then
-    sm.generate_c 
-    puts "Generated source #{sm.cname}.c"
-  end
+puts "Parsed #{sm.dotfile}"
+top = sm.topology
+puts "Graph topology:"
+puts "  Pure source nodes: #{top[:sources].join(', ')}"
+puts "  Pure sink nodes:   #{top[:sinks].empty? ? "<none>" : top[:sinks].join(', ')}"
+
+if !(top[:sources].count == 1 and top[:sinks].count <= 1) then
+  puts "Topology error: there must be exactly one source and zero or one sink"
+  exit 4
+end
+
+puts "Generating C functions for states: #{sm.states_list.join(", ")}."
+puts "                   for transition: #{sm.transition_functions_list.join(", ")}."
+
+
+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}"
 end
 

data/lib/gv_fsm.rb

@@ -2,13 +2,14 @@
 
 require 'ruby-graphviz'
 require 'erb'
+require 'matrix'
 
 require File.expand_path('../templates.rb', __FILE__)
 require File.expand_path("../version.rb", __FILE__)
 
 module GV_FSM
   class FSM
-    attr_reader :states, :transitions, :dotfile, :prefix
+    attr_reader :states, :transitions, :dotfile, :prefix, :error
     attr_accessor :project_name, :description, :cname, :syslog, :ino
     include GV_FSM::Templates
 
@@ -16,6 +17,9 @@ module GV_FSM
       @prefix = ""
       @syslog = true
       @ino = false
+      @error = nil
+      @matrix = nil
+      @nodemap = {}
       parse(filename) if filename
     end
 
@@ -29,13 +33,37 @@ module GV_FSM
       @dotfile = filename
       @states = []
       @transitions = []
-      GraphViz.parse(filename) do |g|
+      graph = GraphViz.parse(filename) do |g|
+        if g.graph_count > 1 then
+          @error = "Only one graph in the dot file is permitted"
+          return nil
+        end
+        unless g.type == "digraph" then
+          @error = "Graph is not directed"
+          return nil
+        end
+        n = g.node_count
+        if n == 0 then
+          @error = "Graph is empty"
+          return nil
+        end
+        @matrix = Matrix.zero(n, n)
+        @description = g.name
+        i = 0
         g.each_node do |id|
           n = g.get_node(id)
-          label = n[:label].source.empty? ? "do_#{id}" : n[:label].source
+          if n[:label].source.empty? or
+            (n[:label].source == id and !n[:label].source.match(/^do_/)) then
+            label = "do_#{id}"
+          else
+            label = n[:label].source
+          end
+          @nodemap[id] = i
+          i += 1
           @states << {id: id, function: @prefix+label}
         end
         g.each_edge do |e|
+          @matrix[@nodemap[e.node_one], @nodemap[e.node_two]] += 1
           from = e.node_one
           to = e.node_two
           unless e[:label] then
@@ -53,6 +81,11 @@ module GV_FSM
           @transitions << {from: from, to: to, function: label ? @prefix+label : nil}
         end
       end
+      unless graph then 
+        @error = "Parsing error"
+        return nil
+      end
+      return graph
     end
 
     def state_functions_list
@@ -103,27 +136,34 @@ module GV_FSM
     end
 
     def generate_c(filename = @cname)
-      File.open("#{filename}.c", "w") do |f|
+      ext = @ino ? "cpp" : "c"
+      fname = "#{filename}.#{ext}"
+      File.open(fname, "w") do |f|
         f.puts ERB.new(HEADER, 0, "<>").result(binding)
         f.puts ERB.new(CC, 0, "<>").result(binding)
       end
+      return fname
     end
 
     def generate_h(filename = @cname)
-      File.open("#{filename}.h", "w") do |f|
+      fname = "#{filename}.h"
+      File.open(fname, "w") do |f|
         f.puts ERB.new(HEADER, 0, "<>").result(binding)
         f.puts ERB.new(HH, 0, "<>").result(binding)
       end
+      return fname
     end
 
-    def generate_ino(filename=@cname)
-      @syslog = false
-      File.open("#{filename}.ino", "w") do |f|
-        f.puts ERB.new(HEADER, 0, "<>").result(binding)
-        f.puts ERB.new(HH, 0, "<>").result(binding)
-        f.puts ERB.new(CC, 0, "<>").result(binding)
-      end
+    def topology
+      res = {matrix: @matrix}
+      # rows have the number of froms, columns the number of tos
+      res[:froms] = @matrix.row_vectors.map {|v| v.sum }
+      res[:tos] = @matrix.column_vectors.map {|v| v.sum }
+      res[:sinks] = res[:froms].each_index.select {|i| res[:froms][i] == 0}.map {|i| @nodemap.keys[i]}
+      res[:sources] = res[:tos].each_index.select {|i| res[:tos][i] == 0}.map {|i| @nodemap.keys[i]}
+      return res
     end
+
   end
 
 end

data/lib/templates.rb

@@ -26,6 +26,8 @@ module GV_FSM
       #ifndef <%= @cname.upcase %>_H
       #define <%= @cname.upcase %>_H
       #include <stdlib.h>
+      <% else %>
+      #include <arduino.h>
       <% end %>
 
       // State data object
@@ -47,7 +49,7 @@ module GV_FSM
       } <%= @prefix %>state_t;
 
       // State human-readable names
-      const char *state_names[] = {<%= states_list.map {|sn| '"'+sn+'"'}.join(", ") %>};
+      extern const char *state_names[];
       
       <% if transition_functions_list.count > 0 then %>
       // State function and state transition prototypes
@@ -73,12 +75,7 @@ module GV_FSM
 
 
       // List of state functions
-      <% fw = state_functions_list.max {|a, b| a.length <=> b.length}.length %>
-      state_func_t *const <%= @prefix %>state_table[<%= @prefix.upcase %>NUM_STATES] = {
-      <% @states.each do |s| %>
-        <%= (s[:function] + ',').ljust(fw+1) %> // in state <%= s[:id] %>
-      <% end %>
-      };
+      extern state_func_t *const <%= @prefix %>state_table[<%= @prefix.upcase %>NUM_STATES];
       
 
       <% if transition_functions_list.count > 0 then %>
@@ -89,21 +86,13 @@ module GV_FSM
       <% end %>
 
       // Table of transition functions
-      transition_func_t *const <%= @prefix %>transition_table[<%= @prefix.upcase %>NUM_STATES][<%= @prefix.upcase %>NUM_STATES] = {
-      <% sl = states_list %>
-      <% fw = transition_functions_list.max {|a, b| a.length <=> b.length}.length %>
-      <% sw = states_list.max {|a, b| a.length <=> b.length}.length %>
-        /* <%= "states:".ljust(sw) %>     <%= sl.map {|e| e.ljust(fw) }.join(", ") %> */
-      <% transitions_map.each_with_index do |l, i| %>
-        /* <%= sl[i].ljust(sw) %> */ {<%= l.map {|e| e.ljust(fw)}.join(", ") %>}, 
-      <% end %>
-      };
+      extern transition_func_t *const <%= @prefix %>transition_table[<%= @prefix.upcase %>NUM_STATES][<%= @prefix.upcase %>NUM_STATES];
       <% else %>
       // No transition functions
       <% end %>
 
       // state manager
-      <%= @prefix %>state_t <%= @prefix %>run_state(<%= @prefix %>state_t cur_state, void *data);
+      <%= @prefix %>state_t <%= @prefix %>run_state(<%= @prefix %>state_t cur_state, state_data_t *data);
       
       <% if !@ino then %>
       #endif
@@ -113,14 +102,44 @@ module GV_FSM
     CC =<<~EOC
       <% if !@ino then %>
       <% if @syslog then %>
+      <% log = :syslog %>
       #include <syslog.h>
       <% end %>
-      #include "<%= @cname %>.h"
+      <% else %>
+      <% if @syslog then log = :ino end %>
       <% end %>
+      #include "<%= @cname %>.h"
       
       <% 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(", ") %>};
+
+      // List of state functions
+      <% fw = state_functions_list.max {|a, b| a.length <=> b.length}.length %>
+      state_func_t *const <%= @prefix %>state_table[<%= @prefix.upcase %>NUM_STATES] = {
+      <% @states.each do |s| %>
+        <%= (s[:function] + ',').ljust(fw+1) %> // in state <%= s[:id] %>
+      <% end %>
+      };
+      <% if transition_functions_list.count > 0 then %>
+      
+      // Table of transition functions
+      transition_func_t *const <%= @prefix %>transition_table[<%= @prefix.upcase %>NUM_STATES][<%= @prefix.upcase %>NUM_STATES] = {
+      <% sl = states_list %>
+      <% fw = transition_functions_list.max {|a, b| a.length <=> b.length}.length %>
+      <% sw = [states_list, "states:"].flatten.max {|a, b| a.length <=> b.length}.length %>
+        /* <%= "states:".ljust(sw) %>     <%= sl.map {|e| e.ljust(fw) }.join(", ") %> */
+      <% transitions_map.each_with_index do |l, i| %>
+        /* <%= sl[i].ljust(sw) %> */ {<%= l.map {|e| e.ljust(fw)}.join(", ") %>}, 
+      <% end %>
+      };
+      <% else %>
+      // No transition functions
+      <% end %>
+
       //  ____  _        _       
       // / ___|| |_ __ _| |_ ___ 
       // \\___ \\| __/ _` | __/ _ \\
@@ -145,8 +164,10 @@ module GV_FSM
       <%= @prefix %>state_t <%= s[:function] %>(<%= @prefix %>state_data_t *data) {
         <%= @prefix %>state_t next_state = <%= dest[s[:id]].first %>;
 
-      <% if @syslog then %>
+      <% if log == :syslog then %>
         syslog(LOG_INFO, "[FSM] In state <%= s[:id] %>");
+      <% elsif log == :ino then %>
+        Serial.println("[FSM] In state <%= s[:id] %>");
       <% end %>
         /* <%= placeholder %> */
         
@@ -156,8 +177,12 @@ module GV_FSM
       <% end %>
             break;
           default:
-      <% if @syslog then %>
+      <% if log == :syslog then %>
             syslog(LOG_WARNING, "[FSM] Cannot pass from <%= s[:id] %> to %s, remaining in this state", state_names[next_state]);
+      <% elsif log == :ino then %>
+            Serial.print("[FSM] Cannot pass from <%= s[:id] %> to ");
+            Serial.print(state_names[next_state]);
+            Serial.println(", remaining in this state");
       <% end %>
             next_state = <%= @prefix.upcase %>NO_CHANGE;
         }
@@ -188,8 +213,10 @@ module GV_FSM
       // <%= i+1 %>. from <%= e[:from] %> to <%= e[:to] %>
       <% end %>
       void <%= t %>(<%= @prefix %>state_data_t *data) {
-      <% if @syslog then %>
+      <% if log == :syslog then %>
         syslog(LOG_INFO, "[FSM] State transition <%= t %>");
+      <% elsif log == :ino then %>
+        Serial.println("[FSM] State transition <%= t %>");
       <% end %>
         /* <%= placeholder %> */
       }
@@ -212,6 +239,7 @@ module GV_FSM
 
       <%= @prefix %>state_t <%= @prefix %>run_state(<%= @prefix %>state_t cur_state, <%= @prefix %>state_data_t *data) {
         <%= @prefix %>state_t new_state = <%= @prefix %>state_table[cur_state](data);
+        if (new_state == <%= @prefix.upcase %>NO_CHANGE) new_state = cur_state;
       <% if transition_functions_list.count > 0 then %>
         transition_func_t *transition = <%= @prefix %>transition_table[cur_state][new_state];
         if (transition)
@@ -222,12 +250,19 @@ module GV_FSM
 
       <% if @ino then %>
       /* Example usage:
+      <%= @prefix %>state_data_t data = {count: 1};
+
+      void loop() {
+        static <%= @prefix %>state_t cur_state = <%= @prefix.upcase %>STATE_INIT;
+        cur_state = <%= @prefix %>run_state(cur_state, &data);
+      }
+      */
       <% else %>
+      <% nsinks = topology[:sinks].count %>
       #ifdef TEST_MAIN
       #include <unistd.h>
       int main() {
-      <% end %>
-        <%= @prefix %>state_t cur_state = <%= @prefix.upcase %>STATE_INIT;
+        <%= @prefix %>state_t cur_state = <%= @prefix.upcase %>STATE_<%= @states.first[:id].upcase %>;
       <% if @syslog then %>
         openlog("SM", LOG_PID | LOG_PERROR, LOG_USER);
         syslog(LOG_INFO, "Starting SM");
@@ -235,13 +270,14 @@ module GV_FSM
         do {
           cur_state = <%= @prefix %>run_state(cur_state, NULL);
           sleep(1);
-        } while (cur_state != <%= @prefix.upcase %>STATE_STOP);
-      <% if !@ino then %>
+      <% if nsinks == 1 %>
+        } while (cur_state != <%= @prefix.upcase %>STATE_<%= topology[:sinks][0].upcase %>);
+      <% else %>
+        } while (1);
+      <% end %>
         return 0;
       }
       #endif
-      <% else %>
-      */
       <% end %>
     EOC
   end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module GV_FSM
-  VERSION = "0.2.2"
+  VERSION = "0.2.7"
 end

metadata

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