CMake:How To Write Platform Checks

From KitwarePublic
Revision as of 18:23, 27 January 2006 by Alex (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

If you want to write software which compiles and runs on different operating systems, you have to take care for the special properties of the different platforms. On different operating systems there are subtle differences, e.g. on FreeBSD you should not use malloc.h, while it is perfectly ok to use it on Linux. These differences are usually handled by providing a header file which contains a bunch of define-statements according to the platform properties, usually named config.h:

  1. define HAVE_MALLOC_H 1

/* #undef HAVE_SYS_MNTTAB_H 1 */ /* #undef HAVE_SYS_MNTENT_H 1 */

  1. define HAVE_SYS_MOUNT_H 1

This header file is then included in the source files and the handled appropriately:


  1. include "config.h"
  1. ifdef HAVE_MALLOC_H
  2. include <malloc.h>
  3. else
  4. include <stdlib.h>
  5. endif

void bar() {

  void *buf=malloc(1024);

... }

The contents of config.h will be different depending on the platform where the sources are compiled, so there needs to be a way to generate this header file before the actual compilation process starts. If you are using autotools-based software, you probably know the ./configure step, which has to be executed before starting make. The ./configure script does some system introspection and generates from the gathered information a config.h header. CMake is able to do the same, and I'll show you how to do it.