13.2 - 无作用域枚举类型

"Key Takeaway"

• 使用enum关键字定义的枚举是无作用域枚举类型，它的枚举值被暴露在和枚举类型定义的作用域中，因此更适合被直接定义在使用它的类中
• 一个枚举类型的枚举值不能用于另一个枚举类型的对象

C++ 中内置了很多有用的基础数据类型和符合类型（分别在4.1 - 基础数据类型简介和12.1 - 复合数据类型中进行了介绍）。但是这些内置数据类型并不是总能满足我们的需要。

例如，我们的程序需要追踪一个苹果的颜色是红色、黄色还是绿色。亦或者我们需要描述一件T恤的可选颜色（通过一个颜色列表）。如果只能使用基础类型的话，你会怎么做？

你可能会把颜色存储为整型值，并隐式地将其关联到对应的颜色(0 = red , 1 = green, 2 = blue)：

int main()
{
    int appleColor{ 0 }; // my apple is red
    int shirtColor{ 1 }; // my shirt is green
 
    return 0;
}

但是这么做并不直观，而且我们讨论过为什么使用魔鬼数字是不利的（5.1 - const 变量和符号常量）。我们可以使用符号常量来避免魔鬼数字的问题：

constexpr int red{ 0 };
constexpr int green{ 1 };
constexpr int blue{ 2 };
 
int main()
{
    int appleColor{ red };
    int shirtColor{ green };
 
    return 0;
}

尽管可读性变好了一些，程序员仍然需要理解appleColor 和 shirtColor (int类型)存放的是另外一些表示颜色的符号常量（而这些常量很可能被定义在其他地方，甚至是其他文件中）。

使用别名可以进一步提高可读性：

using Color = int; // define a type alias named Color
 
// The following color values should be used for a Color
constexpr Color red{ 0 };
constexpr Color green{ 1 };
constexpr Color blue{ 2 };
 
int main()
{
    Color appleColor{ red };
    Color shirtColor{ green };
 
    return 0;
}

可读性更好了。但是程序员仍然需要理解，这些表示颜色的符号常量需要配合 Color 类型的变量来使用。不过至少现在这些类型具有一个唯一的别名 Color ，我们可以搜索它并找到相关的符号常量定义。

但是，因为 Color 只是 int 的别名，所以我们仍然无法保证这些符号常量被正确地使用。我们仍然由可能犯如下的错误。

Color eyeColor{ 8 }; // 语法正确，但语义错误（8不是一个被定义的颜色值）

不仅如此，当我们调试程序的时候，这些变量都会显示为整型值，而不是其符号含义 (red)，这无疑会让debug变得更加困难。

幸运地是，我们还有更好的办法。

枚举

枚举(也称为枚举类型和enum) 是一种复合类型。在枚举类型中，每个可能的值都被定义为一个符号常量（称为枚举值）。

因为枚举属于程序定义类型（13.1 - 程序定义类型简介），所以枚举类型在使用前必须先进行定义。

C++ 支持两种类型的枚举：13.2 - 无作用域枚举类型和13.6 - 限定作用域枚举（枚举类）

无作用域枚举类型

无作用域枚举类型通过 enum 关键字定义。

枚举类型通过实例来学习效果更好。接下来，让我们定义一个无作用域枚举类型来表示颜色值吧：

// 定义一个新的无作用域枚举类型，名为 Color
enum Color
{
    // 枚举值定义在这里
    // 这些符号常量定义了所有可能的值
    // 枚举值通过逗号分割，而不是分号
    red,
    green,
    blue, // 结尾的逗号可有可无，但是推荐写上
}; // 枚举定义必须以分号结尾
 
int main()
{
    // 定义一些Color类型的变量
    Color apple { red };   // my apple is red
    Color shirt { green }; // my shirt is green
    Color cup { blue };    // my cup is blue
 
    Color socks { white }; // 错误: white 不是可用的枚举值
    Color hat { 2 };       // 错误: 2 页不是Color的枚举值
 
    return 0;
}

我们首先使用enum关键字来告诉编译器，我们正在定义一个无作用域枚举，我们将其命名为Color 。

随后，在花括号里面定义Color类型的枚举值：red，green和blue。这些枚举值指定了 Color 类型能够表示或存储的所有可能值。每个枚举值需要通过逗号（而不是分号）隔开——最后一个枚举值后面可以有逗号也可以没有，加上逗号看起来一致性更好。

Color 的定义以分号结尾。至此，枚举类型 Color 就定义完成了！

