Enum trong C: hằng có tên, đánh số tự động, enum sang chuỗi

Code đầy những con số trần trụi là code không ai đọc nổi. if (state == 2) không cho bạn biết gì; if (state == STATE_RUNNING) cho bạn biết tất cả. Một enum (kiểu liệt kê) là cách C đặt tên đàng hoàng cho một tập số nguyên nhỏ, cố định, và khác với một đống #define, chúng được gom vào một kiểu mà trình biên dịch biết.

Định nghĩa một enum

Khai báo đặt tên cho một tag và liệt kê các hằng enum (enumerator) trong cặp ngoặc nhọn:

#include <stdio.h>

enum Color {
    RED,
    GREEN,
    BLUE
};

int main(void) {
    enum Color favorite = GREEN;

    printf("favorite = %d\n", favorite);
    printf("RED=%d GREEN=%d BLUE=%d\n", RED, GREEN, BLUE);
    return 0;
}

Có hai điều cần để ý ngay. Thứ nhất, việc đánh số bắt đầu từ 0 và tăng dần một đơn vị, nên RED là 0, GREEN là 1, BLUE là 2. Thứ hai, tên các hằng enum nhìn thấy được ở mọi nơi trong phạm vi bao quanh: bạn viết GREEN, không phải Color.GREEN. Chúng nằm cùng không gian tên với các biến của bạn, vì thế code C thường viết chúng bằng CHỮ IN HOA hoặc thêm tiền tố theo kiểu (COLOR_RED) để tránh trùng tên.

In một enum thì dùng %d, vì giá trị liệt kê chính là một giá trị số nguyên.

Giá trị tường minh

Gán cho một hằng enum bất kỳ một hằng số tường minh, các hằng phía sau sẽ tiếp tục từ đó:

#include <stdio.h>

enum HttpStatus {
    HTTP_OK        = 200,
    HTTP_CREATED   = 201,
    HTTP_NOT_FOUND = 404,
    HTTP_ERROR     = 500
};

enum Level {
    LOW = 10,
    MEDIUM,          /* 11 */
    HIGH,            /* 12 */
    CRITICAL = 100,
    EXTREME          /* 101 */
};

int main(void) {
    printf("%d %d %d %d\n", HTTP_OK, HTTP_CREATED, HTTP_NOT_FOUND, HTTP_ERROR);
    printf("%d %d %d %d %d\n", LOW, MEDIUM, HIGH, CRITICAL, EXTREME);
    return 0;
}

Các giá trị không bắt buộc phải khác nhau hay theo thứ tự: hai hằng enum có thể dùng chung một số, đôi khi có ích để tạo bí danh (COLOR_DEFAULT = COLOR_BLACK). Chúng phải là hằng số nguyên lúc biên dịch, nên bạn không thể tính một hằng từ một biến.

Một cách viết quen thuộc dùng điều này để ghi lại số lượng:

enum Suit {
    CLUBS, DIAMONDS, HEARTS, SPADES,
    SUIT_COUNT           /* automatically 4 - stays correct if you add a suit */
};

SUIT_COUNT không phải là một chất bài thật; nó là số lượng chất bài, được cơ chế đánh số tự động duy trì miễn phí. Vòng lặp và kích thước mảng có thể dùng nó mà không bao giờ bị lỗi thời.

typedef enum

Giống với struct, tên kiểu đầy đủ trong C là enum Color, và một typedef giúp bỏ từ khóa đó:

#include <stdio.h>

typedef enum Direction {
    DIR_NORTH,
    DIR_EAST,
    DIR_SOUTH,
    DIR_WEST,
    DIR_COUNT
} Direction;

int main(void) {
    const int dx[DIR_COUNT] = {0, 1, 0, -1};
    const int dy[DIR_COUNT] = {-1, 0, 1, 0};

    int x = 0, y = 0;
    Direction path[] = {DIR_EAST, DIR_EAST, DIR_SOUTH, DIR_WEST};

    for (size_t i = 0; i < sizeof path / sizeof path[0]; i++) {
        x += dx[path[i]];
        y += dy[path[i]];
    }

    printf("ended at (%d, %d)\n", x, y);
    return 0;
}

Vì các hằng enum là số nguyên bình thường bắt đầu từ 0, chúng kiêm luôn vai trò chỉ số mảng: dx[DIR_EAST] chạy được mà không cần chuyển đổi gì. Đó là tính chất hữu ích nhất của một enum bắt đầu từ 0.

Enum trong switch

Ghép enum với switch là lúc kiểu này bắt đầu phát huy giá trị. Biên dịch với -Wall và trình biên dịch sẽ báo khi bạn quên một case.

#include <stdio.h>

typedef enum {
    STATE_IDLE,
    STATE_RUNNING,
    STATE_PAUSED,
    STATE_STOPPED
} State;

const char *describe(State s) {
    switch (s) {
        case STATE_IDLE:    return "waiting for work";
        case STATE_RUNNING: return "working";
        case STATE_PAUSED:  return "paused by the user";
        case STATE_STOPPED: return "finished";
    }
    return "unknown";
}

int main(void) {
    for (State s = STATE_IDLE; s <= STATE_STOPPED; s++) {
        printf("%d: %s\n", s, describe(s));
    }
    return 0;
}

Thêm STATE_FAILED vào enum và GCC sẽ cảnh báo: enumeration value 'STATE_FAILED' not handled in switch. Cảnh báo đó là thứ gần nhất với phép kiểm tra tính đầy đủ mà C có, và là lý do mạnh mẽ để viết các switch này không có case default:: một default sẽ làm im cảnh báo và để các trạng thái mới lọt qua mà không được xử lý. Thay vào đó, hãy đặt phương án dự phòng sau switch, như hàm describe đã làm.

