如何将 C/C++ 源代码与我的字符串“交错”（仅在适当位置的函数内部）？

Posted 2023-03-06

【中文标题】如何将 C/C++ 源代码与我的字符串“交错”（仅在适当位置的函数内部）？

【英文标题】：How to "interleave" C/C++ souce with my string (only inside functions at appropriate places)?

【发布时间】：2010-10-21 17:01:00

【问题描述】：

比如有源：

void func1() 
    func3();
    if(qqq) 
         func2();
    
    func4(
    );

应该转化为：

void func1() 
MYMACRO
    func3();
MYMACRO
    if(qqq) 
MYMACRO
         func2();
MYMACRO
    
MYMACRO
    func4(
    );
MYMACRO

即在每行的末尾插入“MYMACRO\n”，其中语句可以是，仅在函数内部。

如何轻松做到？我应该使用正则表达式吗？我应该使用什么工具？

例如，gcc可以在函数内部输出所有语句开始（或结束）的所有行号吗？

@相关 How to tell gcc to instrument the code with calls to my own function each _line_ of code?

@相关 What profiler should I use to measure _real_ time (including waiting for syscalls) spend in this function, not _CPU_ one

【问题讨论】：

你在创造什么样的可恶怪物，为什么？

在原始源文件的每一行的末尾还是在每个逻辑行的末尾（在替换了三元组并拼接了行之后）？ cmets内部呢？你想完成什么？

@JoshD，在相对高级的函数中打印时间戳（仅在一个源文件中）应该几乎不会影响性能。我有时会手动做这样的事情（在很多地方临时插入宏）。我想知道是否有一些汽车的东西。

@Vi：打印到屏幕还是文件？屏幕会很慢。试试这个：做一个循环，在 long long 中将 1 到 10000000 的值相加。然后再次打印每个值。比较运行时间...

@JoshD，值打印在相对较高级别的函数中（这会调用很多较低级别的东西）。像“--gst-debug-level 2”。即使在我们的 6 秒延迟期间屏幕上显示了 100 条消息，它也很有用。

【参考方案1】：

您这样做是为了达到什么目的？根据任务的描述，可能有一种更简单的方法来解决问题。如果您确定这是完成任务的最佳方式，请继续阅读。

---

您必须实现某种基本的 C 语言解析器才能做到这一点。由于您正在处理文本，因此我建议您使用 perl、python 或 ruby​​ 等脚本语言来修改您的文本，而不是编写 C 程序来完成。

您的解析器将一次遍历文件一行，并且对于每一行，它将确定是否需要插入您的宏。解析器需要跟踪许多事情。首先，它需要跟踪它当前是否在评论中。当您遇到/* 序列时，设置一个“in comment”标志并在下次遇到*/ 序列时清除它。无论何时设置该标志，您都不会添加宏调用。此外，您将需要跟踪您是否在函数内。假设您的代码相当简单明了，您可以有一个从零开始的“大括号计数器”，每当遇到 时递增，遇到 时递减。如果您的大括号计数器为零，那么您不在函数内部，您不应该添加宏调用。您还需要添加特殊代码来检测和忽略作为结构定义、数组初始化器等一部分的大括号。请注意，如果您的代码执行更复杂的操作，则简单的大括号计数将不起作用：

void some_function (int arg) 
#ifdef CHECK_LIMIT_ONLY
    if (arg == 0) 
#else
    if (arg < 10) 
#endif
        // some code here
        ...
    

虽然您可能会争辩说 sn-p 只是代码编写不佳的情况，但这只是您可能遇到的问题类型的一个示例。如果你的代码中有一些东西破坏了简单的大括号计数，那么这个问题就会变得更加困难。判断您的代码是否会中断大括号计数的一种方法是，您到达文件末尾时大括号计数是否为非零，或者大括号计数是否在任何时间点变为负数。

一旦您可以确定您何时在函数中而不是在注释中，您需要确定该行是否需要在其后插入宏。您可以从一些简单的规则开始，测试脚本，看看是否有遗漏的情况。对于初学者，任何以分号结尾的行都是语句的结尾，您需要在它之后插入一个宏。与计算大括号类似，当您在函数内部时，您需要计算括号，以便确定您是否在函数调用、循环条件或其他复合语句内部。如果您在其中之一中，您将不添加宏。要跟踪的另一个代码位置是 ... 块的开始行和结束行。如果一行以 或 结尾，您将在其后添加一个宏。

对于像这样的复杂任务，您肯定会想编写一些脚本，在一段相对简单的代码上尝试一下，看看哪里出了问题。进行调整以涵盖您第一次错过的案例并重新测试。当它可以正确解析简单代码时，再给它一些更复杂的东西，看看它的表现如何。

''更新：'' 为了解决一些人表达的关于添加打印命令的额外延迟的担忧，请记住，您不必在每次宏调用时都打印时间戳。相反，让宏调用获取时间戳并将其粘贴到列表中。程序完成后，打印列表中的所有时间戳。这样，您可以将所有与打印相关的延迟保存到测试结束之后。

【讨论】：

为了全面概括，当然，它需要包含三元组。它们在这里可能有意义，例如像"ab??/"cd" 这样的字符串，或者简单地使用??< 和??>，或者??= 来启动预处理器命令。大多数程序不使用三元组，但我不知道 OP 正在处理什么。

事实证明，OP 正在尝试逐行分析代码。顺便说一句，答案很好，+1

我想抽象出语法细节。例如，编译器知道哪些行是语句。它可以告诉它吗？

@Vi：一行可能有多个语句，一个语句可能跨越多行。

@James McNellis，一行中的多个语句应视为一个单元。它应该处理多行语句并且不要破坏它。

【参考方案2】：

重写您的来源，以便以下工作:-)

而不是gcc ... file1.c file2.c ... 做

gcc ... `sed -e's/;/;\nMYMACRO/' file1.c` file1extra.c \
        `sed -e's/;/;\nMYMACRO/' file2.c` file2extra.c \
    ...

【讨论】：

代码struct boo int trick; float treat; ;或for (i = 9; i < 99 ; i++) spank(i);如何工作

它不适用于该代码......这就是首先重写源代码的原因：删除struct定义，for，初始化，......以及其他所有停止“sed技巧”的工作。

我希望它能够在我尚未完全理解但需要修复/破解的大型现有源代码中工作。

【参考方案3】：

这里有一些快速而肮脏的 C# 代码。基本上只是原始文件 IO 的东西。这不是很好，但我确实在大约 3 分钟内完成了它。这段代码暗示功能块用开头的注释行“//FunctionStart”和结尾的注释行“//FunctionEnd”来划分。有更优雅的方法可以做到这一点，这是快速/肮脏/骇人的方法。

使用托管应用来完成这项任务可能有点过头了，但您可以通过简单地添加到此功能来完成很多自定义工作。

        private void InsertMacro(string filePath)
        
            //Declrations:
            StreamReader sr = new StreamReader(filePath);
            StreamWriter sw = new StreamWriter(filePath + ".tmp");
            string line = "";
            bool validBlock = false;

            //Go through source file line by line:
            while ((line = sr.ReadLine()) != null)
            
                if (line == "//FunctionStart")
                    validBlock = true;
                else if (line == "//FunctionEnd")
                    validBlock = false;


                sw.WriteLine(line);

                if (validBlock)
                   sw.WriteLine("MYMACRO");
            

            //Replace legacy source with updated source:
            File.Delete(filePath);
            File.Move(filePath + ".tmp", filePath);

            //Clean up streams:
            sw.Close();
            sr.Close();