c++ - 使用多个 .cpp 文件替代 c++ 中的条件编译

Question

假设我有一个使用条件编译的 C++ 类:

C.hpp

namespace NS{
  class C {
    public:
      C(void);
      ~C(void);
      int func( int arg1 );
    private:
      int memberVar;
}

C.cpp:

#include "C.hpp"

namespace NS{
  C::C( void ){ memberVar = 0; }
  C::~C( void ) {}
  int C::func( int arg1 ){
    int retval = 0;
    memberVar = arg1;
#ifdef DEV_BUILD
    retval = memberVar;
    printf( "memberVar was set.\n" );
#endif
    return retval;
  }
}

(这是一个简化的例子；假设 C 类有几百行长，其中一些函数使用条件编译，每个函数使用相同的条件:#ifdef DEV_BUILD。应用程序是一个嵌入式系统应用程序，条件用于区分测试硬件和生产硬件，它们有一些区别)

有人建议我改为在单独的 .cpp 文件中实现函数...但我对最好的方法有点犹豫。

我的第一 react 是创建 C_dev.cpp 和 C_prod.cpp，分别以不同方式实现 C::func()，然后编辑 C.cpp:

#include "C.hpp"
#ifdef DEV_BUILD
#include "C_dev.cpp"
#else
#include "C_prod.cpp"
#endif

namespace NS{
  C::C( void ){ memberVar = 0; }
  C::~C( void ) {}
}

...但这是糟糕的风格吗？或者有其他问题？

附加限制:

• 不能使用子类。
• 不能使用模板类。

(更新:建议使用单独的文件，但不是必需的。我愿意接受其他建议)

Answer 1

要点 1:如果您有数百个小改动散落在一片原本相同的代码的海洋中，请选择条件编译。它通常更容易阅读和维护。

但是如果您在功能级别上分解差异，则可以将不同的功能拆分到不同的实现文件中。通常我使用操作系统包装器来执行此操作，并且在 Linux 和 Windows 上获取目录列表等方面的差异非常粗粒度。 (注意:此示例已被 C++17 废弃)

要点 2:不要制作多个标题。这只会使问题复杂化。您想要公开两个实现之间的公共(public)接口(interface)。如果做不到，那么您已经迷路了，需要另辟蹊径。制作一个适合所有实现的通用 header 。

对于这个答案，所有实现都使用 Asker 的原始 header C.hpp:

namespace NS{
  class C {
    public:
      C(void);
      ~C(void);
      int func( int arg1 );
    private:
      int memberVar;
}

我将 Asker 的示例分成三个 cpp 文件:一个具有跨所有构建的通用功能，两个实现包含差异的功能。这样您就不会重复任何您绝对不需要重复的功能。

C_common.cpp 所有共享功能都在这里

#include "C.hpp"

namespace NS{
  C::C( void ){ memberVar = 0; }
  C::~C( void ) {}
}

C_debug.cpp:带调试语句的函数放在这里

#include "C.hpp"

namespace NS{
  int C::func( int arg1 ){
    int retval = 0;
    memberVar = arg1;
    retval = memberVar;
    printf( "memberVar was set.\n" );
    return retval;
  }
}

C_no_debug.cpp:这里没有调试语句的函数

#include "C.hpp"

namespace NS{
  int C::func( int arg1 ){
    memberVar = arg1;
    return memberVar;
  }
}

当您链接程序时，您总是链接C_common 并指定链接C_debug 和C_no_debug 中的哪一个。

有时您可以更进一步，分解复杂的函数并仅隔离差异，并为差异提供一个从共享函数中调用的函数。

C_common.cpp

#include "C.hpp"

namespace NS{
  C::C( void ){ memberVar = 0; }
  C::~C( void ) {}
  int C::func( int arg1 ){
    memberVar = arg1;
    debugstuff(); // calls the different functionality
    return memberVar;
  }
}

C_debug.cpp:

#include "C.hpp"

namespace NS{
    void debugstuff()
    {
        printf( "memberVar was set.\n" );
    }
}

C_no_debug.cpp:

#include "C.hpp"

namespace NS{
    void debugstuff()
    {
    }
}

这往往很难扩展，因为您可能会得到许多一个线性函数。请参见上面的第 1 点。但是，如果差异的形状恰到好处，您可以利用传递函数参数来减少垃圾邮件。在这种情况下，合乎逻辑的做法是传入调试字符串。一个打印，另一个丢弃。

C_common.cpp

#include "C.hpp"

namespace NS{
  C::C( void ){ memberVar = 0; }
  C::~C( void ) {}
  int C::func( int arg1 ){
    memberVar = arg1;
    debugstuff("memberVar was set.\n"); // calls the different functionality
                                        // and tells it what to do!
    return memberVar;
  }
}

C_debug.cpp:

#include "C.hpp"

namespace NS{
    void debugstuff(const char * message)
    {
        printf( message );
    }
}

C_no_debug.cpp:

#include "C.hpp"

namespace NS{
    void debugstuff(const char * )
    {
    }
}