RubyGems - netlinx-compile - Versions diffs - 1.0.0 - Mend

netlinx-compile 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (68) hide show

checksums.yaml +7 -0
data/README.txt +2 -0
data/bin/netlinx-compile +4 -0
data/doc/NetLinx.html +151 -0
data/doc/NetLinx/Compile.html +148 -0
data/doc/NetLinx/Compile/Extension.html +145 -0
data/doc/NetLinx/Compile/Extension/AXS.html +154 -0
data/doc/NetLinx/Compile/ExtensionDiscovery.html +324 -0
data/doc/NetLinx/Compile/ExtensionHandler.html +396 -0
data/doc/NetLinx/Compile/Script.html +293 -0
data/doc/NetLinx/Compiler.html +295 -0
data/doc/NetLinx/CompilerResult.html +501 -0
data/doc/NetLinx/NoCompilerError.html +155 -0
data/doc/NetLinx/SourceFile.html +430 -0
data/doc/Test.html +147 -0
data/doc/Test/NetLinx.html +147 -0
data/doc/Test/NetLinx/Compilable.html +148 -0
data/doc/Test/NetLinx/Compile.html +146 -0
data/doc/Test/NetLinx/Compile/Discoverable.html +148 -0
data/doc/Test/NetLinx/Compile/Invokable.html +149 -0
data/doc/created.rid +12 -0
data/doc/images/add.png +0 -0
data/doc/images/arrow_up.png +0 -0
data/doc/images/brick.png +0 -0
data/doc/images/brick_link.png +0 -0
data/doc/images/bug.png +0 -0
data/doc/images/bullet_black.png +0 -0
data/doc/images/bullet_toggle_minus.png +0 -0
data/doc/images/bullet_toggle_plus.png +0 -0
data/doc/images/date.png +0 -0
data/doc/images/delete.png +0 -0
data/doc/images/find.png +0 -0
data/doc/images/loadingAnimation.gif +0 -0
data/doc/images/macFFBgHack.png +0 -0
data/doc/images/package.png +0 -0
data/doc/images/page_green.png +0 -0
data/doc/images/page_white_text.png +0 -0
data/doc/images/page_white_width.png +0 -0
data/doc/images/plugin.png +0 -0
data/doc/images/ruby.png +0 -0
data/doc/images/tag_blue.png +0 -0
data/doc/images/tag_green.png +0 -0
data/doc/images/transparent.png +0 -0
data/doc/images/wrench.png +0 -0
data/doc/images/wrench_orange.png +0 -0
data/doc/images/zoom.png +0 -0
data/doc/index.html +103 -0
data/doc/js/darkfish.js +155 -0
data/doc/js/jquery.js +18 -0
data/doc/js/navigation.js +142 -0
data/doc/js/search.js +94 -0
data/doc/js/search_index.js +1 -0
data/doc/js/searcher.js +228 -0
data/doc/rdoc.css +595 -0
data/doc/table_of_contents.html +138 -0
data/lib/netlinx-compile.rb +1 -0
data/lib/netlinx/compile/extension/axs.rb +18 -0
data/lib/netlinx/compile/extension_discovery.rb +62 -0
data/lib/netlinx/compile/extension_handler.rb +86 -0
data/lib/netlinx/compile/script.rb +115 -0
data/lib/netlinx/compiler.rb +71 -0
data/lib/netlinx/compiler_result.rb +72 -0
data/lib/netlinx/source_file.rb +78 -0
data/lib/test/netlinx/compilable.rb +48 -0
data/lib/test/netlinx/compile/discoverable.rb +14 -0
data/lib/test/netlinx/compile/invokable.rb +15 -0
data/license.txt +13 -0
metadata +156 -0

data/doc/table_of_contents.html ADDED

