使用宏计算源文件行?

Count source file lines using macros?

本文关键字：源文件 计算      更新时间：2023-10-16

是否可以使用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 的东西(。
  • 显然，这可以通过一些外部处理器脚本运行源文件来完成，但这不是我要问的。

有一个__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
};

将常量替换为enum：

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

我知道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;
}

在这里活生生的例子。

为了完整起见：如果您愿意在每行后添加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__的开始值和结束值来使其可重用。

总的来说，这真的很麻烦。您也无法计算包含预处理器指令或以//注释结尾的行。我会改用__LINE__，请参阅另一个答案。

一个更强大的解决方案，允许不同的计数器(只要它们不混合，并且没有将__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__，也就是说。

在GodBolt上工作。

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

根据您的注释，如果要在 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__的解决方案将正常工作。

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

相关文章：