gv_fsm 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d5cf386d941c15a1f9c6efb216b87d53e1d2836db174974f29290873c53a86b
-  data.tar.gz: 9d1bcf0cd2d1bf32ca797d76f4e776a6462dbedc565399da20ef1c581b66fa47
+  metadata.gz: 61d5d6c1ef593ce7d516c48ab905c210d3005081fdd241b47298c55c5340236c
+  data.tar.gz: d8bc69220e149140bd150ad3890dbf11e33651352bf22df483b7941c9a9911c7
 SHA512:
-  metadata.gz: 22269db6b746cba79aace36079d7857850f67d2f484b4661b738ce10b9f15f659f6e6fa1092c8a67d02d8b392ccdce12f2a78dfa41c9d8980e5fae91aaea59bb
-  data.tar.gz: f0408ea83e6cd16a94b8b82916185eec48d779600c93d4f79555edd2ff8268f232c20310abc0c5606014a502ac8ce33b98727815663ffdaf61888109a88c039e
+  metadata.gz: c92f9ebb2275bfb8fd4fa23060cc22c8d34fe2e7eb219e9833f60517417ca11a420758c99fb0bee82cc58795f184a44d230bf03ae947072e1a72271bad34b2c9
+  data.tar.gz: 7a2898d7f153fe7c80a9eb046c54bd4076ffa15bf69987f069d94a70708a17085641fc7dff765fd7816df839f469ce363e7793122e5d09538e882667d5e83650

data/bin/gv_fsm

@@ -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,27 @@ 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
+
+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

@@ -8,7 +8,7 @@ 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 +16,7 @@ module GV_FSM
       @prefix = ""
       @syslog = true
       @ino = false
+      @error = nil
       parse(filename) if filename
     end
 
@@ -29,7 +30,20 @@ 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)
           if n[:label].source.empty? or
@@ -58,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
@@ -108,27 +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
 
-    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

@@ -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
@@ -100,10 +102,13 @@ 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!
@@ -159,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 %> */
         
@@ -170,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;
         }
@@ -202,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 %> */
       }
@@ -237,11 +250,17 @@ 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 %>
       #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);
@@ -251,12 +270,9 @@ module GV_FSM
           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

data/lib/version.rb

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

metadata

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