如何从源文件中提取单个函数

Question

我正在开展一项关于Linux 内核中极其长且复杂的函数。 我试图弄清楚是否有充分的理由编写 600 或 800 行长的函数。

为此，我想找到一个可以从 .c 文件中提取函数的工具，这样我就可以对该函数运行一些自动化测试。

例如，如果我有函数 cifs_parse_mount_options () 文件 connect.c 中，我正在寻找一个大致工作原理如下的解决方案：

extract /fs/cifs/connect.c cifs_parse_mount_options

并返回该函数的 523 行代码（！），从左大括号到右大括号。

当然，任何操作现有软件包的方法，例如 gcc 来做到这一点，也会很有帮助的。

谢谢，

乌迪

编辑：正则表达式的答案提取 C 函数原型声明？ 让我相信，通过正则表达式匹配函数声明绝非易事。

Answer 1

我有类似的需求，要从 C 代码中提取一个函数，我发现 vim （编辑器）适合我的需求（而且更容易一些），因为我不必编写任何外部工具或依赖不可靠的正则表达式，这可能会变得乏味。

测试代码：

$ cat -n c.c
   1 #include <stdio.h>
   2 static int
   3 testme (void)
   4 {
   5     int i=1;
   6 
   7     if (i == 1) {
   8           printf("\nDo something\n");
   9     }
  10     return 0;
  11 }
  12 
  13 int main (int argc, char *argv[])
  14 {
  15     testme();
  16     return 0;
  17 } 

在非交互式 (ex) 模式下使用 vim 和 -es：

步骤 1 - 转到函数的开头vim 搜索（假设函数名称位于行的开头，后跟一个空格 - +/ 并打印行号 - ! echo line(".")

.2 - 移动到行首的下一个右大括号 - +/} 并打印行号

步骤 3 - 退出文件 - +q

步骤 4 - 现在我们有了 start-line# 和 end-line# - 我们将以 ,p 的形式将其通过管道传输到 sed（在之前需要使用 paste 进行一些操作）调用 sed) 转储整个函数

：

$ vim -es c.c +/'testme ' +'exec(":!echo ".line("."))'  +'/^}'  +'exec(":!echo ".line("."))'  +q | paste -sd "," - | xargs -i{} sed -n {}p c.c
testme (void)
{
    int i=1;

    if (i == 1) {
          printf("\nDo something\n");
    }
    return 0;
}

Answer 2

您应该使用 clang 之类的东西，它实际上会解析您的源代码并允许您分析它。 因此它可以找到多种语言的函数，甚至考虑宏。 您没有机会使用正则表达式。

Answer 3

Bash 内置的 declare 似乎提供了类似的功能，但我不确定它是如何实现的。 特别是，declare -f列出了当前环境中的函数：

declare -f quote
declare -f quote_readline

declare输出当前环境中的函数列表：

quote () 
{ 
    local quoted=${1//\'/\'\\\'\'};
    printf "'%s'" "$quoted"
}
quote_readline () 
{ 
    local ret;
    _quote_readline_by_ref "$1" ret;
    printf %s "$ret"
}

最后，declare -f quote 输出 quote 函数的函数定义。

quote () 
{ 
    local quoted=${1//\'/\'\\\'\'};
    printf "'%s'" "$quoted"
}

也许可以重新调整底层机器的用途来满足您的需求。

Answer 4

如果您发现很难提取函数名称：

1> 使用 ctags（一个程序）提取函数名称。
ctags -x --c-kinds=fp 文件路径。
2> 一旦获得函数名称，就编写一个简单的 Perl 脚本，通过传递函数的脚本名称来提取函数的内容，如上所述。

Answer 5

indent -kr code -o code.out

awk -f split.awk code.out

您必须稍微适应 split.awk ，它在某种程度上特定于我的代码和重构需求（例如 y 有这样的结构，它们不是 typedefs

并且我相信你可以制作一个更好的脚本:-)

--
BEGIN   { line=0; FS="";
    out=ARGV[ARGC-1]  ".out";
    var=ARGV[ARGC-1]  ".var";
    ext=ARGV[ARGC-1]  ".ext";
    def=ARGV[ARGC-1]  ".def";
    inc=ARGV[ARGC-1]  ".inc";
    typ=ARGV[ARGC-1]  ".typ";
    system ( rm " " -f " " out " " var " " ext " " def " " inc " " typ );
    }
/^[     ]*\/\/.*/   { print "comment :" $0 "\n"; print $0 >> out ; next ;}
/^#define.*/        { print "define :" $0 ; print $0 >>def ; next;}
/^#include.*/       { print "define :" $0 ; print $0 >>inc ; next;}
/^typedef.*{$/      { print "typedef var :" $0 "\n"; decl="typedef";print $0 >> typ;infile="typ";next;}
/^extern.*$/        { print "extern :" $0 "\n"; print $0 >> ext;infile="ext";next;}
/^[^    }].*{$/     { print "init var :" $0 "\n";decl="var";print $0 >> var; infile="vars";
                print $0;
                fout=gensub("^([^    \\*])*[    ]*([a-zA-A0-9_]*)\\[.*","\\2","g") ".vars";
                     print "var decl : " $0 "in file " fout;
                     print $0 >fout;
                next;
                        }
/^[^    }].*)$/     { print "func  :" $0 "\n";decl="func"; infile="func";
                print $0;
                fout=gensub("^.*[    \\*]([a-zA-A0-9_]*)[   ]*\\(.*","\\1","g") ".func";
                     print "function : " $0 "in file " fout;
                     print $0 >fout;
                next;
            }
/^}[    ]*$/        { print "end of " decl ":" $0 "\n"; 
                if(infile=="typ") {
                    print $0 >> typ;
                }else if (infile=="ext"){
                    print $0 >> ext;
                }else if (infile=="var") {
                    print $0 >> var;
                }else if ((infile=="func")||(infile=="vars")) {
                    print $0 >> fout; 
                    fflush (fout);
                    close (fout);
                }else if (infile=="def") {
                    print $0 >> def;
                }else if (infile=="inc"){
                    print $0 >> inc;
                }else print $0 >> out;
                next;
            }
/^[a-zA-Z_]/        { print "extern :" $0 "\n"; print $0 >> var;infile="var";next;}
            { print "other :" $0 "\n" ; 
                if(infile=="typ") {
                    print $0 >> typ;
                }else if (infile=="ext"){
                    print $0 >> ext;
                }else if (infile=="var") {
                    print $0 >> var;
                }else if ((infile=="func")||(infile=="vars")){
                    print $0 >> fout;
                }else if (infile=="def") {
                    print $0 >> def;
                }else if (infile=="inc"){
                    print $0 >> inc;
                }else print $0 >> out;
               next;
               }

Answer 6

为什么不编写一个小型 PERL/PHP/Python 脚本，甚至一个小型 C++、Java 或 C# 程序来执行此操作？

我不知道有任何现成的工具可以做到这一点，但编写代码来解析文本文件并从 C++ 代码文件中提取函数体不应超过 20 行代码。唯一的 困难的部分是定位函数的开头，使用 RegEx 这应该是一个相对简单的任务。 之后，您所需要做的就是迭代文件的其余部分，跟踪左大括号和右大括号，当您到达函数体右大括号时，您就完成了。