本文系 Creating JVM language 翻译的第 7 篇。
原文中的代码和原文有不一致的地方均在新的代码仓库中更正过,建议参考新的代码仓库。

源码

Github

1. 方法

到目前为止,我们可以在 Enkel 中声明类和变量,但是他们都处于同一个全局作用域中。下一步,我们需要支持方法。

我们的目标是可以处理如下代码:

1
2
3
4
5
6
7
8
9
10
First {
void main (string[] args) {
var x = 25
metoda(x)
}

void metoda (int param) {
print param
}
}

2. 作用域

为了可以访问其他的函数或者变量,他们需要在同一个作用域下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
public class Scope {
private List<Identifier> identifiers; //think of it as a variables for now
private List<FunctionSignature> functionSignatures;
private final MetaData metaData; //currently stores only class name

public Scope(MetaData metaData) {
identifiers = new ArrayList<>();
functionSignatures = new ArrayList<>();
this.metaData = metaData;
}

public Scope(Scope scope) {
metaData = scope.metaData;
identifiers = Lists.newArrayList(scope.identifiers);
functionSignatures = Lists.newArrayList(scope.functionSignatures);
}

//some other methods that expose data to the outside
}

对象 scope 是在类创建的时候被创建的,然后传递给下一层级(方法)。下一层级拷贝并且添加其他的选项。

3. 签名

函数调用的时候,需要提供函数的一些额外信息。假设有如下的伪代码:

1
2
3
4
5
6
f1() {
f2()
}

f2(){
}

解析后如下图所示:

节点的访问顺序如下:

  • Root
  • 函数 f1
  • 对函数 f2 的调用//错误,此时 f2 还没有定义
  • 函数 f2

因此,当函数调用发生时,函数的定义可能没有访问到,f1 解析的时候并没有 f2 的信息。
为了解决这个问题,我们必须访问所有函数的定义并且把函数的签名存储到作用域中。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
public class ClassVisitor extends EnkelBaseVisitor<ClassDeclaration> {

private Scope scope;

@Override
public ClassDeclaration visitClassDeclaration(@NotNull EnkelParser.ClassDeclarationContext ctx) {
String name = ctx.className().getText();
FunctionSignatureVisitor functionSignatureVisitor = new FunctionSignatureVisitor();
List<EnkelParser.FunctionContext> methodsCtx = ctx.classBody().function();
MetaData metaData = new MetaData(ctx.className().getText());
scope = new Scope(metaData);
//First find all signatures
List<FunctionSignature> signatures = methodsCtx.stream()
.map(method -> method.functionDeclaration().accept(functionSignatureVisitor))
.peek(scope::addSignature)
.collect(Collectors.toList());
//Once the signatures are found start parsing methods
List<Function> methods = methodsCtx.stream()
.map(method -> method.accept(new FunctionVisitor(scope)))
.collect(Collectors.toList());
return new ClassDeclaration(name, methods);
}
}

4. Invokestatic

当所有相关的信息都被正确解析后,接下来需要生成字节码了。当前 Enkele 还没有实现对象的创建,因此方法的调用先使用 static 的方式来调用。

int access = Opcodes.ACC_PUBLIC + Opcodes.ACC_STATIC;

静态方法的调用对应的字节码指令是 invokestatic, 需要两个参数:

操作数栈中的会执行出栈操作,并传递给方法调用(类型和个数必须和方法描述一致)。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
public class MethodGenerator {
private final ClassWriter classWriter;

public MethodGenerator(ClassWriter classWriter) {
this.classWriter = classWriter;
}

public void generate(Function function) {
Scope scope = function.getScope();
String name = function.getName();
String description = DescriptorFactory.getMethodDescriptor(function);
Collection<Statement> instructions = function.getStatements();
int access = Opcodes.ACC_PUBLIC + Opcodes.ACC_STATIC;
MethodVisitor mv = classWriter.visitMethod(access, name, description, null, null);
mv.visitCode();
StatementGenerator statementScopeGenrator = new StatementGenerator(mv);
instructions.forEach(instr -> statementScopeGenrator.generate(instr,scope));
mv.visitInsn(Opcodes.RETURN);
mv.visitMaxs(-1,-1); //asm autmatically calculate those but the call is required
mv.visitEnd();
}
}

5. 效果

如下 Enkel 代码:

1
2
3
4
5
6
7
8
9
10
First {
void main (string[] args) {
var x = 25
metoda(x)
}

void metoda (int param) {
print param
}
}

会被编译成如下所示的字节码:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
$ javap -c First
public class First {
public static void main(java.lang.String[]);
Code:
0: bipush 25 //push value 25 onto the stack
2: istore_0 //store value from stack into variable at index 0
3: iload_0 //load variable at index onto the stack
5: invokestatic #10 //call metod Method metoda:(I)V
8: return

public static void metoda(int);
Code:
0: getstatic #16 // Field java/lang/System.out:Ljava/io/PrintStream;
3: iload_0
4: invokevirtual #20 // Method "Ljava/io/PrintStream;".println:(I)V
7: return
}