mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-11-23 18:17:20 +00:00
Introduce new Renderer class
Another massive refactoring, with a bit more polishing to come
This commit is contained in:
Jeremy Ruston
parent
664ce709ab
commit
fef0b9e4da
436
js/Renderer.js
Normal file
436
js/Renderer.js
Normal file
@ -0,0 +1,436 @@
|
||||
/*\
|
||||
title: js/Renderer.js
|
||||
|
||||
Renderer objects
|
||||
|
||||
\*/
|
||||
(function(){
|
||||
|
||||
/*jshint node: true, browser: true, newcap: true */
|
||||
"use strict";
|
||||
|
||||
var utils = require("./Utils.js");
|
||||
|
||||
var MacroNode = function(macroName,paramFn,children,dependencies,store) {
|
||||
if(this instanceof MacroNode) {
|
||||
this.macroName = macroName;
|
||||
this.macro = store.macros[macroName];
|
||||
this.paramFn = paramFn; // Can be a function yielding a hashmap, or a direct hashmap
|
||||
this.children = children;
|
||||
this.dependencies = dependencies;
|
||||
this.store = store;
|
||||
} else {
|
||||
return new MacroNode(macroName,paramFn,children,dependencies,store);
|
||||
}
|
||||
};
|
||||
|
||||
MacroNode.prototype.clone = function() {
|
||||
return new MacroNode(this.macroName,this.paramFn,this.cloneChildren(),this.dependencies,this.store);
|
||||
};
|
||||
|
||||
MacroNode.prototype.cloneChildren = function() {
|
||||
var childClones;
|
||||
if(this.children) {
|
||||
childClones = [];
|
||||
for(var t=0; t<this.children.length; t++) {
|
||||
childClones.push(this.children[t].clone());
|
||||
}
|
||||
}
|
||||
return childClones;
|
||||
};
|
||||
|
||||
MacroNode.prototype.execute = function(tiddler) {
|
||||
// Evaluate the macro parameters to get their values
|
||||
if(typeof this.paramFn === "object") {
|
||||
this.params = this.paramFn;
|
||||
} else {
|
||||
this.params = this.paramFn(tiddler,this.store,utils);
|
||||
}
|
||||
// Save the context tiddler
|
||||
this.tiddlerTitle = tiddler.title;
|
||||
// Render the macro to get its content
|
||||
this.content = this.macro.execute(this,tiddler,this.store);
|
||||
};
|
||||
|
||||
MacroNode.prototype.render = function(type) {
|
||||
var output = [];
|
||||
for(var t=0; t<this.content.length; t++) {
|
||||
output.push(this.content[t].render(type));
|
||||
}
|
||||
return output.join("");
|
||||
};
|
||||
|
||||
MacroNode.prototype.renderInDom = function(domNode,insertBefore) {
|
||||
// Create the wrapper node for the macro
|
||||
var macroContainer = document.createElement(this.macro.wrapperTag || "div");
|
||||
this.domNode = macroContainer;
|
||||
if(insertBefore) {
|
||||
domNode.insertBefore(macroContainer,insertBefore);
|
||||
} else {
|
||||
domNode.appendChild(macroContainer);
|
||||
}
|
||||
// Add some debugging information to it
|
||||
macroContainer.setAttribute("data-tw-macro",this.macroName);
|
||||
// Add event handlers to the node
|
||||
var self = this,
|
||||
dispatchMacroEvent = function(event) {
|
||||
self.macro.events[event.type](event,self);
|
||||
};
|
||||
for(var e in this.macro.events) {
|
||||
macroContainer.addEventListener(e,dispatchMacroEvent,false);
|
||||
}
|
||||
// Render the content of the macro
|
||||
for(var t=0; t<this.content.length; t++) {
|
||||
this.content[t].renderInDom(macroContainer);
|
||||
}
|
||||
};
|
||||
|
||||
MacroNode.prototype.refreshInDom = function(changes) {
|
||||
var t,
|
||||
self = this,
|
||||
hasDependencyChanged = function() {
|
||||
if(self.dependencies.dependentAll) {
|
||||
return true;
|
||||
}
|
||||
for(var rel in self.dependencies) {
|
||||
if(rel !== "dependentAll") {
|
||||
for(var t in self.dependencies[rel]) {
|
||||
if(changes.hasOwnProperty(t)) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
return false;
|
||||
};
|
||||
// Check if any of the dependencies of this macro node have changed
|
||||
if(hasDependencyChanged()) {
|
||||
// Ask the macro to rerender itself if it can
|
||||
var tiddler = this.store.getTiddler(this.tiddlerTitle);
|
||||
if(this.macro.refresh) {
|
||||
this.macro.refresh(this,tiddler,this.store);
|
||||
} else {
|
||||
// Manually reexecute and rerender this macro
|
||||
while(this.domNode.hasChildNodes()) {
|
||||
this.domNode.removeChild(this.domNode.firstChild);
|
||||
}
|
||||
this.execute(tiddler);
|
||||
for(t=0; t<this.content.length; t++) {
|
||||
this.content[t].renderInDom(this.domNode);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// Refresh any children
|
||||
for(t=0; t<this.content.length; t++) {
|
||||
this.content[t].refreshInDom(changes);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
var ElementNode = function(type,attributes,children) {
|
||||
if(this instanceof ElementNode) {
|
||||
this.type = type;
|
||||
this.attributes = attributes;
|
||||
this.children = children;
|
||||
} else {
|
||||
return new ElementNode(type,attributes,children);
|
||||
}
|
||||
};
|
||||
|
||||
ElementNode.prototype.clone = function() {
|
||||
var childClones;
|
||||
if(this.children) {
|
||||
childClones = [];
|
||||
for(var t=0; t<this.children.length; t++) {
|
||||
childClones.push(this.children[t].clone());
|
||||
}
|
||||
}
|
||||
return new ElementNode(this.type,this.attributes,childClones);
|
||||
};
|
||||
|
||||
ElementNode.prototype.execute = function(tiddler) {
|
||||
if(this.children) {
|
||||
for(var t=0; t<this.children.length; t++) {
|
||||
this.children[t].execute(tiddler);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
ElementNode.prototype.render = function(type) {
|
||||
var isHtml = type === "text/html",
|
||||
output = [];
|
||||
if(isHtml) {
|
||||
output.push("<",this.type);
|
||||
if(this.attributes) {
|
||||
for(var a in this.attributes) {
|
||||
var v = this.attributes[a];
|
||||
if(v !== undefined) {
|
||||
if(v instanceof Array) {
|
||||
v = v.join(" ");
|
||||
} else if(typeof v === "object") {
|
||||
var s = [];
|
||||
for(var p in v) {
|
||||
s.push(p + ":" + v[p] + ";");
|
||||
}
|
||||
v = s.join("");
|
||||
}
|
||||
output.push(" ",a,"='",utils.htmlEncode(v),"'");
|
||||
}
|
||||
}
|
||||
}
|
||||
output.push(">");
|
||||
}
|
||||
if(this.children) {
|
||||
for(var t=0; t<this.children.length; t++) {
|
||||
output.push(this.children[t].render(type));
|
||||
}
|
||||
if(isHtml) {
|
||||
output.push("</",this.type,">");
|
||||
}
|
||||
}
|
||||
return output.join("");
|
||||
};
|
||||
|
||||
ElementNode.prototype.renderInDom = function(domNode) {
|
||||
var element = document.createElement(this.type);
|
||||
if(this.attributes) {
|
||||
for(var a in this.attributes) {
|
||||
var v = this.attributes[a];
|
||||
if(v !== undefined) {
|
||||
if(v instanceof Array) { // Ahem, could there be arrays other than className?
|
||||
element.className = v.join(" ");
|
||||
} else if (typeof v === "object") { // ...or objects other than style?
|
||||
for(var p in v) {
|
||||
element.style[p] = v[p];
|
||||
}
|
||||
} else {
|
||||
element.setAttribute(a,v);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
domNode.appendChild(element);
|
||||
if(this.children) {
|
||||
for(var t=0; t<this.children.length; t++) {
|
||||
this.children[t].renderInDom(element);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
ElementNode.prototype.refreshInDom = function(changes) {
|
||||
if(this.children) {
|
||||
for(var t=0; t<this.children.length; t++) {
|
||||
this.children[t].refreshInDom(changes);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
var TextNode = function(text) {
|
||||
if(this instanceof TextNode) {
|
||||
this.text = text;
|
||||
} else {
|
||||
return new TextNode(text);
|
||||
}
|
||||
};
|
||||
|
||||
TextNode.prototype.clone = function() {
|
||||
// We don't actually clone text nodes, instead we re-use them
|
||||
return this;
|
||||
};
|
||||
|
||||
TextNode.prototype.execute = function(tiddler) {
|
||||
// Text nodes don't need executing
|
||||
};
|
||||
|
||||
TextNode.prototype.render = function(type) {
|
||||
return type === "text/html" ? utils.htmlEncode(this.text) : this.text;
|
||||
};
|
||||
|
||||
TextNode.prototype.renderInDom = function(domNode) {
|
||||
domNode.appendChild(document.createTextNode(this.text));
|
||||
};
|
||||
|
||||
TextNode.prototype.refreshInDom = function(changes) {
|
||||
// Text nodes don't need refreshing
|
||||
};
|
||||
|
||||
var EntityNode = function(entity) {
|
||||
if(this instanceof EntityNode) {
|
||||
this.entity = entity;
|
||||
} else {
|
||||
return new EntityNode(entity);
|
||||
}
|
||||
};
|
||||
|
||||
EntityNode.prototype.clone = function() {
|
||||
// We don't actually clone entity nodes, instead we re-use them
|
||||
return this;
|
||||
};
|
||||
|
||||
EntityNode.prototype.execute = function(tiddler) {
|
||||
// Entity nodes don't need executing
|
||||
};
|
||||
|
||||
EntityNode.prototype.render = function(type) {
|
||||
return type === "text/html" ? this.entity : utils.entityDecode(this.entity);
|
||||
};
|
||||
|
||||
EntityNode.prototype.renderInDom = function(domNode) {
|
||||
domNode.appendChild(document.createTextNode(utils.entityDecode(this.entity)));
|
||||
};
|
||||
|
||||
EntityNode.prototype.refreshInDom = function(changes) {
|
||||
// Entity nodes don't need refreshing
|
||||
};
|
||||
|
||||
var RawNode = function(html) {
|
||||
if(this instanceof RawNode) {
|
||||
this.html = html;
|
||||
} else {
|
||||
return new RawNode(html);
|
||||
}
|
||||
};
|
||||
|
||||
RawNode.prototype.clone = function() {
|
||||
// We don't actually clone raw nodes, instead we re-use them
|
||||
return this;
|
||||
};
|
||||
|
||||
RawNode.prototype.execute = function(tiddler) {
|
||||
// Raw nodes don't need executing
|
||||
};
|
||||
|
||||
RawNode.prototype.render = function(type) {
|
||||
return this.html;
|
||||
};
|
||||
|
||||
RawNode.prototype.renderInDom = function(domNode) {
|
||||
var div = document.createElement("div");
|
||||
div.innerHTML = this.html;
|
||||
domNode.appendChild(div);
|
||||
};
|
||||
|
||||
RawNode.prototype.refreshInDom = function(changes) {
|
||||
// Raw nodes don't need refreshing
|
||||
};
|
||||
|
||||
/*
|
||||
Static method to construct a label
|
||||
*/
|
||||
var LabelNode = function(type,value,classes) {
|
||||
classes = (classes || []).slice(0);
|
||||
classes.push("label");
|
||||
return ElementNode("span",{
|
||||
"class": classes,
|
||||
"data-tw-label-type": type
|
||||
},value);
|
||||
};
|
||||
|
||||
/*
|
||||
Static method to construct a split label
|
||||
*/
|
||||
var SplitLabelNode = function(type,left,right,classes) {
|
||||
classes = (classes || []).slice(0);
|
||||
classes.push("splitLabel");
|
||||
return ElementNode("span",{
|
||||
"class": classes
|
||||
},[
|
||||
ElementNode("span",{
|
||||
"class": ["splitLabelLeft"],
|
||||
"data-tw-label-type": type
|
||||
},left),
|
||||
ElementNode("span",{
|
||||
"class": ["splitLabelRight"]
|
||||
},right)
|
||||
]);
|
||||
};
|
||||
|
||||
/*
|
||||
Static method to construct a slider
|
||||
*/
|
||||
var SliderNode = function(type,label,tooltip,children) {
|
||||
var attributes = {
|
||||
"class": "tw-slider",
|
||||
"data-tw-slider-type": type
|
||||
};
|
||||
if(tooltip) {
|
||||
attributes.alt = tooltip;
|
||||
attributes.title = tooltip;
|
||||
}
|
||||
return ElementNode("div",
|
||||
attributes,
|
||||
[
|
||||
ElementNode("a",
|
||||
{
|
||||
"class": ["tw-slider-label"]
|
||||
},[
|
||||
TextNode(label)
|
||||
]
|
||||
),
|
||||
ElementNode("div",
|
||||
{
|
||||
"class": ["tw-slider-body"],
|
||||
"style": {"display": "none"}
|
||||
},
|
||||
children
|
||||
)
|
||||
]
|
||||
);
|
||||
};
|
||||
|
||||
/*
|
||||
Construct a renderer object to render a tiddler, optionally specifying a template it should be rendered through
|
||||
*/
|
||||
var Renderer = function(tiddlerTitle,templateTitle,store) {
|
||||
var t;
|
||||
// If there is no template specified, use the tiddler as its own template
|
||||
templateTitle = templateTitle || tiddlerTitle;
|
||||
// Save parameters
|
||||
this.tiddlerTitle = tiddlerTitle;
|
||||
this.templateTitle = templateTitle;
|
||||
this.store = store;
|
||||
// Start the renderer with a copy of the parse tree for this tiddler template
|
||||
var parseTree = store.parseTiddler(templateTitle).tree;
|
||||
this.steps = [];
|
||||
for(t=0; t<parseTree.length; t++) {
|
||||
this.steps.push(parseTree[t].clone());
|
||||
}
|
||||
// Execute the macros in the root
|
||||
var tiddler = store.getTiddler(tiddlerTitle);
|
||||
for(t=0; t<this.steps.length; t++) {
|
||||
this.steps[t].execute(tiddler);
|
||||
}
|
||||
};
|
||||
|
||||
Renderer.prototype.render = function(type) {
|
||||
var output = [];
|
||||
// Render the root nodes
|
||||
for(var t=0; t<this.steps.length; t++) {
|
||||
output.push(this.steps[t].render(type));
|
||||
}
|
||||
return output.join("");
|
||||
};
|
||||
|
||||
Renderer.prototype.renderInDom = function(domNode,type) {
|
||||
for(var t=0; t<this.steps.length; t++) {
|
||||
this.steps[t].renderInDom(domNode,type);
|
||||
}
|
||||
};
|
||||
|
||||
Renderer.prototype.refreshInDom = function(changes) {
|
||||
for(var t=0; t<this.steps.length; t++) {
|
||||
this.steps[t].refreshInDom(changes);
|
||||
}
|
||||
};
|
||||
|
||||
Renderer.MacroNode = MacroNode;
|
||||
Renderer.ElementNode = ElementNode;
|
||||
Renderer.TextNode = TextNode;
|
||||
Renderer.EntityNode = EntityNode;
|
||||
Renderer.LabelNode = LabelNode;
|
||||
Renderer.SplitLabelNode = SplitLabelNode;
|
||||
Renderer.SliderNode = SliderNode;
|
||||
|
||||
exports.Renderer = Renderer;
|
||||
|
||||
})();
|
||||
Loading…
Reference in New Issue
Block a user