我正在编写一个简单的解析器来读取配置文件。config.h接口只有三个它们的主要功能简述如下
config_init();
config_dinit();
config_parse();
config_read_value();
我的问题是,这些函数会发出不同类型的错误,例如
config_init() emit , FILE_NOT_FOUND,FILE_EOF_ERROR,FILE_OPEN_ERROR, ...
config_dinit() emit , NOT_INIT_ERROR ,
config_parse() emit , PARSE_ERROR, OVERFLOW_ERROR, INVALID_CHARACTER_FOUND_ERROR,...
config_read_value() emit, SECTION_NOT_FOUND,KEYWORD_NOT_FOUND,OVERFLOW_ERROR,NOT_INITIALIZED_ERROR,INVALID_STATE_ERROR,... etc.
Then I create enums for each function, for by using these names ,
enum Config_ParseError{...} , enum Config_InitError{...} ,enum Config_ReadValueError{..}
etc.
一些枚举值相互重叠,也会遇到"编译器错误"。喜欢OVERFLOW错误,
,我愿意接受你的建议
我在谷歌上做了一个快速的研究,发现了最受欢迎的IRC客户端源代码定义了这样的枚举,
enum {
CMDERR_OPTION_UNKNOWN = -3, /* unknown -option */
CMDERR_OPTION_AMBIGUOUS = -2, /* ambiguous -option */
CMDERR_OPTION_ARG_MISSING = -1, /* argument missing for -option */
CMDERR_UNKNOWN, /* unknown command */
CMDERR_AMBIGUOUS, /* ambiguous command */
CMDERR_ERRNO, /* get the error from errno */
CMDERR_NOT_ENOUGH_PARAMS, /* not enough parameters given */
CMDERR_NOT_CONNECTED, /* not connected to server */
CMDERR_NOT_JOINED, /* not joined to any channels in this window */
CMDERR_CHAN_NOT_FOUND, /* channel not found */
CMDERR_CHAN_NOT_SYNCED, /* channel not fully synchronized yet */
CMDERR_ILLEGAL_PROTO, /* requires different chat protocol than the active server */
CMDERR_NOT_GOOD_IDEA, /* not good idea to do, -yes overrides this */
CMDERR_INVALID_TIME, /* invalid time specification */
CMDERR_INVALID_CHARSET, /* invalid charset specification */
CMDERR_EVAL_MAX_RECURSE, /* eval hit recursion limit */
CMDERR_PROGRAM_NOT_FOUND /* program not found */
};
它定义了没有任何名称的enum,这是一个好的风格吗?那为什么呢那个
真的需要一些更好的命名决定。请不要伤害我,我只是开始阅读"编写漂亮的C代码"这本书。
提前感谢。三墩。
我通常喜欢为整个库返回一组错误。这样,在消费者中,他们就不必担心"是X的-1错误输入或无法连接到Y"。
我也是E_
前缀的粉丝,但实际上任何前缀都可以:
enum _config_error
{
E_SUCCESS = 0,
E_INVALID_INPUT = -1,
E_FILE_NOT_FOUND = -2, /* consider some way of returning the OS error too */
....
};
/* type to provide in your API */
typedef enum _config_error error_t;
/* use this to provide a perror style method to help consumers out */
struct _errordesc {
int code;
char *message;
} errordesc[] = {
{ E_SUCCESS, "No error" },
{ E_INVALID_INPUT, "Invalid input" },
{ E_FILE_NOT_FOUND, "File not found" },
....
};
我认为这是一种很好的风格。CMDERR_前缀将相关的错误代码分组在一起(假设它们与某种"命令调用/执行"有关)
由于您的所有示例似乎都与您的配置函数有关,因此我只使用config_前缀(或CFG_)进行一个枚举定义。
enum Config_Errors {
CONFIG_FILE_NOT_FOUND,
CONFIG_FILE_EOF_ERROR,
CONFIG_FILE_OPEN_ERROR,
//etc.
};
公共前缀背后的原因是,当使用枚举类型时,您希望明确该类型的成员都属于同一组。
IRC客户端源代码中的CMDERR_
前缀是一种好的风格,但定义没有任何名称的枚举不是一种好风格。不好,因为你不能说它是枚举类型,只能说它是下面这样的整数类型:
CMDERR function1();
int function1(); // actually returning CMDERR unnamed enum
并且不能使用如下枚举类型定义变量:
CMDERR errResult;
int errResult; // actually errResult is CMDERR unnamed enum