@@ -0,0 +1,138 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+<title>Table of Contents - RDoc Documentation</title>
+<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+</script>
+<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
+<body class="indexpage">
+<h1>Table of Contents - RDoc Documentation</h1>
+<h2 id="classes">Classes/Modules</h2>
+<ul>
+  <li class="module">
+    <a href="NetLinx.html">NetLinx</a>
+  </li>
+    <li class="module">
+    <a href="NetLinx/Compile.html">NetLinx::Compile</a>
+  </li>
+    <li class="module">
+    <a href="NetLinx/Compile/Extension.html">NetLinx::Compile::Extension</a>
+  </li>
+    <li class="class">
+    <a href="NetLinx/Compile/Extension/AXS.html">NetLinx::Compile::Extension::AXS</a>
+  </li>
+    <li class="class">
+    <a href="NetLinx/Compile/ExtensionDiscovery.html">NetLinx::Compile::ExtensionDiscovery</a>
+  </li>
+    <li class="class">
+    <a href="NetLinx/Compile/ExtensionHandler.html">NetLinx::Compile::ExtensionHandler</a>
+  </li>
+    <li class="class">
+    <a href="NetLinx/Compile/Script.html">NetLinx::Compile::Script</a>
+  </li>
+    <li class="class">
+    <a href="NetLinx/Compiler.html">NetLinx::Compiler</a>
+  </li>
+    <li class="class">
+    <a href="NetLinx/CompilerResult.html">NetLinx::CompilerResult</a>
+  </li>
+    <li class="class">
+    <a href="NetLinx/NoCompilerError.html">NetLinx::NoCompilerError</a>
+  </li>
+    <li class="class">
+    <a href="NetLinx/SourceFile.html">NetLinx::SourceFile</a>
+  </li>
+    <li class="module">
+    <a href="Test.html">Test</a>
+  </li>
+    <li class="module">
+    <a href="Test/NetLinx.html">Test::NetLinx</a>
+  </li>
+    <li class="module">
+    <a href="Test/NetLinx/Compilable.html">Test::NetLinx::Compilable</a>
+  </li>
+    <li class="module">
+    <a href="Test/NetLinx/Compile.html">Test::NetLinx::Compile</a>
+  </li>
+    <li class="module">
+    <a href="Test/NetLinx/Compile/Discoverable.html">Test::NetLinx::Compile::Discoverable</a>
+  </li>
+    <li class="module">
+    <a href="Test/NetLinx/Compile/Invokable.html">Test::NetLinx::Compile::Invokable</a>
+  </li>
+</ul>
+<h2 id="methods">Methods</h2>
+<ul>
+    <li class="method"><a href="NetLinx/Compile/ExtensionDiscovery.html#method-c-discover">::discover &mdash; NetLinx::Compile::ExtensionDiscovery</a>
+    <li class="method"><a href="NetLinx/Compile/ExtensionDiscovery.html#method-c-get_handler">::get_handler &mdash; NetLinx::Compile::ExtensionDiscovery</a>
+    <li class="method"><a href="NetLinx/Compiler.html#method-c-new">::new &mdash; NetLinx::Compiler</a>
+    <li class="method"><a href="NetLinx/Compile/ExtensionHandler.html#method-c-new">::new &mdash; NetLinx::Compile::ExtensionHandler</a>
+    <li class="method"><a href="NetLinx/CompilerResult.html#method-c-new">::new &mdash; NetLinx::CompilerResult</a>
+    <li class="method"><a href="NetLinx/SourceFile.html#method-c-new">::new &mdash; NetLinx::SourceFile</a>
+    <li class="method"><a href="NetLinx/Compile/Script.html#method-c-run">::run &mdash; NetLinx::Compile::Script</a>
+    <li class="method"><a href="NetLinx/Compile/ExtensionDiscovery.html#method-c-workspace_extensions">::workspace_extensions &mdash; NetLinx::Compile::ExtensionDiscovery</a>
+    <li class="method"><a href="NetLinx/Compile/ExtensionHandler.html#method-i-3C-3C">#<< &mdash; NetLinx::Compile::ExtensionHandler</a>
+    <li class="method"><a href="NetLinx/Compiler.html#method-i-compile">#compile &mdash; NetLinx::Compiler</a>
+    <li class="method"><a href="NetLinx/SourceFile.html#method-i-compile">#compile &mdash; NetLinx::SourceFile</a>
+    <li class="method"><a href="NetLinx/SourceFile.html#method-i-compiler_include_paths">#compiler_include_paths &mdash; NetLinx::SourceFile</a>
+    <li class="method"><a href="NetLinx/SourceFile.html#method-i-compiler_library_paths">#compiler_library_paths &mdash; NetLinx::SourceFile</a>
+    <li class="method"><a href="NetLinx/SourceFile.html#method-i-compiler_module_paths">#compiler_module_paths &mdash; NetLinx::SourceFile</a>
+    <li class="method"><a href="NetLinx/SourceFile.html#method-i-compiler_target_files">#compiler_target_files &mdash; NetLinx::SourceFile</a>
+    <li class="method"><a href="NetLinx/CompilerResult.html#method-i-error_items">#error_items &mdash; NetLinx::CompilerResult</a>
+    <li class="method"><a href="NetLinx/Compile/ExtensionHandler.html#method-i-include-3F">#include? &mdash; NetLinx::Compile::ExtensionHandler</a>
+    <li class="method"><a href="NetLinx/Compile/ExtensionHandler.html#method-i-is_a_workspace-3F">#is_a_workspace? &mdash; NetLinx::Compile::ExtensionHandler</a>
+    <li class="method"><a href="NetLinx/CompilerResult.html#method-i-success-3F">#success? &mdash; NetLinx::CompilerResult</a>
+    <li class="method"><a href="NetLinx/CompilerResult.html#method-i-target_file">#target_file &mdash; NetLinx::CompilerResult</a>
+    <li class="method"><a href="NetLinx/CompilerResult.html#method-i-to_s">#to_s &mdash; NetLinx::CompilerResult</a>
+    <li class="method"><a href="NetLinx/CompilerResult.html#method-i-warning_items">#warning_items &mdash; NetLinx::CompilerResult</a>
+</ul>
+<footer id="validator-badges">
+  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
+  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.1.
+  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
+</footer>

