yetangitu/epub.js
1
0
Fork 0
mirror of https://github.com/futurepress/epub.js.git synced 2025-10-04 15:09:16 +02:00
Code Issues Releases Wiki Activity

New queue function passes along promises with goto eventss

Browse source
This commit is contained in:
fchasen 2014-02-11 15:58:44 -08:00
parent b6ee097965
commit 02a9a4b566
15 changed files with 894 additions and 362 deletions
Download patch file Download diff file Expand all files Collapse all files

472
build/epub.js
View file

@ -1851,6 +1851,7 @@ EPUBJS.Book = function(options){
this.ready.toc.promise
];
this.pageList = [];
this.pagination = new EPUBJS.Pagination();
this.pageListReady = this.ready.pageList.promise;
@ -1858,10 +1859,15 @@ EPUBJS.Book = function(options){
this.ready.all.then(this._ready.bind(this));
this._q = [];
// Queue for methods used before rendering
this.isRendered = false;
this._q = EPUBJS.core.queue(this);
// Queue for rendering
this._rendering = false;
this._displayQ = [];
this._displayQ = EPUBJS.core.queue(this);
// Queue for going to another location
this._moving = false;
this._gotoQ = EPUBJS.core.queue(this);
/**
* Creates a new renderer.
@ -2025,8 +2031,8 @@ EPUBJS.Book.prototype.unpack = function(packageXml){
then(function(navHtml){
return parse.pageList(navHtml, book.spineIndexByURL, book.spine);
}).then(function(pageList){
book.pageList = book.contents.pageList = pageList;
if(pageList.length) {
book.pageList = book.contents.pageList = pageList;
book.pagination.process(book.pageList);
book.ready.pageList.resolve(book.pageList);
}
@ -2063,6 +2069,9 @@ EPUBJS.Book.prototype.createHiddenRender = function(renderer, _width, _height) {
hiddenEl = document.createElement("div");
hiddenEl.style.visibility = "hidden";
hiddenEl.style.overflow = "hidden";
hiddenEl.style.width = "0";
hiddenEl.style.height = "0";
this.element.appendChild(hiddenEl);
renderer.initialize(hiddenEl, width, height);
@ -2090,8 +2099,8 @@ EPUBJS.Book.prototype.generatePageList = function(width, height){
spinePos = next;
chapter = new EPUBJS.Chapter(this.spine[spinePos], this.store);
pager.displayChapter(chapter, this.globalLayoutProperties).then(function(){
var nextPage = pager.nextPage();
pager.displayChapter(chapter, this.globalLayoutProperties).then(function(chap){
var nextPage = true;//pager.nextPage();
// Page though the entire chapter
while (nextPage) {
nextPage = pager.nextPage();
@ -2144,10 +2153,7 @@ EPUBJS.Book.prototype.loadPagination = function(pagelistJSON) {
if(pageList && pageList.length) {
this.pageList = pageList;
this.pagination.process(this.pageList);
// Wait for book contents to load before resolving
this.ready.all.then(function(){
this.ready.pageList.resolve(this.pageList);
}.bind(this));
this.ready.pageList.resolve(this.pageList);
}
return this.pageList;
};
@ -2201,8 +2207,23 @@ EPUBJS.Book.prototype.listenToRenderer = function(renderer){
"page": page,
"percentage": percent
});
// TODO: Add event for first and last page.
// (though last is going to be hard, since it could be several reflowed pages long)
}
}.bind(this));
renderer.on("render:loaded", this.loadChange.bind(this));
};
// Listens for load events from the Renderer and checks against the current chapter
// Prevents the Render from loading a different chapter when back button is pressed
EPUBJS.Book.prototype.loadChange = function(url){
var uri = EPUBJS.core.uri(url);
if(this.currentChapter && uri.path != this.currentChapter.absolute){
console.warn("Miss Match", uri.path, this.currentChapter.absolute);
this.goto(uri.filename);
}
};
EPUBJS.Book.prototype.unlistenToRenderer = function(renderer){
@ -2392,18 +2413,28 @@ EPUBJS.Book.prototype.restore = function(identifier){
};
EPUBJS.Book.prototype.displayChapter = function(chap, end){
EPUBJS.Book.prototype.displayChapter = function(chap, end, deferred){
var book = this,
render,
cfi,
pos,
store;
store,
defer = deferred || new RSVP.defer();
if(!this.isRendered) return this._enqueue("displayChapter", arguments);
if(!this.isRendered) {
this._q.enqueue("displayChapter", arguments);
// Reject for now. TODO: pass promise to queue
defer.reject({
message : "Rendering",
stack : new Error().stack
});
return defer.promise;
}
if(this._rendering) {
this._displayQ.push(arguments);
return;
// Pass along the current defer
this._displayQ.enqueue("displayChapter", [chap, end, defer]);
return defer.promise;
}
if(_.isNumber(chap)){
@ -2434,10 +2465,16 @@ EPUBJS.Book.prototype.displayChapter = function(chap, end){
render.then(function(chapter){
// chapter.currentLocationCfi = chap;
chapter.gotoCfi(cfi);
defer.resolve(book.renderer);
});
} else if(end) {
render.then(function(chapter){
chapter.lastPage();
defer.resolve(book.renderer);
});
} else {
render.then(function(){
defer.resolve(book.renderer);
});
}
@ -2452,21 +2489,17 @@ EPUBJS.Book.prototype.displayChapter = function(chap, end){
//-- Clear render queue
render.then(function(){
var inwait;
book._rendering = false;
if(book._displayQ.length) {
inwait = book._displayQ.shift();
book.displayChapter.apply(book, inwait);
}
book._displayQ.dequeue();
});
return render;
return defer.promise;
};
EPUBJS.Book.prototype.nextPage = function(){
var next;
if(!this.isRendered) return this._enqueue("nextPage", arguments);
if(!this.isRendered) return this._q.enqueue("nextPage", arguments);
next = this.renderer.nextPage();
@ -2478,7 +2511,7 @@ EPUBJS.Book.prototype.nextPage = function(){
EPUBJS.Book.prototype.prevPage = function() {
var prev;
if(!this.isRendered) return this._enqueue("prevPage", arguments);
if(!this.isRendered) return this._q.enqueue("prevPage", arguments);
prev = this.renderer.prevPage();
@ -2511,28 +2544,48 @@ EPUBJS.Book.prototype.getCurrentLocationCfi = function() {
return this.renderer.currentLocationCfi;
};
EPUBJS.Book.prototype.gotoCfi = function(cfiString){
EPUBJS.Book.prototype.goto = function(target){
if(typeof target === "number"){
return this.gotoPage(target);
} else if(target.indexOf("epubcfi(") === 0) {
return this.gotoCfi(target);
} else if(target.indexOf("%") === target.length-1) {
return this.gotoPercentage(parseInt(target.substring(0, target.length-1)));
} else {
return this.gotoHref(target);
}
};
EPUBJS.Book.prototype.gotoCfi = function(cfiString, defer){
var cfi,
spinePos,
spineItem,
rendered,
deferred;
deferred = defer || new RSVP.defer();
if(!this.isRendered) {
this.settings.previousLocationCfi = cfiString;
return false;
}
// Currently going to a chapter
if(this._moving) {
this._gotoQ.enqueue("gotoCfi", [cfiString, deferred]);
return false;
}
cfi = new EPUBJS.EpubCFI(cfiString);
spinePos = cfi.spinePos;
spineItem = this.spine[spinePos];
deferred = new RSVP.defer();
promise = deferred.promise;
this._moving = true;
//-- If same chapter only stay on current chapter
if(this.currentChapter && this.spinePos === spinePos){
this.renderer.gotoCfi(cfi);
deferred.resolve(this.currentChapter);
return deferred.promise;
this._moving = false;
deferred.resolve(this.renderer.currentLocationCfi);
} else {
if(!spineItem || spinePos == -1) {
@ -2547,22 +2600,33 @@ EPUBJS.Book.prototype.gotoCfi = function(cfiString){
render = this.renderer.displayChapter(this.currentChapter, this.globalLayoutProperties);
render.then(function(rendered){
rendered.gotoCfi(cfi);
});
rendered.gotoCfi(cfi);
this._moving = false;
deferred.resolve(rendered.currentLocationCfi);
}.bind(this));
}
return render;
}
promise.then(function(){
this._gotoQ.dequeue();
}.bind(this));
return promise;
};
EPUBJS.Book.prototype.goto = function(url){
EPUBJS.Book.prototype.gotoHref = function(url, defer){
var split, chapter, section, absoluteURL, spinePos;
var deferred = new RSVP.defer();
//if(!this.isRendered) return this._enqueue("goto", arguments);
var deferred = defer || new RSVP.defer();
if(!this.isRendered) {
this.settings.goto = url;
return;
return false;
}
// Currently going to a chapter
if(this._moving) {
this._gotoQ.enqueue("gotoHref", [url, deferred]);
return false;
}
split = url.split("#");
@ -2582,14 +2646,34 @@ EPUBJS.Book.prototype.goto = function(url){
if(!this.currentChapter || spinePos != this.currentChapter.spinePos){
//-- Load new chapter if different than current
return this.displayChapter(spinePos).then(function(){
if(section) this.render.section(section);
}.bind(this));
if(section){
this.render.section(section);
}
deferred.resolve(this.renderer.currentLocationCfi);
}.bind(this));
}else{
//-- Only goto section
if(section) this.render.section(section);
deferred.resolve(this.currentChapter);
return deferred.promise;
if(section) {
this.render.section(section);
}
deferred.resolve(this.renderer.currentLocationCfi);
}
promise.then(function(){
this._gotoQ.dequeue();
}.bind(this));
return deferred.promise;
};
EPUBJS.Book.prototype.gotoPage = function(pg){
var cfi = this.pagination.cfiFromPage(pg);
return this.gotoCfi(cfi);
};
EPUBJS.Book.prototype.gotoPercentage = function(percent){
var pg = this.pagination.pageFromPercentage(percent);
return this.gotoCfi(pg);
};
EPUBJS.Book.prototype.preloadNextChapter = function() {
@ -2649,7 +2733,7 @@ EPUBJS.Book.prototype.fromStorage = function(stored) {
*/
EPUBJS.Book.prototype.setStyle = function(style, val, prefixed) {
if(!this.isRendered) return this._enqueue("setStyle", arguments);
if(!this.isRendered) return this._q.enqueue("setStyle", arguments);
this.settings.styles[style] = val;
@ -2658,14 +2742,14 @@ EPUBJS.Book.prototype.setStyle = function(style, val, prefixed) {
};
EPUBJS.Book.prototype.removeStyle = function(style) {
if(!this.isRendered) return this._enqueue("removeStyle", arguments);
if(!this.isRendered) return this._q.enqueue("removeStyle", arguments);
this.renderer.removeStyle(style);
this.renderer.reformat();
delete this.settings.styles[style];
};
EPUBJS.Book.prototype.addHeadTag = function(tag, attrs) {
if(!this.isRendered) return this._enqueue("addHeadTag", arguments);
if(!this.isRendered) return this._q.enqueue("addHeadTag", arguments);
this.settings.headTags[tag] = attrs;
};
@ -2708,15 +2792,6 @@ EPUBJS.Book.prototype.destroy = function() {
};
EPUBJS.Book.prototype._enqueue = function(command, args) {
this._q.push({
'command': command,
'args': args
});
};
EPUBJS.Book.prototype._ready = function() {
this.trigger("book:ready");
@ -2729,21 +2804,18 @@ EPUBJS.Book.prototype._rendered = function(err) {
this.isRendered = true;
this.trigger("book:rendered");
this._q.forEach(function(item){
book[item.command].apply(book, item.args);
});
this._q.flush();
};
EPUBJS.Book.prototype.applyStyles = function(callback){
if(!this.isRendered) return this._enqueue("applyStyles", arguments);
if(!this.isRendered) return this._q.enqueue("applyStyles", arguments);
this.renderer.applyStyles(this.settings.styles);
callback();
};
EPUBJS.Book.prototype.applyHeadTags = function(callback){
if(!this.isRendered) return this._enqueue("applyHeadTags", arguments);
if(!this.isRendered) return this._q.enqueue("applyHeadTags", arguments);
this.renderer.applyHeadTags(this.settings.headTags);
callback();
};
@ -2751,7 +2823,7 @@ EPUBJS.Book.prototype.applyHeadTags = function(callback){
EPUBJS.Book.prototype._registerReplacements = function(renderer){
renderer.registerHook("beforeChapterDisplay", this.applyStyles.bind(this), true);
renderer.registerHook("beforeChapterDisplay", this.applyHeadTags.bind(this), true);
renderer.registerHook("beforeChapterDisplay", EPUBJS.replace.hrefs, true);
renderer.registerHook("beforeChapterDisplay", EPUBJS.replace.hrefs.bind(this), true);
if(this._needsAssetReplacement()) {
@ -3222,6 +3294,47 @@ EPUBJS.core.locationOf = function(item, array, compareFunction, _start, _end) {
return EPUBJS.core.locationOf(item, array, compareFunction, start, pivot);
}
};
EPUBJS.core.queue = function(_scope){
var _q = [];
var scope = _scope;
// Add an item to the queue
var enqueue = function(funcName, args, context) {
_q.push({
"funcName" : funcName,
"args" : args,
"context" : context
});
return _q;
};
// Run one item
var dequeue = function(){
var inwait;
if(_q.length) {
inwait = _q.shift();
// Defer to any current tasks
setTimeout(function(){
scope[inwait.funcName].apply(inwait.context || scope, inwait.args);
}, 0);
}
};
// Run All
var flush = function(){
while(_q.length) {
dequeue();
}
};
// Clear all items in wait
var clear = function(){
_q = [];
};
return {
"enqueue" : enqueue,
"dequeue" : dequeue,
"flush" : flush,
"clear" : clear
};
};
EPUBJS.EpubCFI = function(cfiStr){
if(cfiStr) return this.parse(cfiStr);
};
@ -3247,10 +3360,7 @@ EPUBJS.EpubCFI.prototype.generatePathComponent = function(steps) {
var segment = '';
segment += (part.index + 1) * 2;
if(part.id && part.id.slice(0, 6) === "EPUBJS") {
//-- ignore internal @EPUBJS ids for
return;
} else if(part.id) {
if(part.id) {
segment += "[" + part.id + "]";
}
@ -3263,8 +3373,13 @@ EPUBJS.EpubCFI.prototype.generatePathComponent = function(steps) {
EPUBJS.EpubCFI.prototype.generateCfiFromElement = function(element, chapter) {
var steps = this.pathTo(element);
var path = this.generatePathComponent(steps);
return "epubcfi(" + chapter + "!" + path + "/1:0)";
if(!path.length) {
// Start of Chapter
return "epubcfi(" + chapter + ")";
} else {
// First Text Node
return "epubcfi(" + chapter + "!" + path + "/1:0)";
}
};
EPUBJS.EpubCFI.prototype.pathTo = function(node) {
@ -3320,18 +3435,18 @@ EPUBJS.EpubCFI.prototype.parse = function(cfiStr) {
end,
text;
cfi.str = cfiStr;
if(cfiStr.indexOf("epubcfi(") === 0) {
// Remove intial epubcfi( and ending )
cfiStr = cfiStr.slice(8, cfiStr.length-1);
}
chapterComponent = this.getChapterComponent(cfiStr);
pathComponent = this.getPathComponent(cfiStr);
pathComponent = this.getPathComponent(cfiStr) || '';
charecterOffsetComponent = this.getCharecterOffsetComponent(cfiStr);
// Make sure this is a valid cfi or return
if(!chapterComponent.length || !pathComponent.length) {
if(!chapterComponent) {
return {spinePos: -1};
}
@ -3393,8 +3508,83 @@ EPUBJS.EpubCFI.prototype.parse = function(cfiStr) {
return cfi;
};
EPUBJS.EpubCFI.prototype.addMarker = function(cfi, _doc, _marker) {
var doc = _doc || document;
var marker = _marker || this.createMarker(doc);
var parent;
var lastStep;
var text;
var split;
EPUBJS.EpubCFI.prototype.getElement = function(cfi, _doc) {
if(typeof cfi === 'string') {
cfi = this.parse(cfi);
}
// Get the terminal step
lastStep = cfi.steps[cfi.steps.length-1];
// check spinePos
if(cfi.spinePos === -1) {
// Not a valid CFI
return false;
}
// Find the CFI elements parent
parent = this.findParent(cfi, doc);
if(!parent) {
// CFI didn't return an element
// Maybe it isnt in the current chapter?
return false;
}
if(lastStep && lastStep.type === "text") {
text = parent.childNodes[lastStep.index];
if(cfi.characterOffset){
split = text.splitText();
marker.classList.add("EPUBJS-CFI-SPLIT");
parent.insertBefore(marker, split);
} else {
parent.insertBefore(marker, text);
}
} else {
parent.insertBefore(marker, parent.firstChild);
}
return marker;
};
EPUBJS.EpubCFI.prototype.createMarker = function(_doc) {
var doc = _doc || document;
var element = doc.createElement('span');
element.id = "EPUBJS-CFI-MARKER:"+ EPUBJS.core.uuid();
element.classList.add("EPUBJS-CFI-MARKER");
return element;
};
EPUBJS.EpubCFI.prototype.removeMarker = function(marker, _doc) {
var doc = _doc || document;
// var id = marker.id;
// Remove only elements added as markers
if(marker.classList.contains("EPUBJS-CFI-MARKER")){
marker.parentElement.removeChild(marker);
}
// Cleanup textnodes
if(marker.classList.contains("EPUBJS-CFI-SPLIT")){
nextSib = marker.nextSibling;
prevSib = marker.previousSibling;
if(nextSib.nodeType === 3 && prevSib.nodeType === 3){
prevSib.innerText += nextSib.innerText;
marker.parentElement.removeChild(nextSib);
}
marker.parentElement.removeChild(marker);
}
};
EPUBJS.EpubCFI.prototype.findParent = function(cfi, _doc) {
var doc = _doc || document,
element = doc.getElementsByTagName('html')[0],
children = Array.prototype.slice.call(element.children),
@ -3405,38 +3595,30 @@ EPUBJS.EpubCFI.prototype.getElement = function(cfi, _doc) {
cfi = this.parse(cfi);
}
sections = cfi.steps;
sections = cfi.steps.slice(0); // Clone steps array
if(!sections.length) {
return doc.getElementsByTagName('body')[0];
}
while(sections && sections.length > 0) {
part = sections.shift();
// Wrap text elements in a span and return that new element
// Find textNodes Parent
if(part.type === "text") {
text = element.childNodes[part.index];
element = doc.createElement('span');
element.id = "EPUBJS-CFI-MARKER:"+ EPUBJS.core.uuid();
if(cfi.characterOffset) {
textBegin = doc.createTextNode(text.textContent.slice(0, cfi.characterOffset));
textEnd = doc.createTextNode(text.textContent.slice(cfi.characterOffset));
text.parentNode.insertBefore(textEnd, text);
text.parentNode.insertBefore(element, textEnd);
text.parentNode.insertBefore(textBegin, element);
text.parentNode.removeChild(text);
} else {
text.parentNode.insertBefore(element, text);
}
// sort cut to find element by id
element = text.parentNode || element;
// Find element by id if present
} else if(part.id){
element = doc.getElementById(part.id);
// find element in parent
// Find element in parent
}else{
if(!children) console.error("No Kids", element);
element = children[part.index];
}
if(!element) console.error("No Element For", part, cfi);
// Element can't be found
if(typeof element === "undefined") {
console.error("No Element For", part, cfi.str);
return false;
}
// Get current element children and continue through steps
children = Array.prototype.slice.call(element.children);
}
@ -3682,7 +3864,7 @@ EPUBJS.Layout.Reflowable.prototype.calculatePages = function() {
this.documentElement.style.width = "auto"; //-- reset width for calculations
totalWidth = this.documentElement.scrollWidth;
displayedPages = Math.round(totalWidth / this.spreadWidth);
// console.log(totalWidth, this.spreadWidth)
return {
displayedPages : displayedPages,
pageCount : displayedPages
@ -3799,11 +3981,12 @@ EPUBJS.Layout.Fixed.prototype.calculatePages = function(){
};
};
EPUBJS.Pagination = function(pageList) {
this.pageList = pageList;
this.pages = [];
this.locations = [];
this.epubcfi = new EPUBJS.EpubCFI();
if(pageList && pageList.length) {
this.process(pageList);
}
};
EPUBJS.Pagination.prototype.process = function(pageList){
@ -3812,13 +3995,14 @@ EPUBJS.Pagination.prototype.process = function(pageList){
this.locations.push(item.cfi);
}, this);
this.pageList = pageList;
this.firstPage = parseInt(this.pages[0]);
this.lastPage = parseInt(this.pages[this.pages.length-1]);
this.totalPages = this.lastPage - this.firstPage;
};
EPUBJS.Pagination.prototype.pageFromCfi = function(cfi){
var pg;
var pg = -1;
// check if the cfi is in the location list
var index = this.locations.indexOf(cfi);
if(index != -1 && index < (this.pages.length-1) ) {
@ -3832,12 +4016,11 @@ EPUBJS.Pagination.prototype.pageFromCfi = function(cfi){
// Add the new page in so that the locations and page array match up
this.pages.splice(index, 0, pg);
}
return pg;
};
EPUBJS.Pagination.prototype.cfiFromPage = function(pg){
var cfi;
var cfi = -1;
// check that pg is an int
if(typeof pg != "number"){
pg = parseInt(pg);
@ -3869,18 +4052,6 @@ EPUBJS.Pagination.prototype.percentageFromCfi = function(cfi){
var percentage = this.percentageFromPage(pg);
return percentage;
};
// TODO: move these
EPUBJS.Book.prototype.gotoPage = function(pg){
var cfi = this.pagination.cfiFromPage(pg);
this.gotoCfi(cfi);
};
EPUBJS.Book.prototype.gotoPercentage = function(percent){
var pg = this.pagination.pageFromPercentage(percent);
this.gotoCfi(pg);
};
EPUBJS.Parser = function(baseUrl){
this.baseUrl = baseUrl || '';
};
@ -4344,7 +4515,11 @@ EPUBJS.Render.Iframe.prototype.create = function(){
this.iframe = document.createElement('iframe');
this.iframe.id = "epubjs-iframe:" + EPUBJS.core.uuid();
this.iframe.scrolling = "no";
this.iframe.seamless = "seamless";
// Back up if seamless isn't supported
this.iframe.style.border = "none";
this.iframe.addEventListener("load", this.loaded.bind(this), false);
return this.iframe;
};
@ -4357,9 +4532,11 @@ EPUBJS.Render.Iframe.prototype.load = function(url){
var render = this,
deferred = new RSVP.defer();
this.leftPos = 0;
this.iframe.src = url;
// Reset the scroll position
render.leftPos = 0;
if(this.window) {
this.unload();
}
@ -4392,6 +4569,12 @@ EPUBJS.Render.Iframe.prototype.load = function(url){
return deferred.promise;
};
EPUBJS.Render.Iframe.prototype.loaded = function(v){
var url = this.iframe.contentWindow.location.href;
this.trigger("render:loaded", url);
};
// Resize the iframe to the given width and height
EPUBJS.Render.Iframe.prototype.resize = function(width, height){
var iframeBox;
@ -4489,13 +4672,15 @@ EPUBJS.Render.Iframe.prototype.getBaseElement = function(){
// Checks if an element is on the screen
EPUBJS.Render.Iframe.prototype.isElementVisible = function(el){
var rect;
var left;
if(el && typeof el.getBoundingClientRect === 'function'){
rect = el.getBoundingClientRect();
left = rect.left; //+ rect.width;
if( rect.width !== 0 &&
rect.height !== 0 && // Element not visible
rect.left >= 0 &&
rect.left < this.pageWidth ) {
left >= 0 &&
left < this.pageWidth ) {
return true;
}
}
@ -4516,6 +4701,9 @@ EPUBJS.Render.Iframe.prototype.scroll = function(bool){
EPUBJS.Render.Iframe.prototype.unload = function(){
this.window.removeEventListener("resize", this.resized);
};
//-- Enable binding events to Render
RSVP.EventTarget.mixin(EPUBJS.Render.Iframe.prototype);
EPUBJS.Renderer = function(renderMethod) {
// Dom events to listen for
this.listenedEvents = ["keydown", "keyup", "keypressed", "mouseup", "mousedown", "click"];
@ -4530,6 +4718,9 @@ EPUBJS.Renderer = function(renderMethod) {
console.error("Not a Valid Rendering Method");
}
// Listen for load events
this.render.on("render:loaded", this.loaded.bind(this));
// Cached for replacement urls from storage
this.caches = {};
@ -4638,9 +4829,9 @@ EPUBJS.Renderer.prototype.load = function(url){
this.visible(false);
loaded = this.render.load(url);
render = this.render.load(url);
loaded.then(function(contents) {
render.then(function(contents) {
var formated;
this.contents = contents;
@ -4654,6 +4845,7 @@ EPUBJS.Renderer.prototype.load = function(url){
this.render.window.addEventListener("resize", this.resized, false);
}
this.addEventListeners();
this.addSelectionListeners();
@ -4679,6 +4871,13 @@ EPUBJS.Renderer.prototype.load = function(url){
return deferred.promise;
};
EPUBJS.Renderer.prototype.loaded = function(url){
this.trigger("render:loaded", url);
// var uri = EPUBJS.core.uri(url);
// var relative = uri.path.replace(book.bookUrl, '');
// console.log(url, uri, relative);
};
/**
* Reconciles the current chapters layout properies with
* the global layout properities.
@ -4707,8 +4906,7 @@ EPUBJS.Renderer.prototype.reconcileLayoutSettings = function(global, chapter){
settings[property] = value;
}
});
return settings;
return settings;
};
/**
@ -4840,7 +5038,6 @@ EPUBJS.Renderer.prototype.page = function(pg){
this.currentLocationCfi = this.getPageCfi();
this.trigger("renderer:locationChanged", this.currentLocationCfi);
return true;
}
//-- Return false if page is greater than the total
@ -4893,7 +5090,20 @@ EPUBJS.Renderer.prototype.section = function(fragment){
};
// Walk the node tree from an element to the root
EPUBJS.Renderer.prototype.firstElementisTextNode = function(node) {
var children = node.childNodes;
var leng = children.length;
if(leng &&
children[0] && // First Child
children[0].nodeType === 3 && // This is a textNodes
children[0].textContent.trim().length) { // With non whitespace or return charecters
return true;
}
return false;
};
// Walk the node tree from a start element to next visible element
EPUBJS.Renderer.prototype.walk = function(node) {
var r, children, leng,
startNode = node,
@ -4905,7 +5115,7 @@ EPUBJS.Renderer.prototype.walk = function(node) {
while(!r && stack.length) {
node = stack.shift();
if( this.render.isElementVisible(node) ) {
if( this.render.isElementVisible(node) && this.firstElementisTextNode(node)) {
r = node;
}
@ -4916,8 +5126,8 @@ EPUBJS.Renderer.prototype.walk = function(node) {
} else {
return r;
}
for (var i = 0; i < leng; i++) {
if(children[i] != prevNode) stack.push(children[i]);
for (var i = leng-1; i >= 0; i--) {
if(children[i] != prevNode) stack.unshift(children[i]);
}
}
@ -4949,13 +5159,19 @@ EPUBJS.Renderer.prototype.getPageCfi = function(prevEl){
// Goto a cfi position in the current chapter
EPUBJS.Renderer.prototype.gotoCfi = function(cfi){
var element;
var pg;
if(_.isString(cfi)){
cfi = this.epubcfi.parse(cfi);
}
element = this.epubcfi.getElement(cfi, this.doc);
this.pageByElement(element);
marker = this.epubcfi.addMarker(cfi, this.doc);
if(marker) {
pg = this.render.getPageNumberByElement(marker);
// Must Clean up Marker before going to page
this.epubcfi.removeMarker(marker, this.doc);
this.page(pg);
}
};
// Walk nodes until a visible element is found
@ -5188,12 +5404,12 @@ EPUBJS.Renderer.prototype.replaceWithStored = function(query, attr, func, callba
//-- Enable binding events to Renderer
RSVP.EventTarget.mixin(EPUBJS.Renderer.prototype);
var EPUBJS = EPUBJS || {};
EPUBJS.replace = {};
//-- Replaces the relative links within the book to use our internal page changer
EPUBJS.replace.hrefs = function(callback, renderer){
var book = this;
var replacments = function(link, done){
var href = link.getAttribute("href"),
relative = href.search("://"),
@ -5206,7 +5422,7 @@ EPUBJS.replace.hrefs = function(callback, renderer){
}else{
link.onclick = function(){
renderer.book.goto(href);
book.goto(href);
return false;
};

6
build/epub.min.js vendored
View file

File diff suppressed because one or more lines are too long

472
build/epub_no_underscore.js
View file

@ -1850,6 +1850,7 @@ EPUBJS.Book = function(options){
this.ready.toc.promise
];
this.pageList = [];
this.pagination = new EPUBJS.Pagination();
this.pageListReady = this.ready.pageList.promise;
@ -1857,10 +1858,15 @@ EPUBJS.Book = function(options){
this.ready.all.then(this._ready.bind(this));
this._q = [];
// Queue for methods used before rendering
this.isRendered = false;
this._q = EPUBJS.core.queue(this);
// Queue for rendering
this._rendering = false;
this._displayQ = [];
this._displayQ = EPUBJS.core.queue(this);
// Queue for going to another location
this._moving = false;
this._gotoQ = EPUBJS.core.queue(this);
/**
* Creates a new renderer.
@ -2024,8 +2030,8 @@ EPUBJS.Book.prototype.unpack = function(packageXml){
then(function(navHtml){
return parse.pageList(navHtml, book.spineIndexByURL, book.spine);
}).then(function(pageList){
book.pageList = book.contents.pageList = pageList;
if(pageList.length) {
book.pageList = book.contents.pageList = pageList;
book.pagination.process(book.pageList);
book.ready.pageList.resolve(book.pageList);
}
@ -2062,6 +2068,9 @@ EPUBJS.Book.prototype.createHiddenRender = function(renderer, _width, _height) {
hiddenEl = document.createElement("div");
hiddenEl.style.visibility = "hidden";
hiddenEl.style.overflow = "hidden";
hiddenEl.style.width = "0";
hiddenEl.style.height = "0";
this.element.appendChild(hiddenEl);
renderer.initialize(hiddenEl, width, height);
@ -2089,8 +2098,8 @@ EPUBJS.Book.prototype.generatePageList = function(width, height){
spinePos = next;
chapter = new EPUBJS.Chapter(this.spine[spinePos], this.store);
pager.displayChapter(chapter, this.globalLayoutProperties).then(function(){
var nextPage = pager.nextPage();
pager.displayChapter(chapter, this.globalLayoutProperties).then(function(chap){
var nextPage = true;//pager.nextPage();
// Page though the entire chapter
while (nextPage) {
nextPage = pager.nextPage();
@ -2143,10 +2152,7 @@ EPUBJS.Book.prototype.loadPagination = function(pagelistJSON) {
if(pageList && pageList.length) {
this.pageList = pageList;
this.pagination.process(this.pageList);
// Wait for book contents to load before resolving
this.ready.all.then(function(){
this.ready.pageList.resolve(this.pageList);
}.bind(this));
this.ready.pageList.resolve(this.pageList);
}
return this.pageList;
};
@ -2200,8 +2206,23 @@ EPUBJS.Book.prototype.listenToRenderer = function(renderer){
"page": page,
"percentage": percent
});
// TODO: Add event for first and last page.
// (though last is going to be hard, since it could be several reflowed pages long)
}
}.bind(this));
renderer.on("render:loaded", this.loadChange.bind(this));
};
// Listens for load events from the Renderer and checks against the current chapter
// Prevents the Render from loading a different chapter when back button is pressed
EPUBJS.Book.prototype.loadChange = function(url){
var uri = EPUBJS.core.uri(url);
if(this.currentChapter && uri.path != this.currentChapter.absolute){
console.warn("Miss Match", uri.path, this.currentChapter.absolute);
this.goto(uri.filename);
}
};
EPUBJS.Book.prototype.unlistenToRenderer = function(renderer){
@ -2391,18 +2412,28 @@ EPUBJS.Book.prototype.restore = function(identifier){
};
EPUBJS.Book.prototype.displayChapter = function(chap, end){
EPUBJS.Book.prototype.displayChapter = function(chap, end, deferred){
var book = this,
render,
cfi,
pos,
store;
store,
defer = deferred || new RSVP.defer();
if(!this.isRendered) return this._enqueue("displayChapter", arguments);
if(!this.isRendered) {
this._q.enqueue("displayChapter", arguments);
// Reject for now. TODO: pass promise to queue
defer.reject({
message : "Rendering",
stack : new Error().stack
});
return defer.promise;
}
if(this._rendering) {
this._displayQ.push(arguments);
return;
// Pass along the current defer
this._displayQ.enqueue("displayChapter", [chap, end, defer]);
return defer.promise;
}
if(_.isNumber(chap)){
@ -2433,10 +2464,16 @@ EPUBJS.Book.prototype.displayChapter = function(chap, end){
render.then(function(chapter){
// chapter.currentLocationCfi = chap;
chapter.gotoCfi(cfi);
defer.resolve(book.renderer);
});
} else if(end) {
render.then(function(chapter){
chapter.lastPage();
defer.resolve(book.renderer);
});
} else {
render.then(function(){
defer.resolve(book.renderer);
});
}
@ -2451,21 +2488,17 @@ EPUBJS.Book.prototype.displayChapter = function(chap, end){
//-- Clear render queue
render.then(function(){
var inwait;
book._rendering = false;
if(book._displayQ.length) {
inwait = book._displayQ.shift();
book.displayChapter.apply(book, inwait);
}
book._displayQ.dequeue();
});
return render;
return defer.promise;
};
EPUBJS.Book.prototype.nextPage = function(){
var next;
if(!this.isRendered) return this._enqueue("nextPage", arguments);
if(!this.isRendered) return this._q.enqueue("nextPage", arguments);
next = this.renderer.nextPage();
@ -2477,7 +2510,7 @@ EPUBJS.Book.prototype.nextPage = function(){
EPUBJS.Book.prototype.prevPage = function() {
var prev;
if(!this.isRendered) return this._enqueue("prevPage", arguments);
if(!this.isRendered) return this._q.enqueue("prevPage", arguments);
prev = this.renderer.prevPage();
@ -2510,28 +2543,48 @@ EPUBJS.Book.prototype.getCurrentLocationCfi = function() {
return this.renderer.currentLocationCfi;
};
EPUBJS.Book.prototype.gotoCfi = function(cfiString){
EPUBJS.Book.prototype.goto = function(target){
if(typeof target === "number"){
return this.gotoPage(target);
} else if(target.indexOf("epubcfi(") === 0) {
return this.gotoCfi(target);
} else if(target.indexOf("%") === target.length-1) {
return this.gotoPercentage(parseInt(target.substring(0, target.length-1)));
} else {
return this.gotoHref(target);
}
};
EPUBJS.Book.prototype.gotoCfi = function(cfiString, defer){
var cfi,
spinePos,
spineItem,
rendered,
deferred;
deferred = defer || new RSVP.defer();
if(!this.isRendered) {
this.settings.previousLocationCfi = cfiString;
return false;
}
// Currently going to a chapter
if(this._moving) {
this._gotoQ.enqueue("gotoCfi", [cfiString, deferred]);
return false;
}
cfi = new EPUBJS.EpubCFI(cfiString);
spinePos = cfi.spinePos;
spineItem = this.spine[spinePos];
deferred = new RSVP.defer();
promise = deferred.promise;
this._moving = true;
//-- If same chapter only stay on current chapter
if(this.currentChapter && this.spinePos === spinePos){
this.renderer.gotoCfi(cfi);
deferred.resolve(this.currentChapter);
return deferred.promise;
this._moving = false;
deferred.resolve(this.renderer.currentLocationCfi);
} else {
if(!spineItem || spinePos == -1) {
@ -2546,22 +2599,33 @@ EPUBJS.Book.prototype.gotoCfi = function(cfiString){
render = this.renderer.displayChapter(this.currentChapter, this.globalLayoutProperties);
render.then(function(rendered){
rendered.gotoCfi(cfi);
});
rendered.gotoCfi(cfi);
this._moving = false;
deferred.resolve(rendered.currentLocationCfi);
}.bind(this));
}
return render;
}
promise.then(function(){
this._gotoQ.dequeue();
}.bind(this));
return promise;
};
EPUBJS.Book.prototype.goto = function(url){
EPUBJS.Book.prototype.gotoHref = function(url, defer){
var split, chapter, section, absoluteURL, spinePos;
var deferred = new RSVP.defer();
//if(!this.isRendered) return this._enqueue("goto", arguments);
var deferred = defer || new RSVP.defer();
if(!this.isRendered) {
this.settings.goto = url;
return;
return false;
}
// Currently going to a chapter
if(this._moving) {
this._gotoQ.enqueue("gotoHref", [url, deferred]);
return false;
}
split = url.split("#");
@ -2581,14 +2645,34 @@ EPUBJS.Book.prototype.goto = function(url){
if(!this.currentChapter || spinePos != this.currentChapter.spinePos){
//-- Load new chapter if different than current
return this.displayChapter(spinePos).then(function(){
if(section) this.render.section(section);
}.bind(this));
if(section){
this.render.section(section);
}
deferred.resolve(this.renderer.currentLocationCfi);
}.bind(this));
}else{
//-- Only goto section
if(section) this.render.section(section);
deferred.resolve(this.currentChapter);
return deferred.promise;
if(section) {
this.render.section(section);
}
deferred.resolve(this.renderer.currentLocationCfi);
}
promise.then(function(){
this._gotoQ.dequeue();
}.bind(this));
return deferred.promise;
};
EPUBJS.Book.prototype.gotoPage = function(pg){
var cfi = this.pagination.cfiFromPage(pg);
return this.gotoCfi(cfi);
};
EPUBJS.Book.prototype.gotoPercentage = function(percent){
var pg = this.pagination.pageFromPercentage(percent);
return this.gotoCfi(pg);
};
EPUBJS.Book.prototype.preloadNextChapter = function() {
@ -2648,7 +2732,7 @@ EPUBJS.Book.prototype.fromStorage = function(stored) {
*/
EPUBJS.Book.prototype.setStyle = function(style, val, prefixed) {
if(!this.isRendered) return this._enqueue("setStyle", arguments);
if(!this.isRendered) return this._q.enqueue("setStyle", arguments);
this.settings.styles[style] = val;
@ -2657,14 +2741,14 @@ EPUBJS.Book.prototype.setStyle = function(style, val, prefixed) {
};
EPUBJS.Book.prototype.removeStyle = function(style) {
if(!this.isRendered) return this._enqueue("removeStyle", arguments);
if(!this.isRendered) return this._q.enqueue("removeStyle", arguments);
this.renderer.removeStyle(style);
this.renderer.reformat();
delete this.settings.styles[style];
};
EPUBJS.Book.prototype.addHeadTag = function(tag, attrs) {
if(!this.isRendered) return this._enqueue("addHeadTag", arguments);
if(!this.isRendered) return this._q.enqueue("addHeadTag", arguments);
this.settings.headTags[tag] = attrs;
};
@ -2707,15 +2791,6 @@ EPUBJS.Book.prototype.destroy = function() {
};
EPUBJS.Book.prototype._enqueue = function(command, args) {
this._q.push({
'command': command,
'args': args
});
};
EPUBJS.Book.prototype._ready = function() {
this.trigger("book:ready");
@ -2728,21 +2803,18 @@ EPUBJS.Book.prototype._rendered = function(err) {
this.isRendered = true;
this.trigger("book:rendered");
this._q.forEach(function(item){
book[item.command].apply(book, item.args);
});
this._q.flush();
};
EPUBJS.Book.prototype.applyStyles = function(callback){
if(!this.isRendered) return this._enqueue("applyStyles", arguments);
if(!this.isRendered) return this._q.enqueue("applyStyles", arguments);
this.renderer.applyStyles(this.settings.styles);
callback();
};
EPUBJS.Book.prototype.applyHeadTags = function(callback){
if(!this.isRendered) return this._enqueue("applyHeadTags", arguments);
if(!this.isRendered) return this._q.enqueue("applyHeadTags", arguments);
this.renderer.applyHeadTags(this.settings.headTags);
callback();
};
@ -2750,7 +2822,7 @@ EPUBJS.Book.prototype.applyHeadTags = function(callback){
EPUBJS.Book.prototype._registerReplacements = function(renderer){
renderer.registerHook("beforeChapterDisplay", this.applyStyles.bind(this), true);
renderer.registerHook("beforeChapterDisplay", this.applyHeadTags.bind(this), true);
renderer.registerHook("beforeChapterDisplay", EPUBJS.replace.hrefs, true);
renderer.registerHook("beforeChapterDisplay", EPUBJS.replace.hrefs.bind(this), true);
if(this._needsAssetReplacement()) {
@ -3221,6 +3293,47 @@ EPUBJS.core.locationOf = function(item, array, compareFunction, _start, _end) {
return EPUBJS.core.locationOf(item, array, compareFunction, start, pivot);
}
};
EPUBJS.core.queue = function(_scope){
var _q = [];
var scope = _scope;
// Add an item to the queue
var enqueue = function(funcName, args, context) {
_q.push({
"funcName" : funcName,
"args" : args,
"context" : context
});
return _q;
};
// Run one item
var dequeue = function(){
var inwait;
if(_q.length) {
inwait = _q.shift();
// Defer to any current tasks
setTimeout(function(){
scope[inwait.funcName].apply(inwait.context || scope, inwait.args);
}, 0);
}
};
// Run All
var flush = function(){
while(_q.length) {
dequeue();
}
};
// Clear all items in wait
var clear = function(){
_q = [];
};
return {
"enqueue" : enqueue,
"dequeue" : dequeue,
"flush" : flush,
"clear" : clear
};
};
EPUBJS.EpubCFI = function(cfiStr){
if(cfiStr) return this.parse(cfiStr);
};
@ -3246,10 +3359,7 @@ EPUBJS.EpubCFI.prototype.generatePathComponent = function(steps) {
var segment = '';
segment += (part.index + 1) * 2;
if(part.id && part.id.slice(0, 6) === "EPUBJS") {
//-- ignore internal @EPUBJS ids for
return;
} else if(part.id) {
if(part.id) {
segment += "[" + part.id + "]";
}
@ -3262,8 +3372,13 @@ EPUBJS.EpubCFI.prototype.generatePathComponent = function(steps) {
EPUBJS.EpubCFI.prototype.generateCfiFromElement = function(element, chapter) {
var steps = this.pathTo(element);
var path = this.generatePathComponent(steps);
return "epubcfi(" + chapter + "!" + path + "/1:0)";
if(!path.length) {
// Start of Chapter
return "epubcfi(" + chapter + ")";
} else {
// First Text Node
return "epubcfi(" + chapter + "!" + path + "/1:0)";
}
};
EPUBJS.EpubCFI.prototype.pathTo = function(node) {
@ -3319,18 +3434,18 @@ EPUBJS.EpubCFI.prototype.parse = function(cfiStr) {
end,
text;
cfi.str = cfiStr;
if(cfiStr.indexOf("epubcfi(") === 0) {
// Remove intial epubcfi( and ending )
cfiStr = cfiStr.slice(8, cfiStr.length-1);
}
chapterComponent = this.getChapterComponent(cfiStr);
pathComponent = this.getPathComponent(cfiStr);
pathComponent = this.getPathComponent(cfiStr) || '';
charecterOffsetComponent = this.getCharecterOffsetComponent(cfiStr);
// Make sure this is a valid cfi or return
if(!chapterComponent.length || !pathComponent.length) {
if(!chapterComponent) {
return {spinePos: -1};
}
@ -3392,8 +3507,83 @@ EPUBJS.EpubCFI.prototype.parse = function(cfiStr) {
return cfi;
};
EPUBJS.EpubCFI.prototype.addMarker = function(cfi, _doc, _marker) {
var doc = _doc || document;
var marker = _marker || this.createMarker(doc);
var parent;
var lastStep;
var text;
var split;
EPUBJS.EpubCFI.prototype.getElement = function(cfi, _doc) {
if(typeof cfi === 'string') {
cfi = this.parse(cfi);
}
// Get the terminal step
lastStep = cfi.steps[cfi.steps.length-1];
// check spinePos
if(cfi.spinePos === -1) {
// Not a valid CFI
return false;
}
// Find the CFI elements parent
parent = this.findParent(cfi, doc);
if(!parent) {
// CFI didn't return an element
// Maybe it isnt in the current chapter?
return false;
}
if(lastStep && lastStep.type === "text") {
text = parent.childNodes[lastStep.index];
if(cfi.characterOffset){
split = text.splitText();
marker.classList.add("EPUBJS-CFI-SPLIT");
parent.insertBefore(marker, split);
} else {
parent.insertBefore(marker, text);
}
} else {
parent.insertBefore(marker, parent.firstChild);
}
return marker;
};
EPUBJS.EpubCFI.prototype.createMarker = function(_doc) {
var doc = _doc || document;
var element = doc.createElement('span');
element.id = "EPUBJS-CFI-MARKER:"+ EPUBJS.core.uuid();
element.classList.add("EPUBJS-CFI-MARKER");
return element;
};
EPUBJS.EpubCFI.prototype.removeMarker = function(marker, _doc) {
var doc = _doc || document;
// var id = marker.id;
// Remove only elements added as markers
if(marker.classList.contains("EPUBJS-CFI-MARKER")){
marker.parentElement.removeChild(marker);
}
// Cleanup textnodes
if(marker.classList.contains("EPUBJS-CFI-SPLIT")){
nextSib = marker.nextSibling;
prevSib = marker.previousSibling;
if(nextSib.nodeType === 3 && prevSib.nodeType === 3){
prevSib.innerText += nextSib.innerText;
marker.parentElement.removeChild(nextSib);
}
marker.parentElement.removeChild(marker);
}
};
EPUBJS.EpubCFI.prototype.findParent = function(cfi, _doc) {
var doc = _doc || document,
element = doc.getElementsByTagName('html')[0],
children = Array.prototype.slice.call(element.children),
@ -3404,38 +3594,30 @@ EPUBJS.EpubCFI.prototype.getElement = function(cfi, _doc) {
cfi = this.parse(cfi);
}
sections = cfi.steps;
sections = cfi.steps.slice(0); // Clone steps array
if(!sections.length) {
return doc.getElementsByTagName('body')[0];
}
while(sections && sections.length > 0) {
part = sections.shift();
// Wrap text elements in a span and return that new element
// Find textNodes Parent
if(part.type === "text") {
text = element.childNodes[part.index];
element = doc.createElement('span');
element.id = "EPUBJS-CFI-MARKER:"+ EPUBJS.core.uuid();
if(cfi.characterOffset) {
textBegin = doc.createTextNode(text.textContent.slice(0, cfi.characterOffset));
textEnd = doc.createTextNode(text.textContent.slice(cfi.characterOffset));
text.parentNode.insertBefore(textEnd, text);
text.parentNode.insertBefore(element, textEnd);
text.parentNode.insertBefore(textBegin, element);
text.parentNode.removeChild(text);
} else {
text.parentNode.insertBefore(element, text);
}
// sort cut to find element by id
element = text.parentNode || element;
// Find element by id if present
} else if(part.id){
element = doc.getElementById(part.id);
// find element in parent
// Find element in parent
}else{
if(!children) console.error("No Kids", element);
element = children[part.index];
}
if(!element) console.error("No Element For", part, cfi);
// Element can't be found
if(typeof element === "undefined") {
console.error("No Element For", part, cfi.str);
return false;
}
// Get current element children and continue through steps
children = Array.prototype.slice.call(element.children);
}
@ -3681,7 +3863,7 @@ EPUBJS.Layout.Reflowable.prototype.calculatePages = function() {
this.documentElement.style.width = "auto"; //-- reset width for calculations
totalWidth = this.documentElement.scrollWidth;
displayedPages = Math.round(totalWidth / this.spreadWidth);
// console.log(totalWidth, this.spreadWidth)
return {
displayedPages : displayedPages,
pageCount : displayedPages
@ -3798,11 +3980,12 @@ EPUBJS.Layout.Fixed.prototype.calculatePages = function(){
};
};
EPUBJS.Pagination = function(pageList) {
this.pageList = pageList;
this.pages = [];
this.locations = [];
this.epubcfi = new EPUBJS.EpubCFI();
if(pageList && pageList.length) {
this.process(pageList);
}
};
EPUBJS.Pagination.prototype.process = function(pageList){
@ -3811,13 +3994,14 @@ EPUBJS.Pagination.prototype.process = function(pageList){
this.locations.push(item.cfi);
}, this);
this.pageList = pageList;
this.firstPage = parseInt(this.pages[0]);
this.lastPage = parseInt(this.pages[this.pages.length-1]);
this.totalPages = this.lastPage - this.firstPage;
};
EPUBJS.Pagination.prototype.pageFromCfi = function(cfi){
var pg;
var pg = -1;
// check if the cfi is in the location list
var index = this.locations.indexOf(cfi);
if(index != -1 && index < (this.pages.length-1) ) {
@ -3831,12 +4015,11 @@ EPUBJS.Pagination.prototype.pageFromCfi = function(cfi){
// Add the new page in so that the locations and page array match up
this.pages.splice(index, 0, pg);
}
return pg;
};
EPUBJS.Pagination.prototype.cfiFromPage = function(pg){
var cfi;
var cfi = -1;
// check that pg is an int
if(typeof pg != "number"){
pg = parseInt(pg);
@ -3868,18 +4051,6 @@ EPUBJS.Pagination.prototype.percentageFromCfi = function(cfi){
var percentage = this.percentageFromPage(pg);
return percentage;
};
// TODO: move these
EPUBJS.Book.prototype.gotoPage = function(pg){
var cfi = this.pagination.cfiFromPage(pg);
this.gotoCfi(cfi);
};
EPUBJS.Book.prototype.gotoPercentage = function(percent){
var pg = this.pagination.pageFromPercentage(percent);
this.gotoCfi(pg);
};
EPUBJS.Parser = function(baseUrl){
this.baseUrl = baseUrl || '';
};
@ -4343,7 +4514,11 @@ EPUBJS.Render.Iframe.prototype.create = function(){
this.iframe = document.createElement('iframe');
this.iframe.id = "epubjs-iframe:" + EPUBJS.core.uuid();
this.iframe.scrolling = "no";
this.iframe.seamless = "seamless";
// Back up if seamless isn't supported
this.iframe.style.border = "none";
this.iframe.addEventListener("load", this.loaded.bind(this), false);
return this.iframe;
};
@ -4356,9 +4531,11 @@ EPUBJS.Render.Iframe.prototype.load = function(url){
var render = this,
deferred = new RSVP.defer();
this.leftPos = 0;
this.iframe.src = url;
// Reset the scroll position
render.leftPos = 0;
if(this.window) {
this.unload();
}
@ -4391,6 +4568,12 @@ EPUBJS.Render.Iframe.prototype.load = function(url){
return deferred.promise;
};
EPUBJS.Render.Iframe.prototype.loaded = function(v){
var url = this.iframe.contentWindow.location.href;
this.trigger("render:loaded", url);
};
// Resize the iframe to the given width and height
EPUBJS.Render.Iframe.prototype.resize = function(width, height){
var iframeBox;
@ -4488,13 +4671,15 @@ EPUBJS.Render.Iframe.prototype.getBaseElement = function(){
// Checks if an element is on the screen
EPUBJS.Render.Iframe.prototype.isElementVisible = function(el){
var rect;
var left;
if(el && typeof el.getBoundingClientRect === 'function'){
rect = el.getBoundingClientRect();
left = rect.left; //+ rect.width;
if( rect.width !== 0 &&
rect.height !== 0 && // Element not visible
rect.left >= 0 &&
rect.left < this.pageWidth ) {
left >= 0 &&
left < this.pageWidth ) {
return true;
}
}
@ -4515,6 +4700,9 @@ EPUBJS.Render.Iframe.prototype.scroll = function(bool){
EPUBJS.Render.Iframe.prototype.unload = function(){
this.window.removeEventListener("resize", this.resized);
};
//-- Enable binding events to Render
RSVP.EventTarget.mixin(EPUBJS.Render.Iframe.prototype);
EPUBJS.Renderer = function(renderMethod) {
// Dom events to listen for
this.listenedEvents = ["keydown", "keyup", "keypressed", "mouseup", "mousedown", "click"];
@ -4529,6 +4717,9 @@ EPUBJS.Renderer = function(renderMethod) {
console.error("Not a Valid Rendering Method");
}
// Listen for load events
this.render.on("render:loaded", this.loaded.bind(this));
// Cached for replacement urls from storage
this.caches = {};
@ -4637,9 +4828,9 @@ EPUBJS.Renderer.prototype.load = function(url){
this.visible(false);
loaded = this.render.load(url);
render = this.render.load(url);
loaded.then(function(contents) {
render.then(function(contents) {
var formated;
this.contents = contents;
@ -4653,6 +4844,7 @@ EPUBJS.Renderer.prototype.load = function(url){
this.render.window.addEventListener("resize", this.resized, false);
}
this.addEventListeners();
this.addSelectionListeners();
@ -4678,6 +4870,13 @@ EPUBJS.Renderer.prototype.load = function(url){
return deferred.promise;
};
EPUBJS.Renderer.prototype.loaded = function(url){
this.trigger("render:loaded", url);
// var uri = EPUBJS.core.uri(url);
// var relative = uri.path.replace(book.bookUrl, '');
// console.log(url, uri, relative);
};
/**
* Reconciles the current chapters layout properies with
* the global layout properities.
@ -4706,8 +4905,7 @@ EPUBJS.Renderer.prototype.reconcileLayoutSettings = function(global, chapter){
settings[property] = value;
}
});
return settings;
return settings;
};
/**
@ -4839,7 +5037,6 @@ EPUBJS.Renderer.prototype.page = function(pg){
this.currentLocationCfi = this.getPageCfi();
this.trigger("renderer:locationChanged", this.currentLocationCfi);
return true;
}
//-- Return false if page is greater than the total
@ -4892,7 +5089,20 @@ EPUBJS.Renderer.prototype.section = function(fragment){
};
// Walk the node tree from an element to the root
EPUBJS.Renderer.prototype.firstElementisTextNode = function(node) {
var children = node.childNodes;
var leng = children.length;
if(leng &&
children[0] && // First Child
children[0].nodeType === 3 && // This is a textNodes
children[0].textContent.trim().length) { // With non whitespace or return charecters
return true;
}
return false;
};
// Walk the node tree from a start element to next visible element
EPUBJS.Renderer.prototype.walk = function(node) {
var r, children, leng,
startNode = node,
@ -4904,7 +5114,7 @@ EPUBJS.Renderer.prototype.walk = function(node) {
while(!r && stack.length) {
node = stack.shift();
if( this.render.isElementVisible(node) ) {
if( this.render.isElementVisible(node) && this.firstElementisTextNode(node)) {
r = node;
}
@ -4915,8 +5125,8 @@ EPUBJS.Renderer.prototype.walk = function(node) {
} else {
return r;
}
for (var i = 0; i < leng; i++) {
if(children[i] != prevNode) stack.push(children[i]);
for (var i = leng-1; i >= 0; i--) {
if(children[i] != prevNode) stack.unshift(children[i]);
}
}
@ -4948,13 +5158,19 @@ EPUBJS.Renderer.prototype.getPageCfi = function(prevEl){
// Goto a cfi position in the current chapter
EPUBJS.Renderer.prototype.gotoCfi = function(cfi){
var element;
var pg;
if(_.isString(cfi)){
cfi = this.epubcfi.parse(cfi);
}
element = this.epubcfi.getElement(cfi, this.doc);
this.pageByElement(element);
marker = this.epubcfi.addMarker(cfi, this.doc);
if(marker) {
pg = this.render.getPageNumberByElement(marker);
// Must Clean up Marker before going to page
this.epubcfi.removeMarker(marker, this.doc);
this.page(pg);
}
};
// Walk nodes until a visible element is found
@ -5187,12 +5403,12 @@ EPUBJS.Renderer.prototype.replaceWithStored = function(query, attr, func, callba
//-- Enable binding events to Renderer
RSVP.EventTarget.mixin(EPUBJS.Renderer.prototype);
var EPUBJS = EPUBJS || {};
EPUBJS.replace = {};
//-- Replaces the relative links within the book to use our internal page changer
EPUBJS.replace.hrefs = function(callback, renderer){
var book = this;
var replacments = function(link, done){
var href = link.getAttribute("href"),
relative = href.search("://"),
@ -5205,7 +5421,7 @@ EPUBJS.replace.hrefs = function(callback, renderer){
}else{
link.onclick = function(){
renderer.book.goto(href);
book.goto(href);
return false;
};

5
build/reader.js
View file

@ -695,6 +695,8 @@ EPUBJS.reader.TocController = function(toc) {
$list.find(".toc_link").on("click", function(event){
var url = this.getAttribute('href');
event.preventDefault();
//-- Provide the Book with the url to show
// The Url must be found in the books manifest
book.goto(url);
@ -705,19 +707,18 @@ EPUBJS.reader.TocController = function(toc) {
$(this).parent('li').addClass("currentChapter");
event.preventDefault();
});
$list.find(".toc_toggle").on("click", function(event){
var $el = $(this).parent('li'),
open = $el.hasClass("openChapter");
event.preventDefault();
if(open){
$el.removeClass("openChapter");
} else {
$el.addClass("openChapter");
}
event.preventDefault();
});
return {

6
demo/js/epub.min.js vendored
View file

File diff suppressed because one or more lines are too long

2
demo/js/reader.min.js vendored
View file

File diff suppressed because one or more lines are too long

1
examples/page_list.json Normal file
View file

File diff suppressed because one or more lines are too long

21
examples/pagination.html
View file

@ -139,6 +139,11 @@
var totalPages = document.getElementById("totalpg");
var slider = document.createElement("input");
var pageList;
var slide = function(){
book.gotoPage(slider.value);
};
var throttledSlide = _.throttle(slide, 200);
var mouseDown = false;
var rendered = book.renderTo("area");
@ -165,9 +170,12 @@
slider.setAttribute("step", 1);
slider.setAttribute("value", 0);
slider.addEventListener("change", function(value){
console.log(slider.value)
book.gotoPage(slider.value);
slider.addEventListener("change", throttledSlide, false);
slider.addEventListener("mousedown", function(){
mouseDown = true;
}, false);
slider.addEventListener("mouseup", function(){
mouseDown = false;
}, false);
// Wait for book to be rendered to get current page
@ -181,14 +189,15 @@
controls.appendChild(slider);
totalPages.innerText = book.pagination.totalPages;
currentPage.addEventListener("change", function(value){
console.log(currentPage.value)
currentPage.addEventListener("change", function(){
book.gotoPage(currentPage.value);
}, false);
});
book.on('book:pageChanged', function(location){
slider.value = location.page;
if(!mouseDown) {
slider.value = location.page;
}
currentPage.value = location.page;
});
</script>

5
reader/controllers/toc_controller.js
View file

@ -82,6 +82,8 @@ EPUBJS.reader.TocController = function(toc) {
$list.find(".toc_link").on("click", function(event){
var url = this.getAttribute('href');
event.preventDefault();
//-- Provide the Book with the url to show
// The Url must be found in the books manifest
book.goto(url);
@ -92,19 +94,18 @@ EPUBJS.reader.TocController = function(toc) {
$(this).parent('li').addClass("currentChapter");
event.preventDefault();
});
$list.find(".toc_toggle").on("click", function(event){
var $el = $(this).parent('li'),
open = $el.hasClass("openChapter");
event.preventDefault();
if(open){
$el.removeClass("openChapter");
} else {
$el.addClass("openChapter");
}
event.preventDefault();
});
return {

163
src/book.js
View file

@ -83,10 +83,15 @@ EPUBJS.Book = function(options){
this.ready.all.then(this._ready.bind(this));
this._q = [];
// Queue for methods used before rendering
this.isRendered = false;
this._q = EPUBJS.core.queue(this);
// Queue for rendering
this._rendering = false;
this._displayQ = [];
this._displayQ = EPUBJS.core.queue(this);
// Queue for going to another location
this._moving = false;
this._gotoQ = EPUBJS.core.queue(this);
/**
* Creates a new renderer.
@ -440,6 +445,7 @@ EPUBJS.Book.prototype.listenToRenderer = function(renderer){
EPUBJS.Book.prototype.loadChange = function(url){
var uri = EPUBJS.core.uri(url);
if(this.currentChapter && uri.path != this.currentChapter.absolute){
console.warn("Miss Match", uri.path, this.currentChapter.absolute);
this.goto(uri.filename);
}
};
@ -631,18 +637,28 @@ EPUBJS.Book.prototype.restore = function(identifier){
};
EPUBJS.Book.prototype.displayChapter = function(chap, end){
EPUBJS.Book.prototype.displayChapter = function(chap, end, deferred){
var book = this,
render,
cfi,
pos,
store;
store,
defer = deferred || new RSVP.defer();
if(!this.isRendered) return this._enqueue("displayChapter", arguments);
if(!this.isRendered) {
this._q.enqueue("displayChapter", arguments);
// Reject for now. TODO: pass promise to queue
defer.reject({
message : "Rendering",
stack : new Error().stack
});
return defer.promise;
}
if(this._rendering) {
this._displayQ.push(arguments);
return;
// Pass along the current defer
this._displayQ.enqueue("displayChapter", [chap, end, defer]);
return defer.promise;
}
if(_.isNumber(chap)){
@ -673,10 +689,16 @@ EPUBJS.Book.prototype.displayChapter = function(chap, end){
render.then(function(chapter){
// chapter.currentLocationCfi = chap;
chapter.gotoCfi(cfi);
defer.resolve(book.renderer);
});
} else if(end) {
render.then(function(chapter){
chapter.lastPage();
defer.resolve(book.renderer);
});
} else {
render.then(function(){
defer.resolve(book.renderer);
});
}
@ -691,21 +713,17 @@ EPUBJS.Book.prototype.displayChapter = function(chap, end){
//-- Clear render queue
render.then(function(){
var inwait;
book._rendering = false;
if(book._displayQ.length) {
inwait = book._displayQ.shift();
book.displayChapter.apply(book, inwait);
}
book._displayQ.dequeue();
});
return render;
return defer.promise;
};
EPUBJS.Book.prototype.nextPage = function(){
var next;
if(!this.isRendered) return this._enqueue("nextPage", arguments);
if(!this.isRendered) return this._q.enqueue("nextPage", arguments);
next = this.renderer.nextPage();
@ -717,7 +735,7 @@ EPUBJS.Book.prototype.nextPage = function(){
EPUBJS.Book.prototype.prevPage = function() {
var prev;
if(!this.isRendered) return this._enqueue("prevPage", arguments);
if(!this.isRendered) return this._q.enqueue("prevPage", arguments);
prev = this.renderer.prevPage();
@ -750,28 +768,48 @@ EPUBJS.Book.prototype.getCurrentLocationCfi = function() {
return this.renderer.currentLocationCfi;
};
EPUBJS.Book.prototype.gotoCfi = function(cfiString){
EPUBJS.Book.prototype.goto = function(target){
if(typeof target === "number"){
return this.gotoPage(target);
} else if(target.indexOf("epubcfi(") === 0) {
return this.gotoCfi(target);
} else if(target.indexOf("%") === target.length-1) {
return this.gotoPercentage(parseInt(target.substring(0, target.length-1)));
} else {
return this.gotoHref(target);
}
};
EPUBJS.Book.prototype.gotoCfi = function(cfiString, defer){
var cfi,
spinePos,
spineItem,
rendered,
deferred;
deferred = defer || new RSVP.defer();
if(!this.isRendered) {
this.settings.previousLocationCfi = cfiString;
return false;
}
// Currently going to a chapter
if(this._moving) {
this._gotoQ.enqueue("gotoCfi", [cfiString, deferred]);
return false;
}
cfi = new EPUBJS.EpubCFI(cfiString);
spinePos = cfi.spinePos;
spineItem = this.spine[spinePos];
deferred = new RSVP.defer();
promise = deferred.promise;
this._moving = true;
//-- If same chapter only stay on current chapter
if(this.currentChapter && this.spinePos === spinePos){
this.renderer.gotoCfi(cfi);
deferred.resolve(this.currentChapter);
return deferred.promise;
this._moving = false;
deferred.resolve(this.renderer.currentLocationCfi);
} else {
if(!spineItem || spinePos == -1) {
@ -786,22 +824,33 @@ EPUBJS.Book.prototype.gotoCfi = function(cfiString){
render = this.renderer.displayChapter(this.currentChapter, this.globalLayoutProperties);
render.then(function(rendered){
rendered.gotoCfi(cfi);
});
rendered.gotoCfi(cfi);
this._moving = false;
deferred.resolve(rendered.currentLocationCfi);
}.bind(this));
}
return render;
}
promise.then(function(){
this._gotoQ.dequeue();
}.bind(this));
return promise;
};
EPUBJS.Book.prototype.goto = function(url){
EPUBJS.Book.prototype.gotoHref = function(url, defer){
var split, chapter, section, absoluteURL, spinePos;
var deferred = new RSVP.defer();
//if(!this.isRendered) return this._enqueue("goto", arguments);
var deferred = defer || new RSVP.defer();
if(!this.isRendered) {
this.settings.goto = url;
return;
return false;
}
// Currently going to a chapter
if(this._moving) {
this._gotoQ.enqueue("gotoHref", [url, deferred]);
return false;
}
split = url.split("#");
@ -821,14 +870,34 @@ EPUBJS.Book.prototype.goto = function(url){
if(!this.currentChapter || spinePos != this.currentChapter.spinePos){
//-- Load new chapter if different than current
return this.displayChapter(spinePos).then(function(){
if(section) this.render.section(section);
}.bind(this));
if(section){
this.render.section(section);
}
deferred.resolve(this.renderer.currentLocationCfi);
}.bind(this));
}else{
//-- Only goto section
if(section) this.render.section(section);
deferred.resolve(this.currentChapter);
return deferred.promise;
if(section) {
this.render.section(section);
}
deferred.resolve(this.renderer.currentLocationCfi);
}
promise.then(function(){
this._gotoQ.dequeue();
}.bind(this));
return deferred.promise;
};
EPUBJS.Book.prototype.gotoPage = function(pg){
var cfi = this.pagination.cfiFromPage(pg);
return this.gotoCfi(cfi);
};
EPUBJS.Book.prototype.gotoPercentage = function(percent){
var pg = this.pagination.pageFromPercentage(percent);
return this.gotoCfi(pg);
};
EPUBJS.Book.prototype.preloadNextChapter = function() {
@ -888,7 +957,7 @@ EPUBJS.Book.prototype.fromStorage = function(stored) {
*/
EPUBJS.Book.prototype.setStyle = function(style, val, prefixed) {
if(!this.isRendered) return this._enqueue("setStyle", arguments);
if(!this.isRendered) return this._q.enqueue("setStyle", arguments);
this.settings.styles[style] = val;
@ -897,14 +966,14 @@ EPUBJS.Book.prototype.setStyle = function(style, val, prefixed) {
};
EPUBJS.Book.prototype.removeStyle = function(style) {
if(!this.isRendered) return this._enqueue("removeStyle", arguments);
if(!this.isRendered) return this._q.enqueue("removeStyle", arguments);
this.renderer.removeStyle(style);
this.renderer.reformat();
delete this.settings.styles[style];
};
EPUBJS.Book.prototype.addHeadTag = function(tag, attrs) {
if(!this.isRendered) return this._enqueue("addHeadTag", arguments);
if(!this.isRendered) return this._q.enqueue("addHeadTag", arguments);
this.settings.headTags[tag] = attrs;
};
@ -947,15 +1016,6 @@ EPUBJS.Book.prototype.destroy = function() {
};
EPUBJS.Book.prototype._enqueue = function(command, args) {
this._q.push({
'command': command,
'args': args
});
};
EPUBJS.Book.prototype._ready = function() {
this.trigger("book:ready");
@ -968,21 +1028,18 @@ EPUBJS.Book.prototype._rendered = function(err) {
this.isRendered = true;
this.trigger("book:rendered");
this._q.forEach(function(item){
book[item.command].apply(book, item.args);
});
this._q.flush();
};
EPUBJS.Book.prototype.applyStyles = function(callback){
if(!this.isRendered) return this._enqueue("applyStyles", arguments);
if(!this.isRendered) return this._q.enqueue("applyStyles", arguments);
this.renderer.applyStyles(this.settings.styles);
callback();
};
EPUBJS.Book.prototype.applyHeadTags = function(callback){
if(!this.isRendered) return this._enqueue("applyHeadTags", arguments);
if(!this.isRendered) return this._q.enqueue("applyHeadTags", arguments);
this.renderer.applyHeadTags(this.settings.headTags);
callback();
};

41
src/core.js
View file

@ -344,3 +344,44 @@ EPUBJS.core.locationOf = function(item, array, compareFunction, _start, _end) {
return EPUBJS.core.locationOf(item, array, compareFunction, start, pivot);
}
};
EPUBJS.core.queue = function(_scope){
var _q = [];
var scope = _scope;
// Add an item to the queue
var enqueue = function(funcName, args, context) {
_q.push({
"funcName" : funcName,
"args" : args,
"context" : context
});
return _q;
};
// Run one item
var dequeue = function(){
var inwait;
if(_q.length) {
inwait = _q.shift();
// Defer to any current tasks
setTimeout(function(){
scope[inwait.funcName].apply(inwait.context || scope, inwait.args);
}, 0);
}
};
// Run All
var flush = function(){
while(_q.length) {
dequeue();
}
};
// Clear all items in wait
var clear = function(){
_q = [];
};
return {
"enqueue" : enqueue,
"dequeue" : dequeue,
"flush" : flush,
"clear" : clear
};
};

7
src/epubcfi.js
View file

@ -276,8 +276,11 @@ EPUBJS.EpubCFI.prototype.findParent = function(cfi, _doc) {
}else{
element = children[part.index];
}
if(!element) return console.error("No Element For", part, cfi);
// Element can't be found
if(typeof element === "undefined") {
console.error("No Element For", part, cfi.str);
return false;
}
// Get current element children and continue through steps
children = Array.prototype.slice.call(element.children);
}

11
src/pagination.js
View file

@ -70,14 +70,3 @@ EPUBJS.Pagination.prototype.percentageFromCfi = function(cfi){
var percentage = this.percentageFromPage(pg);
return percentage;
};
// TODO: move these
EPUBJS.Book.prototype.gotoPage = function(pg){
var cfi = this.pagination.cfiFromPage(pg);
return this.gotoCfi(cfi);
};
EPUBJS.Book.prototype.gotoPercentage = function(percent){
var pg = this.pagination.pageFromPercentage(percent);
return this.gotoCfi(pg);
};

4
tests/render.js
View file

@ -10,7 +10,7 @@ asyncTest("renderTo element on page", 1, function() {
start();
};
render.then(result, result);
render.then(result).catch(result);
});
@ -177,8 +177,6 @@ asyncTest("Add styles to book", 4, function() {
var $iframe = $( "iframe", "#qunit-fixture" ),
$body;
console.log(Book)
equal( Book.renderer.render.bodyEl.style.background, '', "background not set");
Book.setStyle("background", "purple");