Question

我想删除toy.c文件中的所有注释。从Remove comments from C/C++ code中我可以使用

gcc -E -fpreprocessed -P -dD toy.c

但是我的一些代码（例如我不想编译的不推荐使用的函数）已被封装在between #if 0 and endif, as if they were commented out中。

一方面，上述命令不会删除这种“注释”，因为只有在-fpreprocessed阻止的宏扩展期间才可以删除它。
另一方面，我还有其他不想扩展的宏，因此删除-fpreprocessed是一个坏主意。

我在这里遇到了两难选择。有没有办法解决这种情况？谢谢。

以下玩具示例“ toy.c”足以说明问题。

#define foo 3  /* this is a macro */

// a toy function
int main (void) {
  return foo;
  }

// this is deprecated
#if 0
int main (void) {
  printf("%d\n", foo);
  return 0;
  }
#endif

gcc -E -fpreprocessed -P -dD toy.c给出

#define foo 3
int main (void) {
  return foo;
  }
#if 0
int main (void) {
  printf("%d\n", foo);
  return 0;
  }
#endif

gcc -E -P toy.c给出

int main (void) {
  return 3;
  }

Answer 1

有一对程序，sunifdef（“ unifdef的儿子，可从unifdef获得）和coan，它们可以用来做您要做的事情想。问题Is there a C pre-processor which eliminates #ifdef blocks based on values defined/undefined?的答案将讨论这些程序。

例如，给定“ xyz37.c”：

#define foo 3  /* this is a macro */

// a toy function
int main (void) {
  return foo;
  }

// this is deprecated
#if 0
int main (void) {
  printf("%d\n", foo);
  }
#endif

使用sunifdef

sunifdef -DDEFINED -ned < xyz37.c

给予

#define foo 3  /* this is a macro */

// a toy function
int main (void) {
  return foo;
  }

// this is deprecated

并给出此文件“ xyz23.c”：

#if 0
This is deleted
#else
This is not deleted
#endif

#if 0
Deleted
#endif

#if defined(XYZ)
XYZ is defined
#else
XYZ is not defined
#endif

#if 1
This is persistent
#else
This is inconsistent
#endif

程序

sunifdef -DDEFINE -ned < xyz23.c

给予

This is not deleted

#if defined(XYZ)
XYZ is defined
#else
XYZ is not defined
#endif

This is persistent

我想这就是你所追求的。 -DDEFINED选项似乎是必需的；选择您在代码中不使用的任何名称。如果愿意，可以改用-UNEVER_DEFINE_THIS。 -ned选项评估常数项并消除相关代码。没有它，诸如0和1之类的常数项就不会消除。

我已经愉快地使用sunifdef多年了（侵犯了十年）。我还没有发现它是一个错误，并且我已经使用它来清理了一些令人反感的“ ifdeffery”集。程序coan是对sunifdef的开发，具有更多功能。

Answer 2

预处理器不产生异常。您不能在这里使用它。

使用python的简单状态机可以工作。它甚至可以处理嵌套（嗯，也许不是像嵌套#if 0一样覆盖所有情况，但是您可以在前后比较源并手动验证）。还不支持注释的代码（但似乎您已经覆盖了它）

输入（比演示中的输入略复杂）：

#define foo 3
int main (void) {
  return foo;
  }
#if 0
int main (void) {
  #ifdef DDD
  printf("%d\n", foo);
  #endif
  }
#endif

void other_function()
{}

现在是代码，使用正则表达式检测#if和#endif。

import re
rif0 = re.compile("\s*#if\s+0")
rif = re.compile("\s*#(if|ifn?def)")
endif = re.compile("\s*#endif")

if_nesting = 0
if0_nesting = 0
suppress = False

with open("input.c") as fin, open("output.c","w") as fout:
    for l in fin:
        if rif.match(l):
            if_nesting += 1
            if rif0.match(l):
                suppress = True
                if0_nesting = if_nesting
        elif endif.match(l):
            if if0_nesting == if_nesting:
                suppress = False
            if_nesting -= 1
            continue  # don't write the #endif

        if not suppress:
            fout.write(l))

输出文件包含：

#define foo 3
int main (void) {
  return foo;
  }

void other_function()
{}

因此嵌套起作用，并且#if 0部分已成功删除。 sed "/#if 0/,/#endif/d无法达到的目标。

Answer 3

感谢其他两个答案。

我现在知道unifdef和sunifdef。我很高兴知道这些工具的存在，而且我不是唯一想进行这种代码清理的人。

我还写了一个“ rm_if0_endif.c” （如下所示）来删除对我来说足够的#if 0 ... #endif块。它的哲学基于文本处理。它扫描输入的C脚本，找到#if 0和正确的包围endif，以便在逐字符复制期间可以省略此块。

