有没有一种方法可以实现当头文件重命名时不必修改的头保护？ [英] Is there a way to implement a header guard that doesn't have to be modified when the header file is renamed?

问题描述

目前，对于名为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

推荐答案

正如其他人所指出的，用作标头保护的内容本质上并不重要；它只需要在可能同时包含的一组标头中是唯一的。

您可以创建一个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 %这样的命令，以生成适合我正在编辑的标题的标题保护。这就是为什么它还会生成顶部和底部的空行。

该命令使用脚本isodate和rcsmunger。使用参数compact，isodate命令等同于：

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

完整命令支持许多替代格式，并且比在任何地方都必须键入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:) (dddd)/(dd)/(dd) (dd:dd:dd) $%$$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的原因之一。

这篇关于有没有一种方法可以实现当头文件重命名时不必修改的头保护？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！