ldbws 1.0.3 → 1.0.4

data/doc/js/c_highlighter.js

@@ -0,0 +1,299 @@
+/**
+ * Client-side C syntax highlighter for RDoc
+ */
+
+(function() {
+  'use strict';
+
+  // C control flow and storage class keywords
+  const C_KEYWORDS = new Set([
+    'auto', 'break', 'case', 'continue', 'default', 'do', 'else', 'extern',
+    'for', 'goto', 'if', 'inline', 'register', 'return', 'sizeof', 'static',
+    'switch', 'while',
+    '_Alignas', '_Alignof', '_Generic', '_Noreturn', '_Static_assert', '_Thread_local'
+  ]);
+
+  // C type keywords and type qualifiers
+  const C_TYPE_KEYWORDS = new Set([
+    'bool', 'char', 'const', 'double', 'enum', 'float', 'int', 'long',
+    'restrict', 'short', 'signed', 'struct', 'typedef', 'union', 'unsigned',
+    'void', 'volatile', '_Atomic', '_Bool', '_Complex', '_Imaginary'
+  ]);
+
+  // Library-defined types (typedef'd in headers, not language keywords)
+  // Includes: Ruby C API types (VALUE, ID), POSIX types (size_t, ssize_t),
+  // fixed-width integer types (uint32_t, int64_t), and standard I/O types (FILE)
+  const C_TYPES = new Set([
+    'VALUE', 'ID', 'size_t', 'ssize_t', 'ptrdiff_t', 'uintptr_t', 'intptr_t',
+    'uint8_t', 'uint16_t', 'uint32_t', 'uint64_t',
+    'int8_t', 'int16_t', 'int32_t', 'int64_t',
+    'FILE', 'DIR', 'va_list'
+  ]);
+
+  // Common Ruby VALUE macros and boolean literals
+  const RUBY_MACROS = new Set([
+    'Qtrue', 'Qfalse', 'Qnil', 'Qundef', 'NULL', 'TRUE', 'FALSE', 'true', 'false'
+  ]);
+
+  const OPERATORS = new Set([
+    '==', '!=', '<=', '>=', '&&', '||', '<<', '>>', '++', '--',
+    '+=', '-=', '*=', '/=', '%=', '&=', '|=', '^=', '->',
+    '+', '-', '*', '/', '%', '<', '>', '=', '!', '&', '|', '^', '~'
+  ]);
+
+  // Single character that can start an operator
+  const OPERATOR_CHARS = new Set('+-*/%<>=!&|^~');
+
+  function isMacro(word) {
+    return RUBY_MACROS.has(word) || /^[A-Z][A-Z0-9_]*$/.test(word);
+  }
+
+  function isType(word) {
+    return C_TYPE_KEYWORDS.has(word) || C_TYPES.has(word) || /_t$/.test(word);
+  }
+
+  /**
+   * Escape HTML special characters
+   */
+  function escapeHtml(text) {
+    return text
+      .replace(/&/g, '&amp;')
+      .replace(/</g, '&lt;')
+      .replace(/>/g, '&gt;')
+      .replace(/"/g, '&quot;')
+      .replace(/'/g, '&#39;');
+  }
+
+  /**
+   * Check if position is at line start (only whitespace before it)
+   */
+  function isLineStart(code, pos) {
+    if (pos === 0) return true;
+    for (let i = pos - 1; i >= 0; i--) {
+      const ch = code[i];
+      if (ch === '\n') return true;
+      if (ch !== ' ' && ch !== '\t') return false;
+    }
+    return true;
+  }
+
+  /**
+   * Highlight C source code
+   */
+  function highlightC(code) {
+    const tokens = [];
+    let i = 0;
+    const len = code.length;
+
+    while (i < len) {
+      const char = code[i];
+
+      // Multi-line comment
+      if (char === '/' && code[i + 1] === '*') {
+        let end = code.indexOf('*/', i + 2);
+        end = (end === -1) ? len : end + 2;
+        const comment = code.substring(i, end);
+        tokens.push('<span class="c-comment">', escapeHtml(comment), '</span>');
+        i = end;
+        continue;
+      }
+
+      // Single-line comment
+      if (char === '/' && code[i + 1] === '/') {
+        const end = code.indexOf('\n', i);
+        const commentEnd = (end === -1) ? len : end;
+        const comment = code.substring(i, commentEnd);
+        tokens.push('<span class="c-comment">', escapeHtml(comment), '</span>');
+        i = commentEnd;
+        continue;
+      }
+
+      // Preprocessor directive (must be at line start)
+      if (char === '#' && isLineStart(code, i)) {
+        let end = i + 1;
+        while (end < len && code[end] !== '\n') {
+          if (code[end] === '\\' && end + 1 < len && code[end + 1] === '\n') {
+            end += 2; // Handle line continuation
+          } else {
+            end++;
+          }
+        }
+        const preprocessor = code.substring(i, end);
+        tokens.push('<span class="c-preprocessor">', escapeHtml(preprocessor), '</span>');
+        i = end;
+        continue;
+      }
+
+      // String literal
+      if (char === '"') {
+        let end = i + 1;
+        while (end < len && code[end] !== '"') {
+          if (code[end] === '\\' && end + 1 < len) {
+            end += 2; // Skip escaped character
+          } else {
+            end++;
+          }
+        }
+        if (end < len) end++; // Include closing quote
+        const string = code.substring(i, end);
+        tokens.push('<span class="c-string">', escapeHtml(string), '</span>');
+        i = end;
+        continue;
+      }
+
+      // Character literal
+      if (char === "'") {
+        let end = i + 1;
+        // Handle escape sequences like '\n', '\\', '\''
+        if (end < len && code[end] === '\\' && end + 1 < len) {
+          end += 2; // Skip backslash and escaped char
+        } else if (end < len) {
+          end++; // Single character
+        }
+        if (end < len && code[end] === "'") end++; // Closing quote
+        const charLit = code.substring(i, end);
+        tokens.push('<span class="c-value">', escapeHtml(charLit), '</span>');
+        i = end;
+        continue;
+      }
+
+      // Number (integer or float)
+      if (char >= '0' && char <= '9') {
+        let end = i;
+
+        // Hexadecimal
+        if (char === '0' && (code[i + 1] === 'x' || code[i + 1] === 'X')) {
+          end = i + 2;
+          while (end < len) {
+            const ch = code[end];
+            if ((ch >= '0' && ch <= '9') || (ch >= 'a' && ch <= 'f') || (ch >= 'A' && ch <= 'F')) {
+              end++;
+            } else {
+              break;
+            }
+          }
+        }
+        // Octal
+        else if (char === '0' && code[i + 1] >= '0' && code[i + 1] <= '7') {
+          end = i + 1;
+          while (end < len && code[end] >= '0' && code[end] <= '7') end++;
+        }
+        // Decimal/Float
+        else {
+          while (end < len) {
+            const ch = code[end];
+            if ((ch >= '0' && ch <= '9') || ch === '.') {
+              end++;
+            } else {
+              break;
+            }
+          }
+          // Scientific notation
+          if (end < len && (code[end] === 'e' || code[end] === 'E')) {
+            end++;
+            if (end < len && (code[end] === '+' || code[end] === '-')) end++;
+            while (end < len && code[end] >= '0' && code[end] <= '9') end++;
+          }
+        }
+
+        // Suffix (u, l, f, etc.)
+        while (end < len) {
+          const ch = code[end];
+          if (ch === 'u' || ch === 'U' || ch === 'l' || ch === 'L' || ch === 'f' || ch === 'F') {
+            end++;
+          } else {
+            break;
+          }
+        }
+
+        const number = code.substring(i, end);
+        tokens.push('<span class="c-value">', escapeHtml(number), '</span>');
+        i = end;
+        continue;
+      }
+
+      // Identifier or keyword
+      if ((char >= 'a' && char <= 'z') || (char >= 'A' && char <= 'Z') || char === '_') {
+        let end = i + 1;
+        while (end < len) {
+          const ch = code[end];
+          if ((ch >= 'a' && ch <= 'z') || (ch >= 'A' && ch <= 'Z') ||
+              (ch >= '0' && ch <= '9') || ch === '_') {
+            end++;
+          } else {
+            break;
+          }
+        }
+        const word = code.substring(i, end);
+
+        if (C_KEYWORDS.has(word)) {
+          tokens.push('<span class="c-keyword">', escapeHtml(word), '</span>');
+        } else if (isType(word)) {
+          // Check types before macros (VALUE, ID are types, not macros)
+          tokens.push('<span class="c-type">', escapeHtml(word), '</span>');
+        } else if (isMacro(word)) {
+          tokens.push('<span class="c-macro">', escapeHtml(word), '</span>');
+        } else {
+          // Check if followed by '(' -> function name
+          let nextCharIdx = end;
+          while (nextCharIdx < len && (code[nextCharIdx] === ' ' || code[nextCharIdx] === '\t')) {
+            nextCharIdx++;
+          }
+          if (nextCharIdx < len && code[nextCharIdx] === '(') {
+            tokens.push('<span class="c-function">', escapeHtml(word), '</span>');
+          } else {
+            tokens.push('<span class="c-identifier">', escapeHtml(word), '</span>');
+          }
+        }
+        i = end;
+        continue;
+      }
+
+      // Operators
+      if (OPERATOR_CHARS.has(char)) {
+        let op = char;
+        // Check for two-character operators
+        if (i + 1 < len) {
+          const twoChar = char + code[i + 1];
+          if (OPERATORS.has(twoChar)) {
+            op = twoChar;
+          }
+        }
+        tokens.push('<span class="c-operator">', escapeHtml(op), '</span>');
+        i += op.length;
+        continue;
+      }
+
+      // Everything else (punctuation, whitespace)
+      tokens.push(escapeHtml(char));
+      i++;
+    }
+
+    return tokens.join('');
+  }
+
+  /**
+   * Initialize C syntax highlighting on page load
+   */
+  function initHighlighting() {
+    const codeBlocks = document.querySelectorAll('pre.c');
+
+    codeBlocks.forEach(block => {
+      if (block.getAttribute('data-highlighted') === 'true') {
+        return;
+      }
+
+      const code = block.textContent;
+      const highlighted = highlightC(code);
+
+      block.innerHTML = highlighted;
+      block.setAttribute('data-highlighted', 'true');
+    });
+  }
+
+  if (document.readyState === 'loading') {
+    document.addEventListener('DOMContentLoaded', initHighlighting);
+  } else {
+    initHighlighting();
+  }
+})();

data/doc/js/search_controller.js

@@ -0,0 +1,129 @@
+SearchController = function(data, input, result) {
+  this.data = data;
+  this.input = input;
+  this.result = result;
+
+  this.current = null;
+  this.view = this.result.parentNode;
+  this.ranker = new SearchRanker(data.index);
+  this.init();
+}
+
+SearchController.prototype = Object.assign({}, SearchNavigation, new function() {
+  var suid = 1;
+
+  this.init = function() {
+    var _this = this;
+    var observer = function(e) {
+      switch(e.key) {
+        case 'ArrowUp':
+        case 'ArrowDown':
+          return;
+      }
+      _this.search(_this.input.value);
+    };
+    this.input.addEventListener('keyup', observer);
+    this.input.addEventListener('click', observer); // mac's clear field
+
+    this.ranker.ready(function(results, isLast) {
+      _this.addResults(results, isLast);
+    })
+
+    this.initNavigation();
+    this.setNavigationActive(false);
+  }
+
+  this.search = function(value, selectFirstMatch) {
+    this.selectFirstMatch = selectFirstMatch;
+
+    value = value.trim();
+    if (value) {
+      this.setNavigationActive(true);
+    } else {
+      this.setNavigationActive(false);
+    }
+
+    if (value == '') {
+      this.lastQuery = value;
+      this.result.innerHTML = '';
+      this.result.setAttribute('aria-expanded', 'false');
+      this.setNavigationActive(false);
+    } else if (value != this.lastQuery) {
+      this.lastQuery = value;
+      this.result.setAttribute('aria-busy',     'true');
+      this.result.setAttribute('aria-expanded', 'true');
+      this.firstRun = true;
+      this.ranker.find(value);
+    }
+  }
+
+  this.addResults = function(results, isLast) {
+    var target = this.result;
+    if (this.firstRun && (results.length > 0 || isLast)) {
+      this.current = null;
+      this.result.innerHTML = '';
+    }
+
+    for (var i=0, l = results.length; i < l; i++) {
+      var item = this.renderItem.call(this, results[i]);
+      item.setAttribute('id', 'search-result-' + target.childElementCount);
+      target.appendChild(item);
+    };
+
+    if (this.firstRun && results.length > 0) {
+      this.firstRun = false;
+      this.current = target.firstChild;
+      this.current.classList.add('search-selected');
+    }
+    //TODO: ECMAScript
+    //if (jQuery.browser.msie) this.$element[0].className += '';
+
+    if (this.selectFirstMatch && this.current) {
+      this.selectFirstMatch = false;
+      this.select(this.current);
+    }
+
+    if (isLast) {
+      this.selectFirstMatch = false;
+      this.result.setAttribute('aria-busy', 'false');
+    }
+  }
+
+  this.move = function(isDown) {
+    if (!this.current) return;
+    var next = isDown ? this.current.nextElementSibling : this.current.previousElementSibling;
+    if (next) {
+      this.current.classList.remove('search-selected');
+      next.classList.add('search-selected');
+      this.input.setAttribute('aria-activedescendant', next.getAttribute('id'));
+      this.scrollInElement(next, this.result);
+      this.current = next;
+      this.input.value = next.firstChild.firstChild.text;
+      this.input.select();
+    }
+    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) + ';';
+    });
+  }
+
+  this.hide = function() {
+    this.result.setAttribute('aria-expanded', 'false');
+    this.setNavigationActive(false);
+  }
+
+  this.show = function() {
+    this.result.setAttribute('aria-expanded', 'true');
+    this.setNavigationActive(true);
+  }
+});
+

