gv_fsm 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 450afef3dccacff09f92f297a5b5bcbdfb9d1c960bea0d546bcafe7123f5cebd
-  data.tar.gz: 1fa684d748abecd8c8f17ac2a2b7ca17c83506003eb2cc143596668a32d0a1ea
+  metadata.gz: 2896e7f9617c0ed1a9917e78cd947d1da5ceef2d8554727a4db268a7f70e6229
+  data.tar.gz: 63d897002c102d5291ecbfd7b4c854f8c9fc029e01155ba573d13e2043621afb
 SHA512:
-  metadata.gz: 98d883a1bff3afaae6fe1531a8f702b6600c97bd37fa4260b3eef02ecccfaf978ab3a9acc096a0c62d9d95c2b4450df105a5cc38f1a03f624984813c9ac5bcb9
-  data.tar.gz: 20af124b281a5aeba975d5124c4a552480d03ea9d4cb13903f4c60f3408c28876adf12a040455dd48afb98ebed8dedb0ee65121e6e93e0d3c9d854a43e4fea57
+  metadata.gz: ae5be7ee072d06983c139320227c6b234d703b2556071df085cb3f6a3365d3d1c6a8cf38f9f6daac0b866ed5b77c4726933eee69eda7aa8d9ffe17b9f2c2ca0b
+  data.tar.gz: bd1129ccf730d930b42a8ba53f83eb2adeb6d66368ebd9aab6466c69e2b951d6b461d0e04579254153d2c753c390f16f023806040615e6ac52d53f3b2f60c71a

data/lib/templates.rb

@@ -2,18 +2,23 @@
 module GV_FSM
   module Templates
     HEADER =<<~EOHEADER
-      // Finite State Machine
-      // 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: <%= @dotfile %>
-      // The finite state machine has:
-      //   <%= @states.count %> states
-      //   <%= @transitions.count %> transitions
-      //   <%= transition_functions_list.select {|e| e != 'NULL'}.count %> transition functions
+      /******************************************************************************
+      Finite State Machine
+      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: <%= @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 %>"
+      <% end %>
+      ******************************************************************************/
 
     EOHEADER
 
@@ -22,6 +27,13 @@ module GV_FSM
       #define <%= @cname.upcase %>_H
       #include <stdlib.h>
 
+      // 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;
+
+      // NOTHING SHALL BE CHANGED AFTER THIS LINE!
+
       // List of states
       typedef enum {
       <% @states.each_with_index do |s, i| %>
@@ -29,29 +41,31 @@ module GV_FSM
       <% end %>
         <%= @prefix.upcase %>NUM_STATES,
         <%= @prefix.upcase %>NO_CHANGE
-      } state_t;
+      } <%= @prefix %>state_t;
 
       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);
+      typedef <%= @prefix %>state_t state_func_t(<%= @prefix %>state_data_t *data);
+      typedef void transition_func_t(<%= @prefix %>state_data_t *data);
 
-      // state functions
+      // State functions
       <% @states.each do |s| %>
-      state_t <%= s[:function] %>(void *data);
+      <%= @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] = {
-        <%= state_functions_list.join(",\n  ")%>
+      <% @states.each do |s| %>
+        <%= s[:function] %>, // in state <%= s[:id] %>
+      <% end %>
       };
       
       <% if transition_functions_list.count > 0 then %>
-      // transition functions
+      // Transition functions
       <% transition_functions_list.each do |t| %>
       <% next if t == "NULL" %>
-      void <%= t %>(void *data);
+      void <%= t %>(<%= @prefix %>state_data_t *data);
       <% end %>
 
       // Table of transition functions
@@ -69,7 +83,7 @@ module GV_FSM
       <% end %>
 
       // state manager
-      state_t <%= @prefix %>run_state(state_t cur_state, void *data);
+      <%= @prefix %>state_t <%= @prefix %>run_state(<%= @prefix %>state_t cur_state, void *data);
       
       #endif
     EOH
@@ -78,6 +92,9 @@ module GV_FSM
       #include <syslog.h>
       #include "<%= @cname %>.h"
       
+      <% placeholder = "Your Code Here" %>
+      // SEARCH FOR <%= placeholder %> FOR CODE INSERTION POINTS!
+
       //  ____  _        _       
       // / ___|| |_ __ _| |_ ___ 
       // \\___ \\| __/ _` | __/ _ \\
@@ -97,12 +114,12 @@ module GV_FSM
       <% if dest[s[:id]].empty? or stable then
         dest[s[:id]].unshift @prefix.upcase+"NO_CHANGE"
       end %>
-      // To be executed in state <%= s[:id] %>
-      state_t <%= s[:function] %>(void *data) {
-        state_t next_state = <%= dest[s[:id]].first %>;
+      // Function to be executed in state <%= s[:id] %>
+      <%= @prefix %>state_t <%= s[:function] %>(<%= @prefix %>state_data_t *data) {
+        <%= @prefix %>state_t next_state = <%= dest[s[:id]].first %>;
 
         syslog(LOG_INFO, "[FSM] In state <%= s[:id] %>");
-        /* Your code here */
+        /* <%= placeholder %> */
         
         // valid return states: <%= dest[s[:id]].join(", ") %>
         switch (next_state) {
@@ -135,13 +152,14 @@ module GV_FSM
                                                
       <% transition_functions_list.each do |t| %>
       <% next if t == "NULL" %>
-      // This function is called in transitions:
-      <% transitions_paths[t].each do |e| %>
-      // from <%= e[:from] %> to <%= e[:to] %>
+      <% tpaths = transitions_paths[t] %>
+      // This function is called in <%= tpaths.count %> transition<%= tpaths.count == 1 ? '' : 's' %>:
+      <% tpaths.each_with_index do |e, i| %>
+      // <%= i+1 %>. from <%= e[:from] %> to <%= e[:to] %>
       <% end %>
-      void <%= t %>(void *data) {
+      void <%= t %>(<%= @prefix %>state_data_t *data) {
         syslog(LOG_INFO, "[FSM] State transition <%= t %>");
-        /* Your code here */
+        /* <%= placeholder %> */
       }
 
       <% end %>
@@ -160,8 +178,8 @@ module GV_FSM
       // |_| |_| |_|\\__,_|_| |_|\\__,_|\\__, |\\___|_|   
       //                              |___/           
 
-      state_t <%= @prefix %>run_state(state_t cur_state, void *data) {
-        state_t new_state = <%= @prefix %>state_table[cur_state](data);
+      <%= @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 transition_functions_list.count > 0 then %>
         transition_func_t *transition = <%= @prefix %>transition_table[cur_state][new_state];
         if (transition)
@@ -174,11 +192,11 @@ module GV_FSM
       #ifdef TEST_MAIN
       #include <unistd.h>
       int main() {
-        state_t cur_state = <%= @prefix.upcase %>STATE_INIT;
+        <%= @prefix %>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);
+          cur_state = <%= @prefix %>run_state(cur_state, NULL);
           sleep(1);
         } while (cur_state != <%= @prefix.upcase %>STATE_STOP);
         return 0;

data/lib/version.rb

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

metadata

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