cangjie-enum

name	cangjie-enum
description	仓颉语言枚举类型。当需要了解仓颉语言的enum定义规则、构造器（有参/无参/同名/非穷举）、枚举的使用与名称冲突、枚举成员函数和属性、递归枚举、枚举实现Equatable接口等特性时，应使用此 Skill

仓颉语言枚举类型 Skill

1. 枚举类型定义

1.1 定义规则

• 使用 enum 关键字 + 名称 + {} 体定义
• 体内包含构造器，以 | 分隔（第一个 | 可选）
• 每个枚举须有至少一个具名构造器
• 构造器可以是无参（Red）或有参（Red(UInt8)）
• 同名构造器在参数数量不同时允许（包括 0 个参数）
• 构造器名不能与仓颉关键字同名（如 Bool、String、Int64 等都是关键字）。若需要使用关键字作为构造器名，须用反引号转义（如 `Bool`），或改用其他名称（如 JBool）：

  // 错误：Bool 是关键字
  // | Bool(Bool)  // 编译错误
  // 正确：使用反引号转义或改名
  | `Bool`(Bool)   // 反引号转义
  | JBool(Bool)    // 改名避免冲突
  

• 非穷举枚举：可有一个特殊的未命名 ... 构造器作为最后一个。不能直接匹配，须用 _ 或绑定模式（详见 cangjie-pattern-match Skill）
• 递归定义支持（构造器参数可引用枚举自身）
• 枚举体还可包含成员函数、运算符函数和成员属性，但不能与构造器同名
• 枚举仅能在顶层作用域定义

1.2 定义示例

// 基本枚举：无参构造器
enum Direction {
    | Up | Down | Left | Right
}

// 有参构造器
enum RGBColor {
    | Red(UInt8) | Green(UInt8) | Blue(UInt8)
}

// 同名构造器（参数个数不同）
enum Color {
    | Red | Green | Blue
    | Red(UInt8) | Green(UInt8) | Blue(UInt8)
}

// 非穷举枚举
enum Token {
    | Number | Plus | Minus | ...
}

// 递归枚举
enum Expr {
    | Num(Int64)
    | Add(Expr, Expr)
    | Sub(Expr, Expr)
}

// 包含成员函数的枚举
enum RGBColor2 {
    | Red | Green | Blue

    public func getName() {
        match (this) { // this 表示当前枚举实例
            case Red => "Red"
            case Green => "Green"
            case Blue => "Blue"
        }
    }
}

---

2. 枚举的使用

2.1 创建枚举值

• 通过 TypeName.Constructor 或直接使用构造器名创建实例

enum RGBColor {
    | Red | Green | Blue(UInt8)
}

main() {
    let r = RGBColor.Red   // 类型名限定
    let g = Green           // 直接使用构造器名
    let b = Blue(100)       // 有参构造器
}

2.2 名称冲突

• 若构造器名与作用域中的变量、函数或类名冲突，须用枚举类型名限定

let Red = 1                           // 变量名与构造器同名

enum RGBColor {
    | Red | Green(UInt8) | Blue(UInt8)
}

let r1 = Red                          // 选择变量 Red，而非构造器
let r2 = RGBColor.Red                 // 正确：通过类型名访问构造器

---

3. 枚举与 Equatable

• 枚举默认不实现 Equatable 接口，不能直接使用 == 比较枚举值
• 若需要 == 比较，须使用 @Derive[Equatable] 宏自动派生（std.deriving.*）
• 不使用 @Derive 时，可通过 match 表达式匹配枚举模式进行处理（详见 cangjie-pattern-match Skill）

关于 @Derive 宏的详细用法，可参阅 cangjie-std-libs Skill

完整示例：枚举与 Equatable

import std.deriving.*

@Derive[Equatable]
enum Color {
    | Red | Green | Blue
}

main() {
    let c = Color.Red

    // 使用 @Derive 实现 Equatable 接口后可直接用 == 比较
    if (c == Color.Red) {
        println("It's red!")
    }
}

常见错误

// ❌ 错误：枚举默认不支持 == 比较
enum Status {
    | Active | Inactive
}
// if (Status.Active == Status.Inactive) { }  // 编译错误

---

4. Option 类型

Option 是仓颉预置的一个枚举类型，可表示或有或无的值，引用有效值前必须匹配判断，用于应对空值安全问题，详见 cangjie-option Skill

---

5. 完整可运行示例

import std.deriving.*

// 使用枚举定义一个简单的表达式求值器
enum Expr {
    | Num(Int64)
    | Add(Expr, Expr)
    | Neg(Expr)
}

// 为枚举实现 ToString 接口
enum Color <: ToString { // 也可用 @Derive[ToString] 自动实现
    Red | Green | Blue

    public func toString() { // 枚举中可以定义成员函数
        match (this) {
            case Red => "Red"
            case Green => "Green"
            case Blue => "Blue"
        }
    }
}

main() {
    // 创建枚举值
    let expr = Add(Num(1), Neg(Num(2)))

    // 可结合 match 递归求值，详见 cangjie-pattern-match Skill
    // eval(expr) => 1 + (-2) = -1

    // 实现 ToString 接口的枚举类型可打印
    let color = Red
    println(color)
}