vue3-yuanma/packages/compiler-core/src/ast.ts

231 lines
4.5 KiB
TypeScript
Raw Normal View History

// Vue template is a platform-agnostic superset of HTML (syntax only).
// More namespaces like SVG and MathML are declared by platform specific
// compilers.
export type Namespace = number
export const enum Namespaces {
HTML
}
export const enum NodeTypes {
ROOT,
ELEMENT,
TEXT,
COMMENT,
EXPRESSION,
ATTRIBUTE,
DIRECTIVE,
2019-09-22 03:47:26 +08:00
// containers
2019-09-23 14:52:54 +08:00
COMPOUND_EXPRESSION,
IF,
IF_BRANCH,
2019-09-22 03:47:26 +08:00
FOR,
// codegen
2019-09-23 04:50:57 +08:00
JS_CALL_EXPRESSION,
JS_OBJECT_EXPRESSION,
JS_PROPERTY,
JS_ARRAY_EXPRESSION
}
export const enum ElementTypes {
ELEMENT,
COMPONENT,
SLOT,
TEMPLATE
}
export interface Node {
type: NodeTypes
loc: SourceLocation
}
2019-09-22 03:47:26 +08:00
// The node's range. The `start` is inclusive and `end` is exclusive.
// [start, end)
export interface SourceLocation {
start: Position
end: Position
source: string
}
export interface Position {
offset: number // from start of file
line: number
column: number
}
export type ParentNode = RootNode | ElementNode | IfBranchNode | ForNode
2019-09-22 03:47:26 +08:00
export type ChildNode =
| ElementNode
| ExpressionNode
| TextNode
| CommentNode
| IfNode
| ForNode
export interface RootNode extends Node {
type: NodeTypes.ROOT
children: ChildNode[]
imports: string[]
statements: string[]
hoists: JSChildNode[]
}
export interface ElementNode extends Node {
type: NodeTypes.ELEMENT
ns: Namespace
tag: string
tagType: ElementTypes
isSelfClosing: boolean
2019-09-22 05:42:12 +08:00
props: Array<AttributeNode | DirectiveNode>
children: ChildNode[]
2019-09-22 03:47:26 +08:00
codegenNode: CallExpression | undefined
}
export interface TextNode extends Node {
type: NodeTypes.TEXT
content: string
isEmpty: boolean
}
export interface CommentNode extends Node {
type: NodeTypes.COMMENT
content: string
}
export interface AttributeNode extends Node {
type: NodeTypes.ATTRIBUTE
name: string
value: TextNode | undefined
}
export interface DirectiveNode extends Node {
type: NodeTypes.DIRECTIVE
name: string
exp: ExpressionNode | undefined
arg: ExpressionNode | undefined
modifiers: string[]
}
export interface ExpressionNode extends Node {
type: NodeTypes.EXPRESSION
content: string
isStatic: boolean
isInterpolation: boolean
2019-09-23 14:52:54 +08:00
children?: (ExpressionNode | string)[]
}
export interface IfNode extends Node {
type: NodeTypes.IF
branches: IfBranchNode[]
}
export interface IfBranchNode extends Node {
type: NodeTypes.IF_BRANCH
condition: ExpressionNode | undefined // else
children: ChildNode[]
}
export interface ForNode extends Node {
type: NodeTypes.FOR
source: ExpressionNode
valueAlias: ExpressionNode | undefined
keyAlias: ExpressionNode | undefined
objectIndexAlias: ExpressionNode | undefined
children: ChildNode[]
}
2019-09-23 04:50:57 +08:00
// We also include a number of JavaScript AST nodes for code generation.
// The AST is an intentioanlly minimal subset just to meet the exact needs of
2019-09-22 03:47:26 +08:00
// Vue render function generation.
2019-09-23 04:50:57 +08:00
export type JSChildNode =
2019-09-22 03:47:26 +08:00
| CallExpression
| ObjectExpression
| ArrayExpression
| ExpressionNode
export interface CallExpression extends Node {
2019-09-23 04:50:57 +08:00
type: NodeTypes.JS_CALL_EXPRESSION
2019-09-22 03:47:26 +08:00
callee: string // can only be imported runtime helpers, so no source location
2019-09-23 04:50:57 +08:00
arguments: Array<string | JSChildNode | ChildNode[]>
}
2019-09-22 03:47:26 +08:00
export interface ObjectExpression extends Node {
2019-09-23 04:50:57 +08:00
type: NodeTypes.JS_OBJECT_EXPRESSION
2019-09-22 03:47:26 +08:00
properties: Array<Property>
}
export interface Property extends Node {
2019-09-23 04:50:57 +08:00
type: NodeTypes.JS_PROPERTY
2019-09-22 03:47:26 +08:00
key: ExpressionNode
2019-09-26 00:39:46 +08:00
value: JSChildNode
2019-09-22 03:47:26 +08:00
}
export interface ArrayExpression extends Node {
2019-09-23 04:50:57 +08:00
type: NodeTypes.JS_ARRAY_EXPRESSION
elements: Array<string | JSChildNode>
}
2019-09-22 05:42:12 +08:00
export function createArrayExpression(
elements: ArrayExpression['elements'],
loc: SourceLocation
): ArrayExpression {
return {
2019-09-23 04:50:57 +08:00
type: NodeTypes.JS_ARRAY_EXPRESSION,
2019-09-22 05:42:12 +08:00
loc,
elements
}
}
export function createObjectExpression(
properties: Property[],
loc: SourceLocation
): ObjectExpression {
return {
2019-09-23 04:50:57 +08:00
type: NodeTypes.JS_OBJECT_EXPRESSION,
2019-09-22 05:42:12 +08:00
loc,
properties
}
}
export function createObjectProperty(
key: ExpressionNode,
value: ExpressionNode,
loc: SourceLocation
): Property {
return {
2019-09-23 04:50:57 +08:00
type: NodeTypes.JS_PROPERTY,
2019-09-22 05:42:12 +08:00
loc,
key,
value
}
}
export function createExpression(
content: string,
isStatic: boolean,
2019-09-25 03:49:02 +08:00
loc: SourceLocation,
isInterpolation = false
2019-09-22 05:42:12 +08:00
): ExpressionNode {
return {
type: NodeTypes.EXPRESSION,
loc,
content,
isStatic,
2019-09-25 03:49:02 +08:00
isInterpolation
2019-09-22 05:42:12 +08:00
}
}
export function createCallExpression(
callee: string,
args: CallExpression['arguments'],
loc: SourceLocation
): CallExpression {
return {
2019-09-23 04:50:57 +08:00
type: NodeTypes.JS_CALL_EXPRESSION,
2019-09-22 05:42:12 +08:00
loc,
callee,
arguments: args
}
}