dirtravel 0.0.6 → 0.0.7

data/doc/js/app.js

@@ -1,3 +1,9 @@
+(function() {
+
+var localStorage = {}, sessionStorage = {};
+try { localStorage = window.localStorage; } catch (e) { }
+try { sessionStorage = window.sessionStorage; } catch (e) { }
+
 function createSourceLinks() {
     $('.method_details_list .source_code').
         before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
@@ -16,7 +22,7 @@ function createDefineLinks() {
     $('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
     $('.toggleDefines').toggle(function() {
         tHeight = $(this).parent().prev().height();
-        $(this).prev().show();
+        $(this).prev().css('display', 'inline');
         $(this).parent().prev().height($(this).parent().height());
         $(this).text("(less)");
     },
@@ -42,29 +48,39 @@ function createFullTreeLinks() {
     });
 }
 
-function fixBoxInfoHeights() {
-    $('dl.box dd.r1, dl.box dd.r2').each(function() {
-       $(this).prev().height($(this).height());
-    });
-}
-
-function searchFrameLinks() {
+function searchFrameButtons() {
   $('.full_list_link').click(function() {
     toggleSearchFrame(this, $(this).attr('href'));
     return false;
   });
+  window.addEventListener('message', function(e) {
+    if (e.data === 'navEscape') {
+      $('#nav').slideUp(100);
+      $('#search a').removeClass('active inactive');
+      $(window).focus();
+    }
+  });
+
+  $(window).resize(function() {
+    if ($('#search:visible').length === 0) {
+      $('#nav').removeAttr('style');
+      $('#search a').removeClass('active inactive');
+      $(window).focus();
+    }
+  });
 }
 
 function toggleSearchFrame(id, link) {
-  var frame = $('#search_frame');
+  var frame = $('#nav');
   $('#search a').removeClass('active').addClass('inactive');
-  if (frame.attr('src') == link && frame.css('display') != "none") {
+  if (frame.attr('src') === link && frame.css('display') !== "none") {
     frame.slideUp(100);
     $('#search a').removeClass('active inactive');
   }
   else {
     $(id).addClass('active').removeClass('inactive');
-    frame.attr('src', link).slideDown(100);
+    if (frame.attr('src') !== link) frame.attr('src', link);
+    frame.slideDown(100);
   }
 }
 
@@ -74,43 +90,10 @@ function linkSummaries() {
   });
 }
 
-function framesInit() {
-  if (hasFrames) {
-    document.body.className = 'frames';
-    $('#menu .noframes a').attr('href', document.location);
-    try {
-      window.top.document.title = $('html head title').text();
-    } catch(error) {
-      // some browsers will not allow this when serving from file://
-      // but we don't want to stop the world.
-    }
-  }
-  else {
-    $('#menu .noframes a').text('frames').attr('href', framesUrl);
-  }
-}
-
-function keyboardShortcuts() {
-  if (window.top.frames.main) return;
-  $(document).keypress(function(evt) {
-    if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
-    if (typeof evt.target !== "undefined" &&
-        (evt.target.nodeName == "INPUT" ||
-        evt.target.nodeName == "TEXTAREA")) return;
-    switch (evt.charCode) {
-      case 67: case 99:  $('#class_list_link').click(); break;  // 'c'
-      case 77: case 109: $('#method_list_link').click(); break; // 'm'
-      case 70: case 102: $('#file_list_link').click(); break;   // 'f'
-      default: break;
-    }
-  });
-}
-
 function summaryToggle() {
-  $('.summary_toggle').click(function() {
-    if (localStorage) {
-      localStorage.summaryCollapsed = $(this).text();
-    }
+  $('.summary_toggle').click(function(e) {
+    e.preventDefault();
+    localStorage.summaryCollapsed = $(this).text();
     $('.summary_toggle').each(function() {
       $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
       var next = $(this).parent().parent().nextAll('ul.summary').first();
@@ -132,18 +115,52 @@ function summaryToggle() {
     });
     return false;
   });
-  if (localStorage) {
-    if (localStorage.summaryCollapsed == "collapse") {
-      $('.summary_toggle').first().click();
-    }
-    else localStorage.summaryCollapsed = "expand";
-  }
+  if (localStorage.summaryCollapsed == "collapse") {
+    $('.summary_toggle').first().click();
+  } else { localStorage.summaryCollapsed = "expand"; }
 }
 
-function fixOutsideWorldLinks() {
-  $('a').each(function() {
-    if (window.location.host != this.host) this.target = '_parent';
+function constantSummaryToggle() {
+  $('.constants_summary_toggle').click(function(e) {
+    e.preventDefault();
+    localStorage.summaryCollapsed = $(this).text();
+    $('.constants_summary_toggle').each(function() {
+      $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
+      var next = $(this).parent().parent().nextAll('dl.constants').first();
+      if (next.hasClass('compact')) {
+        next.toggle();
+        next.nextAll('dl.constants').first().toggle();
+      }
+      else if (next.hasClass('constants')) {
+        var list = $('<dl class="constants compact" />');
+        list.html(next.html());
+        list.find('dt').each(function() {
+           $(this).addClass('summary_signature');
+           $(this).text( $(this).text().split('=')[0]);
+          if ($(this).has(".deprecated").length) {
+             $(this).addClass('deprecated');
+          };
+        });
+        // Add the value of the constant as "Tooltip" to the summary object
+        list.find('pre.code').each(function() {
+          console.log($(this).parent());
+          var dt_element = $(this).parent().prev();
+          var tooltip = $(this).text();
+          if (dt_element.hasClass("deprecated")) {
+             tooltip = 'Deprecated. ' + tooltip;
+          };
+          dt_element.attr('title', tooltip);
+        });
+        list.find('.docstring, .tags, dd').remove();
+        next.before(list);
+        next.toggle();
+      }
+    });
+    return false;
   });
+  if (localStorage.summaryCollapsed == "collapse") {
+    $('.constants_summary_toggle').first().click();
+  } else { localStorage.summaryCollapsed = "expand"; }
 }
 
 function generateTOC() {
@@ -154,6 +171,7 @@ function generateTOC() {
   var counter = 0;
   var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
   var i;
+  var curli;
   if ($('#filecontents h1').length > 1) tags.unshift('h1');
   for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
   var lastTag = parseInt(tags[0][1], 10);
@@ -173,19 +191,29 @@ function generateTOC() {
     }
     if (thisTag > lastTag) {
       for (i = 0; i < thisTag - lastTag; i++) {
-        var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
+        if ( typeof(curli) == "undefined" ) {
+          curli = $('<li/>');
+          toc.append(curli);
+        }
+        toc = $('<ol/>');
+        curli.append(toc);
+        curli = undefined;
       }
     }
     if (thisTag < lastTag) {
-      for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
+      for (i = 0; i < lastTag - thisTag; i++) {
+        toc = toc.parent();
+        toc = toc.parent();
+      }
     }
     var title = $(this).attr('toc-title');
     if (typeof(title) == "undefined") title = $(this).text();
-    toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
+    curli =$('<li><a href="#' + this.id + '">' + title + '</a></li>'); 
+    toc.append(curli);
     lastTag = thisTag;
   });
   if (!show) return;
-  html = '<div id="toc"><p class="title"><a class="hide_toc" href="#"><strong>Table of Contents</strong></a> <small>(<a href="#" class="float_toc">left</a>)</small></p></div>';
+  html = '<div id="toc"><p class="title hide_toc"><a href="#"><strong>Table of Contents</strong></a></p></div>';
   $('#content').prepend(html);
   $('#toc').append(_toc);
   $('#toc .hide_toc').toggle(function() {
@@ -197,23 +225,90 @@ function generateTOC() {
     $('#toc').toggleClass('hidden');
     $('#toc .title small').toggle();
   });
-  $('#toc .float_toc').toggle(function() {
-    $(this).text('float');
-    $('#toc').toggleClass('nofloat');
-  }, function() {
-    $(this).text('left');
-    $('#toc').toggleClass('nofloat');
+}
+
+function navResizeFn(e) {
+  if (e.which !== 1) {
+    navResizeFnStop();
+    return;
+  }
+
+  sessionStorage.navWidth = e.pageX.toString();
+  $('.nav_wrap').css('width', e.pageX);
+  $('.nav_wrap').css('-ms-flex', 'inherit');
+}
+
+function navResizeFnStop() {
+  $(window).unbind('mousemove', navResizeFn);
+  window.removeEventListener('message', navMessageFn, false);
+}
+
+function navMessageFn(e) {
+  if (e.data.action === 'mousemove') navResizeFn(e.data.event);
+  if (e.data.action === 'mouseup') navResizeFnStop();
+}
+
+function navResizer() {
+  $('#resizer').mousedown(function(e) {
+    e.preventDefault();
+    $(window).mousemove(navResizeFn);
+    window.addEventListener('message', navMessageFn, false);
   });
+  $(window).mouseup(navResizeFnStop);
+
+  if (sessionStorage.navWidth) {
+    navResizeFn({which: 1, pageX: parseInt(sessionStorage.navWidth, 10)});
+  }
+}
+
+function navExpander() {
+  var done = false, timer = setTimeout(postMessage, 500);
+  function postMessage() {
+    if (done) return;
+    clearTimeout(timer);
+    var opts = { action: 'expand', path: pathId };
+    document.getElementById('nav').contentWindow.postMessage(opts, '*');
+    done = true;
+  }
+
+  window.addEventListener('message', function(event) {
+    if (event.data === 'navReady') postMessage();
+    return false;
+  }, false);
 }
 
-$(framesInit);
-$(createSourceLinks);
-$(createDefineLinks);
-$(createFullTreeLinks);
-$(fixBoxInfoHeights);
-$(searchFrameLinks);
-$(linkSummaries);
-$(keyboardShortcuts);
-$(summaryToggle);
-$(fixOutsideWorldLinks);
-$(generateTOC);
+function mainFocus() {
+  var hash = window.location.hash;
+  if (hash !== '' && $(hash)[0]) {
+    $(hash)[0].scrollIntoView();
+  }
+
+  setTimeout(function() { $('#main').focus(); }, 10);
+}
+
+function navigationChange() {
+  // This works around the broken anchor navigation with the YARD template.
+  window.onpopstate = function() {
+    var hash = window.location.hash;
+    if (hash !== '' && $(hash)[0]) {
+      $(hash)[0].scrollIntoView();
+    }
+  };
+}
+
+$(document).ready(function() {
+  navResizer();
+  navExpander();
+  createSourceLinks();
+  createDefineLinks();
+  createFullTreeLinks();
+  searchFrameButtons();
+  linkSummaries();
+  summaryToggle();
+  constantSummaryToggle();
+  generateTOC();
+  mainFocus();
+  navigationChange();
+});
+
+})();

data/doc/js/full_list.js

@@ -1,8 +1,8 @@
-var inSearch = null;
-var searchIndex = 0;
+(function() {
+
+var $clicked = $(null);
+var searchTimeout = null;
 var searchCache = [];
-var searchString = '';
-var regexSearchString = '';
 var caseSensitiveMatch = false;
 var ignoreKeyCodeMin = 8;
 var ignoreKeyCodeMax = 46;
@@ -12,170 +12,205 @@ RegExp.escape = function(text) {
     return text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
 }
 
-function fullListSearch() {
-  // generate cache
-  searchCache = [];
-  $('#full_list li').each(function() {
-    var link = $(this).find('.object_link a');
-    if (link.length === 0) return;
-    var fullName = link.attr('title').split(' ')[0];
-    searchCache.push({name:link.text(), fullName:fullName, node:$(this), link:link});
+function escapeShortcut() {
+  $(document).keydown(function(evt) {
+    if (evt.which == 27) {
+      window.parent.postMessage('navEscape', '*');
+    }
   });
+}
 
-  $('#search input').keyup(function(event) {
-    if ((event.keyCode > ignoreKeyCodeMin && event.keyCode < ignoreKeyCodeMax)
-         || event.keyCode == commandKey)
-      return;
-    searchString = this.value;
-    caseSensitiveMatch = searchString.match(/[A-Z]/) != null;
-    regexSearchString = RegExp.escape(searchString);
-    if (caseSensitiveMatch) {
-      regexSearchString += "|" +
-        $.map(searchString.split(''), function(e) { return RegExp.escape(e); }).
-        join('.+?');
-    }
-    if (searchString === "") {
-      clearTimeout(inSearch);
-      inSearch = null;
-      $('ul .search_uncollapsed').removeClass('search_uncollapsed');
-      $('#full_list, #content').removeClass('insearch');
-      $('#full_list li').removeClass('found').each(function() {
-
-        var link = $(this).find('.object_link a');
-        if (link.length > 0) link.text(link.text());
+function navResizer() {
+  $(window).mousemove(function(e) {
+    window.parent.postMessage({
+      action: 'mousemove', event: {pageX: e.pageX, which: e.which}
+    }, '*');
+  }).mouseup(function(e) {
+    window.parent.postMessage({action: 'mouseup'}, '*');
+  });
+  window.parent.postMessage("navReady", "*");
+}
+
+function clearSearchTimeout() {
+  clearTimeout(searchTimeout);
+  searchTimeout = null;
+}
+
+function enableLinks() {
+  // load the target page in the parent window
+  $('#full_list li').on('click', function(evt) {
+    $('#full_list li').removeClass('clicked');
+    $clicked = $(this);
+    $clicked.addClass('clicked');
+    evt.stopPropagation();
+
+    if (evt.target.tagName === 'A') return true;
+
+    var elem = $clicked.find('> .item .object_link a')[0];
+    var e = evt.originalEvent;
+    var newEvent = new MouseEvent(evt.originalEvent.type);
+    newEvent.initMouseEvent(e.type, e.canBubble, e.cancelable, e.view, e.detail, e.screenX, e.screenY, e.clientX, e.clientY, e.ctrlKey, e.altKey, e.shiftKey, e.metaKey, e.button, e.relatedTarget);
+    elem.dispatchEvent(newEvent);
+    evt.preventDefault();
+    return false;
+  });
+}
+
+function enableToggles() {
+  // show/hide nested classes on toggle click
+  $('#full_list a.toggle').on('click', function(evt) {
+    evt.stopPropagation();
+    evt.preventDefault();
+    $(this).parent().parent().toggleClass('collapsed');
+    highlight();
+  });
+}
+
+function populateSearchCache() {
+  $('#full_list li .item').each(function() {
+    var $node = $(this);
+    var $link = $node.find('.object_link a');
+    if ($link.length > 0) {
+      searchCache.push({
+        node: $node,
+        link: $link,
+        name: $link.text(),
+        fullName: $link.attr('title').split(' ')[0]
       });
-      if (clicked) {
-        clicked.parents('ul').each(function() {
-          $(this).removeClass('collapsed').prev().removeClass('collapsed');
-        });
-      }
-      highlight();
     }
-    else {
-      if (inSearch) clearTimeout(inSearch);
-      searchIndex = 0;
-      lastRowClass = '';
-      $('#full_list, #content').addClass('insearch');
-      $('#noresults').text('');
-      searchItem();
+  });
+}
+
+function enableSearch() {
+  $('#search input').keyup(function(event) {
+    if (ignoredKeyPress(event)) return;
+    if (this.value === "") {
+      clearSearch();
+    } else {
+      performSearch(this.value);
     }
   });
 
-  $('#search input').focus();
-  $('#full_list').after("<div id='noresults'></div>");
+  $('#full_list').after("<div id='noresults' style='display:none'></div>");
+}
+
+function ignoredKeyPress(event) {
+  if (
+    (event.keyCode > ignoreKeyCodeMin && event.keyCode < ignoreKeyCodeMax) ||
+    (event.keyCode == commandKey)
+  ) {
+    return true;
+  } else {
+    return false;
+  }
+}
+
+function clearSearch() {
+  clearSearchTimeout();
+  $('#full_list .found').removeClass('found').each(function() {
+    var $link = $(this).find('.object_link a');
+    $link.text($link.text());
+  });
+  $('#full_list, #content').removeClass('insearch');
+  $clicked.parents().removeClass('collapsed');
+  highlight();
+}
+
+function performSearch(searchString) {
+  clearSearchTimeout();
+  $('#full_list, #content').addClass('insearch');
+  $('#noresults').text('').hide();
+  partialSearch(searchString, 0);
 }
 
-var lastRowClass = '';
-function searchItem() {
-  for (var i = 0; i < searchCache.length / 50; i++) {
-    var item = searchCache[searchIndex];
+function partialSearch(searchString, offset) {
+  var lastRowClass = '';
+  var i = null;
+  for (i = offset; i < Math.min(offset + 50, searchCache.length); i++) {
+    var item = searchCache[i];
     var searchName = (searchString.indexOf('::') != -1 ? item.fullName : item.name);
-    var matchString = regexSearchString;
+    var matchString = buildMatchString(searchString);
     var matchRegexp = new RegExp(matchString, caseSensitiveMatch ? "" : "i");
     if (searchName.match(matchRegexp) == null) {
       item.node.removeClass('found');
+      item.link.text(item.link.text());
     }
     else {
-      item.node.css('padding-left', '10px').addClass('found');
-      item.node.parents().addClass('search_uncollapsed');
+      item.node.addClass('found');
       item.node.removeClass(lastRowClass).addClass(lastRowClass == 'r1' ? 'r2' : 'r1');
       lastRowClass = item.node.hasClass('r1') ? 'r1' : 'r2';
       item.link.html(item.name.replace(matchRegexp, "<strong>$&</strong>"));
     }
-
-    if (searchCache.length === searchIndex + 1) {
-      searchDone();
-      return;
-    }
-    else {
-      searchIndex++;
-    }
   }
-  inSearch = setTimeout('searchItem()', 0);
+  if(i == searchCache.length) {
+    searchDone();
+  } else {
+    searchTimeout = setTimeout(function() {
+      partialSearch(searchString, i);
+    }, 0);
+  }
 }
 
 function searchDone() {
-  highlight(true);
+  searchTimeout = null;
+  highlight();
   if ($('#full_list li:visible').size() === 0) {
     $('#noresults').text('No results were found.').hide().fadeIn();
-  }
-  else {
-    $('#noresults').text('');
+  } else {
+    $('#noresults').text('').hide();
   }
   $('#content').removeClass('insearch');
-  clearTimeout(inSearch);
-  inSearch = null;
-}
-
-clicked = null;
-function linkList() {
-  $('#full_list li, #full_list li a:last').click(function(evt) {
-    if ($(this).hasClass('toggle')) return true;
-    if (this.tagName.toLowerCase() == "li") {
-      if ($(this).find('.object_link a').length === 0) {
-        $(this).children('a.toggle').click();
-        return false;
-      }
-      var toggle = $(this).children('a.toggle');
-      if (toggle.size() > 0 && evt.pageX < toggle.offset().left) {
-        toggle.click();
-        return false;
-      }
-    }
-    if (clicked) clicked.removeClass('clicked');
-    var win;
-    try {
-      win = window.top.frames.main ? window.top.frames.main : window.parent;
-    } catch (e) { win = window.parent; }
-    if (this.tagName.toLowerCase() == "a") {
-      clicked = $(this).parents('li').addClass('clicked');
-      win.location = this.href;
-    }
-    else {
-      clicked = $(this).addClass('clicked');
-      win.location = $(this).find('a:last').attr('href');
-    }
-    return false;
-  });
 }
 
-function collapse() {
-  if (!$('#full_list').hasClass('class')) return;
-  $('#full_list.class a.toggle').click(function() {
-    $(this).parent().toggleClass('collapsed').next().toggleClass('collapsed');
-    highlight();
-    return false;
-  });
-  $('#full_list.class ul').each(function() {
-    $(this).addClass('collapsed').prev().addClass('collapsed');
-  });
-  $('#full_list.class').children().removeClass('collapsed');
-  highlight();
+function buildMatchString(searchString, event) {
+  caseSensitiveMatch = searchString.match(/[A-Z]/) != null;
+  var regexSearchString = RegExp.escape(searchString);
+  if (caseSensitiveMatch) {
+    regexSearchString += "|" +
+      $.map(searchString.split(''), function(e) { return RegExp.escape(e); }).
+      join('.+?');
+  }
+  return regexSearchString;
 }
 
-function highlight(no_padding) {
-  var n = 1;
-  $('#full_list li:visible').each(function() {
-    var next = n == 1 ? 2 : 1;
-    $(this).removeClass("r" + next).addClass("r" + n);
-    if (!no_padding && $('#full_list').hasClass('class')) {
-      $(this).css('padding-left', (10 + $(this).parents('ul').size() * 15) + 'px');
-    }
-    n = next;
+function highlight() {
+  $('#full_list li:visible').each(function(n) {
+    $(this).removeClass('even odd').addClass(n % 2 == 0 ? 'odd' : 'even');
   });
 }
 
-function escapeShortcut() {
-  $(document).keydown(function(evt) {
-    if (evt.which == 27) {
-      $('#search_frame', window.top.document).slideUp(100);
-      $('#search a', window.top.document).removeClass('active inactive');
-      $(window.top).focus();
-    }
-  });
+/**
+ * Expands the tree to the target element and its immediate
+ * children.
+ */
+function expandTo(path) {
+  var $target = $(document.getElementById('object_' + path));
+  $target.addClass('clicked');
+  $target.removeClass('collapsed');
+  $target.parentsUntil('#full_list', 'li').removeClass('collapsed');
+  if($target[0]) {
+    window.scrollTo(window.scrollX, $target.offset().top - 250);
+    highlight();
+  }
+}
+
+function windowEvents(event) {
+  var msg = event.data;
+  if (msg.action === "expand") {
+    expandTo(msg.path);
+  }
+  return false;
 }
 
-$(escapeShortcut);
-$(fullListSearch);
-$(linkList);
-$(collapse);
+window.addEventListener("message", windowEvents, false);
+
+$(document).ready(function() {
+  escapeShortcut();
+  navResizer();
+  enableLinks();
+  enableToggles();
+  populateSearchCache();
+  enableSearch();
+});
+
+})();