Admin.h File Reference


Detailed Description

This file must be the first file included by all cpp files that are built in any library in the JetByte Tools suite. This file contains global #defines that affect how the code is built.


Defines

#define _WIN32_WINNT   0x0502
 This define determines which version of Windows the build is targetting and, subsequently, which functionality is available from the Windows header files. See here for more details.
#define NOMINMAX
 Don't let Windows.h define macros for min and max. Force the use of the stl template versions.
#define JETBYTE_USE_STL_PORT   0
 If you would rather build with STLPort than the standard STL that ships with Visual Studio then change the 0 to a 1 on the next line. Note that we don't support building with VC6 with the standard STL as it has too many bugs if unpatched. If you define JETBYTE_USE_STL_PORT then you should set the environment variable STLPORT_ROOT to point to, eg, C:-5.0.0.
#define JETBYTE_STL_PORT_VERSION   513
 If you are building with STLPort then the way we work out that the settings are all sane is to try and include an STLPort specific header file... Unfortunately they moved them around at version 5.1.0 and so we now need this define so that you can tell us the version that you're using so that we know where to look... The version is in the form of a number, where version 5.1.3 would be represented as 513 and version 5.0.0 would be represented as 500.
#define JETBYTE_NO_PLATFORM_SDK   0
 If you are using VC6 and you do NOT have a platform SDK installed then change the following define from 0 to 1 and things might still build. Ideally install the latest platfor SDK as that's what all the code is tested with. We don't support building with VC6 without a platform SDK. See here for more details on how to get the latest copy of the Platform SDK.
#define JETBYTE_ENABLE_DEPRECATED   0
 Sometimes we make design mistakes. Some clients still depend on code that we'd like to get rid of. If you'd like to include deprecated code in a library then set JETBYTE_ENABLE_DEPRECATED to 1, else set it to 0.
#define JETBYTE_HAS_INTERLOCKED_64   0
 If you're building with _WIN32_WINNT >= 0x0502 and you know that you will be running on a system that supports the Interlocked64() functions then you can set the following define to 1 and we'll use them. Otherwise we'll cludge around the lack of these 64bit operations with critical sections. Note that you can always compile with _WIN32_WINNT >= 0x0502 and all will be well but if the functions arent exported from Kernel32.dll on the machine that you run on then the process will die at runtime!
#define JETBYTE_SHOW_TODO   0
 If you want to see all of the 'fix this poor design' and 'what about this case?' messages then set the JETBYTE_SHOW_TODO define to 1, else set it to 0.
#define _WCTYPE_INLINE_DEFINED


Define Documentation

#define _WCTYPE_INLINE_DEFINED

#define _WIN32_WINNT   0x0502

This define determines which version of Windows the build is targetting and, subsequently, which functionality is available from the Windows header files. See here for more details.

#define JETBYTE_ENABLE_DEPRECATED   0

Sometimes we make design mistakes. Some clients still depend on code that we'd like to get rid of. If you'd like to include deprecated code in a library then set JETBYTE_ENABLE_DEPRECATED to 1, else set it to 0.

#define JETBYTE_HAS_INTERLOCKED_64   0

If you're building with _WIN32_WINNT >= 0x0502 and you know that you will be running on a system that supports the Interlocked64() functions then you can set the following define to 1 and we'll use them. Otherwise we'll cludge around the lack of these 64bit operations with critical sections. Note that you can always compile with _WIN32_WINNT >= 0x0502 and all will be well but if the functions arent exported from Kernel32.dll on the machine that you run on then the process will die at runtime!

#define JETBYTE_NO_PLATFORM_SDK   0

If you are using VC6 and you do NOT have a platform SDK installed then change the following define from 0 to 1 and things might still build. Ideally install the latest platfor SDK as that's what all the code is tested with. We don't support building with VC6 without a platform SDK. See here for more details on how to get the latest copy of the Platform SDK.

#define JETBYTE_SHOW_TODO   0

If you want to see all of the 'fix this poor design' and 'what about this case?' messages then set the JETBYTE_SHOW_TODO define to 1, else set it to 0.

#define JETBYTE_STL_PORT_VERSION   513

If you are building with STLPort then the way we work out that the settings are all sane is to try and include an STLPort specific header file... Unfortunately they moved them around at version 5.1.0 and so we now need this define so that you can tell us the version that you're using so that we know where to look... The version is in the form of a number, where version 5.1.3 would be represented as 513 and version 5.0.0 would be represented as 500.

#define JETBYTE_USE_STL_PORT   0

If you would rather build with STLPort than the standard STL that ships with Visual Studio then change the 0 to a 1 on the next line. Note that we don't support building with VC6 with the standard STL as it has too many bugs if unpatched. If you define JETBYTE_USE_STL_PORT then you should set the environment variable STLPORT_ROOT to point to, eg, C:-5.0.0.

#define NOMINMAX

Don't let Windows.h define macros for min and max. Force the use of the stl template versions.


Generated on Tue Oct 2 15:45:04 2007 for JetByte Tools - v5.2 by  doxygen 1.5.3