data/lib/netlinx-compile.rb ADDED

	@@ -0,0 +1 @@
1	+ require 'netlinx/compiler'

data/lib/netlinx/compile/extension/axs.rb ADDED

@@ -0,0 +1,18 @@
+require 'netlinx/compile/extension_handler'
+require 'netlinx/source_file'
+module NetLinx
+  module Compile
+    module Extension
+      # Instructs netlinx-compile on how to process .axs NetLinx source code files.
+      class AXS
+        # :nodoc:
+        def self.get_handler
+          handler = NetLinx::Compile::ExtensionHandler.new \
+            extensions: ['axs', 'axi'],
+            handler_class: NetLinx::SourceFile
+        end
+      end
+    end
+  end
+end

data/lib/netlinx/compile/extension_discovery.rb ADDED

@@ -0,0 +1,62 @@
+module NetLinx
+  module Compile
+    # Discovers and auto-requires add-on Ruby libraries for netlinx-compile.
+    class ExtensionDiscovery
+      private_class_method :new
+      class << self
+        # An array of ExtensionHandlers installed on the system.
+        # #discover must be run before this array is populated.
+        attr_accessor :handlers
+        @handlers = []
+        # Searches for gems with 'netlinx-compile' as a dependency.
+        # The 'lib/netlinx/compile/extension/*' path is checked for
+        # compiler extensions.
+        def discover
+          # Require extensions built into netlinx-compile.
+          nc_gem = Gem::Specification.find_by_name 'netlinx-compile'
+          nc_gem_path = File.expand_path 'lib/netlinx/compile/extension', nc_gem.gem_dir
+          nc_gem_files = Dir["#{nc_gem_path}/*.rb"]
+          nc_gem_files.each {|file| require file}
+          # Find gems with a dependency on 'netlinx-compile'.
+          gems = Gem::Specification.each
+            .select{|gem| gem.dependencies
+              .select{|dependency| dependency.name == 'netlinx-compile'}
+              .empty? == false
+            }
+          # Load any Ruby files in their lib/netlinx/compile/extension paths.
+          gems.each do |gem|
+            extension_path = File.expand_path 'lib/netlinx/compile/extension', gem.gem_dir
+            files = Dir["#{extension_path}/*.rb"]
+            files.each {|file| require file}
+          end
+          # Register ExtensionHandler objects.
+          @handlers = NetLinx::Compile::Extension.constants
+            .map{|c| NetLinx::Compile::Extension.const_get c}
+            .select{|c| c.is_a? Class}
+            .map{|c| c.get_handler if c.respond_to? :get_handler}
+            .select{|c| not c.nil?}
+        end
+        # Returns an array of workspace file extensions.
+        def workspace_extensions
+          @handlers
+            .select{|h| h.is_a_workspace?}
+            .map{|h| h.extensions}
+            .flatten
+        end
+        # Get an ExtensionHandler for a given file or extension.
+        def get_handler(filename)
+          @handlers.select{|h| h.include? filename}.first
+        end
+      end
+    end
+  end
+end

data/lib/netlinx/compile/extension_handler.rb ADDED

