config.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.
 
******************************************************************************/
 
// This file is auto-generated by CMake at build time; modifications to this
// file *MUST* be done to config.hpp.in, located in the project's cmake
// templates directory.
//
// Any modifications made to this file will be replaced upon a project
// rebuild -- anytime CMake re-generates our project files.
 
#ifndef NOMLIB_CORE_CONFIG_HPP
#define NOMLIB_CORE_CONFIG_HPP
 
// Debugging
#include <iostream>
#include <string.h> // __FILE__ macro post-processing
 
// Shortened __FILE__ utility macro
//
// TODO: I'd like to see this integrated into the SDL2Logger interface!
#define NOM_FILE \
  ( strrchr(__FILE__, '/') ? strrchr(__FILE__, '/') + 1 : __FILE__ )

#define NOM_USE_SDL2_ASSERT
 
// Include SDL2's enhanced assert facility if enabled, otherwise fall-back to
// standard C assert facility.
#if defined( NOM_USE_SDL2_ASSERT )  // See cmake/platform.cmake
  #include <SDL_assert.h>
#else
  #include <cassert>
#endif
 
// nomlib's platform detection
#include "nomlib/platforms.hpp"
 
// nomlib's standard integer types
#include "nomlib/types.hpp"
 
#include "nomlib/core/SDL2Logger.hpp"
 
// nomlib's general-purpose macros
#include "nomlib/macros.hpp"

#define NOM_LOG_MESSAGE( cat, prio, ... ) \
  { nom::SDL2Logger( cat, prio ).write( __VA_ARGS__ ); }

#if defined( NOM_DEBUG )
  #define NOM_LOG_VERBOSE( cat, ... ) \
    NOM_LOG_MESSAGE( cat, nom::LogPriority::NOM_LOG_PRIORITY_VERBOSE, "[", NOM_FILE, ":", __LINE__, "]", __VA_ARGS__ );
#else
  #define NOM_LOG_VERBOSE( cat, ... ) \
    NOM_LOG_MESSAGE( cat, nom::LogPriority::NOM_LOG_PRIORITY_VERBOSE, __VA_ARGS__ );
#endif

#if defined( NOM_DEBUG )
  #define NOM_LOG_DEBUG( cat, ... ) \
    NOM_LOG_MESSAGE( cat, nom::LogPriority::NOM_LOG_PRIORITY_DEBUG, "[", NOM_FILE, ":", __LINE__, "]", __VA_ARGS__ );
#else
  #define NOM_LOG_DEBUG( cat, ... ) \
    NOM_LOG_MESSAGE( cat, nom::LogPriority::NOM_LOG_PRIORITY_DEBUG, __VA_ARGS__ );
#endif

#define NOM_LOG_INFO( cat, ... ) \
  NOM_LOG_MESSAGE( cat, nom::LogPriority::NOM_LOG_PRIORITY_INFO, __VA_ARGS__ );

#if defined( NOM_DEBUG )
  #define NOM_LOG_WARN( cat, ... ) \
    NOM_LOG_MESSAGE( cat, nom::LogPriority::NOM_LOG_PRIORITY_WARN, "[", NOM_FILE, ":", __LINE__, "]", __VA_ARGS__ );
#else
  #define NOM_LOG_WARN( cat, ... ) \
    NOM_LOG_MESSAGE( cat, nom::LogPriority::NOM_LOG_PRIORITY_WARN, __VA_ARGS__ );
#endif

#if defined( NOM_DEBUG )
  #define NOM_LOG_ERR( cat, ... ) \
    NOM_LOG_MESSAGE( cat, nom::LogPriority::NOM_LOG_PRIORITY_ERROR, "[", NOM_FILE, ":", __LINE__, "]", __VA_ARGS__ );
#else
  #define NOM_LOG_ERR( cat, ... ) \
    NOM_LOG_MESSAGE( cat, nom::LogPriority::NOM_LOG_PRIORITY_ERROR, __VA_ARGS__ );
#endif

#if defined( NOM_DEBUG )
  #define NOM_LOG_CRIT( cat, ... ) \
    NOM_LOG_MESSAGE( cat, nom::LogPriority::NOM_LOG_PRIORITY_CRITICAL, "[", NOM_FILE, ":", __LINE__, "]", __VA_ARGS__ );
#else
  #define NOM_LOG_CRIT( cat, ... ) \
    NOM_LOG_MESSAGE( cat, nom::LogPriority::NOM_LOG_PRIORITY_CRITICAL, __VA_ARGS__ );
#endif

