netlinx-compile 3.1.0 → 3.1.1

data/doc/js/navigation.js

@@ -0,0 +1,142 @@
+/*
+ * Navigation allows movement using the arrow keys through the search results.
+ *
+ * When using this library you will need to set scrollIntoView to the
+ * appropriate function for your layout.  Use scrollInWindow if the container
+ * is not scrollable and scrollInElement if the container is a separate
+ * scrolling region.
+ */
+Navigation = new function() {
+  this.initNavigation = function() {
+    var _this = this;
+
+    $(document).keydown(function(e) {
+      _this.onkeydown(e);
+    }).keyup(function(e) {
+      _this.onkeyup(e);
+    });
+
+    this.navigationActive = true;
+  }
+
+  this.setNavigationActive = function(state) {
+    this.navigationActive = state;
+    this.clearMoveTimeout();
+  }
+
+  this.onkeyup = function(e) {
+    if (!this.navigationActive) return;
+
+    switch(e.keyCode) {
+      case 37: //Event.KEY_LEFT:
+      case 38: //Event.KEY_UP:
+      case 39: //Event.KEY_RIGHT:
+      case 40: //Event.KEY_DOWN:
+        this.clearMoveTimeout();
+        break;
+    }
+  }
+
+  this.onkeydown = function(e) {
+    if (!this.navigationActive) return;
+    switch(e.keyCode) {
+      case 37: //Event.KEY_LEFT:
+        if (this.moveLeft()) e.preventDefault();
+        break;
+      case 38: //Event.KEY_UP:
+        if (e.keyCode == 38 || e.ctrlKey) {
+          if (this.moveUp()) e.preventDefault();
+          this.startMoveTimeout(false);
+        }
+        break;
+      case 39: //Event.KEY_RIGHT:
+        if (this.moveRight()) e.preventDefault();
+        break;
+      case 40: //Event.KEY_DOWN:
+        if (e.keyCode == 40 || e.ctrlKey) {
+          if (this.moveDown()) e.preventDefault();
+          this.startMoveTimeout(true);
+        }
+        break;
+      case 13: //Event.KEY_RETURN:
+        if (this.$current)
+          e.preventDefault();
+          this.select(this.$current);
+        break;
+    }
+    if (e.ctrlKey && e.shiftKey) this.select(this.$current);
+  }
+
+  this.clearMoveTimeout = function() {
+    clearTimeout(this.moveTimeout);
+    this.moveTimeout = null;
+  }
+
+  this.startMoveTimeout = function(isDown) {
+    if (!$.browser.mozilla && !$.browser.opera) return;
+    if (this.moveTimeout) this.clearMoveTimeout();
+    var _this = this;
+
+    var go = function() {
+      if (!_this.moveTimeout) return;
+      _this[isDown ? 'moveDown' : 'moveUp']();
+      _this.moveTimout = setTimeout(go, 100);
+    }
+    this.moveTimeout = setTimeout(go, 200);
+  }
+
+  this.moveRight = function() {
+  }
+
+  this.moveLeft = function() {
+  }
+
+  this.move = function(isDown) {
+  }
+
+  this.moveUp = function() {
+    return this.move(false);
+  }
+
+  this.moveDown = function() {
+    return this.move(true);
+  }
+
+  /*
+   * Scrolls to the given element in the scrollable element view.
+   */
+  this.scrollInElement = function(element, view) {
+    var offset, viewHeight, viewScroll, height;
+    offset = element.offsetTop;
+    height = element.offsetHeight;
+    viewHeight = view.offsetHeight;
+    viewScroll = view.scrollTop;
+
+    if (offset - viewScroll + height > viewHeight) {
+      view.scrollTop = offset - viewHeight + height;
+    }
+    if (offset < viewScroll) {
+      view.scrollTop = offset;
+    }
+  }
+
+  /*
+   * Scrolls to the given element in the window.  The second argument is
+   * ignored
+   */
+  this.scrollInWindow = function(element, ignored) {
+    var offset, viewHeight, viewScroll, height;
+    offset = element.offsetTop;
+    height = element.offsetHeight;
+    viewHeight = window.innerHeight;
+    viewScroll = window.scrollY;
+
+    if (offset - viewScroll + height > viewHeight) {
+      window.scrollTo(window.scrollX, offset - viewHeight + height);
+    }
+    if (offset < viewScroll) {
+      window.scrollTo(window.scrollX, offset);
+    }
+  }
+}
+

data/doc/js/search.js

