gv_fsm 0.2.1 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2896e7f9617c0ed1a9917e78cd947d1da5ceef2d8554727a4db268a7f70e6229
-  data.tar.gz: 63d897002c102d5291ecbfd7b4c854f8c9fc029e01155ba573d13e2043621afb
+  metadata.gz: 61d5d6c1ef593ce7d516c48ab905c210d3005081fdd241b47298c55c5340236c
+  data.tar.gz: d8bc69220e149140bd150ad3890dbf11e33651352bf22df483b7941c9a9911c7
 SHA512:
-  metadata.gz: ae5be7ee072d06983c139320227c6b234d703b2556071df085cb3f6a3365d3d1c6a8cf38f9f6daac0b866ed5b77c4726933eee69eda7aa8d9ffe17b9f2c2ca0b
-  data.tar.gz: bd1129ccf730d930b42a8ba53f83eb2adeb6d66368ebd9aab6466c69e2b951d6b461d0e04579254153d2c753c390f16f023806040615e6ac52d53f3b2f60c71a
+  metadata.gz: c92f9ebb2275bfb8fd4fa23060cc22c8d34fe2e7eb219e9833f60517417ca11a420758c99fb0bee82cc58795f184a44d230bf03ae947072e1a72271bad34b2c9
+  data.tar.gz: 7a2898d7f153fe7c80a9eb046c54bd4076ffa15bf69987f069d94a70708a17085641fc7dff765fd7816df839f469ce363e7793122e5d09538e882667d5e83650

data/bin/gv_fsm

@@ -6,7 +6,7 @@ require 'optparse'
 sm = GV_FSM::FSM.new
 
 options = {header: true, source: true}
-OptionParser.new do |parser|
+op = OptionParser.new do |parser|
   parser.banner =<<~EOB 
   Graphviz to Finite State Machine generator
   Version: #{GV_FSM::VERSION}
@@ -28,7 +28,7 @@ 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
 
@@ -40,21 +40,47 @@ OptionParser.new do |parser|
     sm.prefix = p
   end
 
-end.parse!
+  parser.on("-i", "--ino", "Generate a single .ino file (for Arduino)") do
+    sm.ino = true
+  end
 
-raise ArgumentError, "I need the path to a Graphviz file!" unless ARGV[0]
-raise ArgumentError, "#{ARGV[0]} does not look like a Graphviz file!" unless File.extname(ARGV[0]) == ".dot"
+  parser.on("-l", "--no-log", "Omit log calls in stub functions") do
+    sm.syslog = false
+  end
 
-sm.parse(ARGV[0])
+  parser.on("-h", "--help", "Prints this help") do
+    puts parser
+    exit
+  end
+
+end
+
+op.parse!
+
+unless ARGV[0]
+  STDERR.puts "ERROR: I need the path to a Graphviz file!\n\n"
+  STDERR.puts op
+  exit 1
+end
+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 2
+end
+
+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 options[:header] then
-  sm.generate_h 
-  puts "Generated header #{sm.cname}.h"
+  name = sm.generate_h 
+  puts "Generated header #{name}"
 end
 if options[:source] then
-  sm.generate_c 
-  puts "Generated source #{sm.cname}.c"
+  name = sm.generate_c
+  puts "Generated source #{name}"
 end
 
-

data/lib/gv_fsm.rb

@@ -8,12 +8,15 @@ require File.expand_path("../version.rb", __FILE__)
 
 module GV_FSM
   class FSM
-    attr_reader :states, :transitions, :dotfile, :prefix
-    attr_accessor :project_name, :description, :cname
+    attr_reader :states, :transitions, :dotfile, :prefix, :error
+    attr_accessor :project_name, :description, :cname, :syslog, :ino
     include GV_FSM::Templates
 
     def initialize(filename = nil)
       @prefix = ""
+      @syslog = true
+      @ino = false
+      @error = nil
       parse(filename) if filename
     end
 
@@ -27,16 +30,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
+        if g.node_count == 0 then
+          @error = "Graph is empty"
+          return nil
+        end
+        @description = g.name
         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
           @states << {id: id, function: @prefix+label}
         end
         g.each_edge do |e|
           from = e.node_one
           to = e.node_two
-          next unless e[:label]
+          unless e[:label] then
+            @transitions << {from: from, to: to, function: nil} 
+            next
+          end
           case e[:label].source
           when ""
             label = nil
@@ -48,6 +72,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
@@ -61,7 +90,7 @@ module GV_FSM
     def transition_functions_list
       lst = []
       @transitions.each do |t|
-        if !lst.include? t[:function] then
+        if t[:function] and !lst.include? t[:function] then
           lst << (t[:function] or "NULL")
         end
       end
@@ -98,18 +127,24 @@ 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
+
   end
 
 end

data/lib/templates.rb

@@ -13,7 +13,6 @@ module GV_FSM
       Generated from: <%= @dotfile %>
       The finite state machine has:
         <%= @states.count %> states
-        <%= @transitions.count %> transitions
         <%= transition_functions_list.select {|e| e != 'NULL'}.count %> transition functions
       <% if @prefix != '' %>
       Functions and types have been generated with prefix "<%= @prefix %>"
@@ -23,16 +22,22 @@ module GV_FSM
     EOHEADER
 
     HH =<<~EOH