#define NOM_DUMP( var ) \
  NOM_LOG_MESSAGE( NOM, nom::LogPriority::NOM_LOG_PRIORITY_DEBUG, "[", NOM_FILE, ":", __LINE__, "]", #var, ":", var );

#define NOM_DUMP_VAR( cat, ... ) \
  NOM_LOG_MESSAGE( cat, nom::LogPriority::NOM_LOG_PRIORITY_DEBUG, "[", NOM_FILE, ":", __LINE__, "]", __VA_ARGS__ );

#define NOM_LOG_TRACE( cat ) \
  NOM_LOG_MESSAGE( cat, nom::LogPriority::NOM_LOG_PRIORITY_DEBUG, NOM_FUNC );

#define NOM_LOG_TRACE_PRIO( cat, prio ) \
  NOM_LOG_MESSAGE( cat, prio, NOM_FUNC );
 
#define NOM_STUBBED( cat ) \
  NOM_LOG_MESSAGE( cat, nom::LogPriority::NOM_LOG_PRIORITY_INFO, "Stubbed function", NOM_FUNC, "was called" );
 
#ifdef NOM_DEBUG_ASSERT // -D NOM_DEBUG_ASSERT=on
 
  // Use SDL2's enhanced assert macro if available, otherwise fall-back to
  // standard C assert.
  #if defined( NOM_USE_SDL2_ASSERT )
    #define NOM_ASSERT(expression) SDL_assert(expression)
  #else
    #define NOM_ASSERT(expression) \
      ( assert (expression) )
  #endif // defined( NOM_USE_SDL2_ASSERT )
 
#else // Do not add any overhead
  #define NOM_ASSERT(expression)  // NO-OP
#endif // defined( NOM_DEBUG_ASSERT )
 
#define NOM_ASSERT_INVALID_PATH(reserved) \
  NOM_ASSERT(!"Invalid execution path assertion triggered")
 
#if defined(NOM_COMPILER_CLANG)
  // SOURCE: http://clang.llvm.org/docs/UsersManual.html#controlling-diagnostics-via-pragmas
  #define NOM_PRAGMA_STR(msg) #msg
  #define NOM_PRAGMA_DEFER(arg, ...) arg(__VA_ARGS__)
  #define NOM_PRAGMA_ERROR(msg) \
    _Pragma(NOM_PRAGMA_STR(GCC error(msg " in " \
    NOM_PRAGMA_DEFER(NOM_PRAGMA_STR, __FILE__) \
    ":" NOM_PRAGMA_DEFER(NOM_PRAGMA_STR,__LINE__) )))
#else
  // NO OPCODE defined
  #define NOM_PRAGMA_STR(msg)
  #define NOM_PRAGMA_DEFER(arg, ...)
  #define NOM_PRAGMA_ERROR(msg)
#endif
 
#ifndef __cplusplus
  NOM_PRAGMA_ERROR("nomlib requires a C++11 capable compiler.")
#endif

#if defined(NOM_DEBUG) && defined(NOM_COMPILER_CLANG)

  #define NOM_IGNORED_VARS(expr) \
    _Pragma("clang diagnostic push") \
    _Pragma("clang diagnostic ignored \"-Wunused\"" )

  #define NOM_IGNORED_VARS_ENDL(expr) \
    _Pragma("clang diagnostic pop")

  #define NOM_IGNORED_ENDL(expr) NOM_IGNORED_VARS_ENDL(expr)
 
#else // Ignoring of compiler generated warning messages is not supported
 
  #define NOM_IGNORED_VARS()
  #define NOM_IGNORED_ENDL()
  #define NOM_IGNORED_VARS_ENDL()
 
#endif  // defined(NOM_DEBUG) && defined(NOM_COMPILER_CLANG)
 
// NOTE(jeff): See src/CMakeLists.txt for declarations
 
// Image loader
#define NOM_USE_SDL2_IMAGE TRUE
 
// Font loader
#define NOM_USE_SDL2_TTF TRUE
 
// Audio
/* #undef NOM_USE_CREATIVE_OPENAL */
/* #undef NOM_USE_APPLE_OPENAL */
/* #undef NOM_USE_OPENAL_SOFT */
 
#if defined(NOM_USE_CREATIVE_OPENAL) || defined(NOM_USE_APPLE_OPENAL) || \
    defined(NOM_USE_OPENAL_SOFT)
  #define NOM_USE_OPENAL
#endif
 
#if defined NOM_BUILD_AUDIO_UNIT
  #ifndef NOM_USE_OPENAL
    // One of the above variables must be set in src/CMakeLists.txt
    NOM_PRAGMA_ERROR("Audio Unit: One of the OpenAL audio engines must be selected")
  #endif
#endif
 
/* #undef NOM_USE_LIBSNDFILE */
 
// High-quality rescaling algorithms for low-resolution sprites
// (i.e.: pixel art)
#define NOM_USE_SCALEX TRUE
#define NOM_USE_HQX TRUE
 
#define NOM_USE_LIBROCKET TRUE
/* #undef NOM_USE_LIBROCKET_LUA */
 
#endif // include guard defined