data/doc/js/search_data.js

@@ -0,0 +1 @@
+var search_data = {"index":[{"name":"Ldbws","full_name":"Ldbws","type":"module","path":"Ldbws.html","snippet":"<p>Provides a Ruby abstraction around the UK’s Network Rail live departure board webservice (LDBWS). See …\n"},{"name":"VERSION","full_name":"Ldbws::VERSION","type":"constant","path":"Ldbws.html","snippet":"<p>The current gem version.\n"},{"name":"Request","full_name":"Ldbws::Request","type":"module","path":"Ldbws/Request.html"},{"name":"GetDeparturesBoard","full_name":"Ldbws::Request::GetDeparturesBoard","type":"class","path":"Ldbws/Request/GetDeparturesBoard.html","snippet":"<p>Requests a departure board for a station, filtered by departures to one or many other stations. Corresponds …\n"},{"name":"GetDeparturesBoardWithDetails","full_name":"Ldbws::Request::GetDeparturesBoardWithDetails","type":"class","path":"Ldbws/Request/GetDeparturesBoardWithDetails.html","snippet":"<p>Requests a departure board for a statuion, filtered by departures to one or more other stations. This …\n"},{"name":"GetServiceDetails","full_name":"Ldbws::Request::GetServiceDetails","type":"class","path":"Ldbws/Request/GetServiceDetails.html","snippet":"<p>Returns details about a particular service. Corresponds to <code>GetServiceDetailsResponse</code> in the LDBWS schema. …\n"},{"name":"GetStationBoard","full_name":"Ldbws::Request::GetStationBoard","type":"class","path":"Ldbws/Request/GetStationBoard.html","snippet":"<p>Returns an arrival or departure board for a given station. Corresponds to <code>GetStationBoardRequest</code> in the …\n"},{"name":"GetStationBoardWithDetails","full_name":"Ldbws::Request::GetStationBoardWithDetails","type":"class","path":"Ldbws/Request/GetStationBoardWithDetails.html","snippet":"<p>Returns an arrival or departure board for a given station with full service details. Corresponds to  …\n"},{"name":"ParamValidationError","full_name":"Ldbws::Request::ParamValidationError","type":"class","path":"Ldbws/Request/ParamValidationError.html","snippet":"<p>Raised when an error occurs when validating request parameters. Messages are passed through directly …\n"},{"name":"RequestError","full_name":"Ldbws::RequestError","type":"class","path":"Ldbws/RequestError.html","snippet":"<p>Raised when a request has resulted in an error that this library can make some sense of. This <em>usually</em> …\n"},{"name":"ResponseParsingError","full_name":"Ldbws::ResponseParsingError","type":"class","path":"Ldbws/ResponseParsingError.html","snippet":"<p>Raised when a response from LDBWS cannot be parsed by this library. This is unexpected, and generally …\n"},{"name":"ResponseTypes","full_name":"Ldbws::ResponseTypes","type":"module","path":"Ldbws/ResponseTypes.html"},{"name":"BaseStationBoard","full_name":"Ldbws::ResponseTypes::BaseStationBoard","type":"class","path":"Ldbws/ResponseTypes/BaseStationBoard.html","snippet":"<p>Base station board information. This does not directly correspond to a type in LDBWS.\n<p>Properties\n"},{"name":"CallingPoint","full_name":"Ldbws::ResponseTypes::CallingPoint","type":"class","path":"Ldbws/ResponseTypes/CallingPoint.html","snippet":"<p>Represents a calling point in the LDBWS.\n<p>Properties\n<p>location_name &mdash; the name of the station\n"},{"name":"Coach","full_name":"Ldbws::ResponseTypes::Coach","type":"class","path":"Ldbws/ResponseTypes/Coach.html","snippet":"<p>Information about an individual coach in the train.\n<p>Properties\n<p>number &mdash; the coach number or identifier\n"},{"name":"DepartureItem","full_name":"Ldbws::ResponseTypes::DepartureItem","type":"class","path":"Ldbws/ResponseTypes/DepartureItem.html","snippet":"<p>Represents an item on a departure board.\n<p>Properties\n<p>crs &mdash; the CRS for the item\n"},{"name":"DepartureItemWithDetails","full_name":"Ldbws::ResponseTypes::DepartureItemWithDetails","type":"class","path":"Ldbws/ResponseTypes/DepartureItemWithDetails.html","snippet":"<p>Represents an item on a departure board with additional details.\n<p>Properties\n<p>crs &mdash; the CRS for the item\n"},{"name":"DeparturesBoard","full_name":"Ldbws::ResponseTypes::DeparturesBoard","type":"class","path":"Ldbws/ResponseTypes/DeparturesBoard.html","snippet":"<p>Represents a departures board.\n<p>Properties\n<p>departures &mdash; a list of departures.\n"},{"name":"DeparturesBoardWithDetails","full_name":"Ldbws::ResponseTypes::DeparturesBoardWithDetails","type":"class","path":"Ldbws/ResponseTypes/DeparturesBoardWithDetails.html","snippet":"<p>Represents a departures board with additional details.\n<p>Properties\n<p>departures &mdash; a list of departures.\n"},{"name":"Formation","full_name":"Ldbws::ResponseTypes::Formation","type":"class","path":"Ldbws/ResponseTypes/Formation.html","snippet":"<p>Information about the formation of a train\n<p>Properties\n<p>loading_category &mdash; how heavily-loaded the train is. …\n"},{"name":"LoadingCategory","full_name":"Ldbws::ResponseTypes::LoadingCategory","type":"class","path":"Ldbws/ResponseTypes/LoadingCategory.html","snippet":"<p>The loading category of a train\n<p>Properties\n<p>code, colour, image &mdash; \n"},{"name":"Location","full_name":"Ldbws::ResponseTypes::Location","type":"class","path":"Ldbws/ResponseTypes/Location.html","snippet":"<p>Represents a location in LDBWS.\n<p>Properties\n<p>name, crs, via &mdash; \n"},{"name":"ServiceDetails","full_name":"Ldbws::ResponseTypes::ServiceDetails","type":"class","path":"Ldbws/ResponseTypes/ServiceDetails.html","snippet":"<p>Represents details about a service in LDBWS.\n<p>Properties\n"},{"name":"ServiceItem","full_name":"Ldbws::ResponseTypes::ServiceItem","type":"class","path":"Ldbws/ResponseTypes/ServiceItem.html","snippet":"<p>Represents a service item in LDBWS.\n<p>Properties\n<p>sta &mdash; the scheduled arrival time as a Time object\n"},{"name":"ServiceItemWithCallingPoints","full_name":"Ldbws::ResponseTypes::ServiceItemWithCallingPoints","type":"class","path":"Ldbws/ResponseTypes/ServiceItemWithCallingPoints.html","snippet":"<p>Represents a service item with additional details in LDBWS: extends ServiceItem.\n<p>Properties\n<p>As ServiceItem …\n"},{"name":"StationBoard","full_name":"Ldbws::ResponseTypes::StationBoard","type":"class","path":"Ldbws/ResponseTypes/StationBoard.html","snippet":"<p>Represents a station arrival/departure board in LDBWS.\n<p>Properties\n<p>As BaseStationBoard, and additionally: …\n"},{"name":"StationBoardWithDetails","full_name":"Ldbws::ResponseTypes::StationBoardWithDetails","type":"class","path":"Ldbws/ResponseTypes/StationBoardWithDetails.html","snippet":"<p>Represents a station arrival/departure board with additional details in LDBWS.\n<p>Properties\n<p>As BaseStationBoard …\n"},{"name":"ToiletAvailability","full_name":"Ldbws::ResponseTypes::ToiletAvailability","type":"class","path":"Ldbws/ResponseTypes/ToiletAvailability.html","snippet":"<p>The availability of an individual toilet on a train\n<p>Properties\n<p>type &mdash; the type of toilet\n"},{"name":"Service","full_name":"Ldbws::Service","type":"class","path":"Ldbws/Service.html","snippet":"<p>A wrapper around the National Rail Live Departure Boards Webservice (LDBWS) API.\n<p>API methods are pretty …\n"},{"name":"new","full_name":"Ldbws::Service::new","type":"class_method","path":"Ldbws/Service.html#method-c-new","snippet":"<p>Creates a service object.\n<p>Parameters\n<p>token &mdash; the API token used to connect to the service\n"},{"name":"service","full_name":"Ldbws::service","type":"class_method","path":"Ldbws.html#method-c-service","snippet":"<p>Helper method that returns an instance of [Service].\n<p>Parameters\n<p>token &mdash; the API token used to connect to …\n"},{"name":"all_services","full_name":"Ldbws::ResponseTypes::BaseStationBoard#all_services","type":"instance_method","path":"Ldbws/ResponseTypes/BaseStationBoard.html#method-i-all_services","snippet":"<p>Returns a combined list of all services (train, bus, and ferry), ordered by scheduled time of departure …\n"},{"name":"details","full_name":"Ldbws::RequestError#details","type":"instance_method","path":"Ldbws/RequestError.html#method-i-details","snippet":"<p>Returns the details of the error as a hash.\n"},{"name":"get_arr_board_with_details","full_name":"Ldbws::Service#get_arr_board_with_details","type":"instance_method","path":"Ldbws/Service.html#method-i-get_arr_board_with_details","snippet":"<p>Retrieves a detailed station arrival board.\n<p>Parameters are validated using GetStationBoardWithDetails …\n"},{"name":"get_arr_dep_board_with_details","full_name":"Ldbws::Service#get_arr_dep_board_with_details","type":"instance_method","path":"Ldbws/Service.html#method-i-get_arr_dep_board_with_details","snippet":"<p>Retrieves a detailed station arrival + departures board.\n<p>Parameters are validated using GetStationBoardWithDetails …\n"},{"name":"get_arrival_board","full_name":"Ldbws::Service#get_arrival_board","type":"instance_method","path":"Ldbws/Service.html#method-i-get_arrival_board","snippet":"<p>Retrieves a station arrival board.\n<p>Parameters are validated using GetStationBoard, returns a StationBoard …\n"},{"name":"get_arrival_board_with_details","full_name":"Ldbws::Service#get_arrival_board_with_details","type":"instance_method","path":"Ldbws/Service.html#method-i-get_arrival_board_with_details"},{"name":"get_arrival_departure_board","full_name":"Ldbws::Service#get_arrival_departure_board","type":"instance_method","path":"Ldbws/Service.html#method-i-get_arrival_departure_board","snippet":"<p>Retrieves a station arrival + departure board.\n<p>Parameters are validated using GetStationBoard, returns …\n"},{"name":"get_arrival_departure_board_with_details","full_name":"Ldbws::Service#get_arrival_departure_board_with_details","type":"instance_method","path":"Ldbws/Service.html#method-i-get_arrival_departure_board_with_details"},{"name":"get_dep_board_with_details","full_name":"Ldbws::Service#get_dep_board_with_details","type":"instance_method","path":"Ldbws/Service.html#method-i-get_dep_board_with_details","snippet":"<p>Retrieves a detailed station departure board.\n<p>Parameters are validated using GetStationBoardWithDetails …\n"},{"name":"get_departure_board","full_name":"Ldbws::Service#get_departure_board","type":"instance_method","path":"Ldbws/Service.html#method-i-get_departure_board","snippet":"<p>Retrieves a station departure board.\n<p>Parameters are validated using GetStationBoard, returns a StationBoard …\n"},{"name":"get_departure_board_with_details","full_name":"Ldbws::Service#get_departure_board_with_details","type":"instance_method","path":"Ldbws/Service.html#method-i-get_departure_board_with_details"},{"name":"get_fastest_departures","full_name":"Ldbws::Service#get_fastest_departures","type":"instance_method","path":"Ldbws/Service.html#method-i-get_fastest_departures","snippet":"<p>Retrieves the fastest departures from one station to one or many others.\n<p>Parameters are validated using …\n"},{"name":"get_fastest_departures_with_details","full_name":"Ldbws::Service#get_fastest_departures_with_details","type":"instance_method","path":"Ldbws/Service.html#method-i-get_fastest_departures_with_details","snippet":"<p>Retrieves detailed information about the fastest departures from one station to one or many others.\n<p>Parameters …\n"},{"name":"get_next_departures","full_name":"Ldbws::Service#get_next_departures","type":"instance_method","path":"Ldbws/Service.html#method-i-get_next_departures","snippet":"<p>Retrieves the next departures from one station to one or many others.\n<p>Parameters are validated using  …\n"},{"name":"get_next_departures_with_details","full_name":"Ldbws::Service#get_next_departures_with_details","type":"instance_method","path":"Ldbws/Service.html#method-i-get_next_departures_with_details","snippet":"<p>Retrieves detailed information about the next departures from one station to one or many others.\n<p>Parameters …\n"},{"name":"get_service_details","full_name":"Ldbws::Service#get_service_details","type":"instance_method","path":"Ldbws/Service.html#method-i-get_service_details","snippet":"<p>Retrieves information about a specific service.\n<p>Parameters are validated using GetServiceDetails, returns …\n"},{"name":"messages","full_name":"Ldbws::Request::ParamValidationError#messages","type":"instance_method","path":"Ldbws/Request/ParamValidationError.html#method-i-messages","snippet":"<p>Returns the validation error messages as a hash.\n"}]};

