1. 主页
  2. 文档
  3. 学习君土脚本
  4. 君土脚本对象入门
  5. 枚举

枚举

枚举

使用枚举, 我们可以定义一些有名字的数字常量。 枚举通过举/*enum*/关键字来定义。

  举 方向 {
    上 = 1,
    下,
    左,
    右
  }

一个枚举类型可以包含零个或多个枚举成员。 枚举成员具有一个数字值,它可以是常数或是计算得出的值. 当满足如下条件时,枚举成员被当作是常数:

  • 不具有初始化函数, 并且之前的枚举成员是常数。 在这种情况下,当前枚举成员的值为上一个枚举成员的值加1。 但第一个枚举元素是个例外。 如果它没有初始化方法,那么它的初始值为0
  • 枚举成员使用常数枚举表达式初始化。 常数枚举表达式是君土脚本表达式的子集,它可以在编译阶段求值。 当一个表达式满足下面条件之一时,它就是一个常数枚举表达式:
    • 数字字面量
    • 引用之前定义的常数枚举成员(可以是在不同的枚举类型中定义的). 如果这个成员是在同一个枚举类型中定义的,可以使用非限定名来引用。
    • 带括号的常数枚举表达式
    • +-~ 一元运算符应用于常数枚举表达式
    • +-*/%<<>>>>>&|^ 二元运算符,常数枚举表达式做为其一个操作对象。 若常数枚举表达式求值后为非数/*NaN*/无穷/*Infinity*/,则会在编译阶段报错。

所有其它情况的枚举成员被当作是需要计算得出的值。

  举 文件访问 {
    // 常量 成员
    没有,
    读 = 1 << 1,
    写 = 1 << 2,
    读写 = 读 | 写,
    // 计算成员
    长0 = "123".长
  }

枚举是在运行时真正存在的一个对象。 其中一个原因是因为这样可以从枚举值到枚举名进行反向映射。

  举 举0 {
    甲
  }
  定 甲0 = 举0.甲;
  定 甲名 = 举0[甲0]; // "甲"
  控制台.日志(甲名);

编译成:

    let 举0;
    (function (举0) {
        举0[举0["\u7532"] = 0] = "\u7532";
    })(举0 || (举0 = {}));
    let 甲0 = 举0.甲;
    let 甲名 = 举0[甲0]; // "甲"
    console.log(甲名);

生成的代码中,枚举类型被编译成一个对象,它包含双向映射( -> )和( -> )。引用枚举成员总会生成一次属性访问并且永远不会内联。 在大多数情况下这是很好的并且正确的解决方案。 然而有时候需求却比较严格。 当访问枚举值时,为了避免生成多余的代码和间接引用,可以使用常数枚举。 常数枚举是在关键字前使用修饰符。

  常 举 枚举 {
    甲 = 1,
    乙 = 甲 * 2
  }

常数枚举只能使用常数枚举表达式, 并且不同于常规的枚举的是它们在编译阶段会被删除。 常数枚举成员在使用的地方被内联进来。 这是因为常数枚举不可能有计算成员。

  常 举 方向 {
    上,
    下,
    左,
    右
  }

  定 方向0 = [方向.上, 方向.下, 方向.左, 方向.右];

生成后的代码为:

let 方向0 = [0 /* 上 */, 1 /* 下 */, 2 /* 左 */, 3 /* 右 */];