gv_fsm 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2896e7f9617c0ed1a9917e78cd947d1da5ceef2d8554727a4db268a7f70e6229
-  data.tar.gz: 63d897002c102d5291ecbfd7b4c854f8c9fc029e01155ba573d13e2043621afb
+  metadata.gz: 3579818099a2f3e8d172c9534af08877f3e4b27f4fc09f9c9aa77c6275256ce3
+  data.tar.gz: 5b4acdd1da41b63fbac514f2a481766c5b5c08ba34881ef708d11871910e8d0d
 SHA512:
-  metadata.gz: ae5be7ee072d06983c139320227c6b234d703b2556071df085cb3f6a3365d3d1c6a8cf38f9f6daac0b866ed5b77c4726933eee69eda7aa8d9ffe17b9f2c2ca0b
-  data.tar.gz: bd1129ccf730d930b42a8ba53f83eb2adeb6d66368ebd9aab6466c69e2b951d6b461d0e04579254153d2c753c390f16f023806040615e6ac52d53f3b2f60c71a
+  metadata.gz: 5f481dacfc667927287eecc1b5f901fd915a593ab533b6de35f573e0cb1b66219c5cd37e24f9c54095e1049f8a7f3f67094530338a9c653cbb72585d1ccbcdf3
+  data.tar.gz: 4b835c1bc4f03a6d80e37f64f219b0801756ffaeeedbd7da20f53ffbc428b48efd92ac075c189b5379d30ef125ebaf4417e259b0729d1c9e9ac0a94db08b3e14

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}
@@ -40,21 +40,48 @@ 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-syslog", "Omit syslog 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
 
-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"
 end
-if options[:source] then
-  sm.generate_c 
-  puts "Generated source #{sm.cname}.c"
+
+op.parse!
+
+unless ARGV[0]
+  STDERR.puts "ERROR: I need the path to a Graphviz file!\n\n"
+  STDERR.puts op
+  exit
+end
+unless File.extname(ARGV[0]) == ".dot"
+  STDERR.puts "ERROR: #{ARGV[0]} does not look like a Graphviz file!\n\n"
+  STDERR.puts op
+  exit
 end
 
+sm.parse(ARGV[0])
+
+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
+end
 

data/lib/gv_fsm.rb

@@ -9,11 +9,13 @@ 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_accessor :project_name, :description, :cname, :syslog, :ino
     include GV_FSM::Templates
 
     def initialize(filename = nil)
       @prefix = ""
+      @syslog = true
+      @ino = false
       parse(filename) if filename
     end
 
@@ -36,7 +38,10 @@ module GV_FSM
         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
@@ -61,7 +66,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
@@ -110,6 +115,15 @@ module GV_FSM
         f.puts ERB.new(HH, 0, "<>").result(binding)
       end
     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
+    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,20 @@ module GV_FSM
     EOHEADER
 
     HH =<<~EOH
+      <% if !@ino then %>
       #ifndef <%= @cname.upcase %>_H
       #define <%= @cname.upcase %>_H
       #include <stdlib.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 +46,41 @@ module GV_FSM
         <%= @prefix.upcase %>NO_CHANGE
       } <%= @prefix %>state_t;
 
+      // State human-readable names
       const char *state_names[] = {<%= states_list.map {|sn| '"'+sn+'"'}.join(", ") %>};
-
+      
+      <% 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
+      <% 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] %>, // in state <%= s[:id] %>
+        <%= (s[:function] + ',').ljust(fw+1) %> // in state <%= s[:id] %>
       <% end %>
       };
       
+
       <% if transition_functions_list.count > 0 then %>
       // Transition functions
       <% transition_functions_list.each do |t| %>
@@ -85,12 +105,18 @@ module GV_FSM
       // state manager
       <%= @prefix %>state_t <%= @prefix %>run_state(<%= @prefix %>state_t cur_state, void *data);
       
+      <% if !@ino then %>
       #endif
+      <% end %>
     EOH
 
     CC =<<~EOC
+      <% if !@ino then %>
+      <% if @syslog then %>
       #include <syslog.h>
+      <% end %>
       #include "<%= @cname %>.h"
+      <% end %>
       
       <% placeholder = "Your Code Here" %>
       // SEARCH FOR <%= placeholder %> FOR CODE INSERTION POINTS!
@@ -115,20 +141,24 @@ 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 @syslog then %>
         syslog(LOG_INFO, "[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 @syslog then %>
             syslog(LOG_WARNING, "[FSM] Cannot pass from <%= s[:id] %> to %s, remaining in this state", state_names[next_state]);
+      <% end %>
             next_state = <%= @prefix.upcase %>NO_CHANGE;
         }
         return next_state;
@@ -158,7 +188,9 @@ module GV_FSM
       // <%= i+1 %>. from <%= e[:from] %> to <%= e[:to] %>
       <% end %>
       void <%= t %>(<%= @prefix %>state_data_t *data) {
+      <% if @syslog then %>
         syslog(LOG_INFO, "[FSM] State transition <%= t %>");
+      <% end %>
         /* <%= placeholder %> */
       }
 
@@ -188,20 +220,29 @@ module GV_FSM
         return new_state == <%= @prefix.upcase %>NO_CHANGE ? cur_state : new_state;
       };
 
-
+      <% if @ino then %>
+      /* Example usage:
+      <% else %>
       #ifdef TEST_MAIN
       #include <unistd.h>
       int main() {
+      <% end %>
         <%= @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);
         } while (cur_state != <%= @prefix.upcase %>STATE_STOP);
+      <% if !@ino then %>
         return 0;
       }
       #endif
+      <% else %>
+      */
+      <% end %>
     EOC
   end
 end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module GV_FSM
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 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.2
 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