options.tt

[% WRAPPER layout.tt title='Search NixOS options' menu='nixos' hideSearch=1 %]

<p>
  <input name='query' type='text' class='search-query span3'
         placeholder='Search by name or description'
         id='search' value='' autofocus='autofocus'/>
</p>

<hr />

<p><em id='how-many'>Loading…</em></p>

<div id='results-wrapper' class='hide'>

[% INCLUDE renderPager %]

<table class='table table-hover' id='search-results'>
  <thead>
    <tr>
      <th>Option name</th>
    </tr>
  </thead>
  <tbody>
  </tbody>
</table>

[% INCLUDE renderPager %]

</div>

<div id='details-template' class='search-details hide'>
  <table>
    <tr>
      <th>Description:</th>
      <td>
      <td class='description docbook'><em>Not given</em></td>
      </td>
    </tr>
    <tr>
      <th>Default value:</th>
      <td>
      <td class='default'><em>Not given</em></td>
      </td>
    </tr>
    <tr>
      <th>Type:</th>
      <td>
      <td class='type'><em>Not given</em></td>
      </td>
    </tr>
    <tr>
      <th>Example value:</th>
      <td>
      <td class='example'><em>Not given</em></td>
      </td>
    </tr>
    <tr>
      <th>Declared in:</th>
      <td>
      <td class='declared-in'><em>Unknown</em></td>
      </td>
    </tr>
  </table>
</div>

<script>
//<![CDATA[
var optionData = [];

var results = [];

var resultsPerPage = 15;

var curPage = 0;
var lastPage = 0;

function updateTable() {
  if (0 > curPage) curPage = 0;
  if (curPage > lastPage) curPage = lastPage;

  var body = $('#search-results tbody');
  $('tr', body).remove();

  $('.back').toggleClass('disabled', curPage == 0);
  $('.forward').toggleClass('disabled', curPage >= lastPage);

  var start = curPage * resultsPerPage;
  var end = start + resultsPerPage;
  if (end > results.length) end = results.length;
  res = results.slice(start, end);

  if (results.length == 0) {
    $('#results-wrapper').hide();
    $('#how-many').text('No matching options were found.');
    return;
  }

  $('#how-many').text(
    'Showing results ' + (start + 1) + '-' + end + ' of ' + results.length + '.');

  var odd = true;
  res.forEach(function(optName) {
    var opt = optionData[optName];
    body.append($('<tr/>', { optName: optName })
      .addClass('result')
      .addClass(odd ? 'odd' : 'even')
      .click(showOption)
      .append($('<td/>', { class: 'option' }).append($('<a/>', { text: optName })))

    );
    odd = !odd;
  });

  $('#results-wrapper').show();
};

function refilter() {
  var options = Object.keys(optionData);

  results = options;

  var words = $('#search').val().toLowerCase().split(/ +/).filter(Boolean);

  if (words.length > 0) {
    results = results.filter(function (optName) {
      var opt = optionData[optName];
      function match(word) {
        return (optName.toLowerCase().indexOf(word) != -1
          || (opt.description || '').toLowerCase().indexOf(word) != -1);
      };

      return words.every(match);
    });

    var encodedWords = words.map(function(value) {
      return encodeURIComponent(value);
    });
    var hash = encodedWords.join('+');
    while (document.getElementById(hash)) {
      hash = '+' + hash;
    }
    history.replaceState({}, '', '#' + hash);
  } else {
    history.replaceState({}, '', '#');
  }

  curPage = 0;
  lastPage = (results.length - 1) / resultsPerPage >> 0;

  updateTable();
};

// This function is used for pretty printing Nix values which have been
// exported into JSON, and read as JavaScript objects.  Nix is exported to
// JSON, but JavaScript has terrible serialisation of its internal values.
function ppNix(indent, v) {
  var len = 0;
  var outerIndent = indent;
  indent += "  ";

  function ppRec(v) {
    return ppNix(indent, v)
  }
  function ppIndent(i, firstLine) {
    return i ? indent : firstLine;
  }
  function ppNL(i) {
    return len <= i ? ' ' : '\n';
  }
  function needIndentation(v) {
    if (v == null) return false;
    if (typeof v == "object") {
      if (Array.isArray(v)) {
        if (v.some(needIndentation))
          return true;
        return false;
      }
      if (Object.keys(v).some(propNeedIndentation(v)))
        return true;
      return false;
    }
    if (typeof v == "string")
      return v.indexOf('"') != -1 || v.indexOf('\n') != -1;
    return false;
  }
  function propNeedIndentation(obj) {
    return function (key) {
      return needIndentation(obj[key]);
    }
  }

  if (v == null) return "null";

  // JavaScript consider both objects and arrays as objects.
  if (typeof v == "object") {

    if (Array.isArray(v)) {
      len = v.length;
      // If none of the element inside it need to have indentation levels, then
      // we can just print the whole array on one line.
      if (!v.some(needIndentation)) {
        if (len == 0)
          return '[]';
        var res = '[ ';
        for (var i = 0; i < v.length; i++)
          res += ppNix(indent, v[i]) + ' ';
        return res + ']';
      }

      // Print an array on multiple lines as it contains some complex elements.
      var res = '[';
      for (var i = 0; i < v.length; i++)
        res += ppIndent(i, ' ') + ppNix(indent, v[i]) + ppNL(1);
      return res + ']';
    }

    // Some example attribute are using the literalExample function to wrap
    // their content as it cannot be serialize properly. So if we detect such
    // example, escape characters and return the text without pretty-printing.
    if (v._type == "literalExample") {
      v = ((v.text || '') + '');
      return v;
    }

    // Print an attribute set.  Always indent the first line
    var attrset = Object.keys(v);
    len = attrset.length;
    if (!attrset.some(propNeedIndentation(v))) {
      var res = '{ ';
      for (var i = 0; i < len; i++) {
        var attrName = attrset[i];
        var value = v[attrName];
        res += attrName + ' = ';
        res += ppNix(indent, value);
        res += '; ';
      }
      return res + '}'
    }

    var res = '{\n';
    for (var i = 0; i < len; i++) {
      var attrName = attrset[i];
      var value = v[attrName];
      var ni = needIndentation(value);
      res += indent;
      res += attrName + ' =' + (ni ? '\n' + indent + '  ' : ' ')
      res += ppNix(indent + '  ', value);
      res += ';\n';
    }
    return res + outerIndent + '}';
  }

  if (typeof v == "string") {
    if (v.indexOf('"') == -1 && v.indexOf('\n') == -1) {
      if (/^pkgs\./.test(v))
        return '' + v;
      return '"' + v + '"';
    }
    var lines = v.split('\n');
    var res = "''\n";
    for (var i = 0; i < lines.length; i++)
      res += indent + lines[i] + '\n';
    return res + outerIndent + "''";
  }

  return '' + v;
}

