我的C/C++语言学习进阶之旅使用stb_image库时候报错 multiple definition of ‘stbi_xxxxx‘ 和 previous definition here

Posted 字节卷动

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了我的C/C++语言学习进阶之旅使用stb_image库时候报错 multiple definition of ‘stbi_xxxxx‘ 和 previous definition here相关的知识,希望对你有一定的参考价值。

一、问题描述

1.1 error: undefined reference to 'stbi_load'error: undefined reference to 'stbi_image_free'之类的错误

在我的博客【我的C/C++语言学习进阶之旅】介绍一下NDK开发之C的简单易用图像库stb 中有介绍,要使用 stb_image,您应该有将 stb_image.h 文件添加到工程中,然后在C++文件添加下面的代码

#define STB_IMAGE_IMPLEMENTATION
#include "stb_image.h"

但是如果你只添加了.h头文件,而不添加宏定义的话,则会编译失败

#include "stb_image.h"

则会报错 error: undefined reference to 'stbi_load'error: undefined reference to 'stbi_image_free'之类的错误,如下所示:

上面的错误是我第一次添加stb_image.h库的时候犯的错误。直到我认真读完stbREADME文件才解决这个问题。

通过定义STB_IMAGE_IMPLEMENTATION,预处理器会修改头文件,让其只包含相关的函数定义源码,等于是将这个stb_image.h头文件变为一个.cpp文件了。现在只需要在你的程序中包含stb_image.h并编译就可以了。(工程中不要放stb_image.c文件,否则会报其他错误)

1.2 报错:multiple definition of ‘stbi_xxxxx’

但是,如果将下面这段代码,分别添加到两个cpp文件中,

#define STB_IMAGE_IMPLEMENTATION
#include "stb_image.h"

就会报另外一个错:multiple definition of 'stbi_xxxxx'

例如:我在一个叫做FaceStickerLoader.cpp文件中和一个叫做ImageUtils.cpp中分别引入了下面这段代码。

#define STB_IMAGE_IMPLEMENTATION
#include "stb_image.h"

首先,在FaceStickerLoader.cpp文件中,引入stb_image.h,并定义宏定义 STB_IMAGE_IMPLEMENTATION,如下所示:

然后,我在ImageUtils.cpp中想把相关的图片加载代码抽取出来,然后又引入stb_image.h,并定义宏定义 STB_IMAGE_IMPLEMENTATION,如下所示:

所以就引入了两个宏定义 STB_IMAGE_IMPLEMENTATION

那么编译的时候,就好编译失败,报如下错误:

二、分析错误

2.1 为啥会重复写呢?

因为1.1小结的结论,必须在.c或.cpp文件中添加下面的代码

#define STB_IMAGE_IMPLEMENTATION
#include "stb_image.h"

否则会报错 error: undefined reference to 'stbi_load'error: undefined reference to 'stbi_image_free'之类的错误。

导致我以为需要在每一个引入头文件stb_image.h的cpp代码中都需要添加下面这个宏定义

#define STB_IMAGE_IMPLEMENTATION

真的是一朝被蛇咬十年怕井绳!!!

2.2 解决问题

2.2.1 了解一下STB_IMAGE_IMPLEMENTATION这个宏定义的作用

我们首先了解一下STB_IMAGE_IMPLEMENTATION这个宏定义的作用。

通过定义STB_IMAGE_IMPLEMENTATION,预处理器会修改头文件,让其只包含相关的函数定义源码,等于是将这个stb_image.h头文件变为一个.cpp文件了。现在只需要在你的程序中包含stb_image.h并编译就可以了。(工程中不要放stb_image.c文件,否则会报其他错误)

我们打开stb_image.h头文件代码也可以看到上面作用。

  1. 如果定义了 宏定义STB_IMAGE_IMPLEMENTATION,才会执行下面所有的代码


2. 直到7671行代码才结束这个 宏定义STB_IMAGE_IMPLEMENTATION的范围
3. 因此,我们可以看出来,通过定义STB_IMAGE_IMPLEMENTATION,预处理器会修改头文件,让其只包含相关的函数定义源码,等于是将这个stb_image.h头文件变为一个.cpp文件了。现在只需要在你的程序中包含stb_image.h并编译就可以了。

2.2.2 解决方法1 只在一个源文件(.c、.cpp文件)中定义STB_IMAGE_IMPLEMENTATION

被当做头文件包含到别的文件中,则其不应该在不同的 .c、.cpp文件中被展开(注意:源文件的头文件会在预处理阶段将其头文件展开,也有可能会变成这种情况),否则相当于在不同的源文件中定义同名的C函数,再编译生成 .o文件时肯定会报重定义的错误。