@@ -0,0 +1,94 @@
+Search = function(data, input, result) {
+  this.data = data;
+  this.$input = $(input);
+  this.$result = $(result);
+
+  this.$current = null;
+  this.$view = this.$result.parent();
+  this.searcher = new Searcher(data.index);
+  this.init();
+}
+
+Search.prototype = $.extend({}, Navigation, new function() {
+  var suid = 1;
+
+  this.init = function() {
+    var _this = this;
+    var observer = function() {
+      _this.search(_this.$input[0].value);
+    };
+    this.$input.keyup(observer);
+    this.$input.click(observer); // mac's clear field
+
+    this.searcher.ready(function(results, isLast) {
+      _this.addResults(results, isLast);
+    })
+
+    this.initNavigation();
+    this.setNavigationActive(false);
+  }
+
+  this.search = function(value, selectFirstMatch) {
+    value = jQuery.trim(value).toLowerCase();
+    if (value) {
+      this.setNavigationActive(true);
+    } else {
+      this.setNavigationActive(false);
+    }
+
+    if (value == '') {
+      this.lastQuery = value;
+      this.$result.empty();
+      this.setNavigationActive(false);
+    } else if (value != this.lastQuery) {
+      this.lastQuery = value;
+      this.firstRun = true;
+      this.searcher.find(value);
+    }
+  }
+
+  this.addResults = function(results, isLast) {
+    var target = this.$result.get(0);
+    if (this.firstRun && (results.length > 0 || isLast)) {
+      this.$current = null;
+      this.$result.empty();
+    }
+
+    for (var i=0, l = results.length; i < l; i++) {
+      target.appendChild(this.renderItem.call(this, results[i]));
+    };
+
+    if (this.firstRun && results.length > 0) {
+      this.firstRun = false;
+      this.$current = $(target.firstChild);
+      this.$current.addClass('current');
+    }
+    if (jQuery.browser.msie) this.$element[0].className += '';
+  }
+
+  this.move = function(isDown) {
+    if (!this.$current) return;
+    var $next = this.$current[isDown ? 'next' : 'prev']();
+    if ($next.length) {
+      this.$current.removeClass('current');
+      $next.addClass('current');
+      this.scrollIntoView($next[0], this.$view[0]);
+      this.$current = $next;
+    }
+    return true;
+  }
+
+  this.hlt = function(html) {
+    return this.escapeHTML(html).
+      replace(/\u0001/g, '<em>').
+      replace(/\u0002/g, '</em>');
+  }
+
+  this.escapeHTML = function(html) {
+    return html.replace(/[&<>]/g, function(c) {
+      return '&#' + c.charCodeAt(0) + ';';
+    });
+  }
+
+});
+

data/doc/js/search_index.js

