gv_fsm 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cdb522af0bd9bac3a853e75ad379b063657a6bd21ceb2fcad80c427ca6c00ed
-  data.tar.gz: 350cd6c0dbdbe1e3ff03f8e26eda97b16be7764dc7f5c244a98b3e0997d50b3a
+  metadata.gz: 450afef3dccacff09f92f297a5b5bcbdfb9d1c960bea0d546bcafe7123f5cebd
+  data.tar.gz: 1fa684d748abecd8c8f17ac2a2b7ca17c83506003eb2cc143596668a32d0a1ea
 SHA512:
-  metadata.gz: 2b623ee5a2d45345ff3ab13db5605ffa978b30add3b0ca912588d531fbf81f13b3f5a3210b02bbcee29e736115a10b936201e57828635d81c9c2c82eec869e74
-  data.tar.gz: bc2584dfcc1025b41499bc66ff85113eb2b440031467e1ac74a44450717cc48850cc4c35cfe8594262b59ac6d3e0164c766f439aa9f8eaf6e36e6cdc790262d9
+  metadata.gz: 98d883a1bff3afaae6fe1531a8f702b6600c97bd37fa4260b3eef02ecccfaf978ab3a9acc096a0c62d9d95c2b4450df105a5cc38f1a03f624984813c9ac5bcb9
+  data.tar.gz: 20af124b281a5aeba975d5124c4a552480d03ea9d4cb13903f4c60f3408c28876adf12a040455dd48afb98ebed8dedb0ee65121e6e93e0d3c9d854a43e4fea57

data/bin/gv_fsm

@@ -36,12 +36,17 @@ OptionParser.new do |parser|
     options[:header] = false
   end
 
+  parser.on("-x", "--prefix PREFIX", "Prepend PREFIX to names of generated functions and objects") do |p|
+    sm.prefix = p
+  end
+
 end.parse!
 
 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"
 
 sm.parse(ARGV[0])
+
 puts "Parsed #{sm.dotfile}.\nGenerating C stub for states: #{sm.states_list.join(", ")}."
 if options[:header] then
   sm.generate_h 

data/lib/gv_fsm.rb

@@ -8,14 +8,19 @@ require File.expand_path("../version.rb", __FILE__)
 
 module GV_FSM
   class FSM
-    attr_reader :states, :transitions, :dotfile
+    attr_reader :states, :transitions, :dotfile, :prefix
     attr_accessor :project_name, :description, :cname
     include GV_FSM::Templates
 
     def initialize(filename = nil)
+      @prefix = ""
       parse(filename) if filename
     end
 
+    def prefix=(v)
+      @prefix = v + '_'
+    end
+
     def parse(filename)
       raise ArgumentError, "File must be in .dot format" unless File.extname(filename) == ".dot"
       @cname = File.basename(filename, ".dot") unless (@cname and ! @cname.empty?)
@@ -26,7 +31,7 @@ module GV_FSM
         g.each_node do |id|
           n = g.get_node(id)
           label = n[:label].source.empty? ? "do_#{id}" : n[:label].source
-          @states << {id: id, function: label}
+          @states << {id: id, function: @prefix+label}
         end
         g.each_edge do |e|
           from = e.node_one
@@ -40,7 +45,7 @@ module GV_FSM
           else
             label = e[:label].source
           end
-          @transitions << {from: from, to: to, function: label}
+          @transitions << {from: from, to: to, function: label ? @prefix+label : nil}
         end
       end
     end

data/lib/templates.rb

@@ -3,63 +3,64 @@ module GV_FSM
   module Templates
     HEADER =<<~EOHEADER
       // Finite State Machine
-      // Project: <%= self.project_name or self.dotfile %>
-      // Description: <%= self.description or "<none given>" %>
+      // Project: <%= @project_name or @dotfile %>
+      // Description: <%= @description or "<none given>" %>
       //
       // Generated by gv_fsm ruby gem, see https://rubygems.org/gems/gv_fsm
       // gv_fsm version <%= GV_FSM::VERSION %>
       // Generation date: <%= Time.now %>
-      // Generated from: <%= self.dotfile %>
+      // Generated from: <%= @dotfile %>
       // The finite state machine has:
-      //   <%= self.states.count %> states
-      //   <%= self.transitions.count %> transitions
+      //   <%= @states.count %> states
+      //   <%= @transitions.count %> transitions
+      //   <%= transition_functions_list.select {|e| e != 'NULL'}.count %> transition functions
 
     EOHEADER
 
     HH =<<~EOH
-      #ifndef <%= self.cname.upcase %>_H
-      #define <%= self.cname.upcase %>_H
+      #ifndef <%= @cname.upcase %>_H
+      #define <%= @cname.upcase %>_H
       #include <stdlib.h>
 
       // List of states
       typedef enum {
-      <% self.states.each_with_index do |s, i| %>
-        STATE_<%= s[:id].upcase %><%= i == 0 ? " = 0" : "" %>,  
+      <% @states.each_with_index do |s, i| %>
+        <%= @prefix.upcase %>STATE_<%= s[:id].upcase %><%= i == 0 ? " = 0" : "" %>,  
       <% end %>
-        NUM_STATES,
-        NO_CHANGE
+        <%= @prefix.upcase %>NUM_STATES,
+        <%= @prefix.upcase %>NO_CHANGE
       } state_t;
 
-      const char *state_names[] = {<%= self.states_list.map {|sn| '"'+sn+'"'}.join(", ") %>};
+      const char *state_names[] = {<%= states_list.map {|sn| '"'+sn+'"'}.join(", ") %>};
 
       // State function and state transition prototypes
       typedef state_t state_func_t(void *data);
       typedef void transition_func_t(void *data);
 
       // state functions
-      <% self.states.each do |s| %>
+      <% @states.each do |s| %>
       state_t <%= s[:function] %>(void *data);
       <% end %>
 
       // List of state functions
-      state_func_t *const state_table[NUM_STATES] = {
-        <%= self.state_functions_list.join(",\n  ")%>
+      state_func_t *const <%= @prefix %>state_table[<%= @prefix.upcase %>NUM_STATES] = {
+        <%= state_functions_list.join(",\n  ")%>
       };
       
-      <% if self.transition_functions_list.count > 0 then %>
+      <% if transition_functions_list.count > 0 then %>
       // transition functions
-      <% self.transition_functions_list.each do |t| %>
+      <% transition_functions_list.each do |t| %>
       <% next if t == "NULL" %>
       void <%= t %>(void *data);
       <% end %>
 
       // Table of transition functions
-      transition_func_t *const transition_table[NUM_STATES][NUM_STATES] = {
-      <% sl = self.states_list %>
-      <% fw = self.transition_functions_list.max {|a, b| a.length <=> b.length}.length %>
-      <% sw = self.states_list.max {|a, b| a.length <=> b.length}.length %>
+      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(", ") %> */
-      <% self.transitions_map.each_with_index do |l, i| %>
+      <% transitions_map.each_with_index do |l, i| %>
         /* <%= sl[i].ljust(sw) %> */ {<%= l.map {|e| e.ljust(fw)}.join(", ") %>}, 
       <% end %>
       };
@@ -68,14 +69,14 @@ module GV_FSM
       <% end %>
 
       // state manager
-      state_t run_state(state_t cur_state, void *data);
+      state_t <%= @prefix %>run_state(state_t cur_state, void *data);
       
       #endif
     EOH
 
     CC =<<~EOC
       #include <syslog.h>
-      #include "<%= self.cname %>.h"
+      #include "<%= @cname %>.h"
       
       //  ____  _        _       
       // / ___|| |_ __ _| |_ ___ 
@@ -89,12 +90,12 @@ module GV_FSM
       // |  _| |_| | | | | (__| |_| | (_) | | | \\__ \\
       // |_|  \\__,_|_| |_|\\___|\\__|_|\\___/|_| |_|___/
       //                                             
-      <% dest = self.destinations.dup %>
-      <% self.states.each do |s| %>
+      <% dest = destinations.dup %>
+      <% @states.each do |s| %>
       <% stable = true if dest[s[:id]].include? s[:id] %>
-      <% dest[s[:id]].map! {|n| "STATE_"+n.upcase} %>
+      <% dest[s[:id]].map! {|n| (@prefix+"STATE_"+n).upcase} %>
       <% if dest[s[:id]].empty? or stable then
-        dest[s[:id]].unshift "NO_CHANGE"
+        dest[s[:id]].unshift @prefix.upcase+"NO_CHANGE"
       end %>
       // To be executed in state <%= s[:id] %>
       state_t <%= s[:function] %>(void *data) {
@@ -111,17 +112,17 @@ module GV_FSM
             break;
           default:
             syslog(LOG_WARNING, "[FSM] Cannot pass from <%= s[:id] %> to %s, remaining in this state", state_names[next_state]);
-            next_state = NO_CHANGE;
+            next_state = <%= @prefix.upcase %>NO_CHANGE;
         }
         return next_state;
       }
 
       <% end %>
 
