enum的定义#

定义enum时需要把它所有可能的取值一一列出, 称这些值为 enum的构造器(或者constructor)

enum类型的定义以关键字enum开头, 接着是enum的名字, 之后是定义在一对花括号中的enum体, enum体中定义了若干构造器, 多个构造器之间使用|进行分隔(第一个构造器之前的|是可选的)

构造器可以是有名字的, 也可以是没有名字的...

每个enum中至少存在一个有名字的构造器

有名字的构造器可以没有参数(即”无参构造器”), 也可以携带若干个参数(即”有参构造器”)

如下示例代码定义了一个名为RGBColor的enum类型, 它有3个构造器: Red、Green和Blue, 分别表示RGB色彩模式中的红色、绿色和蓝色

每个构造器有一个UInt8类型的参数, 用来表示每个颜色的亮度级别

1
enum RGBColor {
2
    | Red(UInt8) | Green(UInt8) | Blue(UInt8)
3
}

enum就是枚举类型

定义enum类型时, 一般将所有可能的取值定义为构造器, 此类型的取值只能是定义的构造器, 构造器之间使用|分割(在每个构造器之前, 第一个构造器之前的|是可选的)

每个构造器表示一个此类型enum取值, 但, 无名构造器...无法作为取值

仓颉中的enum是可以携带数据的, C/C++中的enum就不能携带数据

仓颉支持同一个enum中定义多个同名构造器, 但是要求这些构造器的参数个数不同(认为没有参数的构造器的参数个数等于 0), 例如:

1
enum RGBColor {
2
    | Red | Green | Blue
3
    | Red(UInt8) | Green(UInt8) | Blue(UInt8)
4
}

每个enum中最多只有一个没有名字的...构造器, 且...只能是最后一个构造器

拥有...构造器的enum称为non-exhaustive enum

由于没有名字, 这个构造器不能被直接匹配, 在解构时, 需要使用可匹配所有构造器的模式, 如通配符模式_或绑定模式, 具体可参见match表达式的定义

例如:

1
enum t {
2
    | Red | Green | Blue | ...
3
}

仓颉enum的可以定义多个同名构造器, 要求同名构造器之间的参数个数不同, 即 携带数据的个数不同

仓颉enum定义...(无名构造器)时, 只能作为最后一个构造器

enum支持递归定义, 例如, 下面的例子中使用enum定义了一种表达式(即Expr), 此表达式只能有 3 种形式:

1. 单独的一个数字Num(携带一个Int64类型的参数)

2. 加法表达式Add(携带两个Expr类型的参数)

3. 减法表达式Sub(携带两个Expr类型的参数)

对于Add和Sub这两个构造器, 其参数中递归地使用到了Expr自身

1
enum Expr {
2
    | Num(Int64)
3
    | Add(Expr, Expr)
4
    | Sub(Expr, Expr)
5
}

仓颉enum的构造器可以递归定义, 即 构造器参数可以是enum类型本身

就比如文档中的例子, 可以这样使用:

1
enum Expr {
2
    | Num(Int64)
3
    | Add(Expr, Expr)
4
    | Sub(Expr, Expr)
5
}
6

7
func exprRes(expr: Expr) : Int64 {
8
    match (expr) {
9
        case Num(num) => num
10
        case Add(left, right) => exprRes(left) + exprRes(right)
11
        case Sub(left, right) => exprRes(left) - exprRes(right)
12
    }
13
}
14

15
main() {
16
    let num1 = Expr.Num(1)
17
    let num2 = Expr.Num(2)
18
    let addExpr = Expr.Add(num1, num2)
19
    let subExpr = Expr.Sub(num1, num2)
20

21
    println(exprRes(num1))
22
    println(exprRes(num2))
23
    println(exprRes(addExpr))
24
    println(exprRes(subExpr))
25

26
    return 0
27
}

可以使用模式匹配, 匹配对应的构造器实现执行对应的代码