@@ -0,0 +1 @@
+var search_data = {"index":{"searchIndex":["netlinx","compile","extension","axs","extensiondiscovery","extensionhandler","script","compiler","compilerresult","nocompilererror","sourcefile","test","netlinx","compilable","compile","discoverable","invokable","<<()","compile()","compile()","compiler_include_paths()","compiler_library_paths()","compiler_module_paths()","compiler_target_files()","discover()","error_items()","get_handler()","include?()","is_a_workspace?()","new()","new()","new()","new()","run()","success?()","target_file()","to_s()","warning_items()","workspace_extensions()"],"longSearchIndex":["netlinx","netlinx::compile","netlinx::compile::extension","netlinx::compile::extension::axs","netlinx::compile::extensiondiscovery","netlinx::compile::extensionhandler","netlinx::compile::script","netlinx::compiler","netlinx::compilerresult","netlinx::nocompilererror","netlinx::sourcefile","test","test::netlinx","test::netlinx::compilable","test::netlinx::compile","test::netlinx::compile::discoverable","test::netlinx::compile::invokable","netlinx::compile::extensionhandler#<<()","netlinx::compiler#compile()","netlinx::sourcefile#compile()","netlinx::sourcefile#compiler_include_paths()","netlinx::sourcefile#compiler_library_paths()","netlinx::sourcefile#compiler_module_paths()","netlinx::sourcefile#compiler_target_files()","netlinx::compile::extensiondiscovery::discover()","netlinx::compilerresult#error_items()","netlinx::compile::extensiondiscovery::get_handler()","netlinx::compile::extensionhandler#include?()","netlinx::compile::extensionhandler#is_a_workspace?()","netlinx::compile::extensionhandler::new()","netlinx::compiler::new()","netlinx::compilerresult::new()","netlinx::sourcefile::new()","netlinx::compile::script::run()","netlinx::compilerresult#success?()","netlinx::compilerresult#target_file()","netlinx::compilerresult#to_s()","netlinx::compilerresult#warning_items()","netlinx::compile::extensiondiscovery::workspace_extensions()"],"info":[["NetLinx","","NetLinx.html","",""],["NetLinx::Compile","","NetLinx/Compile.html","",""],["NetLinx::Compile::Extension","","NetLinx/Compile/Extension.html","",""],["NetLinx::Compile::Extension::AXS","","NetLinx/Compile/Extension/AXS.html","","<p>Instructs netlinx-compile on how to process .axs NetLinx source code files.\n"],["NetLinx::Compile::ExtensionDiscovery","","NetLinx/Compile/ExtensionDiscovery.html","","<p>Discovers and auto-requires add-on Ruby libraries for netlinx-compile.\n"],["NetLinx::Compile::ExtensionHandler","","NetLinx/Compile/ExtensionHandler.html","","<p>Tells netlinx-compile which class handles the compiling of a set of file\nextensions.\n"],["NetLinx::Compile::Script","","NetLinx/Compile/Script.html","","<p>The container for the script that runs when netlinx-compile is executed.\n"],["NetLinx::Compiler","","NetLinx/Compiler.html","","<p>A wrapper class for the AMX NetLinx compiler executable (nlrc.exe).\n"],["NetLinx::CompilerResult","","NetLinx/CompilerResult.html","","<p>Contains info pertaining to a job run through the compiler.\n"],["NetLinx::NoCompilerError","","NetLinx/NoCompilerError.html","","<p>Raised when the NetLinx compiler (nlrc.exe) cannot be found on the system.\nSee NetLinx::Compiler.\n"],["NetLinx::SourceFile","","NetLinx/SourceFile.html","",""],["Test","","Test.html","",""],["Test::NetLinx","","Test/NetLinx.html","",""],["Test::NetLinx::Compilable","","Test/NetLinx/Compilable.html","","<p>Interface tests for an object that can be compiled with NetLinx::Compiler.\n"],["Test::NetLinx::Compile","","Test/NetLinx/Compile.html","",""],["Test::NetLinx::Compile::Discoverable","","Test/NetLinx/Compile/Discoverable.html","","<p>Interface tests for an object that registers an EventHandler under\nNetLinx::Compile::Extension.\n"],["Test::NetLinx::Compile::Invokable","","Test/NetLinx/Compile/Invokable.html","","<p>Interface tests for an object that provides a means to invoke the compiler\non a Compilable file extension. …\n"],["<<","NetLinx::Compile::ExtensionHandler","NetLinx/Compile/ExtensionHandler.html#method-i-3C-3C","(file_extension)","<p>Alias to add a file extension.\n"],["compile","NetLinx::Compiler","NetLinx/Compiler.html#method-i-compile","(compilable)","<p>Compile the specified object with the NetLinx compiler. See\nTest::NetLinx::Compilable.\n"],["compile","NetLinx::SourceFile","NetLinx/SourceFile.html#method-i-compile","()","<p>Execute the compiler on itself.\n"],["compiler_include_paths","NetLinx::SourceFile","NetLinx/SourceFile.html#method-i-compiler_include_paths","()","<p>See Test::NetLinx::Compilable interface.\n"],["compiler_library_paths","NetLinx::SourceFile","NetLinx/SourceFile.html#method-i-compiler_library_paths","()","<p>See Test::NetLinx::Compilable interface.\n"],["compiler_module_paths","NetLinx::SourceFile","NetLinx/SourceFile.html#method-i-compiler_module_paths","()","<p>See Test::NetLinx::Compilable interface.\n"],["compiler_target_files","NetLinx::SourceFile","NetLinx/SourceFile.html#method-i-compiler_target_files","()","<p>See Test::NetLinx::Compilable interface.\n"],["discover","NetLinx::Compile::ExtensionDiscovery","NetLinx/Compile/ExtensionDiscovery.html#method-c-discover","()","<p>Searches for gems with &#39;netlinx-compile&#39; as a dependency. The\n&#39;lib/netlinx/compile/extension/*&#39; …\n"],["error_items","NetLinx::CompilerResult","NetLinx/CompilerResult.html#method-i-error_items","()","<p>An enumerable list of errors.\n"],["get_handler","NetLinx::Compile::ExtensionDiscovery","NetLinx/Compile/ExtensionDiscovery.html#method-c-get_handler","(filename)","<p>Get an ExtensionHandler for a given file or extension.\n"],["include?","NetLinx::Compile::ExtensionHandler","NetLinx/Compile/ExtensionHandler.html#method-i-include-3F","(file_extension)","<p>Returns true if this ExtensionHandler can handle the specified file\nextension.\n"],["is_a_workspace?","NetLinx::Compile::ExtensionHandler","NetLinx/Compile/ExtensionHandler.html#method-i-is_a_workspace-3F","()","<p>Returns true if the ExtensionHandler handles a workspace file (as opposed\nto a source code file).\n<p>Workspace …\n"],["new","NetLinx::Compile::ExtensionHandler","NetLinx/Compile/ExtensionHandler.html#method-c-new","(**kvargs)","<p>Parameters:\n\n<pre>extensions: An array of file extensions (without the leading dot)\n            that this ExtensionHandler ...</pre>\n"],["new","NetLinx::Compiler","NetLinx/Compiler.html#method-c-new","(**kvargs)","<p>Checks for the AMX NetLinx compiler (third-party software, nlrc.exe) at the\ndefault installation path. …\n"],["new","NetLinx::CompilerResult","NetLinx/CompilerResult.html#method-c-new","(**kvargs)","<p>Args:\n\n<pre>stream -- The raw stream of text returned by the compiler.\ncompiler_target_files  -- See Compilable ...</pre>\n"],["new","NetLinx::SourceFile","NetLinx/SourceFile.html#method-c-new","(**kvargs)","<p>Parameters:\n\n<pre>file: Name or path of the file to compile.\ncompiler_include_paths: Array of additional paths ...</pre>\n"],["run","NetLinx::Compile::Script","NetLinx/Compile/Script.html#method-c-run","(**kvargs)","<p>Run the script.\n"],["success?","NetLinx::CompilerResult","NetLinx/CompilerResult.html#method-i-success-3F","()","<p>Compile was successful?\n"],["target_file","NetLinx::CompilerResult","NetLinx/CompilerResult.html#method-i-target_file","()","<p>Returns the absolute path of the source code file that was compiled.\n"],["to_s","NetLinx::CompilerResult","NetLinx/CompilerResult.html#method-i-to_s","()","<p>Alias of #stream.\n"],["warning_items","NetLinx::CompilerResult","NetLinx/CompilerResult.html#method-i-warning_items","()","<p>An enumerable list of warnings.\n"],["workspace_extensions","NetLinx::Compile::ExtensionDiscovery","NetLinx/Compile/ExtensionDiscovery.html#method-c-workspace_extensions","()","<p>Returns an array of workspace file extensions.\n"]]}}

