libSBML C++ API  5.18.0
libsbml-config.h File Reference

Decides whether to #include Unix or Windows configuration variables. More...

Include dependency graph for libsbml-config.h:
This graph shows which files directly or indirectly include this file:

Detailed Description

Decides whether to #include Unix or Windows configuration variables.

Author
Ben Bornstein

Some explanations about this file are warranted. This file includes one of the following (depending on operating system and compiler):

  • libsbml-config-unix.h
  • libsbml-config-win.h

On Linux, MacOS X, Cygwin, etc., libsbml-config-unix.h and libsbml-package.h are generated from libsbml-config-unix.h.in and libsbml-package.h.in, respectively, by the configure script at the top level of the libSBML distribution.

On Windows, we cannot rely on libsbml-config-win.h being generated by configure, since most developers will not be able to run configure in that environment. Instead, both libsbml-config-win.h and libsbml-package.h (which see) are stored in the source repository and must be updated by the libSBML developers as necessary. The file libsbml-config-win.h should rarely, if ever, need to be updated, while libsbml-package.h should require minor updates prior to each libsbml release. This is admittedly not an ideal and fool-proof arrangement; however, at this time it is the best we have been able to find under the circumstances.

Finally, libsbml-config.h, libsbml-package.h, libsbml-config-unix.h, and (for consistency) libsbml-config-win.h are all installed by "make install".