437 lines
10 KiB
TypeScript
437 lines
10 KiB
TypeScript
import {
|
|
RootNode,
|
|
ChildNode,
|
|
ElementNode,
|
|
IfNode,
|
|
ForNode,
|
|
TextNode,
|
|
CommentNode,
|
|
ExpressionNode,
|
|
NodeTypes,
|
|
JSChildNode,
|
|
CallExpression,
|
|
ArrayExpression,
|
|
ObjectExpression,
|
|
IfBranchNode
|
|
} from './ast'
|
|
import { SourceMapGenerator, RawSourceMap } from 'source-map'
|
|
import { advancePositionWithMutation, assert } from './utils'
|
|
import { isString, isArray } from '@vue/shared'
|
|
import { RENDER_LIST, TO_STRING } from './runtimeConstants'
|
|
|
|
type CodegenNode = ChildNode | JSChildNode
|
|
|
|
export interface CodegenOptions {
|
|
// will generate import statements for
|
|
// runtime helpers; otherwise will grab the helpers from global `Vue`.
|
|
// default: false
|
|
mode?: 'module' | 'function'
|
|
prefixIdentifiers?: boolean
|
|
// Filename for source map generation.
|
|
filename?: string
|
|
}
|
|
|
|
export interface CodegenResult {
|
|
code: string
|
|
map?: RawSourceMap
|
|
}
|
|
|
|
export interface CodegenContext extends Required<CodegenOptions> {
|
|
source: string
|
|
code: string
|
|
line: number
|
|
column: number
|
|
offset: number
|
|
indentLevel: number
|
|
map?: SourceMapGenerator
|
|
push(code: string, node?: CodegenNode): void
|
|
indent(): void
|
|
deindent(withoutNewLine?: boolean): void
|
|
newline(): void
|
|
}
|
|
|
|
function createCodegenContext(
|
|
ast: RootNode,
|
|
{
|
|
mode = 'function',
|
|
prefixIdentifiers = false,
|
|
filename = `template.vue.html`
|
|
}: CodegenOptions
|
|
): CodegenContext {
|
|
const context: CodegenContext = {
|
|
mode,
|
|
prefixIdentifiers,
|
|
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__
|
|
? undefined
|
|
: new (require('source-map')).SourceMapGenerator(),
|
|
|
|
push(code, node?: CodegenNode) {
|
|
context.code += code
|
|
if (context.map) {
|
|
if (node) {
|
|
context.map.addMapping({
|
|
source: context.filename,
|
|
original: {
|
|
line: node.loc.start.line,
|
|
column: node.loc.start.column - 1 // source-map column is 0 based
|
|
},
|
|
generated: {
|
|
line: context.line,
|
|
column: context.column - 1
|
|
}
|
|
})
|
|
}
|
|
advancePositionWithMutation(context, code, code.length)
|
|
}
|
|
},
|
|
indent() {
|
|
newline(++context.indentLevel)
|
|
},
|
|
deindent(withoutNewLine = false) {
|
|
if (withoutNewLine) {
|
|
--context.indentLevel
|
|
} else {
|
|
newline(--context.indentLevel)
|
|
}
|
|
},
|
|
newline() {
|
|
newline(context.indentLevel)
|
|
}
|
|
}
|
|
const newline = (n: number) => context.push('\n' + ` `.repeat(n))
|
|
if (!__BROWSER__) {
|
|
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 imports = ast.imports.join(', ')
|
|
if (mode === 'function') {
|
|
// generate const declarations for helpers
|
|
if (imports) {
|
|
push(`const { ${imports} } = Vue\n\n`)
|
|
}
|
|
push(`return `)
|
|
} else {
|
|
// generate import statements for helpers
|
|
if (imports) {
|
|
push(`import { ${imports} } from 'vue'\n\n`)
|
|
}
|
|
push(`export default `)
|
|
}
|
|
push(`function render() {`)
|
|
indent()
|
|
// generate asset resolution statements
|
|
if (ast.statements.length) {
|
|
ast.statements.forEach(s => {
|
|
push(s)
|
|
newline()
|
|
})
|
|
newline()
|
|
}
|
|
if (!prefixIdentifiers) {
|
|
push(`with (this) {`)
|
|
indent()
|
|
} else {
|
|
push(`const _ctx = this`)
|
|
newline()
|
|
}
|
|
push(`return `)
|
|
genChildren(ast.children, context, true /* asRoot */)
|
|
if (!prefixIdentifiers) {
|
|
deindent()
|
|
push(`}`)
|
|
}
|
|
deindent()
|
|
push(`}`)
|
|
return {
|
|
code: context.code,
|
|
map: context.map ? context.map.toJSON() : undefined
|
|
}
|
|
}
|
|
|
|
// This will generate a single vnode call if:
|
|
// - The list has length === 1, AND:
|
|
// - This is a root node, OR:
|
|
// - The only child is a text or expression.
|
|
function genChildren(
|
|
children: ChildNode[],
|
|
context: CodegenContext,
|
|
asRoot: boolean = false
|
|
) {
|
|
const child = children[0]
|
|
if (
|
|
children.length === 1 &&
|
|
(asRoot ||
|
|
child.type === NodeTypes.TEXT ||
|
|
child.type == NodeTypes.EXPRESSION)
|
|
) {
|
|
genNode(child, context)
|
|
} else {
|
|
genNodeListAsArray(children, context)
|
|
}
|
|
}
|
|
|
|
function genNodeListAsArray(
|
|
nodes: (string | CodegenNode | ChildNode[])[],
|
|
context: CodegenContext
|
|
) {
|
|
const multilines = nodes.length > 1
|
|
context.push(`[`)
|
|
multilines && context.indent()
|
|
genNodeList(nodes, context, multilines)
|
|
multilines && context.deindent()
|
|
context.push(`]`)
|
|
}
|
|
|
|
function genNodeList(
|
|
nodes: (string | CodegenNode | ChildNode[])[],
|
|
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.EXPRESSION:
|
|
genExpression(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
|
|
default:
|
|
__DEV__ &&
|
|
assert(false, `unhandled codegen node type: ${(node as any).type}`)
|
|
}
|
|
}
|
|
|
|
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 | ExpressionNode, context: CodegenContext) {
|
|
context.push(JSON.stringify(node.content), node)
|
|
}
|
|
|
|
function genExpression(node: ExpressionNode, context: CodegenContext) {
|
|
const { push } = context
|
|
const { content, children, isStatic, isInterpolation } = node
|
|
if (isInterpolation) {
|
|
push(`${TO_STRING}(`)
|
|
}
|
|
if (children) {
|
|
genCompoundExpression(node, context)
|
|
} else {
|
|
push(isStatic ? JSON.stringify(content) : content, node)
|
|
}
|
|
if (isInterpolation) {
|
|
push(`)`)
|
|
}
|
|
}
|
|
|
|
function genExpressionAsPropertyKey(
|
|
node: ExpressionNode,
|
|
context: CodegenContext
|
|
) {
|
|
if (node.children) {
|
|
return genCompoundExpression(node, context)
|
|
}
|
|
if (node.isStatic) {
|
|
// only quote keys if necessary
|
|
const text = /^\d|[^\w]/.test(node.content)
|
|
? JSON.stringify(node.content)
|
|
: node.content
|
|
context.push(text, node)
|
|
} else {
|
|
context.push(`[${node.content}]`, node)
|
|
}
|
|
}
|
|
|
|
function genCompoundExpression(node: ExpressionNode, context: CodegenContext) {
|
|
for (let i = 0; i < node.children!.length; i++) {
|
|
const child = node.children![i]
|
|
if (isString(child)) {
|
|
context.push(child)
|
|
} else {
|
|
genExpression(child, context)
|
|
}
|
|
}
|
|
}
|
|
|
|
function genComment(node: CommentNode, context: CodegenContext) {
|
|
context.push(`<!--${node.content}-->`, node)
|
|
}
|
|
|
|
// control flow
|
|
function genIf(node: IfNode, context: CodegenContext) {
|
|
genIfBranch(node.branches[0], node.branches, 1, context)
|
|
}
|
|
|
|
function genIfBranch(
|
|
{ condition, children }: IfBranchNode,
|
|
branches: IfBranchNode[],
|
|
nextIndex: number,
|
|
context: CodegenContext
|
|
) {
|
|
if (condition) {
|
|
// v-if or v-else-if
|
|
const { push, indent, deindent, newline } = context
|
|
push(`(`)
|
|
genExpression(condition, context)
|
|
push(`)`)
|
|
indent()
|
|
context.indentLevel++
|
|
push(`? `)
|
|
genChildren(children, context)
|
|
context.indentLevel--
|
|
newline()
|
|
push(`: `)
|
|
if (nextIndex < branches.length) {
|
|
genIfBranch(branches[nextIndex], branches, nextIndex + 1, context)
|
|
} else {
|
|
context.push(`null`)
|
|
}
|
|
deindent(true /* without newline */)
|
|
} else {
|
|
// v-else
|
|
__DEV__ && assert(nextIndex === branches.length)
|
|
genChildren(children, context)
|
|
}
|
|
}
|
|
|
|
function genFor(node: ForNode, context: CodegenContext) {
|
|
const { push } = context
|
|
const { source, keyAlias, valueAlias, objectIndexAlias, children } = node
|
|
push(`${RENDER_LIST}(`, node)
|
|
genExpression(source, context)
|
|
push(`, (`)
|
|
if (valueAlias) {
|
|
genExpression(valueAlias, context)
|
|
}
|
|
if (keyAlias) {
|
|
if (!valueAlias) {
|
|
push(`_`)
|
|
}
|
|
push(`, `)
|
|
genExpression(keyAlias, context)
|
|
}
|
|
if (objectIndexAlias) {
|
|
if (!keyAlias) {
|
|
if (!valueAlias) {
|
|
push(`_, __`)
|
|
} else {
|
|
push(`__`)
|
|
}
|
|
}
|
|
push(`, `)
|
|
genExpression(objectIndexAlias, context)
|
|
}
|
|
push(`) => `)
|
|
genChildren(children, context)
|
|
push(`)`)
|
|
}
|
|
|
|
// JavaScript
|
|
function genCallExpression(
|
|
node: CallExpression,
|
|
context: CodegenContext,
|
|
multilines = node.arguments.length > 2
|
|
) {
|
|
context.push(node.callee + `(`, node)
|
|
multilines && context.indent()
|
|
genNodeList(node.arguments, context, multilines)
|
|
multilines && context.deindent()
|
|
context.push(`)`)
|
|
}
|
|
|
|
function genObjectExpression(node: ObjectExpression, context: CodegenContext) {
|
|
const { push, indent, deindent, newline } = context
|
|
const { properties } = node
|
|
const multilines = properties.length > 1
|
|
push(multilines ? `{` : `{ `, node)
|
|
multilines && indent()
|
|
for (let i = 0; i < properties.length; i++) {
|
|
const { key, value } = properties[i]
|
|
// key
|
|
genExpressionAsPropertyKey(key, context)
|
|
push(`: `)
|
|
// value
|
|
genExpression(value, context)
|
|
if (i < properties.length - 1) {
|
|
if (multilines) {
|
|
push(`,`)
|
|
newline()
|
|
} else {
|
|
push(`, `)
|
|
}
|
|
}
|
|
}
|
|
multilines && deindent()
|
|
push(multilines ? `}` : ` }`)
|
|
}
|
|
|
|
function genArrayExpression(node: ArrayExpression, context: CodegenContext) {
|
|
genNodeListAsArray(node.elements, context)
|
|
}
|