geary/ui/composer-web-view.js
Michael James Gratton fd97ad2887 Reimplement inserting/removing \t chars in the composer.
* ui/composer-web-view.js (ComposerPageState): Add tabOut/tabIn
  functions, listen to key Tab key pressess on the body and invoke the
  appropriate method if found.

* src/client/web-process/util-composer.vala: Removed old vala
  implementation of same.
2017-02-01 00:41:44 +11:00

321 lines
11 KiB
JavaScript
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/*
* Copyright 2016 Software Freedom Conservancy Inc.
* Copyright 2016 Michael Gratton <mike@vee.net>
*
* This software is licensed under the GNU Lesser General Public License
* (version 2.1 or later). See the COPYING file in this distribution.
*/
/**
* Application logic for ComposerWebView.
*/
let ComposerPageState = function() {
this.init.apply(this, arguments);
};
ComposerPageState.BODY_ID = "message-body";
ComposerPageState.QUOTE_START = "‘";
ComposerPageState.QUOTE_END = "’";
ComposerPageState.QUOTE_MARKER = "\x7f";
ComposerPageState.prototype = {
__proto__: PageState.prototype,
init: function() {
PageState.prototype.init.apply(this, []);
this.messageBody = null;
this.undoEnabled = false;
this.redoEnabled = false;
this.cursorFontFamily = null;
this.cursorFontSize = null;
let state = this;
document.addEventListener("click", function(e) {
if (e.target.tagName == "A") {
state.linkClicked(e.target);
}
}, true);
this.bodyObserver = new MutationObserver(function() {
state.checkCommandStack();
});
},
loaded: function() {
let state = this;
this.messageBody = document.getElementById(ComposerPageState.BODY_ID);
this.messageBody.addEventListener("keydown", function(e) {
if (e.keyCode == 9) {
if (!e.shiftKey) {
state.tabOut();
} else {
state.tabIn();
}
e.preventDefault();
}
});
// Search for and remove a particular styling when we quote
// text. If that style exists in the quoted text, we alter it
// slightly so we don't mess with it later.
let nodeList = document.querySelectorAll(
"blockquote[style=\"margin: 0 0 0 40px; border: none; padding: 0px;\"]");
for (let i = 0; i < nodeList.length; ++i) {
nodeList.item(i).setAttribute(
"style",
"margin: 0 0 0 40px; padding: 0px; border:none;"
);
}
// Focus within the HTML document
document.body.focus();
// Set cursor at appropriate position
let cursor = document.getElementById("cursormarker");
if (cursor != null) {
let range = document.createRange();
range.selectNodeContents(cursor);
range.collapse(false);
let selection = window.getSelection();
selection.removeAllRanges();
selection.addRange(range);
cursor.parentNode.removeChild(cursor);
}
// Enable editing and observation machinery only after
// modifying the body above.
this.messageBody.contentEditable = true;
this.setBodyObserverEnabled(true);
// Chain up here so we continue to a preferred size update
// after munging the HTML above.
PageState.prototype.loaded.apply(this, []);
},
undo: function() {
document.execCommand("undo", false, null);
this.checkCommandStack();
},
redo: function() {
document.execCommand("redo", false, null);
this.checkCommandStack();
},
tabOut: function() {
document.execCommand(
"inserthtml", false, "<span style='white-space: pre-wrap'>\t</span>"
);
},
tabIn: function() {
// If there is no selection and the character before the
// cursor is tab, delete it.
let selection = window.getSelection();
if (selection.isCollapsed) {
selection.modify("extend", "backward", "character");
if (selection.getRangeAt(0).toString() == "\t") {
document.execCommand("delete", false, null);
} else {
selection.collapseToEnd();
}
}
},
getHtml: function() {
return this.messageBody.innerHTML;
},
getText: function() {
return ComposerPageState.htmlToQuotedText(this.messageBody);
},
setRichText: function(enabled) {
if (enabled) {
document.body.classList.remove("plain");
} else {
document.body.classList.add("plain");
}
},
setBodyObserverEnabled: function(enabled) {
if (enabled) {
let config = {
attributes: true,
childList: true,
characterData: true,
subtree: true
};
this.bodyObserver.observe(this.messageBody, config);
} else {
this.bodyObserver.disconnect();
}
},
checkCommandStack: function() {
let canUndo = document.queryCommandEnabled("undo");
let canRedo = document.queryCommandEnabled("redo");
// Update the body observer - if we can undo we don't need to
// keep an eye on mutations any more, until we can't undo
// again.
this.setBodyObserverEnabled(!canUndo);
if (canUndo != this.undoEnabled || canRedo != this.redoEnabled) {
this.undoEnabled = canUndo;
this.redoEnabled = canRedo;
window.webkit.messageHandlers.commandStackChanged.postMessage(
this.undoEnabled + "," + this.redoEnabled
);
}
},
undoBlockquoteStyle: function() {
let nodeList = document.querySelectorAll(
"blockquote[style=\"margin: 0 0 0 40px; border: none; padding: 0px;\"]"
);
for (let i = 0; i < nodeList.length; ++i) {
let element = nodeList.item(i);
element.removeAttribute("style");
element.setAttribute("type", "cite");
}
},
linkClicked: function(element) {
window.getSelection().selectAllChildren(element);
},
selectionChanged: function() {
PageState.prototype.selectionChanged.apply(this, []);
let selection = window.getSelection();
let active = selection.focusNode;
if (active != null && active.nodeType != Node.ELEMENT_TYPE) {
active = active.parentNode;
}
if (active != null) {
let styles = window.getComputedStyle(active);
let fontFamily = styles.getPropertyValue("font-family");
let fontSize = styles.getPropertyValue("font-size");
if (fontFamily != this.cursorFontFamily ||
fontSize != this.cursorFontSize) {
this.cursorFontFamily = fontFamily;
this.cursorFontSize = fontSize;
window.webkit.messageHandlers.cursorStyleChanged.postMessage(
fontFamily + "," + fontSize
);
}
}
}
};
/**
* Convert a HTML DOM tree to plain text with delineated quotes.
*
* Lines are delinated using LF. Quoted lines are prefixed with
* `ComposerPageState.QUOTE_MARKER`, where the number of markers
* indicates the depth of nesting of the quote.
*
* This will modify/reset the DOM, since it ultimately requires
* stuffing `QUOTE_MARKER` into existing paragraphs and getting it
* back out in a way that preserves the visual presentation.
*/
ComposerPageState.htmlToQuotedText = function(root) {
// XXX It would be nice to just clone the root and modify that, or
// see if we can implement this some other way so as to not modify
// the DOM at all, but currently unit test show that the results
// are not the same if we work on a clone, likely because of the
// use of HTMLElement::innerText. Need to look into it more.
let savedDoc = root.innerHTML;
let blockquotes = root.querySelectorAll("blockquote");
let nbq = blockquotes.length;
let bqtexts = new Array(nbq);
// Get text of blockquotes and pull them out of DOM. They are
// replaced with tokens deliminated with the characters
// QUOTE_START and QUOTE_END (from a unicode private use block).
// We need to get the text while they're still in the DOM to get
// newlines at appropriate places. We go through the list of
// blockquotes from the end so that we get the innermost ones
// first.
for (let i = nbq - 1; i >= 0; i--) {
let bq = blockquotes.item(i);
let text = bq.innerText;
if (text.substr(-1, 1) == "\n") {
text = text.slice(0, -1);
} else {
console.debug(
" no newline at end of quote: " +
text.length > 0
? "0x" + text.codePointAt(text.length - 1).toString(16)
: "empty line"
);
}
bqtexts[i] = text;
bq.innerText = (
ComposerPageState.QUOTE_START
+ i.toString()
+ ComposerPageState.QUOTE_END
);
}
// Reassemble plain text out of parts, and replace non-breaking
// space with regular space.
let text = ComposerPageState.resolveNesting(root.innerText, bqtexts);
// Reassemble DOM now we have the plain text
root.innerHTML = savedDoc;
return ComposerPageState.replaceNonBreakingSpace(text);
};
ComposerPageState.resolveNesting = function(text, values) {
let tokenregex = new RegExp(
"(.?)" +
ComposerPageState.QUOTE_START +
"([0-9]*)" +
ComposerPageState.QUOTE_END +
"(?=(.?))", "g"
);
return text.replace(tokenregex, function(match, p1, p2, p3, offset, str) {
let key = new Number(p2);
let prevChars = p1;
let nextChars = p3;
let insertNext = "";
// Make sure there's a newline before and after the quote.
if (prevChars != "" && prevChars != "\n")
prevChars = prevChars + "\n";
if (nextChars != "" && nextChars != "\n")
insertNext = "\n";
let value = "";
if (key >= 0 && key < values.length) {
let nested = ComposerPageState.resolveNesting(values[key], values);
value = prevChars + ComposerPageState.quoteLines(nested) + insertNext;
} else {
console.error("Regex error in denesting blockquotes: Invalid key");
}
return value;
});
};
/**
* Prefixes each NL-delineated line with `ComposerPageState.QUOTE_MARKER`.
*/
ComposerPageState.quoteLines = function(text) {
let lines = text.split("\n");
for (let i = 0; i < lines.length; i++)
lines[i] = ComposerPageState.QUOTE_MARKER + lines[i];
return lines.join("\n");
};
/**
* Converts all non-breaking space chars to plain spaces.
*/
ComposerPageState.replaceNonBreakingSpace = function(text) {
// XXX this is a separate function for unit testing - since when
// running as a unit test, HTMLElement.innerText appears to not
// convert &nbsp into U+00A0.
return text.replace(new RegExp(" ", "g"), " ");
};
var geary = new ComposerPageState();
window.onload = function() {
geary.loaded();
};