c++ - 提高可读性的 C++ 结构，计算结果为非宏

Question

我有以下情况。我们正在编写一个库，它有一个类，其中有很多字段(大部分)取决于一些可选字段，如果可选字段存在与否，这些可选字段具有“标志”(基本上是数字中的位)。

类的字段需要公开以便于访问(我知道这很糟糕)，并且第 3 方开发人员将阅读头文件(除了他们的文档)以熟悉结构和连接各个字段对应的选项。

问题是，客户希望他们的开发人员能够轻松地识别哪些字段取决于哪个可选结构，并尽可能少地付出努力。

其中一个解决方案是在字段(类成员)名称上方或之后添加注释，告诉它使用此选项字段。这是基本的选择。

但是这个类已经有大约 500 个成员(字段)，所以我不知道如果添加额外的 500 行，或者长注释会增加它的质量。

我们提出了以下结构:

#define DEPENDS
#define ON
#define BIT(x) ((x)-1)
#define OF(x)

struct source{};

struct options 
{
    options(const source&) {}
};

template <int BITIDX>
struct optional
{
    optional(const options&) {}
};

struct something
{
    // this constructor will be implemented in the CPP
    // so the user  (developer) will not see it
    something (const source& src) :
      msource(src), initial_options(src), other_options(src), 
      field1(initial_options), field2(other_options) {}

    options initial_options;
    options other_options;

    optional<DEPENDS ON BIT(1) OF (initial_options)>   field1;
    optional<DEPENDS ON BIT(1) OF (other_options)  >   field2;

    source msource;
};

int main()
{
    source s;
    something a(s);
}

但显然由于 namespace 污染、宏等原因，这并没有好多少......

那么，问题是:是否有更好的方法来实现我们的目标，即提供一种有意义的方式来从一个选项中呈现一个字段的连接？

(请注意，不允许允许 C++11 类成员初始化，否则我不会问这个问题:)我们必须坚持使用旧的编译器:( )

Answer 1

struct something
{
    enum OptionGroup { Initial, Other /*...*/ };
    enum InitialFields { A, B /*...*/ };
    enum OtherFields { X, Y /*...*/ };

因此，我们枚举了每个可选组中的字段 A、B 等。由于它们是从零开始递增的，因此枚举值将告诉我们哪个位代表每个字段。

    template <typename TYPE, OptionGroup GROUP, int BIT>
    struct Optional {
        TYPE val;
        operator TYPE& () { return val; }
        operator TYPE const& () const { return val; }
    };

这记录了一个可选字段的组，以及该组中的哪个位代表它。您没有说您的字段类型是什么，所以我将其设为通用。您也没有说明如何初始化它们，因此它可能需要构造函数等。

    int mandatory1;
    int initialOptions;
    Optional<int, Initial, A> a;
    Optional<int, Initial, B> b;
    int otherOptions;
    Optional<double, Other, X> x;

这里我们实际存储了一系列必填字段和可选字段。

现在，我们需要一些方法来获取每个组的标志:

    template <OptionGroup GROUP> int getGroupFlags();

有了它，我们可以检查给定的字段是否有效......

    template <typename TYPE, OptionGroup GROUP, int BIT>
    bool isValid(Optional<TYPE,GROUP,BIT> const &field) {
        return getGroupFlags<GROUP>() & (1 << BIT);
    }
};

遗憾的是，记录枚举和组之间的关联仍然是手动的(这是能够将两组选项标志合并到一个位字段中的地方，这会让生活更轻松)

template <> int something::getGroupFlags<something::Initial>() { return intialOptions; }
template <> int something::getGroupFlags<something::Other>() { return otherOptions; }

这可以大大清理(例如，通过将每个可选组绑定(bind)到单个结构而不是硬编码讨厌的 OptionGroup->flag 字段关系)，但这似乎是最少的工作。