data/doc/js/search_navigation.js

@@ -0,0 +1,105 @@
+/*
+ * SearchNavigation 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.
+ */
+SearchNavigation = new function() {
+  this.initNavigation = function() {
+    var _this = this;
+
+    document.addEventListener('keydown', function(e) {
+      _this.onkeydown(e);
+    });
+
+    this.navigationActive = true;
+  }
+
+  this.setNavigationActive = function(state) {
+    this.navigationActive = state;
+  }
+
+  this.onkeydown = function(e) {
+    if (!this.navigationActive) return;
+    switch(e.key) {
+      case 'ArrowLeft':
+        if (this.moveLeft()) e.preventDefault();
+        break;
+      case 'ArrowUp':
+        if (e.key == 'ArrowUp' || e.ctrlKey) {
+          if (this.moveUp()) e.preventDefault();
+        }
+        break;
+      case 'ArrowRight':
+        if (this.moveRight()) e.preventDefault();
+        break;
+      case 'ArrowDown':
+        if (e.key == 'ArrowDown' || e.ctrlKey) {
+          if (this.moveDown()) e.preventDefault();
+        }
+        break;
+      case 'Enter':
+        if (this.current) e.preventDefault();
+        this.select(this.current);
+        break;
+    }
+    if (e.ctrlKey && e.shiftKey) this.select(this.current);
+  }
+
+  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);
+    }
+  }
+}
+