platforms.hpp

/******************************************************************************
 
  nomlib - C++11 cross-platform game engine
 
Copyright (c) 2013, 2014 Jeffrey Carpenter <i8degrees@gmail.com>
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
******************************************************************************/
#ifndef NOMLIB_SUPPORTED_PLATFORMS_HPP
#define NOMLIB_SUPPORTED_PLATFORMS_HPP

 
#if defined(_WIN32) || defined(__WIN32__)
  #define NOM_PLATFORM_WINDOWS
// NOTE: The following two macros -- linux and __linux -- are obsolete and are
// not POSIX compliant!
#elif defined(__linux__) || defined(linux) || defined(__linux)
  #define NOM_PLATFORM_LINUX
  #define NOM_PLATFORM_POSIX
#elif defined(__APPLE__) || defined(__MAC__) || defined(MACOSX) || defined(macintosh) || defined(Macintosh)
  #define NOM_PLATFORM_OSX
  #define NOM_PLATFORM_POSIX // Assume POSIX-compliant Unix
#elif defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || \
      defined(__bsdi__) || defined(__DragonFly__)
  #define NOM_PLATFORM_BSD
  #define NOM_PLATFORM_POSIX
#endif

#if defined( __i386__ ) || defined( _M_IX86 )
  #define NOM_PLATFORM_ARCH_X86
#elif defined( __x86_64__ ) || defined( _M_AMD64 )
  #define NOM_PLATFORM_ARCH_X86_64
#endif

#if defined(_MSC_VER) // Microsoft Visual C++
  #define NOM_COMPILER_MSVCPP
  #define NOM_COMPILER_FEATURE_NULLPTR // See include/nomlib/types.hpp
#else // Assume llvm-clang
  #define NOM_COMPILER_CLANG
  #define NOM_COMPILER_FEATURE_NULLPTR // See include/nomlib/types.hpp
#endif

#if defined ( NOM_COMPILER_MSVCPP ) // MSVC++
  #define NOM_FUNC __FUNCTION__
#else // We assume clang or GNU v2+
  #define NOM_FUNC __PRETTY_FUNCTION__
#endif
 
#ifdef PATH_MAX
  #undef PATH_MAX
#endif

#define PATH_MAX 256
 
// Cross-platform macro for obtaining the CPU's Time Stamp Counter (RDTSC)
//
//    See also
// 1. http://handmadehero.com
// 2. http://www.strchr.com/performance_measurements_with_rdtsc
#if defined(NOM_PLATFORM_WINDOWS) && defined(NOM_COMPILER_MSVCPP)
  // Use built-in compiler intrinsic
  #define NOM_RDTSC() __rdtsc();
#else // Assume clang compiler
  #define NOM_RDTSC() nom::rdtsc()
#endif // MS Windows && MSVCPP
 
namespace nom {
 
enum Platform
{
  PLATFORM_UNKNOWN = 0,   
  PLATFORM_WINDOWS,       
  PLATFORM_LINUX,         
  PLATFORM_BSD,           
  PLATFORM_OSX,           
  NUM_PLATFORMS,          
};
 
struct PlatformSpec
{
  const char* name = "Unknown";

  Platform env = PLATFORM_UNKNOWN;

  int num_cpus = 1;

  int cpu_cache_size = 0;

  int total_ram = 0;
};
 
PlatformSpec platform_info();
 
} // namespace nom
 
#endif // include guard