duet-bootstrap 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 27921562d72a16cdf929f5efcad5e7b699c2c4f9
+  data.tar.gz: c81e36b9600e49921d786c25171fc4a45a97f9ff
+SHA512:
+  metadata.gz: 184c79bdb3376c64b86759818613618ad672255e60e406d08c6634eb90d0e6402cdef029e6cc4f1ed2312e5e5f3522a7381ba6f4c7f343b694b26f21b7f852f0
+  data.tar.gz: 16bbdc7ea060562aaa628375629301f2ddd4c69c5280feb968f1b548ea5653ac1aa59f6c9f9f9b8de6bd047595dd312258b9c9243e26c6148b8308ce507cf252

data/README.html

@@ -0,0 +1,7 @@
+<h1>duet-bootstrap</h1>
+
+<p>This gem generates a NetLinx workspace and source code to start up a Duet module. It is intended to be used when the entire AMX system has been programmed in Duet.</p>
+
+<h2>Website</h2>
+
+<p><a href="https://sourceforge.net/p/duet-bootstrap/wiki/Home/">https://sourceforge.net/p/duet-bootstrap/wiki/Home/</a></p>

data/bin/duet-bootstrap

@@ -0,0 +1,192 @@
+#! /usr/bin/env ruby
+
+# Duet Bootstrap
+# v1.0.0
+#
+# Website: https://sourceforge.net/projects/duet-bootstrap
+#
+#
+# -- THIS IS A THIRD-PARTY TOOL AND IS NOT AFFILIATED WITH --
+# --                 THE AMX ORGANIZATION                  --
+#
+#
+# This script was designed to run on Ruby v2.0.0-p0
+# http://www.ruby-lang.org/en/downloads/
+#
+# OVERVIEW
+#
+#	This script generates a NetLinx workspace and source code to start
+#	up a Duet module. It is intended to be used when the entire AMX
+#	system has been programmed in Duet.
+#
+#	This script will generate a workspace and source file in the
+#	working directory. It will also compile the generated source
+#	code if the NetLinx compiler executable is found.
+#
+# CONFIGURATION
+#
+#	It is recommended, although not required, to add this script to
+#	your operating system's PATH environment variable so that the
+#	script can be called from within the folder of a Duet project.
+#	There is plenty of information on the internet on how to do this.
+#
+#	If you would like to change the default AMX master that will be
+#	used when generating workspaces, open the NetLinx Workspace file
+#	located at template/template.apw. Modify the communication
+#	settings, save the workspace, and close NetLinx Studio.
+#
+# EXECUTION
+#
+#	This script will run on many different operating systems.
+#
+#	On Windows, the fastest and easiest way to use this script is
+#	through the command line. Open Windows Explorer and browse
+#	to the folder of your compiled Duet .jar file. With no file
+#	selected, hold shift and right-click in the empty space of
+#	the file browser pane, then select "Open command window here"
+#	from the context menu.
+#
+#	Run this script and pass the Duet module as a parameter in
+#	the file path. Pressing the tab key will auto-complete the
+#	file name.
+#	
+#	Example: >duet-bootstrap My_Duet_File_dr1_0_0.jar
+#
+#---------------------------------------------------------------------- 
+#   Copyright 2013 Alex McLain
+#   
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#---------------------------------------------------------------------- 
+
+require 'rexml/document'
+
+templatePath = File.expand_path '../../lib/duet-bootstrap/template', __FILE__
+
+params = Hash.new
+
+# Initialize parameters.
+params[:projectName]	= ''
+params[:duetModuleName] = ''
+params[:duetModulePath] = ''
+
+# Make sure Duet module file was passed to the script.
+if ARGV[0].nil?
+	puts 'No Duet module was specified.'
+	exit
+end
+
+params[:duetModulePath] = ARGV[0].strip
+
+# Check Duet file extension.
+unless File.extname(params[:duetModulePath]).downcase == '.jar'
+	puts 'Input file was not a Duet file.'
+	exit
+end
+
+# Parse Duet module name.
+params[:duetModuleName] = File.basename(params[:duetModulePath], '.jar')
+params[:projectName] = params[:duetModuleName][/(.*)_dr[0-9]+/, 1].gsub(/_/, ' ')
+
+# Import existing AMX workspace template.
+workspaceTemplate = File.open("#{templatePath}/template.apw", 'r')
+xml = REXML::Document.new(workspaceTemplate)
+
+# Rename the workspace.
+xml.elements.each('/Workspace/Identifier') do |identifier|
+	identifier.text = params[:projectName]
+	break
+end
+
+# Rename the project.
+xml.elements.each('/Workspace/Project/Identifier') do |identifier|
+	identifier.text = params[:projectName]
+	break
+end
+
+# Rename the system.
+xml.elements.each('/Workspace/Project/System/Identifier') do |identifier|
+	identifier.text = params[:projectName]
+end
+
+# Delete all links to files in the workspace's system. The script
+# will regenerate them.
+xml.elements.delete_all('/Workspace/Project/System/File')
+
+# Add file nodes.
+xml.elements.each('/Workspace/Project/System') do |e|
+	
+	# Add Duet file.
+	fileElement = e.add_element('File')
+	fileElement.add_attributes('CompileType' => 'None', 'Type' => 'DUET')
+	
+	identifier = fileElement.add_element('Identifier')
+	identifier.text = params[:duetModuleName]
+
+	filePathName = fileElement.add_element('FilePathName')
+	filePathName.text = params[:duetModulePath]
+
+	# Add NetLinx file.
+	fileElement = e.add_element('File')
+	fileElement.add_attributes('CompileType' => 'Netlinx', 'Type' => 'MasterSrc')
+
+	identifier = fileElement.add_element('Identifier')
+	identifier.text = params[:projectName]
+
+	filePathName = fileElement.add_element('FilePathName')
+	filePathName.text = "#{params[:projectName]}.axs"
+	
+	break
+end
+
+
+# Save workspace.
+File.open("#{params[:projectName]}.apw", 'w') do |file|
+	file << xml
+end
+
+
+# Import NetLinx source code file template.
+template = File.open("#{templatePath}/template.axs", 'r').read
+
+template.gsub!(/%%_PROJECT_NAME_%%/, params[:projectName])
+template.gsub!(/%%_MODULE_NAME_%%/, params[:duetModuleName])
+
+# Save source code file.
+File.open("#{params[:projectName]}.axs", 'w') do |file|
+	file << template
+end
+
+puts 'Generated project.'
+
+
+# Check for NetLinx compiler.
+compilerPath = 'C:\Program Files (x86)\Common Files\AMXShare\COM\nlrc.exe'
+
+canCompile = File.exists?(compilerPath)
+unless canCompile
+	# Use path for 32-bit O/S and try again.
+	compilerPath = 'C:\Program Files\Common Files\AMXShare\COM\nlrc.exe'
+
+	canCompile = File.exists?(compilerPath)
+	unless canCompile
+		puts 'NetLinx compiler not found. Can\'t auto-compile.'
+	end
+end
+
+# Execute NetLinx compiler.
+if canCompile
+	system("\"#{compilerPath}\" \"#{File.absolute_path("#{params[:projectName]}.axs")}\"")
+end
+
+puts 'Done.'
+

data/doc/created.rid

@@ -0,0 +1,2 @@
+Thu, 04 Jul 2013 10:00:32 -0700
+lib/duet-bootstrap.rb	Thu, 04 Jul 2013 09:36:35 -0700

data/doc/index.html

@@ -0,0 +1,69 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+
+<title>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>
+<nav id="metadata">
+  <nav id="home-section" class="section">
+  <h3 class="section-header">
+    <a href="./index.html">Home</a>
+    <a href="./table_of_contents.html#classes">Classes</a>
+    <a href="./table_of_contents.html#methods">Methods</a>
+  </h3>
+</nav>
+
+
+  <nav id="search-section" class="section project-section" class="initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <h3 class="section-header">
+      <input type="text" name="search" placeholder="Search" id="search-field"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </h3>
+  </form>
+
+  <ul id="search-results" class="initially-hidden"></ul>
+</nav>
+
+
+  <div id="project-metadata">
+    
+    <nav id="classindex-section" class="section project-section">
+  <h3 class="section-header">Class and Module Index</h3>
+
+  <ul class="link-list">
+  
+  </ul>
+</nav>
+
+  </div>
+</nav>
+
+<div id="documentation" class="description">
+<p>This is the API documentation for RDoc Documentation.
+</div>
+
+
+<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/doc/js/darkfish.js

@@ -0,0 +1,155 @@
+/**
+ *
+ * Darkfish Page Functions
+ * $Id: darkfish.js 53 2009-01-07 02:52:03Z deveiant $
+ *
+ * Author: Michael Granger <mgranger@laika.com>
+ *
+ */
+
+/* Provide console simulation for firebug-less environments */
+if (!("console" in window) || !("firebug" in console)) {
+  var names = ["log", "debug", "info", "warn", "error", "assert", "dir", "dirxml",
+    "group", "groupEnd", "time", "timeEnd", "count", "trace", "profile", "profileEnd"];
+
+  window.console = {};
+  for (var i = 0; i < names.length; ++i)
+    window.console[names[i]] = function() {};
+};
+
+
+/**
+ * Unwrap the first element that matches the given @expr@ from the targets and return them.
+ */
+$.fn.unwrap = function( expr ) {
+  return this.each( function() {
+    $(this).parents( expr ).eq( 0 ).after( this ).remove();
+  });
+};
+
+
+function showSource( e ) {
+  var target = e.target;
+  var codeSections = $(target).
+    parents('.method-detail').
+    find('.method-source-code');
+
+  $(target).
+    parents('.method-detail').
+    find('.method-source-code').
+    slideToggle();
+};
+
+function hookSourceViews() {
+  $('.method-heading').click( showSource );
+};
+
+function toggleDebuggingSection() {
+  $('.debugging-section').slideToggle();
+};
+
+function hookDebuggingToggle() {
+  $('#debugging-toggle img').click( toggleDebuggingSection );
+};
+
+function hookTableOfContentsToggle() {
+  $('.indexpage li .toc-toggle').each( function() {
+    $(this).click( function() {
+      $(this).toggleClass('open');
+    });
+
+    var section = $(this).next();
+
+    $(this).click( function() {
+      section.slideToggle();
+    });
+  });
+}
+
+function hookSearch() {
+  var input  = $('#search-field').eq(0);
+  var result = $('#search-results').eq(0);
+  $(result).show();
+
+  var search_section = $('#search-section').get(0);
+  $(search_section).show();
+
+  var search = new Search(search_data, input, result);
+
+  search.renderItem = function(result) {
+    var li = document.createElement('li');
+    var html = '';
+
+    // TODO add relative path to <script> per-page
+    html += '<p class="search-match"><a href="' + rdoc_rel_prefix + result.path + '">' + this.hlt(result.title);
+    if (result.params)
+      html += '<span class="params">' + result.params + '</span>';
+    html += '</a>';
+
+
+    if (result.namespace)
+      html += '<p class="search-namespace">' + this.hlt(result.namespace);
+
+    if (result.snippet)
+      html += '<div class="search-snippet">' + result.snippet + '</div>';
+
+    li.innerHTML = html;
+
+    return li;
+  }
+
+  search.select = function(result) {
+    var result_element = result.get(0);
+    window.location.href = result_element.firstChild.firstChild.href;
+  }
+
+  search.scrollIntoView = search.scrollInWindow;
+};
+
+function highlightTarget( anchor ) {
+  console.debug( "Highlighting target '%s'.", anchor );
+
+  $("a[name]").each( function() {
+    if ( $(this).attr("name") == anchor ) {
+      if ( !$(this).parent().parent().hasClass('target-section') ) {
+        console.debug( "Wrapping the target-section" );
+        $('div.method-detail').unwrap( 'div.target-section' );
+        $(this).parent().wrap( '<div class="target-section"></div>' );
+      } else {
+        console.debug( "Already wrapped." );
+      }
+    }
+  });
+};
+
+function highlightLocationTarget() {
+  console.debug( "Location hash: %s", window.location.hash );
+  if ( ! window.location.hash || window.location.hash.length == 0 ) return;
+
+  var anchor = window.location.hash.substring(1);
+  console.debug( "Found anchor: %s; matching %s", anchor, "a[name=" + anchor + "]" );
+
+  highlightTarget( anchor );
+};
+
+function highlightClickTarget( event ) {
+  console.debug( "Highlighting click target for event %o", event.target );
+  try {
+    var anchor = $(event.target).attr( 'href' ).substring(1);
+    console.debug( "Found target anchor: %s", anchor );
+    highlightTarget( anchor );
+  } catch ( err ) {
+    console.error( "Exception while highlighting: %o", err );
+  };
+};
+
+
+$(document).ready( function() {
+  hookSourceViews();
+  hookDebuggingToggle();
+  hookSearch();
+  highlightLocationTarget();
+  hookTableOfContentsToggle();
+
+  $('ul.link-list a').bind( "click", highlightClickTarget );
+});