mirror of
https://github.com/odoo/owl.git
synced 2025-10-06 19:59:41 +07:00
Géry Debongnie
342 lines
11 KiB
TypeScript
342 lines
11 KiB
TypeScript
import { CompilationContext } from "./compilation_context";
|
|
import { QWeb } from "./qweb";
|
|
import { htmlToVDOM } from "../vdom/html_to_vdom";
|
|
|
|
/**
|
|
* Owl QWeb Directives
|
|
*
|
|
* This file contains the implementation of most standard QWeb directives:
|
|
* - t-esc
|
|
* - t-raw
|
|
* - t-set/t-value
|
|
* - t-if/t-elif/t-else
|
|
* - t-call
|
|
* - t-foreach/t-as
|
|
* - t-debug
|
|
* - t-log
|
|
*/
|
|
|
|
//------------------------------------------------------------------------------
|
|
// t-esc and t-raw
|
|
//------------------------------------------------------------------------------
|
|
QWeb.utils.getFragment = function(str: string): DocumentFragment {
|
|
const temp = document.createElement("template");
|
|
temp.innerHTML = str;
|
|
return temp.content;
|
|
};
|
|
|
|
QWeb.utils.htmlToVDOM = htmlToVDOM;
|
|
|
|
function compileValueNode(value: any, node: Element, qweb: QWeb, ctx: CompilationContext) {
|
|
if (value === "0" && ctx.caller) {
|
|
qweb._compileNode(ctx.caller, ctx);
|
|
return;
|
|
}
|
|
|
|
if (value.xml instanceof NodeList && !value.id) {
|
|
for (let node of Array.from(value.xml)) {
|
|
qweb._compileNode(<ChildNode>node, ctx);
|
|
}
|
|
return;
|
|
}
|
|
let exprID: string;
|
|
if (typeof value === "string") {
|
|
exprID = `_${ctx.generateID()}`;
|
|
ctx.addLine(`var ${exprID} = ${ctx.formatExpression(value)};`);
|
|
} else {
|
|
exprID = value.id;
|
|
}
|
|
ctx.addIf(`${exprID} || ${exprID} === 0`);
|
|
if (ctx.escaping) {
|
|
if (ctx.parentTextNode) {
|
|
ctx.addLine(`vn${ctx.parentTextNode}.text += ${exprID};`);
|
|
} else if (ctx.parentNode) {
|
|
ctx.addLine(`c${ctx.parentNode}.push({text: ${exprID}});`);
|
|
} else {
|
|
let nodeID = ctx.generateID();
|
|
ctx.rootContext.rootNode = nodeID;
|
|
ctx.rootContext.parentTextNode = nodeID;
|
|
ctx.addLine(`var vn${nodeID} = {text: ${exprID}};`);
|
|
if (ctx.rootContext.shouldDefineResult) {
|
|
ctx.addLine(`result = vn${nodeID}`);
|
|
}
|
|
}
|
|
} else {
|
|
ctx.rootContext.shouldDefineUtils = true;
|
|
ctx.addLine(`c${ctx.parentNode}.push(...utils.htmlToVDOM(${exprID}));`);
|
|
}
|
|
if (node.childNodes.length) {
|
|
ctx.addElse();
|
|
qweb._compileChildren(node, ctx);
|
|
}
|
|
|
|
if (value.xml instanceof NodeList && value.id) {
|
|
ctx.addElse();
|
|
for (let node of Array.from(value.xml)) {
|
|
qweb._compileNode(<ChildNode>node, ctx);
|
|
}
|
|
}
|
|
ctx.closeIf();
|
|
}
|
|
|
|
QWeb.addDirective({
|
|
name: "esc",
|
|
priority: 70,
|
|
atNodeEncounter({ node, qweb, ctx }): boolean {
|
|
let value = ctx.getValue(node.getAttribute("t-esc")!);
|
|
compileValueNode(value, node, qweb, ctx.subContext("escaping", true));
|
|
return true;
|
|
}
|
|
});
|
|
|
|
QWeb.addDirective({
|
|
name: "raw",
|
|
priority: 80,
|
|
atNodeEncounter({ node, qweb, ctx }): boolean {
|
|
let value = ctx.getValue(node.getAttribute("t-raw")!);
|
|
compileValueNode(value, node, qweb, ctx);
|
|
return true;
|
|
}
|
|
});
|
|
|
|
//------------------------------------------------------------------------------
|
|
// t-set
|
|
//------------------------------------------------------------------------------
|
|
QWeb.addDirective({
|
|
name: "set",
|
|
extraNames: ["value"],
|
|
priority: 60,
|
|
atNodeEncounter({ node, ctx }): boolean {
|
|
const variable = node.getAttribute("t-set")!;
|
|
let value = node.getAttribute("t-value")!;
|
|
ctx.variables[variable] = ctx.variables[variable] || {};
|
|
let qwebvar = ctx.variables[variable];
|
|
|
|
if (value) {
|
|
const formattedValue = ctx.formatExpression(value);
|
|
if (ctx.variables.hasOwnProperty(variable) && qwebvar.id) {
|
|
ctx.addLine(`${qwebvar.id} = ${formattedValue}`);
|
|
} else {
|
|
const varName = `_${ctx.generateID()}`;
|
|
ctx.addLine(`var ${varName} = ${formattedValue};`);
|
|
qwebvar.id = varName;
|
|
qwebvar.expr = formattedValue;
|
|
}
|
|
} else {
|
|
qwebvar.xml = node.childNodes;
|
|
}
|
|
return true;
|
|
}
|
|
});
|
|
|
|
//------------------------------------------------------------------------------
|
|
// t-if, t-elif, t-else
|
|
//------------------------------------------------------------------------------
|
|
QWeb.addDirective({
|
|
name: "if",
|
|
priority: 20,
|
|
atNodeEncounter({ node, ctx }): boolean {
|
|
let cond = ctx.getValue(node.getAttribute("t-if")!);
|
|
ctx.addIf(typeof cond === "string" ? ctx.formatExpression(cond) : cond.id!);
|
|
return false;
|
|
},
|
|
finalize({ ctx }) {
|
|
ctx.closeIf();
|
|
}
|
|
});
|
|
|
|
QWeb.addDirective({
|
|
name: "elif",
|
|
priority: 30,
|
|
atNodeEncounter({ node, ctx }): boolean {
|
|
let cond = ctx.getValue(node.getAttribute("t-elif")!);
|
|
ctx.addLine(`else if (${typeof cond === "string" ? ctx.formatExpression(cond) : cond.id}) {`);
|
|
ctx.indent();
|
|
return false;
|
|
},
|
|
finalize({ ctx }) {
|
|
ctx.closeIf();
|
|
}
|
|
});
|
|
|
|
QWeb.addDirective({
|
|
name: "else",
|
|
priority: 40,
|
|
atNodeEncounter({ ctx }): boolean {
|
|
ctx.addLine(`else {`);
|
|
ctx.indent();
|
|
return false;
|
|
},
|
|
finalize({ ctx }) {
|
|
ctx.closeIf();
|
|
}
|
|
});
|
|
|
|
//------------------------------------------------------------------------------
|
|
// t-call
|
|
//------------------------------------------------------------------------------
|
|
QWeb.addDirective({
|
|
name: "call",
|
|
priority: 50,
|
|
atNodeEncounter({ node, qweb, ctx }): boolean {
|
|
if (node.nodeName !== "t") {
|
|
throw new Error("Invalid tag for t-call directive (should be 't')");
|
|
}
|
|
const subTemplate = node.getAttribute("t-call")!;
|
|
const nodeTemplate = qweb.templates[subTemplate];
|
|
if (!nodeTemplate) {
|
|
throw new Error(`Cannot find template "${subTemplate}" (t-call)`);
|
|
}
|
|
const nodeCopy = node.cloneNode(true) as Element;
|
|
nodeCopy.removeAttribute("t-call");
|
|
|
|
// extract variables from nodecopy
|
|
const tempCtx = new CompilationContext();
|
|
tempCtx.nextID = ctx.rootContext.nextID;
|
|
tempCtx.allowMultipleRoots = true;
|
|
qweb._compileNode(nodeCopy, tempCtx);
|
|
const vars = Object.assign({}, ctx.variables, tempCtx.variables);
|
|
ctx.rootContext.nextID = tempCtx.nextID;
|
|
|
|
const templateMap = Object.create(ctx.templates);
|
|
// open new scope, if necessary
|
|
const hasNewVariables = Object.keys(tempCtx.variables).length > 0;
|
|
|
|
// compile sub template
|
|
let subCtx = ctx.subContext("caller", nodeCopy).subContext("variables", Object.create(vars));
|
|
subCtx = subCtx.subContext("templates", templateMap);
|
|
|
|
if (templateMap[subTemplate]) {
|
|
// OUCH, IT IS A RECURSIVE TEMPLATE SITUATION...
|
|
// This is a tricky situation... We obviously cannot inline the compiled
|
|
// template. So, what we need to do is to compile it, and make sure we
|
|
// properly transfer everything from the current scope to the sub template.
|
|
ctx.rootContext.shouldTrackScope = true;
|
|
ctx.rootContext.shouldDefineOwner = true;
|
|
let subTemplateName;
|
|
if (ctx.hasParentWidget) {
|
|
subTemplateName = ctx.templateName;
|
|
} else {
|
|
subTemplateName = `__${ctx.generateID()}`;
|
|
subCtx.variables = {};
|
|
let id = 0;
|
|
for (let v in vars) {
|
|
subCtx.variables[v] = vars[v];
|
|
(vars[v] as any).id = `_v${id++}`;
|
|
}
|
|
const subTemplateFn = qweb._compile(subTemplateName, nodeTemplate.elem, subCtx);
|
|
qweb.recursiveFns[subTemplateName] = subTemplateFn;
|
|
}
|
|
let varCode = `{}`;
|
|
if (Object.keys(vars).length) {
|
|
let id = 0;
|
|
const content = Object.values(vars)
|
|
.map((v: any) => `_v${id++}: ${v.expr}`)
|
|
.join(",");
|
|
varCode = `{${content}}`;
|
|
}
|
|
ctx.addLine(
|
|
`this.recursiveFns['${subTemplateName}'].call(this, context, Object.assign({}, extra, {parentNode: c${ctx.parentNode}, fiber: {vars: ${varCode}, scope}}));`
|
|
);
|
|
return true;
|
|
}
|
|
templateMap[subTemplate] = true;
|
|
|
|
if (hasNewVariables) {
|
|
ctx.addLine("{");
|
|
ctx.indent();
|
|
// add new variables, if any
|
|
for (let key in tempCtx.variables) {
|
|
const v = tempCtx.variables[key];
|
|
if (v.expr) {
|
|
ctx.addLine(`let ${v.id} = ${v.expr};`);
|
|
}
|
|
// todo: handle XML variables...
|
|
}
|
|
}
|
|
qweb._compileNode(nodeTemplate.elem, subCtx);
|
|
|
|
// close new scope
|
|
if (hasNewVariables) {
|
|
ctx.dedent();
|
|
ctx.addLine("}");
|
|
}
|
|
|
|
return true;
|
|
}
|
|
});
|
|
|
|
//------------------------------------------------------------------------------
|
|
// t-foreach
|
|
//------------------------------------------------------------------------------
|
|
QWeb.addDirective({
|
|
name: "foreach",
|
|
extraNames: ["as"],
|
|
priority: 10,
|
|
atNodeEncounter({ node, qweb, ctx }): boolean {
|
|
ctx.rootContext.shouldProtectContext = true;
|
|
ctx = ctx.subContext("loopNumber", ctx.loopNumber + 1);
|
|
const elems = node.getAttribute("t-foreach")!;
|
|
const name = node.getAttribute("t-as")!;
|
|
let arrayID = ctx.generateID();
|
|
ctx.addLine(`var _${arrayID} = ${ctx.formatExpression(elems)};`);
|
|
ctx.addLine(`if (!_${arrayID}) { throw new Error('QWeb error: Invalid loop expression')}`);
|
|
let keysID = ctx.generateID();
|
|
let valuesID = ctx.generateID();
|
|
ctx.addLine(`var _${keysID} = _${valuesID} = _${arrayID};`);
|
|
ctx.addIf(`!(_${arrayID} instanceof Array)`);
|
|
ctx.addLine(`_${keysID} = Object.keys(_${arrayID});`);
|
|
ctx.addLine(`_${valuesID} = Object.values(_${arrayID});`);
|
|
ctx.closeIf();
|
|
ctx.addLine(`var _length${keysID} = _${keysID}.length;`);
|
|
const loopVar = `i${ctx.loopNumber}`;
|
|
ctx.addLine(`for (let ${loopVar} = 0; ${loopVar} < _length${keysID}; ${loopVar}++) {`);
|
|
ctx.indent();
|
|
ctx.addToScope(name + "_first", `${loopVar} === 0`);
|
|
ctx.addToScope(name + "_last", `${loopVar} === _length${keysID} - 1`);
|
|
ctx.addToScope(name + "_index", loopVar);
|
|
ctx.addToScope(name, `_${keysID}[${loopVar}]`);
|
|
ctx.addToScope(name + "_value", `_${valuesID}[${loopVar}]`);
|
|
const nodeCopy = <Element>node.cloneNode(true);
|
|
let shouldWarn =
|
|
!nodeCopy.hasAttribute("t-key") &&
|
|
node.children.length === 1 &&
|
|
node.children[0].tagName !== "t" &&
|
|
!node.children[0].hasAttribute("t-key");
|
|
if (shouldWarn) {
|
|
console.warn(
|
|
`Directive t-foreach should always be used with a t-key! (in template: '${ctx.templateName}')`
|
|
);
|
|
}
|
|
|
|
nodeCopy.removeAttribute("t-foreach");
|
|
qweb._compileNode(nodeCopy, ctx);
|
|
ctx.dedent();
|
|
ctx.addLine("}");
|
|
return true;
|
|
}
|
|
});
|
|
|
|
//------------------------------------------------------------------------------
|
|
// t-debug
|
|
//------------------------------------------------------------------------------
|
|
QWeb.addDirective({
|
|
name: "debug",
|
|
priority: 1,
|
|
atNodeEncounter({ ctx }) {
|
|
ctx.addLine("debugger;");
|
|
}
|
|
});
|
|
|
|
//------------------------------------------------------------------------------
|
|
// t-log
|
|
//------------------------------------------------------------------------------
|
|
QWeb.addDirective({
|
|
name: "log",
|
|
priority: 1,
|
|
atNodeEncounter({ ctx, value }) {
|
|
const expr = ctx.formatExpression(value);
|
|
ctx.addLine(`console.log(${expr})`);
|
|
}
|
|
});
|