教你使用swift写编译器玩具(6)

前言

本章对应官方教程第6章。在之前的教程中我们为Kaleidoscope实现了一些基本的功能,但现在它有个大问题,那就是没有更多的操作符。所以本章内容展示了如何为让Kaleidoscope支持自定义操作符。

教程如下:

教你使用swift写编译器玩具(0)

教你使用swift写编译器玩具(1)

教你使用swift写编译器玩具(2)

教你使用swift写编译器玩具(3)

教你使用swift写编译器玩具(4)

教你使用swift写编译器玩具(5)

教你使用swift写编译器玩具(6)

教你使用swift写编译器玩具(7)

教你使用swift写编译器玩具(8)

仓库在这

开始

既然我们要支持自定义运算符,那么肯定是需要在函数的处理上提供支持。因为我们需要支持一元运算符和二元运算符,所以需要定义两个token。他们分别是unary,用于扩展一元运算符。和binary,用于扩展二元运算符。

我们举两个例子说明用户自定义操作符的用法。

用于扩展一元运算符的函数写法,扩展了"非"操作符。

def unary ! (v)
  if v then
    0
  else
    1;

用于扩展二元运算符的函数写法,扩展了"或"操作符。

def binary | 5 (LHS RHS)
  if LHS then
    1
  else if RHS then
    1
  else
    0;

Token解析

需要做的第一件还是完善token的解析。

enum Token {
    ...
        case binary
        case unary
        ...
}

    else if identifierStr == "binary" {
        currentToken = CurrentToken(token: .binary, val: "binary")
} else if identifierStr == "unary" {
        currentToken = CurrentToken(token: .unary, val: "unary")
} 

扩展AST Node

既然我们是用def去自定义操作符,那么我们肯定需要改变之前的AST数据结构。

首先我们来看PrototypeAST的改变。

enum PrototypeKind: Int {
    case identifier
    case unary
    case binary
}

class PrototypeAST {
    
    let name: String
    
    let args: [String]
    
    let isOperator: Bool//是否是运算符定义函数
    
    let precedence: UInt//运算符优先级
    
    //是否是二元运算符定义函数
    private var isBinaryOp: Bool {
        return isOperator && args.count == 2
    }
    
    //是否是一元运算符定义函数
    private var isUnaryOp: Bool {
        return isOperator && args.count == 1
    }
    
    //运算符定义名字
    var operatorName: String? {
        guard isUnaryOp || isOperator else {
            return nil
        }
        return String(Array(name).last!)
    }
    
    init(_ name: String, _ args: [String], _ isOperator: Bool = false, _ precedence: UInt = 0) {
        self.name = name
        self.args = args
        self.isOperator = isOperator
        self.precedence = precedence
    }
    
    func codeGen() -> Function {
        let doubles = Array(repeating: FloatType.double, count: args.count)
        let ft = FunctionType(doubles, FloatType.double, variadic: false)
        var f: Function = theModule.addFunction(name, type: ft)
        //这其实是默认linkage,这里为了和官方教程保持一致,显示的写一下
        f.linkage = .external
        //设置参数名
        var p = f.firstParameter
        for i in 0..<args.count {
            p?.name = args[i]
            p = p?.next()
        }
        return f
    }
    
}

紧接着我们需要改变parsePrototype()方法。

    /// 解析函数原型
    ///
    /// - Returns: 函数原型AST
    func parsePrototype() -> PrototypeAST {
        var fnName: String
        let kind: PrototypeKind
        var binaryPrecedence: UInt = 30
        
        switch lexer.currentToken!.token {
        case .identifier:
            fnName = lexer.currentToken!.val
            kind = .identifier
            lexer.nextToken()
            break
        case .binary:
            lexer.nextToken()
            //不是ASCII字符不可以使用
            guard Array(lexer.currentToken!.val)[0].isASCII else {
                fatalError("Expected binary operator.")
            }
            fnName = "binary"
            fnName += lexer.currentToken!.val
            kind = .binary
            lexer.nextToken()
            
            //解析二元表达式优先级
            if lexer.currentToken!.token == .number {
                let num = UInt(lexer.currentToken!.val)!
                if num < 1 || num > 100 {
                    fatalError("Invalid precedence: must be 1...100.")
                }
                binaryPrecedence = num
                lexer.nextToken()
            }
            break
        default:
            fatalError("Expected function name in prototype.")
        }
        
        if lexer.currentToken!.val != "(" {
            fatalError("Expected '(' in prototype")
        }
        
        lexer.nextToken()
        var argNames: [String] = []
        while lexer.currentToken!.token == .identifier {
            argNames.append(lexer.currentToken!.val)
            lexer.nextToken()
        }
        if lexer.currentToken!.val != ")" {
            fatalError("Expected ')' in prototype")
        }
        lexer.nextToken()
        
        if kind != .identifier && kind.rawValue != argNames.count {
            fatalError("Invalid number of operands for operator.")
        }
        
        return PrototypeAST(fnName, argNames, kind.rawValue != 0, binaryPrecedence)
    }

其实这里的变化无非就是需要多解析一元表达式和二元表达式这两种情况而已。