另外, 在enum体中还可以定义一系列成员函数、操作符函数(详见操作符重载)和成员属性(详见属性), 但是要求构造器、成员函数、成员属性之间不能重名

例如, 下面的例子在RGBColor中定义了一个名为printType的函数, 它会输出字符串RGBColor:

1
enum RGBColor {
2
    | Red | Green | Blue
3

4
    public static func printType() {
5
        print("RGBColor")
6
    }
7
}

注意:

enum只能定义在源文件的顶层作用域

仓颉enum中可以定义一些列的成员函数、成员属性等, 但不能存在成员变量

当然也可以实现接口, 比如:

1
enum Week <: ToString {
2
    | Monday
3
    | Tuesday
4
    | Wednesday
5
    | Thurday
6
    | Friday
7
    | Saturday
8
    | Sunday
9

10
    public func toString(): String {
11
        match (this) {
12
            case Monday => "Monday"
13
            case Wednesday => "Wednesday"
14
            case Thurday => "Thurday"
15
            case Friday => "Friday"
16
            case Saturday => "Saturday"
17
            case Sunday => "Sunday"
18
            case _ => "None"
19
        }
20
    }
21
}
22

23
main() {
24
    let theDay = Week.Monday
25
    println(theDay)
26
}

这段代码将会输出:

1
Monday

enum的使用#

定义了enum类型之后, 就可以创建此类型的实例(即enum值), enum值只能取enum类型定义中的一个构造器

enum没有构造函数, 可以通过类型名.构造器, 或者直接使用构造器的方式来构造一个enum值(对于有参构造器, 需要传实参)

下例中, RGBColor中定义了三个构造器, 其中有两个无参构造器(Red和Green)和一个有参构造器(Blue(UInt8)), main中定义了三个RGBColor类型的变量r, g和b

其中, r的值使用RGBColor.Red进行初始化, g的值直接使用Green进行初始化, b的值使用Blue(100)进行初始化:

1
enum RGBColor {
2
    | Red | Green | Blue(UInt8)
3
}
4

5
main() {
6
    let r = RGBColor.Red
7
    let g = Green
8
    let b = Blue(100)
9
}

当省略类型名时, enum构造器的名字可能和类型名、变量名、函数名发生冲突

此时必须加上enum类型名来使用enum构造器, 否则只会选择同名的类型、变量、函数定义

下面的例子中, 只有构造器Blue(UInt8)可以不带类型名使用, Red和Green(UInt8)皆会因为名字冲突而不能直接使用, 必须加上类型名RGBColor

1
let Red = 1
2

3
func Green(g: UInt8) {
4
    return g
5
}
6

7
enum RGBColor {
8
    | Red | Green(UInt8) | Blue(UInt8)
9
}
10

11
let r1 = Red                 // Will choose 'let Red'
12
let r2 = RGBColor.Red        // Ok: constructed by enum type name
13

14
let g1 = Green(100)          // Will choose 'func Green'
15
let g2 = RGBColor.Green(100) // Ok: constructed by enum type name
16

17
let b = Blue(100)            // Ok: can be uniquely identified as an enum constructor

如下的例子中, 只有构造器Blue会因为名称冲突而不能直接使用, 必须加上类型名RGBColor

1
class Blue {}
2

3
enum RGBColor {
4
    | Red | Green(UInt8) | Blue(UInt8)
5
}
6

7
let r = Red                 // Ok: constructed by enum type name
8

9
let g = Green(100)          // Ok: constructed by enum type name
10

11
let b = Blue(100)           // Will choose constructor of 'class Blue' and report an error

仓颉 可以使用enum定义的其中一个构造器作为enum变量的值

enum没有构造函数:

1. 可以通过类型名.构造器的方式, 构造一个enum值(对于有参构造器, 需要传实参)

   比如: RGBColor.Red或RGBColor.Green(100)

2. 直接使用构造器的方式, 构造一个enum值(对于有参构造器, 需要传实参)

   比如: Red或Green(100)

   但, 当构造器名与其他可见标识符存在冲突时, 就只能通过指定enum类型名来构造enum值