@@ -0,0 +1,86 @@
+module NetLinx
+  module Compile
+    # Tells netlinx-compile which class handles the compiling
+    # of a set of file extensions.
+    class ExtensionHandler
+      # A list of file extensions that this ExtensionHandler handles.
+      attr_accessor :extensions
+      # A list of file extensions that this ExtensionHandler usurps.
+      # For example, third-party workspace extensions would
+      # probably usurp the .apw workspace extension.
+      attr_accessor :usurps
+      # The class to invoke to handle compiling a file extension specified
+      # in this ExtensionHandler.
+      attr_reader :handler_class
+      # Parameters:
+      #   extensions: An array of file extensions (without the leading dot)
+      #               that this ExtensionHandler supports.
+      #
+      #   usurps:     Future.
+      #               Lets this ExtensionHandler take priority over other
+      #               ones. For example, most third-party handlers would
+      #               probably usurp the .apw NetLinx Studio workspace
+      #               extension.
+      #
+      #   is_a_workspace: Set to true if this ExtensionHandler is for
+      #               compiling a workspace. False by default. This
+      #               parameter assists with smart compiling, as
+      #               ExtensionDiscovery can return all workspace_handlers.
+      #
+      #   handler_class: A reference to the class that should be instantiated
+      #               if this handler is selected. For example,
+      #               NetLinx::SourceFile is the class that handles files
+      #               with the .axs extension.
+      def initialize(**kvargs)
+        @extensions     = kvargs.fetch :extensions,     []
+        @usurps         = kvargs.fetch :usurps,         []
+        @is_a_workspace = kvargs.fetch :is_a_workspace, false
+        @handler_class  = kvargs.fetch :handler_class,  nil
+      end
+      # Alias to add a file extension.
+      def <<(file_extension)
+        @extensions << parse_extension(file_extension)
+      end
+      # Returns true if the ExtensionHandler handles a workspace file
+      # (as opposed to a source code file).
+      #
+      # Workspace files are significant because they contain information
+      # about a project, connection settings for a master, and possibly
+      # multiple systems that need to be compiled. Therefore, when
+      # smart-compiling, workspaces need to be distinguished from source
+      # code files because discovering a workspace should be considered a
+      # better match than discovering a source code file.
+      def is_a_workspace?
+        @is_a_workspace
+      end
+      # Returns true if this ExtensionHandler can handle the specified
+      # file extension.
+      def include?(file_extension)
+        @extensions.include? parse_extension(file_extension)
+      end
+      private
+      # Parse a file extension from the given string.
+      #
+      # Examples:
+      #   apw
+      #   .apw
+      #   workspace.apw
+      #   c:/path/to/workspace.apw
+      def parse_extension(file_extension)
+        ext = file_extension.scan(/(?:^\s*|(?<=\.))(\w+)$/).first
+        raise ArgumentError, "Could not parse a file extension from the string: #{file_extension}" unless ext
+        ext.first
+      end
+    end
+  end
+end

data/lib/netlinx/compile/script.rb ADDED

@@ -0,0 +1,115 @@
+require 'optparse'
+require 'ostruct'
+require 'netlinx/compile/extension_discovery'
+module NetLinx
+  module Compile
+    # The container for the script that runs when netlinx-compile is executed.
+    class Script
+      private_class_method :new
+      class << self
+        # Run the script.
+        def run(**kvargs)
+          # :argv is a convenience to override ARGV, like for testing.
+          args = kvargs.fetch :argv, ARGV
+          # Command line options.
+          @options = OpenStruct.new \
+            source: '',
+            include_paths: [],
+            use_workspace: false
+          OptionParser.new do |opts|
+            opts.banner = "Usage: netlinx-compile [options]"
+            opts.on '-h', '--help', 'Display this help screen.' do
+              puts opts
+              exit
+            end
+            opts.on '-s', '--source FILE', 'Source file to compile.' do |v|
+              @options.source = v
+            end
+            opts.on '-i', '--include [Path1,Path2]', Array, 'Additional include and module paths.' do |v|
+              @options.include_paths = v
+            end
+            opts.on '-w', '--workspace', '--smart',
+                    'Search up directory tree for a workspace',
+                    'containing the source file.' do |v|
+              @options.use_workspace = v
+            end
+          end.parse! args
+          if @options.source.empty?
+            puts "No source file specified.\nRun \"netlinx-compile -h\" for help."
+            exit
+          end
+          # Find an ExtensionHandler for the given file.
+          ExtensionDiscovery.discover
+          source_file = File.expand_path @options.source
+          handler = NetLinx::Compile::ExtensionDiscovery.get_handler source_file
+          # If the handler is a workspace handler, go straight to compiling it.
+          # Otherwise, if the use_workspace flag is true, search up through the
+          # directory tree to try to find a workspace that includes the
+          # specified source file.
+          if (not handler.is_a_workspace?) && @options.use_workspace
+            workspace_extensions = NetLinx::Compile::ExtensionDiscovery.workspace_extensions
+            dir = File.expand_path '.'
+            while dir != File.expand_path('..', dir) do
+              workspaces = Dir["#{dir}/*.{#{workspace_extensions.join ','}}"]
+              unless workspaces.empty?
+                # TODO: Handle workspace file extension usurping logic here.
+                new_source_file = workspaces.first
+                new_handler = NetLinx::Compile::ExtensionDiscovery.get_handler new_source_file
+                new_handler_class = new_handler.handler_class.new \
+                  file: File.expand_path(new_source_file)
+                # If supported by the new_handler, make sure the source_file is
+                # included in the workspace before overwriting the old handler.
+                overwrite_old_handler = false
+                if new_handler_class.respond_to? :include?
+                  overwrite_old_handler = true if new_handler_class.include? source_file
+                else
+                  # Workspace doesn't expose an interface to see if it
+                  # includes the source file, so assume it does.
+                  # Otherwise the user could have compiled without the
+                  # workspace flag.
+                  overwrite_old_handler = true
+                end
+                if overwrite_old_handler
+                  source_file = new_source_file
+                  handler = new_handler
+                  handler_class = new_handler_class
+                  break
+                end
+              end
+              dir = File.expand_path '..', dir
+            end
+          end
+          # Instantiate the class that can handle compiling of the file.
+          handler_class = handler.handler_class.new \
+            file: File.expand_path(source_file)
+          result = handler_class.compile
+          result.map {|r| r.to_s}
+        end
+      end
+    end
+  end
+end

