7

I've got a very large application built using Visual Studio 2008 which is designed to run on Windows XP. The code consists of one solution file which contains six separate projects. My job is to port this application to run on Linux. I have not done anything like this before.

I discovered yesterday that my company wishes for this code to still compile on Windows once I'm done with it. My first idea for accomplishing this is to use a preprocessor statement such as:

#define COMPILE_FOR_LINUX

Then, I could tell the compiler which files to include in the headers using preprocessor blocks like these:

#ifdef COMPILE_FOR_LINUX
// include required Linux headers here and skip Windows header includes
#else
// include required Windows headers here and skip Linux header includes
#endif

After including the appropriate files, I could encapsulate all the platform dependent code with blocks like these:

#ifdef COMPILE_FOR_LINUX
// compile Linux specific code used here.
#else
// compile Windows specific code used here.
#endif

In order to make it as easy as possible for somebody to compile the application for their preferred platform, I'd like to have COMPILE_FOR_LINUX specified in just one place. However, I'm not sure how to accomplish this.

One idea I had was to create an empty header file, and then have every single file in the solution include this header file as specified in the Visual Studio solution file include path. For Linux, I'd have another version of the header file which defines COMPILE_FOR_LINUX, and then have the makefile point to this version instead of the empty one. However, I'm sure this is a very crude solution, and I'm unsure if it will even work.

Could anybody suggest a more elegant method for defining something globally or creating a variable in such a way that every file in the solution can see it?

Alex Jansen
  • 1,455
  • 5
  • 18
  • 34
  • Just in case other people are looking for this: http://stackoverflow.com/questions/5268177/is-there-anyway-to-define-constant-on-a-solution-basis – Peter M Jul 27 '16 at 18:04

1 Answers1

2

It depends on the compiler you're using, but for gcc you can specify preprocessor directives from the command line, so you'll just need to add COMPILE_FOR_LINUX in your makefile.

g++ -DCOMPILE_FOR_LINUX .....

For windows, if using MSVS, you can change the Preprocessor directives tab in the project properties (actually, you don't need to, since COMPILE_FOR_LINUX isn't defined, but you can add a COMPILE_FOR_WINDOWS for consistency).

Luchian Grigore
  • 253,575
  • 64
  • 457
  • 625
  • This sounds promising. Thanks! – Alex Jansen Aug 02 '12 at 18:18
  • Shouldn't that be -DCOMPILE_FOR_LINUX? – mort Aug 02 '12 at 18:42
  • @mort I don't know, haven't worked with gcc in a while. Is it? – Luchian Grigore Aug 02 '12 at 18:43
  • Furthermore, I would NOT use a COMPILE_FOR_WINDOWS flag - what do you do if both or none are defined? – mort Aug 02 '12 at 18:43
  • Yes, it is. Refer to http://stackoverflow.com/questions/2410976/how-to-define-a-string-in-gcc-command-line for examples. – mort Aug 02 '12 at 18:44
  • @mort Just make sure you define them then. What do you do if you compile for linux and `COMPILE_FOR_LINUX` is not defined? Same thing. Also, it makes it easier to add new platforms. – Luchian Grigore Aug 02 '12 at 18:44
  • but what would you do if more than one is defined? If COMPILE_FOR_LINUX is not defined, you'll compile for Windows. What would you do if both are defined? You'd get some nasty errors if you e.g., include files for both linux and windows. – mort Aug 02 '12 at 18:46
  • @mort that's good. The erros will point out that you're doing something wrong - i.e. defining both files. Compiler errors are good. – Luchian Grigore Aug 02 '12 at 18:49
  • Helpful compiler errors are good. I suppose you could check the defines at the very beginning to hive a helpful error message and avoid nasty surprises. – mort Aug 02 '12 at 18:58
  • @mort I meant defining both *macros* in my comment. – Luchian Grigore Aug 02 '12 at 18:58