解析完AST之后我们还需要支持代码生成,所以我们在BinaryExprAST中的codeGen()方法里支持一下。

    func codeGen() -> IRValue? {
        ...
        //如果走到这里了,说明这个运算符是用户自己定义的
        let fn = getFunction(named: "binary" + op)
        guard fn != nil else {
            fatalError("\(String(describing: fn)) binary operator not found!")
        }
        let ops = [l!, r!]
        return builder.buildCall(fn!, args: ops, name: "binaryOp")
    }

FunctionASTcodeGen()方法里把自定义操作符放在全局操作符表中。

        func codeGen() -> Function? {     
        ...
                //如果是操作符,把他放在全局的操作符表中
        if proto.isOperator {
            BinOpPrecedence[proto.operatorName!] = proto.precedence
        }
        ...
    }

支持一元运算符

由于之前在Kaleidoscope中不支持一元运算符,所以我们需要新增一个AST Node UnaryExprAST

class UnaryExprAST: ExprAST {
    
    let op: String
    
    let operand: ExprAST
    
    init(_ op: String, _ operand: ExprAST) {
        self.op = op
        self.operand = operand
    }
    
}

接着按照惯例我们在Parser中添加解析逻辑。

    /// 解析一元表达式
    ///
    /// - Returns: AST
    private func parseUnaryExpr() -> ExprAST? {
        //当前token不是操作符,那就是基本类型
        if lexer.currentToken!.val == "(" ||
            lexer.currentToken!.val == "," ||
            Array(lexer.currentToken!.val)[0].isLetter ||
            Array(lexer.currentToken!.val)[0].isNumber {
            return parsePrimary()
        }
        
        let op = lexer.currentToken!.val
        lexer.nextToken()
        //这里需要递归的处理一元运算符,比如说 !! x,这里有两个!!需要处理
        if let operand = parseUnaryExpr() {
            return UnaryExprAST(op, operand)
        }
        return nil
    }

为了调用这个方法,我们需要改变之前调用parsePrimary()方法的地方改为调用parseUnaryExpr()方法。

    private func parseBinOpRHS(_ exprPrec: Int, _ lhs: inout ExprAST) -> ExprAST? {
        while true {
                        ...
            //解析二元运算符右边的表达式
            var rhs = parseUnaryExpr()
            guard rhs != nil else {
                return nil
            }
            ...
    }
      
    func parseExpression() -> ExprAST? {
        var lhs = parseUnaryExpr()
        guard lhs != nil else {
            return nil
        }
        return parseBinOpRHS(0, &lhs!)
    }

接着我们为parsePrototype()方法添加解析支持。

        ...
                case .unary:
            lexer.nextToken()
            guard Array(lexer.currentToken!.val)[0].isASCII else {
                fatalError("Expected unary operator.")
            }
            fnName = "unary"
            fnName += lexer.currentToken!.val
            kind = .unary
            lexer.nextToken()
            break
                ...

最后我们实现UnaryExprASTcodeGen()方法即可。

    func codeGen() -> IRValue? {
        let operandVal = operand.codeGen()
        guard operandVal != nil else {
            return nil
        }
        let fn = getFunction(named: "unary" + op)
        guard fn != nil else {
            fatalError("Unknow unary operator.")
        }
        return builder.buildCall(fn!, args: [operandVal!], name: "unaryOp")
    }

测试

一元运算符

//输入
def unary ! (v) if v then 0 else 1;
def testfunc(x) !x;
testfunc(1);

//输出
Read function definition:

define i64 @"unary!"(i64 %v) {
entry:
  %ifCond = icmp eq i64 %v, 0
  %. = select i1 %ifCond, i64 1, i64 0
  ret i64 %.
}
Read function definition:

define i64 @testfunc(i64 %x) {
entry:
  %unaryOp = call i64 @"unary!"(i64 %x)
  ret i64 %unaryOp
}
Read top-level expression:

define i64 @__anon_expr() {
entry:
  %call = call i64 @testfunc(i64 1)
  ret i64 %call
}
Evaluated to 0.

二元运算符

//输入
def binary > 10 (LHS RHS) RHS < LHS;
def testfunc(v) if v > 10 then 1 else 0;
testfunc(1);

//输出
Read function definition:

define i64 @"binary>"(i64 %LHS, i64 %RHS) {
entry:
  %boolCmp = icmp slt i64 %RHS, %LHS
  %0 = sext i1 %boolCmp to i64
  ret i64 %0
}
Read function definition:

define i64 @testfunc(i64 %v) {
entry:
  %binaryOp = call i64 @"binary>"(i64 %v, i64 10)
  %ifCond = icmp eq i64 %binaryOp, 0
  %. = select i1 %ifCond, i64 0, i64 1
  ret i64 %.
}
Read top-level expression:

define i64 @__anon_expr() {
entry:
  %call = call i64 @testfunc(i64 1)
  ret i64 %call
}
Evaluated to 0.
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 156,069评论 4 358
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,212评论 1 287
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 105,912评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,424评论 0 202
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,741评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,194评论 1 206
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,553评论 2 307
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,289评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,923评论 1 237
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,251评论 2 240
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,775评论 1 255
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,144评论 2 249
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,698评论 3 228
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,936评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,658评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,214评论 2 267
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,159评论 2 258