因此,我们的解决方法就是只在一个源文件(.c、.cpp文件)中声明宏定义STB_IMAGE_IMPLEMENTATION
如下所示:


这样我们就可以正常编译项目。

但是这样的解决方法不好,就是如果后续有人copy代码,copy了比如ImageUtils.cpp这个文件到其他的工程去,只包含了stb_image.h头文件单没有声明宏定义STB_IMAGE_IMPLEMENTATION

#include "../include/stb/stb_image.h"

那么就会出现1.1小结出现的问题:报错 error: undefined reference to 'stbi_load'error: undefined reference to 'stbi_image_free'之类的错误,如下所示:

那么有没有其他方式呢?答案是有的!我们接着看。

2.2.3 解决方法2 添加另外一个宏定义

2.2.3.1 分析源码

C语言中为解决多个源文件包含相同的函数提供了更好的办法,相信你已经猜到了------static关键字,其修饰的函数和全局变量只在本文件中可见,这样就不会和其他文件冲突了。

我们来看下错误,我们先看第一次报错的两行提示,如下所示

  C:/android/SDK/ndk/21.4.7075529/toolchains/llvm/prebuilt/windows-x86_64/lib/gcc/arm-linux-androideabi/4.9.x/../../../../arm-linux-androideabi/bin\\ld: error: XXXRender.a(ImageUtils.cpp.o): multiple definition of 'stbi__unpremultiply_on_load_thread(int)'
  C:/Android/SDK/ndk/21.4.7075529/toolchains/llvm/prebuilt/windows-x86_64/lib/gcc/arm-linux-androideabi/4.9.x/../../../../arm-linux-androideabi/bin\\ld: XXXRender.a(FaceStickerLoader.cpp.o): previous definition here

然后我们查看这个stbi__unpremultiply_on_load_thread(int)方法的实现,如下所示:

STBIDEF void stbi__unpremultiply_on_load_thread(int flag_true_if_should_unpremultiply)

   stbi__unpremultiply_on_load_local = flag_true_if_should_unpremultiply;
   stbi__unpremultiply_on_load_set = 1;

在函数前面有一个STBIDEF宏定义来修饰函数。我们来查看下这个STBIDEF宏定义是什么情况?

#ifndef STBIDEF
#ifdef STB_IMAGE_STATIC
#define STBIDEF static
#else
#define STBIDEF extern
#endif
#endif

好家伙,如果定义了宏定义STB_IMAGE_STATIC
那么宏定义 STBIDEF就是 static
否则宏定义 STBIDEF就是extern

可以参考这篇博客:static和extern对函数的作用 了解staticextern两个关键字。

好了,问题迎刃而解!

我们只要定义了宏定义STB_IMAGE_STATIC,那么那么宏定义 STBIDEF就是 static,那么下面的代码就是:

即:

STBIDEF void stbi__unpremultiply_on_load_thread(int flag_true_if_should_unpremultiply)

   stbi__unpremultiply_on_load_local = flag_true_if_should_unpremultiply;
   stbi__unpremultiply_on_load_set = 1;

编译之后就是

static void stbi__unpremultiply_on_load_thread(int flag_true_if_should_unpremultiply)

   stbi__unpremultiply_on_load_local = flag_true_if_should_unpremultiply;
   stbi__unpremultiply_on_load_set = 1;

那么就不会编译出错了!!!

2.2.3.2 解决问题

两个cpp文件都添加

#define STB_IMAGE_STATIC
#define STB_IMAGE_IMPLEMENTATION
#include "../include/stb/stb_image.h"

使用前预先定义 STB_IMAGE_STATIC ,添加该宏定义以后,函数会被static 修饰(否则为extern修饰),完美的解决了重定义的问题。推荐大家使用!

如下所示:

添加好之后,重新编译即可成功!!!

三、总结

我们介绍了两种方式解决此问题,推荐使用第2种方式来解决!

以上是关于我的C/C++语言学习进阶之旅使用stb_image库时候报错 multiple definition of ‘stbi_xxxxx‘ 和 previous definition here的主要内容,如果未能解决你的问题,请参考以下文章

我的C/C++语言学习进阶之旅介绍一下NDK开发之C的简单易用图像库stb

我的C/C++语言学习进阶之旅介绍一下NDK开发之C的简单易用图像库stb

我的渲染技术进阶之旅解决显示3D模型时因为使用stb_image库加载纹理时未翻转y轴导致模型纹理映射出错的问题

我的渲染技术进阶之旅解决显示3D模型时因为使用stb_image库或者opencv库加载纹理时未翻转y轴导致模型纹理映射出错的问题

我的C语言学习进阶之旅关于C/C++内存对齐读取文件产生的问题以及解决方法

我的C/C++语言学习进阶之旅C++格式化字符串