Fix a few warnings from the IDE

This commit is contained in:
mossroy 2013-07-27 14:57:36 +02:00
parent 86c2fe532d
commit e3ef342e2e
2 changed files with 49 additions and 13 deletions

View File

@ -47,7 +47,7 @@ define(function(require) {
storage = navigator.getDeviceStorage('sdcard'); storage = navigator.getDeviceStorage('sdcard');
} }
if (storage != null) { if (storage !== null) {
// If DeviceStorage is available, we look for archives in it // If DeviceStorage is available, we look for archives in it
$('#scanningForArchives').show(); $('#scanningForArchives').show();
evopedia.LocalArchive.scanForArchives(storage, populateDropDownListOfArchives); evopedia.LocalArchive.scanForArchives(storage, populateDropDownListOfArchives);
@ -73,6 +73,7 @@ define(function(require) {
/** /**
* Populate the drop-down list of titles with the given list * Populate the drop-down list of titles with the given list
* @param {type} archiveDirectories
*/ */
function populateDropDownListOfArchives(archiveDirectories) { function populateDropDownListOfArchives(archiveDirectories) {
$('#scanningForArchives').hide(); $('#scanningForArchives').hide();
@ -128,6 +129,8 @@ define(function(require) {
/** /**
* Handle key input in the prefix input zone * Handle key input in the prefix input zone
* @param {type} evt
* @returns {undefined}
*/ */
function onKeyUpPrefix(evt) { function onKeyUpPrefix(evt) {
// Use a timeout, so that very quick typing does not cause a lot of overhead // Use a timeout, so that very quick typing does not cause a lot of overhead
@ -142,6 +145,7 @@ define(function(require) {
/** /**
* Search the index for titles that start with the given prefix (implemented * Search the index for titles that start with the given prefix (implemented
* with a binary search inside the index file) * with a binary search inside the index file)
* @param {type} prefix
*/ */
function searchTitlesFromPrefix(prefix) { function searchTitlesFromPrefix(prefix) {
$('#searchingForTitles').show(); $('#searchingForTitles').show();
@ -157,6 +161,7 @@ define(function(require) {
/** /**
* Display the list of titles with the given array of titles * Display the list of titles with the given array of titles
* @param {type} titleArray
*/ */
function populateListOfTitles(titleArray) { function populateListOfTitles(titleArray) {
var titleListUl = $('#titleList'); var titleListUl = $('#titleList');
@ -195,6 +200,7 @@ define(function(require) {
/** /**
* Creates an instance of title from given titleId (including resolving redirects), * Creates an instance of title from given titleId (including resolving redirects),
* and call the function to read the corresponding article * and call the function to read the corresponding article
* @param {type} titleId
*/ */
function findTitleFromTitleIdAndLaunchArticleRead(titleId) { function findTitleFromTitleIdAndLaunchArticleRead(titleId) {
if (localArchive.dataFiles && localArchive.dataFiles.length > 0) { if (localArchive.dataFiles && localArchive.dataFiles.length > 0) {
@ -202,7 +208,7 @@ define(function(require) {
$("#articleName").html(title.name); $("#articleName").html(title.name);
$("#readingArticle").show(); $("#readingArticle").show();
$("#articleContent").html(""); $("#articleContent").html("");
if (title.fileNr == 255) { if (title.fileNr === 255) {
localArchive.resolveRedirect(title, readArticle); localArchive.resolveRedirect(title, readArticle);
} }
else { else {
@ -216,11 +222,12 @@ define(function(require) {
/** /**
* Read the article corresponding to the given title * Read the article corresponding to the given title
* @param {type} title
*/ */
function readArticle(title) { function readArticle(title) {
if ($.isArray(title)) { if ($.isArray(title)) {
title = title[0]; title = title[0];
if (title.fileNr == 255) { if (title.fileNr === 255) {
localArchive.resolveRedirect(title, readArticle); localArchive.resolveRedirect(title, readArticle);
return; return;
} }
@ -231,6 +238,8 @@ define(function(require) {
/** /**
* Display the the given HTML article in the web page, * Display the the given HTML article in the web page,
* and convert links to javascript calls * and convert links to javascript calls
* @param {type} title
* @param {type} htmlArticle
*/ */
function displayArticleInForm(title, htmlArticle) { function displayArticleInForm(title, htmlArticle) {
$("#readingArticle").hide(); $("#readingArticle").hide();
@ -310,6 +319,7 @@ define(function(require) {
/** /**
* Changes the URL of the browser page * Changes the URL of the browser page
* @param {type} titleName
*/ */
function pushBrowserHistoryState(titleName) { function pushBrowserHistoryState(titleName) {
if (titleName) { if (titleName) {
@ -321,6 +331,8 @@ define(function(require) {
/** /**
* Replace article content with the one of the given title * Replace article content with the one of the given title
* @param {type} titleName
* @returns {undefined}
*/ */
function goToArticle(titleName) { function goToArticle(titleName) {
$("#articleName").html(titleName); $("#articleName").html(titleName);

View File

@ -10,6 +10,9 @@ define(function(require) {
/** /**
* Read an integer encoded in 4 bytes * Read an integer encoded in 4 bytes
* @param {type} byteArray
* @param {type} firstIndex
* @returns {Number}
*/ */
function readIntegerFrom4Bytes(byteArray, firstIndex) { function readIntegerFrom4Bytes(byteArray, firstIndex) {
return byteArray[firstIndex] + byteArray[firstIndex + 1] * 256 + byteArray[firstIndex + 2] * 65536 + byteArray[firstIndex + 3] * 16777216; return byteArray[firstIndex] + byteArray[firstIndex + 1] * 256 + byteArray[firstIndex + 2] * 65536 + byteArray[firstIndex + 3] * 16777216;
@ -17,13 +20,18 @@ define(function(require) {
/** /**
* Read an integer encoded in 2 bytes * Read an integer encoded in 2 bytes
* @param {type} byteArray
* @param {type} firstIndex
* @returns {Number}
*/ */
function readIntegerFrom2Bytes(byteArray, firstIndex) { function readIntegerFrom2Bytes(byteArray, firstIndex) {
return byteArray[firstIndex] + byteArray[firstIndex + 1] * 256; return byteArray[firstIndex] + byteArray[firstIndex + 1] * 256;
} }
/** /**
* Convert a Uint8Array to a lowercase hex string. * Convert a Uint8Array to a lowercase hex string
* @param {type} byteArray
* @returns {String}
*/ */
function uint8ArrayToHex(byteArray) { function uint8ArrayToHex(byteArray) {
var s = ''; var s = '';
@ -37,7 +45,9 @@ define(function(require) {
} }
/** /**
* Convert a Uint8Array to base64. * Convert a Uint8Array to base64
* @param {type} byteArray
* @returns {String}
*/ */
function uint8ArrayToBase64(byteArray) { function uint8ArrayToBase64(byteArray) {
var b64 = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/="; var b64 = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=";
@ -453,7 +463,7 @@ define(function(require) {
for (i = 0; i < titleList.length; i++) { for (i = 0; i < titleList.length; i++) {
var titleName = titleList[i].name; var titleName = titleList[i].name;
var normalizedTitleName = normalize_string.normalizeString(titleName); var normalizedTitleName = normalize_string.normalizeString(titleName);
if (normalizedTitleName.length < normalizedPrefix.length || normalizedTitleName.substring(0, normalizedPrefix.length) != normalizedPrefix) { if (normalizedTitleName.length < normalizedPrefix.length || normalizedTitleName.substring(0, normalizedPrefix.length) !== normalizedPrefix) {
break; break;
} }
} }
@ -596,10 +606,15 @@ define(function(require) {
}; };
reader.readAsArrayBuffer(blob); reader.readAsArrayBuffer(blob);
}); });
} };
/** /**
* Recursive algorithm to find the position of the Math image in the data file * Recursive algorithm to find the position of the Math image in the data file
* @param {type} hexString
* @param {type} lo
* @param {type} hi
* @param {type} callbackFunction
*/ */
LocalArchive.prototype.findMathDataPosition = function(hexString, lo, hi, callbackFunction) { LocalArchive.prototype.findMathDataPosition = function(hexString, lo, hi, callbackFunction) {
var entrySize = 16 + 4 + 4; var entrySize = 16 + 4 + 4;
@ -651,12 +666,12 @@ define(function(require) {
var binaryTitleFile = e.target.result; var binaryTitleFile = e.target.result;
var byteArray = new Uint8Array(binaryTitleFile); var byteArray = new Uint8Array(binaryTitleFile);
if (byteArray.length == 0) { if (byteArray.length === 0) {
throw "Unable to find redirected article : offset " + title.blockStart + " not found in title file"; throw "Unable to find redirected article : offset " + title.blockStart + " not found in title file";
} }
var redirectedTitle = title; var redirectedTitle = title;
redirectedTitle.fileNr = byteArray[2]; redirectedTitle.fileNr = 1 * byteArray[2];
redirectedTitle.blockStart = readIntegerFrom4Bytes(byteArray, 3); redirectedTitle.blockStart = readIntegerFrom4Bytes(byteArray, 3);
redirectedTitle.blockOffset = readIntegerFrom4Bytes(byteArray, 7); redirectedTitle.blockOffset = readIntegerFrom4Bytes(byteArray, 7);
redirectedTitle.articleLength = readIntegerFrom4Bytes(byteArray, 11); redirectedTitle.articleLength = readIntegerFrom4Bytes(byteArray, 11);
@ -680,7 +695,7 @@ define(function(require) {
var cursor = storage.enumerate(); var cursor = storage.enumerate();
cursor.onerror = function() { cursor.onerror = function() {
alert("Error scanning directory sd-card : " + cursor.error); alert("Error scanning directory sd-card : " + cursor.error);
} };
cursor.onsuccess = function() { cursor.onsuccess = function() {
if (cursor.result) { if (cursor.result) {
var file = cursor.result; var file = cursor.result;
@ -736,9 +751,13 @@ define(function(require) {
/** /**
* Creates a Title instance from an encoded title line from a title file * Creates a Title instance from an encoded title line from a title file
* @param {type} encodedTitle
* @param {type} archive
* @param {type} titleOffset
* @returns {_L1.Title}
*/ */
Title.parseTitle = function(encodedTitle, archive, titleOffset) { Title.parseTitle = function(encodedTitle, archive, titleOffset) {
if (archive == null) { if (archive === null) {
throw "archive cannot be null"; throw "archive cannot be null";
} }
if (titleOffset < 0) { if (titleOffset < 0) {
@ -748,7 +767,7 @@ define(function(require) {
t.archive = archive; t.archive = archive;
t.titleOffset = titleOffset; t.titleOffset = titleOffset;
if (encodedTitle == null || encodedTitle.length < 15) if (encodedTitle === null || encodedTitle.length < 15)
return null; return null;
if (encodedTitle[encodedTitle.length - 1] == '\n') { if (encodedTitle[encodedTitle.length - 1] == '\n') {
@ -766,7 +785,7 @@ define(function(require) {
escapedEncodedTitle[i + 2] = 10; // Corresponds to \n escapedEncodedTitle[i + 2] = 10; // Corresponds to \n
} }
t.fileNr = escapedEncodedTitle[2]; t.fileNr = 1 * escapedEncodedTitle[2];
t.blockStart = readIntegerFrom4Bytes(escapedEncodedTitle, 3); t.blockStart = readIntegerFrom4Bytes(escapedEncodedTitle, 3);
t.blockOffset = readIntegerFrom4Bytes(escapedEncodedTitle, 7); t.blockOffset = readIntegerFrom4Bytes(escapedEncodedTitle, 7);
t.articleLength = readIntegerFrom4Bytes(escapedEncodedTitle, 11); t.articleLength = readIntegerFrom4Bytes(escapedEncodedTitle, 11);
@ -792,6 +811,9 @@ define(function(require) {
/** /**
* Creates a title instance from a serialized id * Creates a title instance from a serialized id
* @param {type} localArchive
* @param {type} titleId
* @returns {_L1.Title}
*/ */
Title.parseTitleId = function(localArchive, titleId) { Title.parseTitleId = function(localArchive, titleId) {
var title = new Title(); var title = new Title();
@ -825,6 +847,8 @@ define(function(require) {
/** /**
* ErrorHandler for FileReader * ErrorHandler for FileReader
* @param {type} evt
* @returns {undefined}
*/ */
function errorHandler(evt) { function errorHandler(evt) {
switch (evt.target.error.code) { switch (evt.target.error.code) {