data/lib/netlinx/compiler.rb ADDED

@@ -0,0 +1,71 @@
+require 'netlinx/compiler_result'
+module NetLinx
+  # Raised when the NetLinx compiler (nlrc.exe) cannot be found on the system.
+  # See NetLinx::Compiler.
+  class NoCompilerError < Exception; end
+  # A wrapper class for the AMX NetLinx compiler executable (nlrc.exe).
+  class Compiler
+    # Checks for the AMX NetLinx compiler (third-party software, nlrc.exe) at the
+    # default installation path. This can be overridden by specifying :compiler_path.
+    def initialize(**kvargs)
+      @compiler_exe = 'nlrc.exe'
+      @compiler_path = kvargs.fetch :compiler_path,
+        File.expand_path('C:\Program Files (x86)\Common Files\AMXShare\COM') # 64-bit O/S path
+      # Check for NetLinx compiler at :compiler_path or the 64-bit O/S path.
+      unless File.exists? File.expand_path('nlrc.exe', @compiler_path)
+        # Compiler not found. Try 32-bit O/S path.
+        @compiler_path = File.expand_path('C:\Program Files\Common Files\AMXShare\COM')
+        unless File.exists? File.expand_path('nlrc.exe', @compiler_path)
+          # ---------------------------------------------------------
+          # TODO: Check if the compiler was added to the system path.
+          #       Execute system('nlrc').
+          # ---------------------------------------------------------
+          # Compiler not found.
+          raise NetLinx::NoCompilerError, 'The NetLinx compiler (nlrc.exe) could not be found on the system.'
+        end
+      end
+    end
+    # Compile the specified object with the NetLinx compiler.
+    # See Test::NetLinx::Compilable.
+    def compile(compilable)
+      compiler = File.expand_path @compiler_exe, @compiler_path
+      result   = []
+      compilable.compiler_target_files.each do |target_file|
+        # Construct paths.
+        include_paths = "-I#{compilable.compiler_include_paths.join ';'}" unless
+          compilable.compiler_include_paths.empty?
+        module_paths = "-M#{compilable.compiler_module_paths.join ';'}" unless
+          compilable.compiler_module_paths.empty?
+        library_paths = "-L#{compilable.compiler_library_paths.join ';'}" unless
+          compilable.compiler_library_paths.empty?
+        # Run the NetLinx compiler.
+        io = IO.popen "\"#{compiler}\" \"#{target_file}\" \"#{include_paths}\" \"#{module_paths}\" \"#{library_paths}\""
+        stream = io.read
+        io.close
+        # Build the result.
+        result << NetLinx::CompilerResult.new(
+          compiler_target_files:  [target_file],
+          compiler_include_paths: compilable.compiler_include_paths,
+          compiler_module_paths:  compilable.compiler_module_paths,
+          compiler_library_paths: compilable.compiler_library_paths,
+          stream: stream
+        )
+      end
+      result
+    end
+  end
+end