文本处理方法是有限的，因为它仅针对#if 0 ... #endif情况而设计，但是我现在只需要这种方法。 C程序不是这种文本处理的唯一方法。 Jean-François Fabre's answer演示了如何在Python中进行操作。我也可以使用readLines，startsWith和writeLines在R中做类似的事情。因为我还不是C的专家，所以我选择在C中进行此工作，因此该任务促使我学习。这是我的“ rm_if0_endif.c” 的演示。请注意，该程序可以连接多个C文件，并为每个文件添加标题。

原始输入文件“ input.c”

#define foo 3  /* this is a macro */

// a toy function
int test1 (void) {
  return foo;
  }

#if 0

#undef foo
#define foo 4

#ifdef bar
  #warning "??"
#endif

// this is deprecated
int main (void) {
  printf("%d\n", foo);
  return 0;
  }

#endif

// another toy
int test2 (void) {
  return foo;
  }

gcc预处理输出“ gcc_output.c”（作为我的程序的输入）

gcc -E -fpreprocessed -P -dD input.c > gcc_output.c

#define foo 3
int test1 (void) {
  return foo;
  }
#if 0
#undef foo
#define foo 4
#ifdef bar
  #warning "??"
#endif
int main (void) {
  printf("%d\n", foo);
  return 0;
  }
#endif
int test2 (void) {
  return foo;
  }

程序中的最终输出“ final_output.c”

“ rm_if0_endif.c”具有实用程序功能pattern_matching和主力功能rm_if0_endif：

void rm_if0_endif (char *InputFile,
                   char *OutputFile, char *WriteMode, char *OutputHeader);

下面的附件文件具有main功能，

rm_if0_endif("gcc_output.c",
             "final_output.c", "w", "// this is a demo of 'rm_if0_endif.c'\n");

它产生：

// this is a demo of 'rm_if0_endif.c'
#define foo 3
int test1 (void) {
  return foo;
  }

int test2 (void) {
  return foo;
  }

附录：“ rm_if0_endif.c”

#include <stdio.h>
int pattern_matching (FILE *fp, const char *pattern, int length_pattern) {
  int flag = 1;
  int i, c;
  for (i = 0; i < length_pattern; i++) {
    c = fgetc(fp);
    if (c != pattern[i]) {
      flag = 0; break;
      }
    }
  return flag;
  }
void rm_if0_endif (char *InputFile,
                   char *OutputFile, char *WriteMode, char *OutputHeader) {
  FILE *fp_r = fopen(InputFile, "r");
  FILE *fp_w = fopen(OutputFile, WriteMode);
  fpos_t pos;
  if (fp_r == NULL) perror("error when opening input file!");
  fputs(OutputHeader, fp_w);
  int c, i, a1, a2;
  int if_0_flag, if_flag, endif_flag, EOF_flag;
  const char *if_0 = "if 0";
  const char *endif = "endif";
  EOF_flag = 0;
  while (EOF_flag == 0) {
    do {
      c = fgetc(fp_r);
      while ((c != '#') && (c != EOF)) {
        fputc(c, fp_w);
        c = fgetc(fp_r);
        }
      if (c == EOF) {
        EOF_flag = 1; break;
        }
      fgetpos(fp_r, &pos);
      if_0_flag = pattern_matching(fp_r, if_0, 4);
      fsetpos(fp_r, &pos);
      if (if_0_flag == 0) fputc('#', fp_w);
      } while (if_0_flag == 0);
    if (EOF_flag == 1) break;
    a1 = 1; a2 = 0;
    do {
      c = fgetc(fp_r);
      while (c != '#') c = fgetc(fp_r);
      fgetpos(fp_r, &pos);
      if_flag = pattern_matching(fp_r, if_0, 2);
      fsetpos(fp_r, &pos);
      if (if_flag == 1) a1++;
      fgetpos(fp_r, &pos);
      endif_flag = pattern_matching(fp_r, endif, 5);
      fsetpos(fp_r, &pos);
      if (endif_flag == 1) a2++;
      } while (a1 != a2);
    for (i = 0; i < 5; i++) c = fgetc(fp_r);
    if (c == EOF) {
      EOF_flag == 1;
      }
    }
  fclose(fp_r);
  fclose(fp_w);
  }
int main (void) {
  rm_if0_endif("gcc_output.c",
               "final_output.c", "w", "// this is a demo of 'rm_if0_endif.c'\n");
  return 0;
  }

将C文件导出到新文件时，删除#if 0和#endif之间的代码

3 个答案: