netlinx-erb 1.0.0

data/lib/netlinx/erb/rpc.rb

@@ -0,0 +1,270 @@
+# -----------------------------------------------------------------------------
+# The MIT License (MIT)
+
+# Copyright (c) 2014 Alex McLain and Joe McIlvain
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+# -----------------------------------------------------------------------------
+
+require 'netlinx/workspace'
+
+# :nodoc:
+class RPC
+  
+  # :nodoc:
+  def self.build
+    fn_exp = /
+    (?#
+      Pull out comment\\description above the function, enclosed in slash\\star syntax.
+      Does not have to exist.
+    )
+    ^(?<desc>[\t ]*\/\*(?:[^\*]|\*[^\/])*\*\/)?\s*
+
+    (?# Find the function definition. )
+    define_function\s+
+
+    (?# Capture function's return type, if it exists.)
+    (?<rtn>\w+(?<width>\[\d+\])?)??\s*
+
+    (?# Capture the function name. )
+    (?<name>\w+)
+
+    (?#
+      Capture the function parameters.
+      Run this through another regex to get the type\\name pairs.
+    )
+    \(\s*(?<params>.*?)\s*\)\s*
+
+    (?# Capture the function's source code. )
+    {[\r\n]*(?<code>(?:.|\r|\n)*?)?[\r\n]*}
+    /x
+
+    param_exp = /\s*(?:(?<type>\w+)\s+(?<name>\w+(?<width>\[\d*\])?)),?\s*/
+
+    sections = {} # Collect a set of matches for each file, separated by file.
+
+
+    # Pull file list from workspace.
+    workspace_path = Dir['*.apw'].first
+    workspace = NetLinx::Workspace.new file: workspace_path
+
+    file_paths = workspace.projects.first.systems.first.files
+      .map(&:path)
+      .select { |path| path =~ /(\.axi|\.axs)$/ }
+      .reject { |path| path =~ /rpc(?:-|_.*?)?\.axi/ } # Remove RPC files.
+
+    # file_paths = Dir['**/*.axi']
+
+    file_paths.each do |f|
+      str = File.open(f.gsub('\\', '/'), "r:iso-8859-1").read
+      matches = []
+      
+      while str =~ fn_exp
+        matches << $~
+        str = $'
+      end
+      
+      sections[f] = matches
+    end
+
+    # -----------------------
+    # Documentation Generator
+    # -----------------------
+
+    # output = ''
+    # sections.each do |name, matches|
+      
+    #   output << "--------------------------------------------------\n"
+    #   output << "FILE: '#{name}'\n"
+    #   output << "--------------------------------------------------\n"
+    #   output << "\n\n"
+      
+    #   matches.each do |m|
+    #     output << m[:desc].to_s
+    #     output << "\n"
+    #     output << m[:name].to_s
+    #     output << "\n\n\n"
+    #   end
+      
+    # end
+
+    # File.open('functions.axi', 'w+') { |f| f << output }
+
+
+    # ----------------------
+    # RPC Function Generator
+    # ----------------------
+
+    # Generate list of included and excluded files for sanity check.
+    directory_files = Dir['**/*.axi'] + Dir['**/*.axs']
+
+    included_files  = ''
+    file_paths.each { |path| included_files << path.to_s.gsub('\\', '/') + "\n" } # TODO: As string.
+
+    excluded_files  = ''
+    (directory_files - file_paths.map { |path| path.gsub '\\', '/' }).each { |path| excluded_files << path.to_s.gsub('\\', '/') + "\n" }
+
+    fn_symbols = [] # Symbol names to avoid duplicates.
+    output = ''
+
+    output << <<-EOS
+(***********************************************************)
+(*                         WARNING                         *)
+(***********************************************************)
+(*  This file is automatically generated.                  *)
+(***********************************************************)
+
+/*
+Included Files:
+---------------
+#{included_files}
+
+Excluded Files:
+---------------
+#{excluded_files}
+*/
+
+
+#if_not_defined RPC_FUNCTION_LIST
+#define RPC_FUNCTION_LIST 1
+
+DEFINE_EVENT
+
+data_event[vdvRPC]
+{
+    string:
+    {
+        char f_name[255];
+        f_name = rpc_function_name(data.text);
+        
+EOS
+
+    sections.each do |name, matches|
+      output << "        /*------------------------------------------------------------------/\n"
+      output << "            FILE: '#{name}'\n"
+      output << "        /------------------------------------------------------------------*/\n\n"
+      
+      
+      matches.each do |fn|
+        function_valid = true
+        fn_output      = ''
+        return_type    = fn[:rtn].nil? ? nil : fn[:rtn].downcase.to_sym
+        # TODO: Calculate return value width.
+        params         = []
+        
+        # Store function name as symbol and check for duplicates.
+        fn_sym = fn[:name].downcase.to_sym
+        
+        if fn_symbols.include? fn_sym
+          output << "        // Already defined.\n"
+          function_valid = false
+        else
+          fn_symbols << fn_sym
+        end
+        
+        # Retrieve params.
+        str = fn[:params]
+        while str =~ param_exp
+          params << $~
+          str = $'
+        end
+        
+        # Generate function handler.
+        fn_output << "        if(compare_string(f_name, '#{fn[:name].downcase}'))\n"
+        fn_output << "        {\n"
+        
+        # Generate return value.
+        if return_type
+          case return_type
+          when :integer
+            fn_output << "            #{return_type.to_s} return_value;\n"
+          end
+          
+          fn_output << "            \n"
+        end
+        
+        fn_output << "            print(LOG_LEVEL_INFO, 'RPC: #{fn[:name]}()');\n"
+        fn_output << "            \n"
+        
+        # Set return value equal to function if return value exists.
+        fn_output << "            "
+        fn_output << "return_value = " if return_type
+        
+        fn_output << "#{fn[:name]}("
+        fn_output << ");\n" if params.empty?
+
+        function_valid = false unless [nil, :integer].include? return_type
+          
+        # Generate parameters.
+        param_index = 0
+        params.each do |param|
+          param_index += 1
+          
+          valid_params = [:integer]
+          type = param[:type].downcase.to_sym
+          
+          unless valid_params.include? type
+            function_valid = false
+            break
+          end
+          
+          case type
+          when :integer
+            fn_output << "\n                rpc_get_arg_i(#{param_index}, data.text),"
+          end
+        end
+        
+        # Remove trailing comma from last arg.
+        fn_output.chop! unless params.empty?
+        
+        # Close function.
+        fn_output << "\n            );\n" unless params.empty?
+        
+        # Print return value if exists.
+        if return_type
+          fn_output << "            \n"
+          
+          case return_type
+          when :integer
+            fn_output << "            print(LOG_LEVEL_INFO, \"'RPC RTN: ', itoa(return_value)\");\n"
+          end
+        end
+        
+        fn_output << "        }\n\n"
+
+        # Store function string.
+        if function_valid
+          output << fn_output 
+        else
+          output << "        // Skipped:\n"
+          output << "        // #{fn[:name]}(#{fn[:params]})\n\n"
+        end
+      end
+      
+    end
+
+    output << "    }\n"
+    output << "}\n"
+    output << "#end_if\n\n"
+
+
+    File.open('include/rpc-functions.axi', 'w+') { |f| f << output }
+  end
+  
+end

data/lib/netlinx/rake/erb.rb

@@ -0,0 +1,26 @@
+
+require 'yard'
+require 'netlinx/rake/compile'
+require 'netlinx/rake/src'
+
+require_relative 'erb/generate_erb'
+require_relative 'erb/generate_rpc'
+require_relative 'erb/lines'
+
+
+task :default=>[:generate_rpc, :check_for_docs, :compile, :pack]
+
+NetLinx::Rake::ERB::Lines.new
+NetLinx::Rake::ERB::GenerateERB.new
+NetLinx::Rake::ERB::GenerateRPC.new :generate_rpc => :generate_erb
+
+# Generate Ruby documentation.
+YARD::Rake::YardocTask.new :doc do |t|
+  puts "\n"
+  # t.options = %w(- README.md)
+end
+
+# Make sure the readme has been converted to HTML.
+task :check_for_docs do
+  Rake::Task[:doc].invoke unless Dir.exists? 'doc'
+end

data/lib/netlinx/rake/erb/generate_erb.rb

@@ -0,0 +1,66 @@
+
+require 'rake'
+require 'rake/tasklib'
+
+module NetLinx
+  module Rake
+    module ERB
+      
+      # Generate Netlinx source code files from the erb template files.
+      class GenerateERB < ::Rake::TaskLib
+        
+        attr_accessor :name
+        
+        def initialize name = :generate_erb
+          @name = name
+          yield self if block_given?
+          
+          desc "Generate Netlinx source code files from the erb template files."
+          
+          task(name) do
+            require 'netlinx-erb'
+            
+            puts "Generating NetLinx files from ERB..."
+            puts "------------------------------------"
+            
+            templates = Dir['include/**/*.erb']
+
+            outputs = templates.map { |str| str.gsub /\.erb$/, '' }
+
+            templates.each do |template|
+              file_name = template.gsub /\.erb$/, ''
+              puts "   #{file_name}"
+              
+              header = $AUTOGEN_HEADER = <<-HEADER
+(***********************************************************)
+(*                         WARNING                         *)
+(***********************************************************}
+    This file was generated from the following template
+    and should NOT be edited directly: 
+    
+      #{template}
+    
+    See the documentation at `doc/index.html` for
+    information about maintaining this project.
+    
+    Generated with netlinx-erb:
+      https://github.com/amclain/netlinx-erb
+{***********************************************************)
+
+          HEADER
+              buffer = header + File.read(template)
+              
+              File.open file_name, 'w+' do |file|
+                file.write ::ERB.new(buffer, nil, '%<>-')
+                  .result(NetLinx::ERB.binding)
+              end
+            end
+            
+            puts "\nDone."
+          end
+        end
+        
+      end
+    end
+  end
+end

data/lib/netlinx/rake/erb/generate_rpc.rb

@@ -0,0 +1,31 @@
+
+require 'rake'
+require 'rake/tasklib'
+
+module NetLinx
+  module Rake
+    module ERB
+      
+      # Generate NetLinx RPC file.
+      class GenerateRPC < ::Rake::TaskLib
+        
+        attr_accessor :name
+        
+        def initialize name = :generate_rpc
+          @name = name
+          yield self if block_given?
+          
+          desc "Generate NetLinx RPC file."
+          
+          task(name) do
+            require 'netlinx-erb'
+            puts "\n\nGenerating RPC functions..."
+            RPC.build
+            puts "Done.\n\n"
+          end
+        end
+        
+      end
+    end
+  end
+end

data/lib/netlinx/rake/erb/lines.rb

@@ -0,0 +1,47 @@
+
+require 'rake'
+require 'rake/tasklib'
+
+module NetLinx
+  module Rake
+    module ERB
+      
+      # Show lines of code for .axi files.
+      class Lines < ::Rake::TaskLib
+        
+        attr_accessor :name
+        
+        def initialize name = :lines
+          @name = name
+          yield self if block_given?
+          
+          desc "Show lines of code for .axi files."
+          
+          task(name) do
+            require 'netlinx/workspace'
+            
+            workspace_path = Dir['*.apw'].first
+            workspace = NetLinx::Workspace.new file: workspace_path
+            file_paths = workspace.projects.first.systems.first.files
+              .map(&:path)
+              .select { |path| File.extname(path) == '.axs' or File.extname(path) == '.axi' }
+            
+            puts "\n\nLines of code..."
+              puts "----------------"
+            
+            lines_by_path = file_paths.map { |path| {path: path, lines: File.read(path).lines.count} }
+            lines_by_path.each do |line_by_path|
+              puts "#{line_by_path[:lines]}\t#{line_by_path[:path]}"
+            end
+            
+            puts "-----\t--------------------"
+            total = 0
+            lines_by_path.map { |l| l[:lines] }.each { |lines| total += lines }
+            puts "#{total}\tTotal"
+          end
+        end
+        
+      end
+    end
+  end
+end

data/license.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Alex McLain and Joe McIlvain
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.