import { RootNode, TemplateChildNode, ElementNode, IfNode, ForNode, TextNode, CommentNode, ExpressionNode, NodeTypes, JSChildNode, CallExpression, ArrayExpression, ObjectExpression, SourceLocation, Position, InterpolationNode, CompoundExpressionNode, SimpleExpressionNode, ElementTypes, SlotFunctionExpression, SequenceExpression, ConditionalExpression } from './ast' import { SourceMapGenerator, RawSourceMap } from 'source-map' import { advancePositionWithMutation, assert, isSimpleIdentifier } from './utils' import { isString, isArray } from '@vue/shared' import { RENDER_LIST, TO_STRING, CREATE_VNODE, COMMENT } from './runtimeConstants' type CodegenNode = TemplateChildNode | JSChildNode export interface CodegenOptions { // - Module mode will generate ES module import statements for helpers // and export the render function as the default export. // - Function mode will generate a single `const { helpers... } = Vue` // statement and return the render function. It is meant to be used with // `new Function(code)()` to generate a render function at runtime. // Default: 'function' mode?: 'module' | 'function' // Prefix suitable identifiers with _ctx. // If this option is false, the generated code will be wrapped in a // `with (this) { ... }` block. // Default: false prefixIdentifiers?: boolean // Generate source map? // Default: false sourceMap?: boolean // Filename for source map generation. // Default: `template.vue.html` filename?: string } export interface CodegenResult { code: string ast: RootNode map?: RawSourceMap } export interface CodegenContext extends Required { source: string code: string line: number column: number offset: number indentLevel: number map?: SourceMapGenerator helper(name: string): string push(code: string, node?: CodegenNode, openOnly?: boolean): void resetMapping(loc: SourceLocation): void indent(): void deindent(withoutNewLine?: boolean): void newline(): void } function createCodegenContext( ast: RootNode, { mode = 'function', prefixIdentifiers = false, sourceMap = false, filename = `template.vue.html` }: CodegenOptions ): CodegenContext { const context: CodegenContext = { mode, prefixIdentifiers, sourceMap, filename, source: ast.loc.source, code: ``, column: 1, line: 1, offset: 0, indentLevel: 0, // lazy require source-map implementation, only in non-browser builds! map: __BROWSER__ || !sourceMap ? undefined : new (require('source-map')).SourceMapGenerator(), helper(name) { return prefixIdentifiers ? name : `_${name}` }, push(code, node, openOnly) { context.code += code if (!__BROWSER__ && context.map) { if (node) { let name if (node.type === NodeTypes.SIMPLE_EXPRESSION && !node.isStatic) { const content = node.content.replace(/^_ctx\./, '') if (content !== node.content && isSimpleIdentifier(content)) { name = content } } addMapping(node.loc.start, name) } advancePositionWithMutation(context, code) if (node && !openOnly) { addMapping(node.loc.end) } } }, resetMapping(loc: SourceLocation) { if (!__BROWSER__ && context.map) { addMapping(loc.start) } }, indent() { newline(++context.indentLevel) }, deindent(withoutNewLine = false) { if (withoutNewLine) { --context.indentLevel } else { newline(--context.indentLevel) } }, newline() { newline(context.indentLevel) } } function newline(n: number) { context.push('\n' + ` `.repeat(n)) } function addMapping(loc: Position, name?: string) { context.map!.addMapping({ name, source: context.filename, original: { line: loc.line, column: loc.column - 1 // source-map column is 0 based }, generated: { line: context.line, column: context.column - 1 } }) } if (!__BROWSER__ && context.map) { context.map.setSourceContent(filename, context.source) } return context } export function generate( ast: RootNode, options: CodegenOptions = {} ): CodegenResult { const context = createCodegenContext(ast, options) const { mode, push, prefixIdentifiers, indent, deindent, newline } = context const hasImports = ast.imports.length const useWithBlock = !prefixIdentifiers && mode !== 'module' // preambles if (mode === 'function') { // Generate const declaration for helpers // In prefix mode, we place the const declaration at top so it's done // only once; But if we not prefixing, we place the decalration inside the // with block so it doesn't incur the `in` check cost for every helper access. if (hasImports) { if (prefixIdentifiers) { push(`const { ${ast.imports.join(', ')} } = Vue\n`) } else { // save Vue in a separate variable to avoid collision push(`const _Vue = Vue\n`) } } genHoists(ast.hoists, context) push(`return `) } else { // generate import statements for helpers if (hasImports) { push(`import { ${ast.imports.join(', ')} } from "vue"\n`) } genHoists(ast.hoists, context) push(`export default `) } // enter render function push(`function render() {`) indent() if (useWithBlock) { push(`with (this) {`) indent() // function mode const declarations should be inside with block // also they should be renamed to avoid collision with user properties if (hasImports) { push(`const { ${ast.imports.map(n => `${n}: _${n}`).join(', ')} } = _Vue`) newline() newline() } } else { push(`const _ctx = this`) newline() } // generate asset resolution statements if (ast.statements.length) { ast.statements.forEach(s => { push(s) newline() }) newline() } // generate the VNode tree expression push(`return `) genChildren(ast.children, context, true) if (useWithBlock) { deindent() push(`}`) } deindent() push(`}`) return { ast, code: context.code, map: context.map ? context.map.toJSON() : undefined } } function genHoists(hoists: JSChildNode[], context: CodegenContext) { hoists.forEach((exp, i) => { context.push(`const _hoisted_${i + 1} = `) genNode(exp, context) context.newline() }) context.newline() } // This will generate a single vnode call if: // - The target position explicitly allows a single node (root, if, for) // - The list has length === 1, AND The only child is a: // - text // - expression // - outlet, which always produces an array function genChildren( children: TemplateChildNode[], context: CodegenContext, allowSingle: boolean = false ) { if (!children.length) { return context.push(`null`) } const child = children[0] const type = child.type if ( children.length === 1 && (allowSingle || type === NodeTypes.TEXT || type === NodeTypes.INTERPOLATION || type === NodeTypes.COMPOUND_EXPRESSION || (type === NodeTypes.ELEMENT && (child as ElementNode).tagType === ElementTypes.SLOT)) ) { genNode(child, context) } else { genNodeListAsArray(children, context) } } function genNodeListAsArray( nodes: (string | CodegenNode | TemplateChildNode[])[], context: CodegenContext ) { const multilines = nodes.length > 3 || ((!__BROWSER__ || __DEV__) && nodes.some( n => isArray(n) || (!isString(n) && n.type !== NodeTypes.SIMPLE_EXPRESSION) )) context.push(`[`) multilines && context.indent() genNodeList(nodes, context, multilines) multilines && context.deindent() context.push(`]`) } function genNodeList( nodes: (string | CodegenNode | TemplateChildNode[])[], context: CodegenContext, multilines: boolean = false ) { const { push, newline } = context for (let i = 0; i < nodes.length; i++) { const node = nodes[i] if (isString(node)) { push(node) } else if (isArray(node)) { genChildren(node, context) } else { genNode(node, context) } if (i < nodes.length - 1) { if (multilines) { push(',') newline() } else { push(', ') } } } } function genNode(node: CodegenNode, context: CodegenContext) { switch (node.type) { case NodeTypes.ELEMENT: genElement(node, context) break case NodeTypes.TEXT: genText(node, context) break case NodeTypes.SIMPLE_EXPRESSION: genExpression(node, context) break case NodeTypes.INTERPOLATION: genInterpolation(node, context) break case NodeTypes.COMPOUND_EXPRESSION: genCompoundExpression(node, context) break case NodeTypes.COMMENT: genComment(node, context) break case NodeTypes.IF: genIf(node, context) break case NodeTypes.FOR: genFor(node, context) break case NodeTypes.JS_CALL_EXPRESSION: genCallExpression(node, context) break case NodeTypes.JS_OBJECT_EXPRESSION: genObjectExpression(node, context) break case NodeTypes.JS_ARRAY_EXPRESSION: genArrayExpression(node, context) break case NodeTypes.JS_SLOT_FUNCTION: genSlotFunction(node, context) break case NodeTypes.JS_SEQUENCE_EXPRESSION: genSequenceExpression(node, context) break case NodeTypes.JS_CONDITIONAL_EXPRESSION: genConditionalExpression(node, context) break /* istanbul ignore next */ default: if (__DEV__) { assert(false, `unhandled codegen node type: ${(node as any).type}`) // make sure we exhaust all possible types const exhaustiveCheck: never = node return exhaustiveCheck } } } function genElement(node: ElementNode, context: CodegenContext) { __DEV__ && assert( node.codegenNode != null, `AST is not transformed for codegen. ` + `Apply appropriate transforms first.` ) genCallExpression(node.codegenNode!, context, false) } function genText( node: TextNode | SimpleExpressionNode, context: CodegenContext ) { context.push(JSON.stringify(node.content), node) } function genExpression(node: SimpleExpressionNode, context: CodegenContext) { const { content, isStatic } = node context.push(isStatic ? JSON.stringify(content) : content, node) } function genInterpolation(node: InterpolationNode, context: CodegenContext) { const { push, helper } = context push(`${helper(TO_STRING)}(`) genNode(node.content, context) push(`)`) } function genCompoundExpression( node: CompoundExpressionNode, context: CodegenContext ) { for (let i = 0; i < node.children!.length; i++) { const child = node.children![i] if (isString(child)) { context.push(child) } else { genNode(child, context) } } } function genExpressionAsPropertyKey( node: ExpressionNode, context: CodegenContext ) { const { push } = context if (node.type === NodeTypes.COMPOUND_EXPRESSION) { push(`[`) genCompoundExpression(node, context) push(`]`) } else if (node.isStatic) { // only quote keys if necessary const text = isSimpleIdentifier(node.content) ? node.content : JSON.stringify(node.content) push(text, node) } else { push(`[${node.content}]`, node) } } function genComment(node: CommentNode, context: CodegenContext) { if (__DEV__) { const { push, helper } = context push( `${helper(CREATE_VNODE)}(${helper(COMMENT)}, 0, ${JSON.stringify( node.content )})`, node ) } } // control flow function genIf(node: IfNode, context: CodegenContext) { genNode(node.codegenNode, context) } function genFor(node: ForNode, context: CodegenContext) { const { push, helper, indent, deindent } = context const { source, keyAlias, valueAlias, objectIndexAlias, children } = node push(`${helper(RENDER_LIST)}(`, node, true) genNode(source, context) push(`, (`) if (valueAlias) { genNode(valueAlias, context) } if (keyAlias) { if (!valueAlias) { push(`__value`) } push(`, `) genNode(keyAlias, context) } if (objectIndexAlias) { if (!keyAlias) { if (!valueAlias) { push(`__value, __key`) } else { push(`, __key`) } } push(`, `) genNode(objectIndexAlias, context) } push(`) => {`) indent() push(`return `) genChildren(children, context, true) deindent() push(`})`) } // JavaScript function genCallExpression( node: CallExpression, context: CodegenContext, multilines = false ) { context.push(node.callee + `(`, node, true) multilines && context.indent() genNodeList(node.arguments, context, multilines) multilines && context.deindent() context.push(`)`) } function genObjectExpression(node: ObjectExpression, context: CodegenContext) { const { push, indent, deindent, newline, resetMapping } = context const { properties } = node const multilines = properties.length > 1 || ((!__BROWSER__ || __DEV__) && properties.some(p => p.value.type !== NodeTypes.SIMPLE_EXPRESSION)) push(multilines ? `{` : `{ `) multilines && indent() for (let i = 0; i < properties.length; i++) { const { key, value, loc } = properties[i] resetMapping(loc) // reset source mapping for every property. // key genExpressionAsPropertyKey(key, context) push(`: `) // value genNode(value, context) if (i < properties.length - 1) { // will only reach this if it's multilines push(`,`) newline() } } multilines && deindent() const lastChar = context.code[context.code.length - 1] push(multilines || /[\])}]/.test(lastChar) ? `}` : ` }`) } function genArrayExpression(node: ArrayExpression, context: CodegenContext) { genNodeListAsArray(node.elements, context) } function genSlotFunction( node: SlotFunctionExpression, context: CodegenContext ) { context.push(`(`, node) if (node.params) genNode(node.params, context) context.push(`) => `) // pre-normalized slots should always return arrays genNodeListAsArray(node.returns, context) } function genConditionalExpression( node: ConditionalExpression, context: CodegenContext ) { const { test, consequent, alternate } = node const { push, indent, deindent, newline } = context if (test.type === NodeTypes.SIMPLE_EXPRESSION) { const needsQuote = !isSimpleIdentifier(test.content) needsQuote && push(`(`) genExpression(test, context) needsQuote && push(`)`) } else { genCompoundExpression(test, context) } indent() context.indentLevel++ push(`? `) genNode(consequent, context) context.indentLevel-- newline() push(`: `) const isNested = alternate.type === NodeTypes.JS_CONDITIONAL_EXPRESSION if (!isNested) { context.indentLevel++ } genNode(alternate, context) if (!isNested) { context.indentLevel-- } deindent(true /* without newline */) } function genSequenceExpression( node: SequenceExpression, context: CodegenContext ) { context.push(`(`) genNodeList(node.expressions, context) context.push(`)`) }