Welcome, Guest. Please login or register. Did you miss your activation email?

Author Topic: Define STB_IMAGE_STATIC and STB_IMAGE_WRITE_STATIC  (Read 1092 times)

0 Members and 1 Guest are viewing this topic.

FRex

  • Hero Member
  • *****
  • Posts: 1842
    • View Profile
    • My GitHub Page
    • Email
Define STB_IMAGE_STATIC and STB_IMAGE_WRITE_STATIC
« on: January 14, 2019, 04:15:36 pm »
We should define those two macros in ImageLoader.cpp so that a statically linked SFML doesn't collide and cause tons of linking errors when the user's program also includes their own STB without defining those macros (they make all stb functions static).

Yes, I know I'm inventing random niche problems daily.
ZipSavings, script to count rar/7z/zip savings: https://goo.gl/vvBj5M
LuaConsole: https://goo.gl/X4kRUk
FoxRaycaster: https://goo.gl/27nVS8
Small Games - Heart, Routing and Snek: https://goo.gl/15ZGWE https://goo.gl/k5gwWD https://goo.gl/4nKPnT
Botes - a notes app in Pascal: https://goo.gl/bzTqsi

eXpl0it3r

  • SFML Team
  • Hero Member
  • *****
  • Posts: 9300
    • View Profile
    • development blog
    • Email
Re: Define STB_IMAGE_STATIC and STB_IMAGE_WRITE_STATIC
« Reply #1 on: January 15, 2019, 07:32:07 am »
Sure, why not. ;)
Official FAQ: https://www.sfml-dev.org/faq.php
Nightly Builds: https://www.nightlybuilds.ch/
——————————————————————
Dev Blog: https://dev.my-gate.net/
Thor: http://www.bromeon.ch/libraries/thor/

FRex

  • Hero Member
  • *****
  • Posts: 1842
    • View Profile
    • My GitHub Page
    • Email
Re: Define STB_IMAGE_STATIC and STB_IMAGE_WRITE_STATIC
« Reply #2 on: January 15, 2019, 07:35:03 am »
I'm not sure what the ;) was for, are you agreeing or not? Reason as to why not would be if more files included those two headers but they don't (unless I missed something) so it's not an issue at all.

And to make it clear, I mean #define in the code of ImageLoader.cpp before including those two headers, not in any build/project settings.

Oh, and wouldn't it produce "unused static function" errors in some cases? It still should be done though.

On the other hand this might make this part of code marginally faster and the built SFML a bit smaller if unused functions get stripped out, not that it matters for these parts of code.
« Last Edit: January 15, 2019, 07:41:03 am by FRex »
ZipSavings, script to count rar/7z/zip savings: https://goo.gl/vvBj5M
LuaConsole: https://goo.gl/X4kRUk
FoxRaycaster: https://goo.gl/27nVS8
Small Games - Heart, Routing and Snek: https://goo.gl/15ZGWE https://goo.gl/k5gwWD https://goo.gl/4nKPnT
Botes - a notes app in Pascal: https://goo.gl/bzTqsi

eXpl0it3r

  • SFML Team
  • Hero Member
  • *****
  • Posts: 9300
    • View Profile
    • development blog
    • Email
Re: Define STB_IMAGE_STATIC and STB_IMAGE_WRITE_STATIC
« Reply #3 on: January 15, 2019, 09:45:36 am »
Oh, I didn't want to sound ambiguous. :D

If there are no obvious down sides, then I don't see a reason, not to go ahead with it.
Official FAQ: https://www.sfml-dev.org/faq.php
Nightly Builds: https://www.nightlybuilds.ch/
——————————————————————
Dev Blog: https://dev.my-gate.net/
Thor: http://www.bromeon.ch/libraries/thor/

FRex

  • Hero Member
  • *****
  • Posts: 1842
    • View Profile
    • My GitHub Page
    • Email
Re: Define STB_IMAGE_STATIC and STB_IMAGE_WRITE_STATIC
« Reply #4 on: January 15, 2019, 09:50:09 am »
Those warning that might appear are the only downside. Let's see what Laurent says.
ZipSavings, script to count rar/7z/zip savings: https://goo.gl/vvBj5M
LuaConsole: https://goo.gl/X4kRUk
FoxRaycaster: https://goo.gl/27nVS8
Small Games - Heart, Routing and Snek: https://goo.gl/15ZGWE https://goo.gl/k5gwWD https://goo.gl/4nKPnT
Botes - a notes app in Pascal: https://goo.gl/bzTqsi

Laurent

  • Administrator
  • Hero Member
  • *****
  • Posts: 32123
    • View Profile
    • SFML's website
    • Email
Re: Define STB_IMAGE_STATIC and STB_IMAGE_WRITE_STATIC
« Reply #5 on: January 15, 2019, 09:52:46 am »
Laurent says he doesn't really care, but Laurent could also say "don't fix it if it isn't broken" :D
Laurent Gomila - SFML developer

FRex

  • Hero Member
  • *****
  • Posts: 1842
    • View Profile
    • My GitHub Page
    • Email
Re: Define STB_IMAGE_STATIC and STB_IMAGE_WRITE_STATIC
« Reply #6 on: January 15, 2019, 10:00:26 am »
It is broken. Linking SMFL statically + using STB in your own code without those macros on your side = linking errors. A lot of "LNK2005   _stbi_load_from_memory already defined in main.obj" will happen (for various functions). SFML's internal details shouldn't force a user to do that. Especially if we can fix it in two lines that'll also make the compiled code smaller and/or faster. It's like a smaller scale version of when static SFML linked its deps statically.

Oh, you also get one "LNK1169 one or more multiply defined symbols found". :P
« Last Edit: January 15, 2019, 10:09:51 am by FRex »
ZipSavings, script to count rar/7z/zip savings: https://goo.gl/vvBj5M
LuaConsole: https://goo.gl/X4kRUk
FoxRaycaster: https://goo.gl/27nVS8
Small Games - Heart, Routing and Snek: https://goo.gl/15ZGWE https://goo.gl/k5gwWD https://goo.gl/4nKPnT
Botes - a notes app in Pascal: https://goo.gl/bzTqsi

Laurent

  • Administrator
  • Hero Member
  • *****
  • Posts: 32123
    • View Profile
    • SFML's website
    • Email
Re: Define STB_IMAGE_STATIC and STB_IMAGE_WRITE_STATIC
« Reply #7 on: January 15, 2019, 10:10:51 am »
Quote
It is broken. Linking SMFL statically + using STB in your own code without those macros on your side = linking errors.
Ok, so you actually tried it, it was not a guess. So go ahead and fix it, sure :)
Laurent Gomila - SFML developer

FRex

  • Hero Member
  • *****
  • Posts: 1842
    • View Profile
    • My GitHub Page
    • Email
Re: Define STB_IMAGE_STATIC and STB_IMAGE_WRITE_STATIC
« Reply #8 on: January 15, 2019, 10:18:31 am »
Jesus. Yes. :P



And I didn't need to try to know it'd happen (but I tried it yesterday just to be sure). I just thought of this problem again when I thought that right now the only way to save png to memory is to use stb_image_write (or something else) yourself.

Actually it's kinda ironic that it's SFML that misses this save-to-memory functionality, thus forcing you to use stb_image_write yourself but then it turns out SFML in static linking prevents you from doing that...
« Last Edit: January 15, 2019, 10:23:07 am by FRex »
ZipSavings, script to count rar/7z/zip savings: https://goo.gl/vvBj5M
LuaConsole: https://goo.gl/X4kRUk
FoxRaycaster: https://goo.gl/27nVS8
Small Games - Heart, Routing and Snek: https://goo.gl/15ZGWE https://goo.gl/k5gwWD https://goo.gl/4nKPnT
Botes - a notes app in Pascal: https://goo.gl/bzTqsi

FRex

  • Hero Member
  • *****
  • Posts: 1842
    • View Profile
    • My GitHub Page
    • Email
Re: Define STB_IMAGE_STATIC and STB_IMAGE_WRITE_STATIC
« Reply #9 on: January 15, 2019, 11:43:26 am »
Defining STB_IMAGE_WRITE_STATIC causes dynamic SFML Graphics to fail to build with "LNK2019   unresolved external symbol _sprintf referenced in function __bdf_parse_properties   sfml-graphics   D:\sources\SFML\src\SFML\Graphics\freetype.lib(bdf.obj)".

Static SFML Graphics builds but then fails with same error unless  you use sprintf in your code.

So bdf.obj needs that, and unless some user code (or our stbi_image_write) pulls it in by calling it somewhere it fails to link. ???

It fails with this define because only function in stbi_image_write that calls sprintf is stbi_write_hdr_core which never gets called by SFML or any functions it calls so it gets stripped from the .obj by the compiler.

This is correct and adding legacy_stdio_definitions.lib to linker in either cases removes the _sprintf missing error: https://stackoverflow.com/questions/32418766/c-unresolved-external-symbol-sprintf-and-sscanf-in-visual-studio-2015

My brain right now...
« Last Edit: January 15, 2019, 11:53:43 am by FRex »
ZipSavings, script to count rar/7z/zip savings: https://goo.gl/vvBj5M
LuaConsole: https://goo.gl/X4kRUk
FoxRaycaster: https://goo.gl/27nVS8
Small Games - Heart, Routing and Snek: https://goo.gl/15ZGWE https://goo.gl/k5gwWD https://goo.gl/4nKPnT
Botes - a notes app in Pascal: https://goo.gl/bzTqsi

eXpl0it3r

  • SFML Team
  • Hero Member
  • *****
  • Posts: 9300
    • View Profile
    • development blog
    • Email
Re: Define STB_IMAGE_STATIC and STB_IMAGE_WRITE_STATIC
« Reply #10 on: January 15, 2019, 12:50:25 pm »
I'd rather pick the other option recommended in the SO answer to rebuild freetype with the "correct" VS 2015 version. Only question is then whether there could be some compatibility issues, but if it's just for an older version of VS 2015 or similar, then that's fine.

Soon we can drop the non MSVC universal libs, once VS 2019 comes out.
Official FAQ: https://www.sfml-dev.org/faq.php
Nightly Builds: https://www.nightlybuilds.ch/
——————————————————————
Dev Blog: https://dev.my-gate.net/
Thor: http://www.bromeon.ch/libraries/thor/

FRex

  • Hero Member
  • *****
  • Posts: 1842
    • View Profile
    • My GitHub Page
    • Email
Re: Define STB_IMAGE_STATIC and STB_IMAGE_WRITE_STATIC
« Reply #11 on: January 15, 2019, 12:55:30 pm »
I have no idea. This is pretty WTF. Like I know there is a warning/error when using these 'unsafe' functions but this is a whole new level of WTF. ;D And the fact this one unused function in image write was saving us...

Quote
Soon we can drop the non MSVC universal libs, once VS 2019 comes out.
Oh, why? And what's the difference between stuff in libs-msvc-universal and libs-msvc?
« Last Edit: January 15, 2019, 01:37:37 pm by FRex »
ZipSavings, script to count rar/7z/zip savings: https://goo.gl/vvBj5M
LuaConsole: https://goo.gl/X4kRUk
FoxRaycaster: https://goo.gl/27nVS8
Small Games - Heart, Routing and Snek: https://goo.gl/15ZGWE https://goo.gl/k5gwWD https://goo.gl/4nKPnT
Botes - a notes app in Pascal: https://goo.gl/bzTqsi

eXpl0it3r

  • SFML Team
  • Hero Member
  • *****
  • Posts: 9300
    • View Profile
    • development blog
    • Email
Re: Define STB_IMAGE_STATIC and STB_IMAGE_WRITE_STATIC
« Reply #12 on: January 15, 2019, 04:44:28 pm »
Because we're only ever providing builds for three different VS versions. With VS 2019 getting released soon, that will be VS 2015, 2017 and 2019 which all use the Universal CRT (see here). I guess it's something to discuss with the rest and kind of off-topic here. :D
Official FAQ: https://www.sfml-dev.org/faq.php
Nightly Builds: https://www.nightlybuilds.ch/
——————————————————————
Dev Blog: https://dev.my-gate.net/
Thor: http://www.bromeon.ch/libraries/thor/

FRex

  • Hero Member
  • *****
  • Posts: 1842
    • View Profile
    • My GitHub Page
    • Email
Re: Define STB_IMAGE_STATIC and STB_IMAGE_WRITE_STATIC
« Reply #13 on: January 15, 2019, 05:03:21 pm »
Builds of what? Extlibs? Because the extlibs are the problem here. CMake files we give are supposed to support 3 last version of VS?

I'm still mind blown this happens to work right now (flawlessly since VS 2015!!!) because sprintf is used once in a function we never use...

And the fact this prevents us from just defining STB_IMAGE_WRITE_STATIC...

We can define STB_IMAGE_STATIC no problem though!
« Last Edit: January 15, 2019, 05:06:43 pm by FRex »
ZipSavings, script to count rar/7z/zip savings: https://goo.gl/vvBj5M
LuaConsole: https://goo.gl/X4kRUk
FoxRaycaster: https://goo.gl/27nVS8
Small Games - Heart, Routing and Snek: https://goo.gl/15ZGWE https://goo.gl/k5gwWD https://goo.gl/4nKPnT
Botes - a notes app in Pascal: https://goo.gl/bzTqsi

 

anything