在 main() 函数中，我们初始化了三个 Color 类型的变量：apple 被初始化为 red，shirt 初始化为 green ，cup 初始化为 blue。

程序会为这三个对象分配内存。注意，当初始化枚举类型时，所用的初始化值必须是该类型定义过的枚举值。变量socks 和 hat 并不能成功定义，因为 white 和 2 并不是 Color 的枚举值。

"作者注"

命名规则小结:

• 枚举和枚举类型指的是类型本身(例如 Color)
• 枚举值指的是枚举中可能值所对应的符号常量(例如 red)

枚举类型和枚举值的命名

按照惯例，枚举类型的名字以大写字母开头（规则适用于所有自定义类型）。

"注意"

枚举类型不一定要有名字，但是现代C++推荐避免使用匿名的枚举。

枚举值必须有名字。可惜的是，对于枚举值的名字暂时还没有约定俗成的命名规范。通常的选择有：小写字母开头（例如red），大写字母开头（例如Red，全大写（例如RED）、全大写且添加将枚举类型作为前缀（例如COLOR_RED），再或者使用k作为前缀并配合大小写交替(kColorRed)。

现代C++指南通常建议避免使用全大写的命名约定，因为全大写通常用于预处理器宏，可能会发生冲突。我们还建议避免以大写字母开头的约定，因为以大写字母开头的名称通常为自定义类型保留。

"最佳实践"

以大写字母开头命名枚举类型。以小写字母开头命名枚举值。

枚举类型是可区分类型

你创建的每个枚举类型都被认为是一个不同的类型，这意味着编译器可以将其与其他类型区分开来(不像typedefs或类型别名，它们是一种别名，与其对应的类型并没有区别)。

枚举类型是不同的，因此一种枚举类型中枚举值也不能用于另一种枚举类型的对象:

enum Pet
{
    cat,
    dog,
    pig,
    whale,
};
 
enum Color
{
    black,
    red,
    blue,
};
 
int main()
{
    Pet myPet { black }; // 编译错误: black 不是 Pet 的枚举值
    Color shirt { pig }; // 编译错误: pig 不是 Color 的枚举值
 
    return 0;
}

你可能也不想要一件”pig“衬衫。

使用枚举

因为枚举器是描述性的，它们对于增强代码文档性和可读性非常有用。当你的相关常量的集合很小，并且对象每次只需要保存其中一个值时，枚举类型是最合适的。

星期几、方向或者一副牌中的花色都是常见的枚举定义。

enum DaysOfWeek
{
    sunday,
    monday,
    tuesday,
    wednesday,
    thursday,
    friday,
    saturday,
};
 
enum CardinalDirections
{
    north,
    east,
    south,
    west,
};
 
enum CardSuits
{
    clubs,
    diamonds,
    hearts,
    spades,
};

有时候被调函数需要像主调函数返回状态码以表明自己是否执行成功。传统做法是使用负值来代表不同的错误码，例如：

int readFileContents()
{
    if (!openFile())
        return -1;
    if (!readFile())
        return -2;
    if (!parseFile())
        return -3;
 
    return 0; // success
}

但是，这些魔鬼数字含义非常模糊。更好的办法是使用枚举类型：

enum FileReadResult
{
    readResultSuccess,
    readResultErrorFileOpen,
    readResultErrorFileRead,
    readResultErrorFileParse,
};
 
FileReadResult readFileContents()
{
    if (!openFile())
        return readResultErrorFileOpen;
    if (!readFile())
        return readResultErrorFileRead;
    if (!parseFile())
        return readResultErrorFileParse;
 
    return readResultSuccess;
}

然后调用者可以将返回值和特定的枚举值进行比较，相对于直接和整型数比较，这种方法可读性更好。

if (readFileContents() == readResultSuccess)
{
    // do something
}
else
{
    // print error message
}

枚举类型也可以用于标识简单游戏中的道具、怪物或地形类型。基本上，任何相关对象的小集合都可以使用枚举表示：

enum ItemType
{
	sword,
	torch,
	potion,
};
 
int main()
{
	ItemType holding{ torch };
 
	return 0;
}

枚举类型也可以用于函数形参，表示用户的输入的不同选项：

enum SortOrder
{
    alphabetical,
    alphabeticalReverse,
    numerical,
};
 
void sortData(SortOrder order)
{
    if (order == alphabetical)
        // sort data in forwards alphabetical order
    else if (order == alphabeticalReverse)
        // sort data in backwards alphabetical order
    else if (order == numerical)
        // sort data numerically
}

