Skip to content

Commit

Permalink
Completed patch searching for rust docs
Browse files Browse the repository at this point in the history 
Made temporary changes to include multiple keywords in rustdoc search

Implemented search based on multiple keywords

Added some commenting and house cleaning

Added path searching to rustdoc
  • Loading branch information
b1nd committed Jan 14, 2014
1 parent ff3d5d4 commit 9a45c9d
Showing 1 changed file with 125 additions and 49 deletions.
174 changes: 125 additions & 49 deletions src/librustdoc/html/static/main.js
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2013 The Rust Project Developers. See the COPYRIGHT
// Copyright 2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
Expand All @@ -11,7 +11,7 @@
/*jslint browser: true, es5: true */
/*globals $: true, searchIndex: true, rootPath: true, allPaths: true */

(function () {
(function() {
"use strict";
var resizeTimeout, interval;

Expand All @@ -21,9 +21,9 @@
if (resizeTimeout) {
clearTimeout(resizeTimeout);
}
resizeTimeout = setTimeout(function () {
resizeTimeout = setTimeout(function() {
var contentWidth = $('.content').width();
$('.docblock.short').width(function () {
$('.docblock.short').width(function() {
return contentWidth - 40 - $(this).prev().width();
}).addClass('nowrap');
}, 150);
Expand All @@ -50,7 +50,7 @@
highlightSourceLines();
$(window).on('hashchange', highlightSourceLines);

$(document).on('keyup', function (e) {
$(document).on('keyup', function(e) {
if (document.activeElement.tagName === 'INPUT') {
return;
}
Expand All @@ -71,13 +71,13 @@
e.preventDefault();
$('.search-input').focus();
}
}).on('click', function (e) {
}).on('click', function(e) {
if (!$(e.target).closest('#help').length) {
$('#help').addClass('hidden');
}
});

$('.version-selector').on('change', function () {
$('.version-selector').on('change', function() {
var i, match,
url = document.location.href,
stripped = '',
Expand All @@ -102,13 +102,29 @@
// clear cached values from the search bar
$(".search-input")[0].value = '';

/**
* Executes the query and builds an index of results
* @param {[Object]} query [The user query]
* @param {[type]} max [The maximum results returned]
* @param {[type]} searchWords [The list of search words to query against]
* @return {[type]} [A search index of results]
*/
function execQuery(query, max, searchWords) {
var valLower = query.query.toLowerCase(),
val = valLower,
typeFilter = query.type,
results = [],
aa = 0,
bb = 0;
bb = 0,
split = valLower.split("::");

//remove empty keywords
for (var j = 0; j < split.length; j++) {
split[j].toLowerCase();
if (split[j] === "") {
split.splice(j, 1);
}
}

// quoted values mean literal search
bb = searchWords.length;
Expand All @@ -128,31 +144,41 @@
} else {
// gather matching search results up to a certain maximum
val = val.replace(/\_/g, "");
for (aa = 0; aa < bb; aa += 1) {
if (searchWords[aa].indexOf(val) > -1 || searchWords[aa].replace(/_/g, "").indexOf(val) > -1) {
// filter type: ... queries
if (!typeFilter || typeFilter === searchIndex[aa].ty) {
results.push([aa, searchWords[aa].replace(/_/g, "").indexOf(val)]);
for (var i = 0; i < split.length; i++) {
for (aa = 0; aa < bb; aa += 1) {
if (searchWords[aa].indexOf(split[i]) > -1 || searchWords[aa].indexOf(val) > -1 || searchWords[aa].replace(/_/g, "").indexOf(val) > -1) {
// filter type: ... queries
if (!typeFilter || typeFilter === searchIndex[aa].ty) {
results.push([aa, searchWords[aa].replace(/_/g, "").indexOf(val)]);
}
}
if (results.length === max) {
break;
}
}
if (results.length === max) {
break;
}
}
}

bb = results.length;
for (aa = 0; aa < bb; aa += 1) {
results[aa].push(searchIndex[results[aa][0]].ty);
}
for (aa = 0; aa < bb; aa += 1) {
results[aa].push(searchIndex[results[aa][0]].path);
results[aa].push(searchIndex[results[aa][0]].name);
results[aa].push(searchIndex[results[aa][0]].parent);
}

// if there are no results then return to default and fail
if (results.length === 0) {
return [];
}

results.forEach(function(item) {
for (var i = 0; i < split.length; i++) {
if (item[3].indexOf(split[i]) === -1) {
item = null;
break;
}
}
});
// sort by exact match
results.sort(function search_complete_sort0(aaa, bbb) {
if (searchWords[aaa[0]] === valLower && searchWords[bbb[0]] !== valLower) {
Expand Down Expand Up @@ -203,10 +229,58 @@
results[aa][0] = -1;
}
}

for (var i = 0; i < results.length; i++) {
var result = results[i],
name = result[4].toLowerCase(),
path = result[3].toLowerCase(),
parent = allPaths[result[5]];

var valid = validateResult(name, path, split, parent);
if (!valid) {
result[0] = -1;
}
}
return results;
}

/**
* Validate performs the following boolean logic. For example: "File::open" will give
* IF A PARENT EXISTS => ("file" && "open") exists in (name || path || parent)
* OR => ("file" && "open") exists in (name || path )
*
* This could be written functionally, but I wanted to minimise functions on stack.
* @param {[string]} name [The name of the result]
* @param {[string]} path [The path of the result]
* @param {[string]} keys [The keys to be used (["file", "open"])]
* @param {[object]} parent [The parent of the result]
* @return {[boolean]} [Whether the result is valid or not]
*/
function validateResult(name, path, keys, parent) {
//initially valid
var validate = true;
//if there is a parent, then validate against parent
if (parent !== undefined) {
for (var i = 0; i < keys.length; i++) {
// if previous keys are valid and current key is in the path, name or parent
if ((validate) && (name.toLowerCase().indexOf(keys[i]) > -1 || path.toLowerCase().indexOf(keys[i]) > -1 || parent.name.toLowerCase().indexOf(keys[i]) > -1)) {
validate = true;
} else {
validate = false;
}
}
} else {
for (var i = 0; i < keys.length; i++) {
// if previous keys are valid and current key is in the path, name
if ((validate) && (name.toLowerCase().indexOf(keys[i]) > -1 || path.toLowerCase().indexOf(keys[i]) > -1)) {
validate = true;
} else {
validate = false;
}
}
}
return validate;
}

function getQuery() {
var matches, type, query = $('.search-input').val();

Expand All @@ -226,25 +300,25 @@
function initSearchNav() {
var hoverTimeout, $results = $('.search-results .result');

$results.on('click', function () {
$results.on('click', function() {
var dst = $(this).find('a')[0];
console.log(window.location.pathname, dst.pathname);
if (window.location.pathname == dst.pathname) {
$('#search').addClass('hidden');
$('#main').removeClass('hidden');
}
document.location.href = dst.href;
}).on('mouseover', function () {
}).on('mouseover', function() {
var $el = $(this);
clearTimeout(hoverTimeout);
hoverTimeout = setTimeout(function () {
hoverTimeout = setTimeout(function() {
$results.removeClass('highlighted');
$el.addClass('highlighted');
}, 20);
});

$(document).off('keypress.searchnav');
$(document).on('keypress.searchnav', function (e) {
$(document).on('keypress.searchnav', function(e) {
var $active = $results.filter('.highlighted');

if (e.keyCode === 38) { // up
Expand Down Expand Up @@ -282,7 +356,7 @@
if (results.length > 0) {
shown = [];

results.forEach(function (item) {
results.forEach(function(item) {
var name, type;

if (shown.indexOf(item) !== -1) {
Expand All @@ -298,55 +372,57 @@
if (type === 'mod') {
output += item.path +
'::<a href="' + rootPath +
item.path.replace(/::/g, '/') + '/' +
name + '/index.html" class="' +
type + '">' + name + '</a>';
item.path.replace(/::/g, '/') + '/' +
name + '/index.html" class="' +
type + '">' + name + '</a>';
} else if (type === 'static' || type === 'reexport') {
output += item.path +
'::<a href="' + rootPath +
item.path.replace(/::/g, '/') +
'/index.html" class="' + type +
'">' + name + '</a>';
item.path.replace(/::/g, '/') +
'/index.html" class="' + type +
'">' + name + '</a>';
} else if (item.parent !== undefined) {
var myparent = allPaths[item.parent];
var anchor = '#' + type + '.' + name;
output += item.path + '::' + myparent.name +
'::<a href="' + rootPath +
item.path.replace(/::/g, '/') +
'/' + myparent.type +
'.' + myparent.name +
'.html' + anchor +
'" class="' + type +
'">' + name + '</a>';
item.path.replace(/::/g, '/') +
'/' + myparent.type +
'.' + myparent.name +
'.html' + anchor +
'" class="' + type +
'">' + name + '</a>';
} else {
output += item.path +
'::<a href="' + rootPath +
item.path.replace(/::/g, '/') +
'/' + type +
'.' + name +
'.html" class="' + type +
'">' + name + '</a>';
item.path.replace(/::/g, '/') +
'/' + type +
'.' + name +
'.html" class="' + type +
'">' + name + '</a>';
}

output += '</td><td><span class="desc">' + item.desc +
'</span></td></tr>';
'</span></td></tr>';
});
} else {
output += 'No results :( <a href="https://duckduckgo.com/?q=' +
encodeURIComponent('rust ' + query.query) +
'">Try on DuckDuckGo?</a>';
encodeURIComponent('rust ' + query.query) +
'">Try on DuckDuckGo?</a>';
}

output += "</p>";
$('#main.content').addClass('hidden');
$('#search.content').removeClass('hidden').html(output);
$('#search .desc').width($('#search').width() - 40 -
$('#search td:first-child').first().width());
$('#search td:first-child').first().width());
initSearchNav();
}

function search(e) {
var query, filterdata = [], obj, i, len,
var query,
filterdata = [],
obj, i, len,
results = [],
maxResults = 200,
resultIndex;
Expand Down Expand Up @@ -464,7 +540,7 @@
function startSearch() {
var keyUpTimeout;
$('.do-search').on('click', search);
$('.search-input').on('keyup', function () {
$('.search-input').on('keyup', function() {
clearTimeout(keyUpTimeout);
keyUpTimeout = setTimeout(search, 100);
});
Expand All @@ -475,4 +551,4 @@
}

initSearch(searchIndex);
}());
}());

5 comments on commit 9a45c9d

@bors
Copy link
Contributor

@bors bors commented on 9a45c9d Jan 14, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

saw approval from alexcrichton
at https://github.com/b1nd/rust/commit/9a45c9d7c6928743f9e7a7161bf564a65bfc0577

@bors
Copy link
Contributor

@bors bors commented on 9a45c9d Jan 14, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

merging b1nd/rust/rust-doc = 9a45c9d into auto

@bors
Copy link
Contributor

@bors bors commented on 9a45c9d Jan 14, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

b1nd/rust/rust-doc = 9a45c9d merged ok, testing candidate = 9dbbfb8

@bors
Copy link
Contributor

@bors bors commented on 9a45c9d Jan 14, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

all tests pass:
success: http://buildbot.rust-lang.org/builders/auto-mac-32-opt/builds/3547
success: http://buildbot.rust-lang.org/builders/auto-mac-32-nopt-c/builds/1389
success: http://buildbot.rust-lang.org/builders/auto-mac-32-nopt-t/builds/1393
success: http://buildbot.rust-lang.org/builders/auto-mac-64-opt/builds/3549
success: http://buildbot.rust-lang.org/builders/auto-mac-64-nopt-c/builds/2650
success: http://buildbot.rust-lang.org/builders/auto-mac-64-nopt-t/builds/2655
success: http://buildbot.rust-lang.org/builders/auto-linux-32-opt/builds/3565
success: http://buildbot.rust-lang.org/builders/auto-linux-32-nopt-c/builds/2653
success: http://buildbot.rust-lang.org/builders/auto-linux-32-nopt-t/builds/2659
success: http://buildbot.rust-lang.org/builders/auto-linux-64-opt/builds/3567
success: http://buildbot.rust-lang.org/builders/auto-linux-64-nopt-c/builds/2653
success: http://buildbot.rust-lang.org/builders/auto-linux-64-nopt-t/builds/2658
success: http://buildbot.rust-lang.org/builders/auto-linux-64-x-android/builds/2727
success: http://buildbot.rust-lang.org/builders/auto-win-32-opt/builds/3555
success: http://buildbot.rust-lang.org/builders/auto-win-32-nopt-c/builds/2657
success: http://buildbot.rust-lang.org/builders/auto-win-32-nopt-t/builds/2661
success: http://buildbot.rust-lang.org/builders/auto-bsd-64-opt/builds/3328

@bors
Copy link
Contributor

@bors bors commented on 9a45c9d Jan 14, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fast-forwarding master to auto = 9dbbfb8

Please sign in to comment.