+      <% if !@ino then %>
       #ifndef <%= @cname.upcase %>_H
       #define <%= @cname.upcase %>_H
       #include <stdlib.h>
+      <% else %>
+      #include <arduino.h>
+      <% end %>
 
       // State data object
       // By default set to void; override this typedef or load the proper
       // header if you need
       typedef void <%= @prefix %>state_data_t;
-
+      <% if !@ino then %>
+      
       // NOTHING SHALL BE CHANGED AFTER THIS LINE!
+      <% end %>
 
       // List of states
       typedef enum {
@@ -43,24 +48,36 @@ module GV_FSM
         <%= @prefix.upcase %>NO_CHANGE
       } <%= @prefix %>state_t;
 
-      const char *state_names[] = {<%= states_list.map {|sn| '"'+sn+'"'}.join(", ") %>};
-
+      // State human-readable names
+      extern const char *state_names[];
+      
+      <% if transition_functions_list.count > 0 then %>
       // State function and state transition prototypes
       typedef <%= @prefix %>state_t state_func_t(<%= @prefix %>state_data_t *data);
       typedef void transition_func_t(<%= @prefix %>state_data_t *data);
+      <% else %>
+      // State function prototype
+      typedef <%= @prefix %>state_t state_func_t(<%= @prefix %>state_data_t *data);
+      <%end %>
 
       // State functions
+      <% dest = destinations.dup %>
       <% @states.each do |s| %>
+      <% stable = true if dest[s[:id]].include? s[:id] %>
+      <% dest[s[:id]].map! {|n| (@prefix+"STATE_"+n).upcase} %>
+      <% if dest[s[:id]].empty? or stable then
+        dest[s[:id]].unshift @prefix.upcase+"NO_CHANGE"
+      end %>
+      // Function to be executed in state <%= s[:id] %>
+      // valid return states: <%= dest[s[:id]].join(", ") %>
       <%= @prefix %>state_t <%= s[:function] %>(<%= @prefix %>state_data_t *data);
       <% end %>
 
+
       // List of state functions
-      state_func_t *const <%= @prefix %>state_table[<%= @prefix.upcase %>NUM_STATES] = {
-      <% @states.each do |s| %>
-        <%= s[:function] %>, // in state <%= s[:id] %>
-      <% end %>
-      };
+      extern state_func_t *const <%= @prefix %>state_table[<%= @prefix.upcase %>NUM_STATES];
       
+
       <% if transition_functions_list.count > 0 then %>
       // Transition functions
       <% transition_functions_list.each do |t| %>
@@ -69,32 +86,60 @@ 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
+      <% end %>
     EOH
 
     CC =<<~EOC
+      <% if !@ino then %>
+      <% if @syslog then %>
+      <% log = :syslog %>
       #include <syslog.h>
+      <% end %>
+      <% 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 %>
+
       //  ____  _        _       
       // / ___|| |_ __ _| |_ ___ 
       // \\___ \\| __/ _` | __/ _ \\
@@ -115,20 +160,30 @@ module GV_FSM
         dest[s[:id]].unshift @prefix.upcase+"NO_CHANGE"
       end %>
       // Function to be executed in state <%= s[:id] %>
+      // valid return states: <%= dest[s[:id]].join(", ") %>
       <%= @prefix %>state_t <%= s[:function] %>(<%= @prefix %>state_data_t *data) {
         <%= @prefix %>state_t next_state = <%= dest[s[:id]].first %>;
 
+      <% 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 %> */
         
-        // valid return states: <%= dest[s[:id]].join(", ") %>
         switch (next_state) {
       <% dest[s[:id]].each  do |str| %>
           case <%= str %>:
       <% end %>
             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]);
+      <% 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;
         }
         return next_state;
@@ -158,7 +213,11 @@ module GV_FSM
       // <%= i+1 %>. from <%= e[:from] %> to <%= e[:to] %>
       <% end %>
       void <%= t %>(<%= @prefix %>state_data_t *data) {
+      <% if log == :syslog then %>
         syslog(LOG_INFO, "[FSM] State transition <%= t %>");
+      <% elsif log == :ino then %>
+        Serial.println("[FSM] State transition <%= t %>");
+      <% end %>
         /* <%= placeholder %> */
       }
 
@@ -180,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)
@@ -188,13 +248,24 @@ module GV_FSM
         return new_state == <%= @prefix.upcase %>NO_CHANGE ? cur_state : new_state;
       };
 
+      <% 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 %>
       #ifdef TEST_MAIN
       #include <unistd.h>
       int main() {
         <%= @prefix %>state_t cur_state = <%= @prefix.upcase %>STATE_INIT;
+      <% if @syslog then %>
         openlog("SM", LOG_PID | LOG_PERROR, LOG_USER);
         syslog(LOG_INFO, "Starting SM");
+      <% end %>
         do {
           cur_state = <%= @prefix %>run_state(cur_state, NULL);
           sleep(1);
@@ -202,6 +273,7 @@ module GV_FSM
         return 0;
       }
       #endif
+      <% end %>
     EOC
   end
 end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module GV_FSM
-  VERSION = "0.2.1"
+  VERSION = "0.2.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gv_fsm
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.6
 platform: ruby
 authors:
 - Paolo Bosetti
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-08 00:00:00.000000000 Z
+date: 2020-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-graphviz