function showOption() {
  var optName = $(this).attr('optName');
  var opt = optionData[optName];

  var expanded = $(this).attr('expanded');
  $('tr.details', $(this).parent()).remove();
  $('tr', $(this).parent()).removeAttr('expanded');
  if (expanded) return;

  var details = $('#details-template').clone().removeAttr('id').show();

  // Parses the XML fragment
  var x = $.parseXML('<xml xmlns:xlink="http://www.w3.org/1999/xlink"><para>' + opt.description + '</para></xml>');

  // For each xlink, replace with equivalent `<a>`.
  $(x).find("link").each(function (i, el) {
    var link = $(el).attr("xlink:href");
    var inner = el.innerHTML;
    if (inner === "" || !inner) {
      inner = link;
    }
    $($("<a></a>").html(inner).attr("href", link)).replaceAll(el);
  });

  // For each [filename], replace with equivalent `<tt>`.
  $(x).find("filename").each(function (i, el) {
    var inner = el.innerHTML;
    $($("<tt></tt>").html(inner)).replaceAll(el);
  });

  // For each [option, literal], replace with equivalent `<code>`.
  $(x).find("option, literal").each(function (i, el) {
    var inner = el.innerHTML;
    $($("<code></code>").html(inner)).replaceAll(el);
  });

  // Fixes manpage references.
  $(x).find("citerefentry manvolnum").each(function (i, el) {
	var el = $(el).parent();
	var title = el.children("refentrytitle")[0].innerHTML;
	var volnum = el.children("manvolnum")[0].innerHTML;
    $($("<tt class='man_page'></tt>").html(title + "(" + volnum + ")")).replaceAll(el);
  });

  // Since `<para>` can be inside a `<para>`, we have to do this ugly loop.
  // Well, unless someone else has something more elegant.
  var paras = []
  while ((paras = $(x).find("para")).length > 0) {
    paras.each(function (i, el) {
      var inner = el.innerHTML;
      $($("<p></p>").html(inner)).replaceAll(el);
    });
  }

  // For each [option, literal], replace with equivalent `<code>`.
  $(x).find("important").each(function (i, el) {
    var inner = el.innerHTML;
    $($("<div class='docbook-important'></div>").html(inner)).replaceAll(el);
  });

  $('.description', details).empty().append($(x).contents());

  if ('default' in opt)
    $('.default', details).empty().addClass('pre').text(ppNix('', opt.default));

  if ('type' in opt)
    $('.type', details).empty().addClass('pre').text(opt.type);

  if ('example' in opt)
    $('.example', details).empty().addClass('pre').text(ppNix('', opt.example));

  if (opt.declarations.length > 0) {
    var res = $('.declared-in', details);
    res.empty();
    var first = true;
    opt.declarations.forEach(function(module) {
      var url = "https://github.com/NixOS/nixpkgs/tree/[%latestNixOSBranch%]/" + module;
      if (!first) res.append(', '); first = false;
      res.append($('<a/>', { href: url }).append($('<tt/>').text(module)));
    });
  }

  $(this).after($('<tr/>')
    .addClass('details')
    .append($('<td/>', { colspan: 3 })
      .append(details))
  ).attr('expanded', 1);
};

$.ajax({
  url: 'https://channels.nixos.org/nixos-[%latestNixOSSeries%]/options.json.br',
  type: 'GET',
  dataType: 'json',
  error: function(a, b, c) { alert('Failed to get option data.'); },
  success: function(data) {
    optionData = data;

    var lastHash;
    var hashChanged = true;

    function updateQuery() {
      var query = decodeURIComponent(document.location.hash.replace(/^#\+*/, '').replace(/\+/g, ' '));
      if (query.length && query.length > 0 ){ $('#search').val(query); } else { $('#search').val('') };
      refilter();
      lastHash = location.hash || '#';
    }

    $(window).on('popstate', updateQuery);

    updateQuery();

    $('#search').on('input', function() {
      if (hashChanged) {
        history.pushState({}, '', location.hash || '#');
        hashChanged = false;
      }
      refilter();
    });
    $('#search').on('change', function() {
      var hash = location.hash || '#';
      if (lastHash != hash) {
        hashChanged = true;
        lastHash = hash;
      }
    });
  }
});

//]]>
</script>

[% END %]