data/doc/js/searcher.js

@@ -0,0 +1,228 @@
+Searcher = function(data) {
+  this.data = data;
+  this.handlers = [];
+}
+
+Searcher.prototype = new function() {
+  // search is performed in chunks of 1000 for non-blocking user input
+  var CHUNK_SIZE = 1000;
+  // do not try to find more than 100 results
+  var MAX_RESULTS = 100;
+  var huid = 1;
+  var suid = 1;
+  var runs = 0;
+
+  this.find = function(query) {
+    var queries = splitQuery(query);
+    var regexps = buildRegexps(queries);
+    var highlighters = buildHilighters(queries);
+    var state = { from: 0, pass: 0, limit: MAX_RESULTS, n: suid++};
+    var _this = this;
+
+    this.currentSuid = state.n;
+
+    if (!query) return;
+
+    var run = function() {
+      // stop current search thread if new search started
+      if (state.n != _this.currentSuid) return;
+
+      var results =
+        performSearch(_this.data, regexps, queries, highlighters, state);
+      var hasMore = (state.limit > 0 && state.pass < 4);
+
+      triggerResults.call(_this, results, !hasMore);
+      if (hasMore) {
+        setTimeout(run, 2);
+      }
+      runs++;
+    };
+    runs = 0;
+
+    // start search thread
+    run();
+  }
+
+  /*  ----- Events ------  */
+  this.ready = function(fn) {
+    fn.huid = huid;
+    this.handlers.push(fn);
+  }
+
+  /*  ----- Utilities ------  */
+  function splitQuery(query) {
+    return jQuery.grep(query.split(/(\s+|::?|\(\)?)/), function(string) {
+      return string.match(/\S/)
+    });
+  }
+
+  function buildRegexps(queries) {
+    return jQuery.map(queries, function(query) {
+      return new RegExp(query.replace(/(.)/g, '([$1])([^$1]*?)'), 'i')
+    });
+  }
+
+  function buildHilighters(queries) {
+    return jQuery.map(queries, function(query) {
+      return jQuery.map(query.split(''), function(l, i) {
+        return '\u0001$' + (i*2+1) + '\u0002$' + (i*2+2);
+      }).join('');
+    });
+  }
+
+  // function longMatchRegexp(index, longIndex, regexps) {
+  //     for (var i = regexps.length - 1; i >= 0; i--){
+  //         if (!index.match(regexps[i]) && !longIndex.match(regexps[i])) return false;
+  //     };
+  //     return true;
+  // }
+
+
+  /*  ----- Mathchers ------  */
+
+  /*
+   * This record matches if the index starts with queries[0] and the record
+   * matches all of the regexps
+   */
+  function matchPassBeginning(index, longIndex, queries, regexps) {
+    if (index.indexOf(queries[0]) != 0) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if the longIndex starts with queries[0] and the
+   * longIndex matches all of the regexps
+   */
+  function matchPassLongIndex(index, longIndex, queries, regexps) {
+    if (longIndex.indexOf(queries[0]) != 0) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if the index contains queries[0] and the record
+   * matches all of the regexps
+   */
+  function matchPassContains(index, longIndex, queries, regexps) {
+    if (index.indexOf(queries[0]) == -1) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if regexps[0] matches the index and the record
+   * matches all of the regexps
+   */
+  function matchPassRegexp(index, longIndex, queries, regexps) {
+    if (!index.match(regexps[0])) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+
+  /*  ----- Highlighters ------  */
+  function highlightRegexp(info, queries, regexps, highlighters) {
+    var result = createResult(info);
+    for (var i=0, l = regexps.length; i < l; i++) {
+      result.title = result.title.replace(regexps[i], highlighters[i]);
+      result.namespace = result.namespace.replace(regexps[i], highlighters[i]);
+    };
+    return result;
+  }
+
+  function hltSubstring(string, pos, length) {
+    return string.substring(0, pos) + '\u0001' + string.substring(pos, pos + length) + '\u0002' + string.substring(pos + length);
+  }
+
+  function highlightQuery(info, queries, regexps, highlighters) {
+    var result = createResult(info);
+    var pos = 0;
+    var lcTitle = result.title.toLowerCase();
+
+    pos = lcTitle.indexOf(queries[0]);
+    if (pos != -1) {
+      result.title = hltSubstring(result.title, pos, queries[0].length);
+    }
+
+    result.namespace = result.namespace.replace(regexps[0], highlighters[0]);
+    for (var i=1, l = regexps.length; i < l; i++) {
+      result.title = result.title.replace(regexps[i], highlighters[i]);
+      result.namespace = result.namespace.replace(regexps[i], highlighters[i]);
+    };
+    return result;
+  }
+
+  function createResult(info) {
+    var result = {};
+    result.title = info[0];
+    result.namespace = info[1];
+    result.path = info[2];
+    result.params = info[3];
+    result.snippet = info[4];
+    return result;
+  }
+
+  /*  ----- Searching ------  */
+  function performSearch(data, regexps, queries, highlighters, state) {
+    var searchIndex = data.searchIndex;
+    var longSearchIndex = data.longSearchIndex;
+    var info = data.info;
+    var result = [];
+    var i = state.from;
+    var l = searchIndex.length;
+    var togo = CHUNK_SIZE;
+    var matchFunc, hltFunc;
+
+    while (state.pass < 4 && state.limit > 0 && togo > 0) {
+      if (state.pass == 0) {
+        matchFunc = matchPassBeginning;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 1) {
+        matchFunc = matchPassLongIndex;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 2) {
+        matchFunc = matchPassContains;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 3) {
+        matchFunc = matchPassRegexp;
+        hltFunc = highlightRegexp;
+      }
+
+      for (; togo > 0 && i < l && state.limit > 0; i++, togo--) {
+        if (info[i].n == state.n) continue;
+        if (matchFunc(searchIndex[i], longSearchIndex[i], queries, regexps)) {
+          info[i].n = state.n;
+          result.push(hltFunc(info[i], queries, regexps, highlighters));
+          state.limit--;
+        }
+      };
+      if (searchIndex.length <= i) {
+        state.pass++;
+        i = state.from = 0;
+      } else {
+        state.from = i;
+      }
+    }
+    return result;
+  }
+
+  function triggerResults(results, isLast) {
+    jQuery.each(this.handlers, function(i, fn) {
+      fn.call(this, results, isLast)
+    })
+  }
+}
+