C语言关于include顺序不同导致编译结果不同的问题

  今天遇到了因为include顺序不同而编译结果不同的问题。归根结底还是自己写代码的习惯不好导致的。

编译环境

  既然要写就多写点吧。最近又开始做TI的DSP C6455相关的开发了。之前的文章里有写到，TI提供有一个CSL库，但是比较老，输出的格式是COFF，而现在一般是ELF。如果做一些新的开发的话，建议重新编译CSL库，并选择输出为ELF格式。

  C6000 DSP的编译工具链目前主要有7.4和8.3版本。8.0以上的版本不再支持C6455了，所以我目前用的CGT版本是7.4.24，7.4版本的应该都差不多，因为文档都是一样的。

问题简化

  实际工程中包含大大小小的文件很多，头文件的include层层嵌套。所以我在这里为了说明关键问题，把我实际遇到的问题做了简化。整个工程包含三个文件main.cpp, CData.cpp和CData.hpp。源码如下：

// main.cpp 
/* Scenario 1: it doesn't work */
#include "csl_types.h"
#include "CData.hpp"
/* Scenario 2: it does work */
// #include "CData.hpp"
// #include "csl_types.h"
int main(void) {
    return 0;
}

// CData.cpp 
#include "CData.hpp"

// CData.cpp 
#ifndef CDATA_HPP_
#define CDATA_HPP_
#include <assert.h>
#include <stdlib.h>
class CData {
public:
CData(): m_pData(NULL), m_nCnt(0) {}
CData(int nCnt): m_nCnt(nCnt) {
    m_pData = new int[nCnt];
    assert(m_pData != NULL);
}
~CData(){
    if(m_pData){
        delete[] m_pData;
        m_pData = NULL;
    }
}
protected:
    int *m_pData;
    int m_nCnt;
};
#endif

  实际上的现象就是main.cpp中include了两个头文件，它们include的前后顺序不同，导致了编译结果不同。在第一种情况下编译得到这样的结果：

  而在第二种情况下就是能够正常完成编译。

问题分析

a value of type "void *" cannot be used to initialize an entity of type "int *"
a value of type "void *" cannot be assigned to an entity of type "int *"

  报错提示的问题和NULL有关，大概意思是NULL是一个void *的类型，不能把它赋给其他类型的变量。但可以看到，单独编译CData.cpp是没有出现问题的。而在编译main.cpp的时候，因为先include了csl_types.h，导致改变了NULL的定义，所以出了问题。

  查找有NULL相关的定义的文件可以找到：

// stdlib.h
#ifndef NULL
#define NULL 0
#endif

// csl_types.h
#ifndef NULL
#define NULL ((void*)0)
#endif

// xdc/std.h
#undef NULL
#if defined(__cplusplus) || !defined(xdc__strict)
#define NULL 0
#else
#define NULL ((void *)0)
#endif

  stdlib.h大家应该都比较熟悉，是标准库。csl_types.h是在用CSL的时候会不经意间包含的一个头文件。还有xdc/std.h是在用RTSC时可能会用到的头文件。这几个文件里都有关于NULL的定义。

  我这次遇到的问题就是因为前两个文件include的前后顺序不同，NULL定义的情况也就不同了。而第三个文件感觉比较好，会先undef NULL，然后再重新define，应该可以一定程度上避免这个问题。但是第三个文件中有些类型的定义也会和csl_types.h产生冲突，所以用起来还是要注意。

总结

  这次虽然两个头文件include的顺序引发的问题。但是归根结底我觉得还是因为我直接在头文件里做类（CData）的定义，而没有把定义放在cpp文件中。如果把方法的具体实现放在源文件里，然后把那些头文件中的include放到源文件里去，应该可以一定程度上避免这种问题的出现。

  实际工程中遇到这类问题，往往include有多层，很难发现，所以还是应该要有一个良好的编程习惯！

到此这篇关于C语言关于include顺序不同导致编译结果不同的问题的文章就介绍到这了,更多相关C语言include顺序内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！