使用宏计算源文件行数？

Question

是否可以使用 C/C++ 预处理器将源文件中的行数计入宏或某种编译时可用值？例如。我可以在下面替换MAGIC1、MAGIC2和MAGIC3，并在使用MAGIC3时以某种方式获得值4吗？

MAGIC1 // can be placed wherever you like before the relevant 
       // lines - either right before them, or in global scope etc.
foo(); MAGIC2
bar(); MAGIC2
baz(); MAGIC2
quux(); MAGIC2
// ... possibly a bunch of code here; not guaranteed to be in same scope ...
MAGIC3

注意事项：

• 编译器特定的预处理器功能扩展是可以接受的，但不可取。
• 如果这仅在某些 C++ 的帮助下才可能实现，而不是 C 构造，那也是可以接受但不可取的（即我想要一些适用于 C 的东西）。
• 显然这可以通过一些外部处理器脚本运行源文件来完成，但这不是我要问的。

Answer 1

有一个__LINE__ 预处理器宏，它为您提供了一个整数，用于出现在上面的行。您可以在某行取其值，然后在后面的某行取值，然后进行比较。

static const int BEFORE = __LINE__;
foo();
bar();
baz();
quux();
static const int AFTER = __LINE__;
static const int COUNT = AFTER - BEFORE - 1; // 4

如果您想计算某些内容的出现次数而不是源代码行，__COUNTER__ 可能是一个非标准选项，由 一些 编译器（如 GCC 和 MSVC）支持。

#define MAGIC2_2(c)
#define MAGIC2(c) MAGIC2_2(c)
static const int BEFORE = __COUNTER__;
void foo(); MAGIC2(__COUNTER__);
void bar(
    int multiple,
    float lines); MAGIC2(__COUNTER__);
void baz(); MAGIC2(__COUNTER__);
void quux(); MAGIC2(__COUNTER__);
static const int AFTER = __COUNTER__;
static const int COUNT = AFTER - BEFORE - 1; // 4

我取了__COUNTER__ 的初始值，因为它可能以前在源文件中使用过，或者某些包含的头文件。

在 C 而不是 C++ 中，对常量变量有限制，因此可以使用 enum。

enum MyEnum
{
    FOO = COUNT // C: error: enumerator value for ‘FOO’ is not an integer constant
};

将 const 替换为 enum:

enum {BEFORE = __LINE__};
foo();
bar();
baz();
quux();
enum { COUNT = __LINE__ - BEFORE - 1};
enum MyEnum
{
    FOO = COUNT // OK
};

Answer 2

我知道 OP 的要求是使用宏，但我想添加另一种不涉及使用宏的方法。

C++20 引入了source_location 类，它表示有关源代码的某些信息，例如文件名、行号和函数名。在这种情况下，我们可以很容易地使用它。

#include <iostream>
#include <source_location>

static constexpr auto line_number_start = std::source_location::current().line();
void foo();
void bar();
static constexpr auto line_number_end = std::source_location::current().line();

int main() {
    std::cout << line_number_end - line_number_start - 1 << std::endl; // 2

    return 0;
}

还有活生生的例子here。

Answer 3

为了完整性：如果您愿意在每行后添加MAGIC2，可以使用__COUNTER__：

#define MAGIC2 static_assert(__COUNTER__ + 1, "");

/* some */     MAGIC2
void source(); MAGIC2
void lines();  MAGIC2

constexpr int numberOfLines = __COUNTER__;

int main()
{
    return numberOfLines;
}

https://godbolt.org/z/i8fDLx（返回3）

您可以通过存储__COUNTER__ 的开始值和结束值来使其可重用。

总的来说，这确实很麻烦。您也无法计算包含预处理器指令或以// cmets 结尾的行。我会改用__LINE__，请参阅其他答案。

Answer 4

一种更强大的解决方案，允许使用不同的计数器（只要它们不混合，并且在其他任务中没有使用 __COUNTER__）：

#define CONCATENATE(s1, s2) s1##s2
#define EXPAND_THEN_CONCATENATE(s1, s2) CONCATENATE(s1, s2)

#define COUNT_THIS_LINE static_assert(__COUNTER__ + 1, "");
#define START_COUNTING_LINES(count_name) \
  enum { EXPAND_THEN_CONCATENATE(count_name, _start) = __COUNTER__ };
#define FINISH_COUNTING_LINES(count_name) \
  enum { count_name = __COUNTER__ - EXPAND_THEN_CONCATENATE(count_name, _start) - 1 };

这隐藏了实现细节（尽管它隐藏在宏中......）。这是@MaxLanghof 答案的概括。请注意，当我们开始计数时，__COUNTER__ 可能有一个非零值。

它的使用方法如下：

START_COUNTING_LINES(ze_count)

int hello(int x) {
    x++;
    /* some */     COUNT_THIS_LINE
    void source(); COUNT_THIS_LINE
    void lines();  COUNT_THIS_LINE
    return x;
}

FINISH_COUNTING_LINES(ze_count)

int main()
{
    return ze_count;
}

此外，这是有效的 C - 如果您的预处理器支持 __COUNTER__，那就是。

Works on GodBolt.

如果您使用 C++，您可以修改此解决方案，甚至不污染全局命名空间 - 通过将计数器放置在 namespace macro_based_line_counts { ... } 或 namespace detail 等中）

Answer 5

根据您的评论，如果您想在 C 或 C++ 中指定（编译时）数组大小，您可以这样做

int array[]; //incomplete type
enum{ LINE0 = __LINE__ }; //enum constants are integer constant expressions
/*lines to be counted; may use array (though not sizeof(array)) */
/*...*/
int array[ __LINE__ - LINE0 ]; //complete the definition of int array[]

如果您在中间行中需要sizeof(array)，您可以将其替换为静态变量引用（除非它绝对需要是整数常量表达式）并且优化编译器应该同样对待它（消除对存放在内存中的静态变量）

int array[]; static int count;
enum{ LINE0 = __LINE__ }; //enum constants are integer constant expressions
//... possibly use count here
enum { LINEDIFF = __LINE__ - LINE0 }; 
int array[ LINEDIFF ]; /*complete the definition of int array[]*/ 
static int count = LINEDIFF; //fill the count in later

基于__COUNTER__ 的解决方案（如果该扩展可用）与基于__LINE__ 的解决方案的工作方式相同。

C++ 中的constexprs 应该和enum 一样工作，但enum 也可以在普通 C 中工作（我上面的解决方案是普通 C 解决方案）。