手拉手教你实现一门编程语言 Enkel, 系列 12

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

源码

Github

为什么需要命名参数

在 Java 中（多数语言中也是如此）方法调用的参数匹配是通过索引值，如果方法调用的参数比较少并且参数的类型有差别的情况，是合理的。不幸的是，如果方法调用的参数有很多个，并且类型相同，这是个悲剧。

例如：
Rect createRectangle(int x1,int y1,int x2, int y2) //createRectangle signature

我打赌你很有可能会传错参数。

你发现问题了吗？这种情况开发者很容易搞混参数的顺序，由于是相同类型，编译器也没办帮你检查问题。

这就是命名参数的有点，你可以给参数指定名字，而不是仅仅通过索引值来指定参数。
使用命名参数有很多好处：

• 参数的顺序不受限制
• 代码可读性提高
• 不用再两个文件中跳转对比方法的签名和实际传参是否一致

语法规则更改

functionCall : functionName '('argument? (',' argument)* ')';
argument : expression              //unnamed argument
         | name '->' expression   ; //named argument

方法调用的参数之间用逗号分割。argument 有两种格式，命名参数和未命名参数，这两种格式不允许同时存在。

记录参数

在第七部分描述到，方法的解析分为两个步骤: 首先记录所有的方法签名（方法的声明），下一步是解析方法体，这样保证在解析方法体的时候，所有的方法签名都已经被解析过了。

实现命名参数的思路是把命名参数的调用转换成未命名参数的调用，参数索引位置通过方法签名去获得：

• 在方法签名中查找匹配的参数名字
• 获得参数的索引
• 如果参数的索引值和实际不一致，记录下来

image

上图中的示例，x1 的索引和 y1 对调。

{
    //other stuff
    @Override
    public Expression visitFunctionCall(@NotNull EnkelParser.FunctionCallContext ctx) {
        String funName = ctx.functionName().getText();
        FunctionSignature signature = scope.getSignature(funName); 
        List<EnkelParser.ArgumentContext> argumentsCtx = ctx.argument();
        //Create comparator that compares arguments based on their index in signature
        Comparator<EnkelParser.ArgumentContext> argumentComparator = (arg1, arg2) -> {
            if(arg1.name() == null) return 0; //If the argument is not named skip
            String arg1Name = arg1.name().getText();
            String arg2Name = arg2.name().getText();
            return signature.getIndexOfParameter(arg1Name) - signature.getIndexOfParameter(arg2Name);
        };
        List<Expression> arguments = argumentsCtx.stream() //parsed arguments (wrong order)
                .sorted(argumentComparator) //Order using created comparator
                .map(argument -> argument.expression().accept(this)) //Map parsed arguments into expressions
                .collect(toList());
        return new FunctionCall(signature, arguments);
    }
}

这种方式对字节码的生成是透明的，字节码生成阶段无需了解方法调用参数是命名还是未命名

示例

如下的 Enkel 代码：

NamedParamsTest {

    main(string[] args) {
        createRect(x1->25,x2->-25,y1->50,y2->-50)
    }

    createRect (int x1,int y1,int x2, int y2) {
        print "Created rect with x1=" + x1 + " y1=" + y1 + " x2=" + x2 + " y2=" + y2
    }
}

编译后的字节码如下：

public class NamedParamsTest {
  public static void main(java.lang.String[]);
    Code:
       0: bipush        25          //x1 (1 index in call)
       2: bipush        50          //y1 (3 index in call)
       4: bipush        -25         //x2 (2 index in call)
       6: bipush        -50         //y2 (4 index in call)
       8: invokestatic  #10                 // Method createRect:(IIII)V
      11: return

  public static void createRect(int, int, int, int);
    Code:
      //normal printing code 
}

输出：
Created rect with x1=25 y1=50 x2=-25 y2=-50