Chuyển enum thành chuỗi

C không giữ tên nào lúc chạy; printf("%s", GREEN) không thể chạy được vì GREEN đơn giản chỉ là 1. Có hai mẫu giải quyết việc này.

Cách dùng switch, được trình biên dịch kiểm tra:

#include <stdio.h>

typedef enum { RED, GREEN, BLUE, COLOR_COUNT } Color;

const char *color_name(Color c) {
    switch (c) {
        case RED:   return "RED";
        case GREEN: return "GREEN";
        case BLUE:  return "BLUE";
        case COLOR_COUNT: break;
    }
    return "UNKNOWN";
}

int main(void) {
    for (Color c = RED; c < COLOR_COUNT; c++) {
        printf("%d = %s\n", c, color_name(c));
    }
    return 0;
}

Và cách dùng bảng tra cứu, ngắn hơn nhưng không được kiểm tra: nếu mảng và enum lệch nhau thì không có cảnh báo nào:

#include <stdio.h>

typedef enum { RED, GREEN, BLUE, COLOR_COUNT } Color;

static const char *COLOR_NAMES[COLOR_COUNT] = {
    [RED]   = "RED",
    [GREEN] = "GREEN",
    [BLUE]  = "BLUE",
};

const char *color_name(Color c) {
    if (c < 0 || c >= COLOR_COUNT) {
        return "UNKNOWN";
    }
    return COLOR_NAMES[c];
}

int main(void) {
    printf("%s %s %s\n", color_name(RED), color_name(GREEN), color_name(BLUE));
    printf("%s\n", color_name((Color)99));
    return 0;
}

Các chỉ số mảng chỉ định ([RED] = "RED") ít nhất giữ tên gắn với đúng ô của nó, nên sắp xếp lại enum không thể âm thầm xáo trộn các chuỗi. Phép kiểm tra giới hạn quan trọng vì không có gì ngăn nơi gọi truyền vào một giá trị nằm ngoài enum, xem phần tiếp theo.

Enum không kín kẽ

Bên dưới, một biến enum là số nguyên, và C không kiểm soát phạm vi:

#include <stdio.h>

typedef enum { RED, GREEN, BLUE } Color;

int main(void) {
    Color c = (Color)42;      /* legal; no check at all */
    int n = BLUE;             /* enum to int: implicit and fine */

    printf("c = %d, n = %d\n", c, n);
    printf("RED + GREEN = %d\n", RED + GREEN);
    return 0;
}

Phép toán số học trên hằng enum chạy được, so sánh với int thường chạy được, và một phép ép kiểu ra ngoài phạm vi vẫn được chấp nhận. Vì vậy hãy coi enum là tài liệu tuyệt vời và một gợi ý tốt cho trình biên dịch, không phải là một sự đảm bảo. Hãy kiểm tra mọi giá trị đến từ bên ngoài chương trình, như một tệp, một đối số, một thông điệp mạng, trước khi dùng nó trong switch.

Kích thước và lưu trữ

Trong C17, mọi hằng enum phải vừa trong một int: enum Huge { BIG = 3000000000 }; vi phạm ràng buộc và bị một trình biên dịch nghiêm ngặt (-pedantic-errors) từ chối, dù gcc và clang chấp nhận nó như một phần mở rộng ở chế độ mặc định. Bản thân các hằng enum có kiểu int, còn kích thước của kiểu enum do cài đặt quyết định (trong thực tế là int):

#include <stdio.h>

enum Small { A, B, C };
enum Flags { READ = 1, WRITE = 2, EXEC = 4 };

int main(void) {
    printf("sizeof(enum Small) = %zu\n", sizeof(enum Small));
    printf("sizeof(enum Flags) = %zu\n", sizeof(enum Flags));
    printf("sizeof(int)        = %zu\n", sizeof(int));
    return 0;
}

(C23 gỡ bỏ giới hạn này: một hằng enum có thể vượt phạm vi int, và bạn còn có thể chọn kiểu nền bằng enum E : unsigned long { ... }. Cho đến khi bộ công cụ của bạn nhắm tới C23, hãy giữ các hằng enum trong phạm vi int.)

Vì lựa chọn chính xác do cài đặt quyết định, đừng bao giờ ghi trực tiếp một enum vào tệp nhị phân hay gói tin mạng rồi mong máy khác đọc lại được. Hãy chuyển sang một kiểu có độ rộng cố định như uint8_t hoặc uint32_t từ <stdint.h> tại ranh giới đó.

Enum và #define

Cả hai đều đặt tên cho một con số. Nhìn chung enum tốt hơn:

Hãy dùng #define khi hằng không phải số nguyên (một chuỗi, một số thực) hoặc khi chính bộ tiền xử lý phải dùng được nó, như trong biên dịch có điều kiện. Với một tập trạng thái, cờ hoặc loại số nguyên có liên quan, hãy dùng enum.

Quy ước đặt tên

Enum rất dễ trùng tên vì tên của chúng nằm trong phạm vi thông thường. Những quy ước giúp các codebase C lớn luôn gọn gàng:

• Thêm tiền tố là tên kiểu cho mỗi hằng enum: COLOR_RED, STATE_IDLE, HTTP_OK. Một RED không có tiền tố trong chương trình đồ họa sớm muộn cũng đụng phải RED của người khác.
• Viết hằng enum bằng SHOUT_CASE, khớp với cách viết các hằng khác.
• Đặt tên kiểu ở dạng số ít PascalCase hoặc snake_case_t: Color, State hoặc color_t, nhất quán trong toàn dự án.
• Thêm một hằng đánh dấu _COUNT ở cuối khi bạn sẽ lặp hoặc lấy chỉ số bằng enum.