有没有办法实现在重命名头文件时不必修改的头文件?

时间:2016-12-28 16:15:47

标签: c c-preprocessor header-files

目前,对于名为 test_header.h 的头文件,我使用 -

#ifndef TEST_HEADER_H
#define TEST_HEADER_H   
/* code */
#endif /* TEST_HEADER_H */

我想要的是一个不直接使用文件名的页眉。像(,如果如此粗略的假设解决方案) -

#if __FILE__ not in INCLUDE_LIST
#APPEND(INCLUDE_LIST, __FILE__)
/* code */
#endif

3 个答案:

答案 0 :(得分:4)

您可以随意命名标题保护。

  • 如果您的标题与某个主题相关,请在此之后命名,即LIST_OPERATIONS
  • 省略警卫并编写一个脚本,根据当前文件名插入它们。在编译之前,将此脚本作为构建过程的一部分运行。 (请记住要么在构建之后创建修改后的副本,要么删除包含,否则最终会在标题中包含很多包含警示)
  • 根据应该用于项目的编译器,他们可能支持#pragma once方法。

答案 1 :(得分:3)

#pragma once

它非常便携,得到了所有主要编译器以及14个编译器中的13个(according to Wikipedia)的良好支持。

另请查看#pragma once vs include guards?

答案 2 :(得分:2)

正如其他人所指出的那样,你用作头球后卫的内在并不重要;它只需要在可能共同包含的标题集中是唯一的。

您可以创建UUID或GUID并将其用作标头保护(或某种类型的哈希 - MD5,SHA1,SHA2,SHA3,...)。唯一的诀窍是处理领先数字的可能性;这很容易解决(我使用H_作为前缀)。

大多数情况下,我使用的是基于文件名的名称,并且通常不会经常重命名标题,这是一个问题。

这是一个名为hdrguard的脚本,用于为给定的头文件生成标题保护行:

#!/bin/sh
#
# @(#)$Id: hdrguard.sh,v 1.8 2016/05/09 18:41:57 jleffler Exp $
#
# Generate #ifndef sequence to guard header against multiple inclusion

arg0=$(basename $0 .sh)

usestr="Usage: $arg0 [-bdfhimV] header.h [...]"

usage()
{
    echo "$usestr" 1>&2
    exit 1
}

help()
{
    echo "$usestr"
    echo
    echo "  -b  Use base name of file for guard"
    echo "  -d  Use _DOT_H after name (instead of _H)"
    echo "  -f  Use specified path name of file for guard (default)"
    echo "  -h  Print this help message and exit"
    echo "  -i  Omit _INCLUDED after name"
    echo "  -m  Generate MD5 hash value as header guard"
    echo "  -V  Print version information and exit"
    exit 0
}

opt_incl=yes
opt_base=no
opt_dot=no
opt_md5=no
while getopts bdfhimV opt
do
    case "$opt" in
    (b) opt_base=yes;;
    (d) opt_dot=yes;;
    (f) opt_base=no;;
    (h) help;;
    (i) opt_incl=no;;
    (m) opt_md5=yes;;
    (V) echo "$arg0: HDRGUARD Version "'$Revision: 1.8 $ ($Date: 2016/05/09 18:41:57 $)' | rcsmunger; exit 0;;
    (*) usage;;
    esac
done

shift $(($OPTIND - 1))

[ $# -eq 0 ] && usage

for i in "$@"
do
    if [ $opt_base = yes ]
    then i=$(basename $i)
    fi
    if [ $opt_dot = yes ]
    then i=$(echo "$i" | sed 's/\.h$/_dot_h/')
    fi
    i=$(echo $i | tr 'a-z' 'A-Z' | tr -s '/+.-' '____' | sed 's/^_//')
    if [ $opt_incl = yes ]
    then
        case "$i" in
        (*_INCLUDED)
            : OK;;
        (*)
            i="${i}_INCLUDED";;
        esac
    fi
    if [ $opt_md5 = yes ]
    then
        tmp=$(mktemp ./hdrgrd.XXXXXXXX)
        trap "rm -f $tmp; exit 1" 0 1 2 3 13 15 
        echo "$i.$(isodate compact)" > "$tmp"
        i=$(md5 "$tmp" | sed 'y/abcdef/ABCDEF/; s/\([^ ]*\) .*/H_\1/')
        rm -f "$tmp"
        trap 0 1 2 3 13 15
    fi
    echo
    echo "#ifndef $i"
    echo "#define $i"
    echo
    echo "#endif /* $i */"
    echo
done

它没有SHA1,SHA2或SHA3的代码 - 它可选地使用MD5(以命令md5的形式)。添加对替代哈希算法的支持并不是很难。它不需要文件存在。

示例用途:

$ hdrguard header.h

#ifndef HEADER_H_INCLUDED
#define HEADER_H_INCLUDED

#endif /* HEADER_H_INCLUDED */

$ hdrguard -m header.h

#ifndef H_6DC5070597F88701EB6D2CCAACC73383
#define H_6DC5070597F88701EB6D2CCAACC73383

#endif /* H_6DC5070597F88701EB6D2CCAACC73383 */

$

我经常在vim内使用它,在光标位于空行时输入!!hdrguard %等命令,以生成适合标题编辑的标题保护。这也是它产生顶部和底部空白行的原因。

该命令使用脚本isodatercsmunger。使用参数compactisodate命令等同于:

date +'%Y%m%d.%H%M%S'

complete命令支持许多替代格式,并且比在任何地方输入date命令更简洁。您完全可以放弃使用单独的脚本并将展开的内容嵌入到hdrguard中。实际上,你可以只用date就可以了;它只是散列操作的种子材料,使数据被散列为唯一。

$ isodate compact
20161228.185232
$

rcsmunger命令只是将RCS ID字符串转换为我更喜欢报告版本信息的格式:

#!/usr/bin/env perl -p
#
# @(#)$Id: rcsmunger.pl,v 1.9 2015/11/02 23:54:32 jleffler Exp $
#
# Remove the keywords around the values of RCS keywords

use strict;
use warnings;

# Beware of RCS hacking at RCS keywords!
# Convert date field to ISO 8601 (ISO 9075) notation
s%\$(Date:) (\d\d\d\d)/(\d\d)/(\d\d) (\d\d:\d\d:\d\d) \$%\$$1 $2-$3-$4 $5 \$%go;
# Remove keywords
s/\$([A-Z][a-z]+|RCSfile): ([^\$]+) \$/$2/go;

例如:

$ hdrguard -V
hdrguard: HDRGUARD Version 1.8 (2016-05-09 18:41:57)
$

您可以将版本信息的打印视为老式版本控件;如果您使用git之类的DVCS,则必须采用不同的方式,这是我没有批量迁移到git进行个人软件收集的原因之一。