Handling stdafx.h in cross-platform code
Solution 1
You're best off using precompiled headers still for fastest compilation.
You can use precompiled headers in gcc as well. See here.
The compiled precompiled header will have an extension appended as .gch
instead of .pch
.
So for example if you precompile stdafx.h you will have a precompiled header that will be automatically searched for called stdafx.h.gch
anytime you include stdafx.h
Example:
stdafx.h:
#include <string>
#include <stdio.h>
a.cpp:
#include "stdafx.h"
int main(int argc, char**argv)
{
std::string s = "Hi";
return 0;
}
Then compile as:
> g++ -c stdafx.h -o stdafx.h.gch
> g++ a.cpp
> ./a.out
Your compilation will work even if you remove stdafx.h after step 1.
Solution 2
I used option 3 last time I needed to do this same thing. My project was pretty small but this worked wonderfully.
Solution 3
I would only use option 1 in a big team of developers. Options 2, 3, and 4 will often halt the productivity of other members of your team, so you can save a few minutes a day in compile time.
Here's why:
Let's assume that half of your developers use VS and half use gcc. Every now and then some VS developer will forget to include a header in a .cpp file. He won't notice, because the stdafx.h implicitly includes it. So, he pushes his changes in the version control, and then a few other members of the gcc team will get compiler errors. So, for every 5 minutes-a-day you gain by using precompiled headers, 5 other people waste by fixing your missing headers.
If you don't share the same code across all of your compilers, you will run into problems like that every day. If you force your VS developers to check for compilation on gcc before pushing changes, then you will throw away all your productivity gains from using precompiled headers.
Option 4 sounds appealing, but what if you want to use another compiler at some point in time ? Option 4 only works if you only use VS and gcc.
Notice that option 1 may make gcc compilation suffer a few seconds. Although it may not be noticeable.
Solution 4
I'd either go for option 4 or option 2. I've experimented with precompiled headers on both various VS versions and GCC on Linux (blog posts about this here and here). In my experience, VS is a lot more sensitive to the length of the include paths, number of directories in the include path and the number of include files than G++ is. When I measured build times properly arranged precompiled headers would make a massive difference to the compile time under VS whereas G++ was pretty much unimpressed by this.
Actually, based on the above what I did the last time I worked on a project where this was necessary to rein in the compile time was to precompile the equivalent of stdafx.h under Windows where it made sense and simply used it as a regular file under Linux.
Solution 5
Very simple solution. Add a dummy file entry for "stdafx.h" in Linux environment.
dimba
Updated on July 09, 2022Comments
-
dimba almost 2 years
I have a Visual Studio C++ based program that uses pre-compiled headers (
stdafx.h
). Now we are porting the application to Linux using gcc 4.x.The question is how to handle pre-compiled header in both environments. I've googled but can not come to a conclusion.
Obviously I want leave
stdafx.h
in Visual Studio since the code base is pretty big and pre-compiled headers boost compilation time.But the question is what to do in Linux. This is what I found:
- Leave the
stdafx.h
as is. gcc compiles code considerable faster than VC++ (or it is just my Linux machine is stronger ... :) ), so I maybe happy with this option. -
Use approach from here - make
stdafx.h
look like (setUSE_PRECOMPILED_HEADER
for VS only):#ifdef USE_PRECOMPILED_HEADER ... my stuff #endif
Use the approach from here - compile VC++ with
/FI
to implicitly includestdafx.h
in each cpp file. Therefore in VS your code can be switched easily to be compiled without pre-compiled headers and no code will have to be changed.
I personally dislike dependencies and the messstdafx.h
is pushing a big code base towards. Therefore the option is appealing to me - on Linux you don't havestdafx.h
, while still being able to turn on pre-compiled headers on VS by/FI
only.- On Linux compile
stdafx.h
only as a precompiled header (mimic Visual Studio)
Your opinion? Are there other approaches to treat the issue?
- Leave the
-
Brian R. Bondy almost 15 yearsI meant just that after you run g++ -c stdafx.h -o stdafx.h.gch, you can remove stdafx.h and your compilation would still work (g++ a.cpp). You wouldn't actually do this, but I mentioned it as proof that it is using the precompiled header.
-
Brian R. Bondy almost 15 years@idimba: Yes it is option 4, but you modified your question and added #4 three minutes after I posted my answer. The respective header file should be included anyway in source.
-
zzxyz over 5 yearsLet's not worry about my recent comment on a different question:
The compiler for main just needs the function/class declarations (.hpp), not the implementations/definitions. The linker finds those. #includeing .cpp files can be done but is incredibly bizarre.