很多编程语言会使用枚举来定义布尔类型——毕竟布尔类型本质上就是一个具有两个枚举值的枚举类型：false 和 true！但是，C++ 中的true 和 false 是关键字而不是枚举值。

无作用域枚举类型的作用域

无作用域枚举类型之所以被赋予这样的名字，是因为它会将其定义的枚举值暴露在和自己一样的作用域中（而不是像命名空间那样创建了一个新的作用域空间）。

例如：

enum Color // 该枚举类型在全局作用域中定义
{
    red, // 所以 red 也位于全局作用域
    green,
    blue,
};
 
int main()
{
    Color apple { red }; // apple 是 red 的
 
    return 0;
}

Color 枚举类型被定义在全局作用域中，因此它所有枚举值(red、green 和 blue) 都会被放到全局作用域中。这无疑会污染全局作用域，而且显著提高了命名冲突的可能性。

同样地，由于这个原因，相同的枚举值名称不能用在不同的枚举类型中（如果它们在一个作用域中被定义的话）：

enum Color
{
    red,
    green,
    blue, // blue 在全局作用域
};
 
enum Feeling
{
    happy,
    tired,
    blue, // 错误：命名冲突
};
 
int main()
{
    Color apple { red }; // my apple is red
    Feeling me { happy }; // I'm happy right now (even though my program doesn't compile)
 
    return 0;
}

在上面的例子中，两个无作用域枚举类型都被定义在全局作用域中，但是它们都包含了一个同名的枚举值blue。这无疑会导致命名冲突，程序是无法编译的。

无作用域枚举还为它们的枚举值提供命名作用(非常类似于命名空间为其中声明的变量名提供命名作用域区域)。这意味着你可以按以下方式访问无作用域枚举的枚举值：

enum Color
{
    red,
    green,
    blue, // blue 位于全局命名空间
};
 
int main()
{
    Color apple { red }; // 可以直接使用
    Color raspberry { Color::red }; // 也可以通过Color访问
 
    return 0;
}

不过多数情况下，枚举值不会通过作用域解析运算符来访问。

避免枚举值的命名冲突

有很多常见的方法可以避免无作用域枚举值的命名冲突。一种选择是在命名枚举值前，加上枚举本身的名称：

enum Color
{
    color_red,
    color_blue,
    color_green,
};
 
enum Feeling
{
    feeling_happy,
    feeling_tired,
    feeling_blue, // no longer has a naming collision with color_blue
};
 
int main()
{
    Color paint { color_blue };
    Feeling me { feeling_blue };
 
    return 0;
}

虽然这仍然会污染命名空间，但通过使名称更长、更唯一，减少了命名冲突的机会。

一个更好的选择是将枚举类型放在能够提供单独作用域的东西中，例如命名空间:

namespace color
{
    // The names Color, red, blue, and green are defined inside namespace color
    enum Color
    {
        red,
        green,
        blue,
    };
}
 
namespace feeling
{
    enum Feeling
    {
        happy,
        tired,
        blue, // feeling::blue doesn't collide with color::blue
    };
}
 
int main()
{
    color::Color paint { color::blue };
    feeling::Feeling me { feeling::blue };
 
    return 0;
}

但这意味着我们现在必须在枚举和枚举值名称前面加上作用域名称。

"扩展阅读"

类也能够提供作用域，通常将与类相关的枚举类型直接定义在类内。我们会在15.3 - 类中的嵌套类型中进行详细介绍。

另外一个接近方案是使用限定作用域枚举会在13.6 - 限定作用域枚举（枚举类）中进行介绍。

"最佳实践"

最好将枚举放在一个命名的作用域中(例如命名空间或类)，这样枚举值就不会污染全局命名空间。

比较枚举值

我们可以使用等于号或不等号 (operator== 和 operator!=) 来判断两个枚举值是否相同。

#include <iostream>
 
enum Color
{
    red,
    green,
    blue,
};
 
int main()
{
    Color shirt{ blue };
 
    if (shirt == blue) // if the shirt is blue
        std::cout << "Your shirt is blue!";
    else
        std::cout << "Your shirt is not blue!";
 
    return 0;
}

在上面的例子中，我们使用if语句来测试shirt 是否等于blue 。这为我们提供了一种基于枚举所持有的枚举值来按照条件执行程序的方法。

我们将在下一课中更多地使用它。