-      <% if self.transition_functions_list.count > 0 then %>
+      <% if transition_functions_list.count > 0 then %>
       //  _____                    _ _   _              
       // |_   _| __ __ _ _ __  ___(_) |_(_) ___  _ __   
-      //   | || '__/ _` | '_ \\/ __| | __| |/ _ \\| '_ \\  
+      //   | || '__/ _` | '_ \\/ __| | __| |/ _ \\| '_ \\
       //   | || | | (_| | | | \\__ \\ | |_| | (_) | | | | 
       //   |_||_|  \\__,_|_| |_|___/_|\\__|_|\\___/|_| |_| 
       //                                                
@@ -132,10 +133,10 @@ module GV_FSM
       // |_|  \\__,_|_| |_|\\___|\\__|_|\\___/|_| |_|___/
       //    
                                                
-      <% self.transition_functions_list.each do |t| %>
+      <% transition_functions_list.each do |t| %>
       <% next if t == "NULL" %>
       // This function is called in transitions:
-      <% self.transitions_paths[t].each do |e| %>
+      <% transitions_paths[t].each do |e| %>
       // from <%= e[:from] %> to <%= e[:to] %>
       <% end %>
       void <%= t %>(void *data) {
@@ -148,7 +149,7 @@ module GV_FSM
 
       //  ____  _        _        
       // / ___|| |_ __ _| |_ ___  
-      // \\___ \\| __/ _` | __/ _ \\ 
+      // \\___ \\| __/ _` | __/ _ \\
       //  ___) | || (_| | ||  __/ 
       // |____/ \\__\\__,_|\\__\\___| 
       //                          
@@ -159,27 +160,27 @@ module GV_FSM
       // |_| |_| |_|\\__,_|_| |_|\\__,_|\\__, |\\___|_|   
       //                              |___/           
 
-      state_t run_state(state_t cur_state, void *data) {
-        state_t new_state = state_table[cur_state](data);
-      <% if self.transition_functions_list.count > 0 then %>
-        transition_func_t *transition = transition_table[cur_state][new_state];
+      state_t <%= @prefix %>run_state(state_t cur_state, void *data) {
+        state_t new_state = <%= @prefix %>state_table[cur_state](data);
+      <% if transition_functions_list.count > 0 then %>
+        transition_func_t *transition = <%= @prefix %>transition_table[cur_state][new_state];
         if (transition)
           transition(data);
       <% end %>
-        return new_state == NO_CHANGE ? cur_state : new_state;
+        return new_state == <%= @prefix.upcase %>NO_CHANGE ? cur_state : new_state;
       };
 
 
       #ifdef TEST_MAIN
       #include <unistd.h>
       int main() {
-        state_t cur_state = STATE_INIT;
+        state_t cur_state = <%= @prefix.upcase %>STATE_INIT;
         openlog("SM", LOG_PID | LOG_PERROR, LOG_USER);
         syslog(LOG_INFO, "Starting SM");
         do {
           cur_state = run_state(cur_state, NULL);
           sleep(1);
-        } while (cur_state != STATE_STOP);
+        } while (cur_state != <%= @prefix.upcase %>STATE_STOP);
         return 0;
       }
       #endif

data/lib/version.rb

@@ -1,3 +1,3 @@
 module GV_FSM
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

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