dali/public-api/common/dali-common.h

   1 #ifndef __DALI_COMMON_H__
   2 #define __DALI_COMMON_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <cstdio>
  23
  24 #ifdef EMSCRIPTEN
  25 #include <emscripten/emscripten.h>
  26 #endif
  27 /*
  28  * Definitions for shared library support
  29  *
  30  * If a library is configured with --enable-exportall or --enable-debug
  31  * then HIDE_DALI_INTERNALS is not defined, and nothing is hidden.
  32  * If it is configured without these options (the default), then HIDE_INTERNALS
  33  * is defined when building the library, visibility is automatically hidden, and the explicit
  34  * defines below come into use.
  35  * When building a library that uses DALI, HIDE_DALI_INTERNALS
  36  */
  37 #if __GNUC__ >= 4
  38 #  ifndef HIDE_DALI_INTERNALS
  39 #    define DALI_EXPORT_API
  40 #    define DALI_IMPORT_API
  41 #    define DALI_INTERNAL
  42 #  else
  43 #    define DALI_EXPORT_API __attribute__ ((visibility ("default")))
  44 #    define DALI_IMPORT_API __attribute__ ((visibility ("default")))
  45 #    define DALI_INTERNAL   __attribute__ ((visibility ("hidden")))
  46 #  endif
  47 #else
  48 /** Visibility attribute to show method definitions */
  49 #  define DALI_EXPORT_API
  50 /** Visibility attribute to show declarations */
  51 #  define DALI_IMPORT_API
  52 /** Visibility attribute to hide declarations */
  53 #  define DALI_INTERNAL
  54 #endif
  55
  56 #if defined (__GXX_EXPERIMENTAL_CXX0X__) || (__cplusplus >= 201103L)
  57 // C++0x support
  58 #define _CPP11
  59 #else
  60 // C++0x not supported
  61 #endif
  62
  63 #ifdef EMSCRIPTEN
  64
  65 #ifndef __clang__
  66 # error not clang?
  67 #endif
  68
  69 // clang cpp11 check is per feature
  70 #if !__has_feature(cxx_constexpr)
  71 # error constexpr needed for compile-time-math. Use -std=c+11
  72 #endif
  73
  74 #define _CPP11
  75
  76 #endif
  77
  78 /**
  79  * @brief The DALi namespace
  80  */
  81 namespace Dali
  82 {
  83
  84 /**
  85  * @brief Method to log assertion message in DALI_ASSERT_ALWAYS macro below.
  86  *
  87  * @param[in] location Where the assertion occurred
  88  * @param[in] condition The assertion condition
  89  */
  90 DALI_IMPORT_API void DaliAssertMessage( const char* location, const char* condition );
  91
  92 /**
  93  * @brief Exception class for Dali Core library - Raised by assertions in codebase.
  94  */
  95 class DALI_IMPORT_API DaliException
  96 {
  97 public:
  98   /**
  99    * @brief Constructor.
 100    *
 101    * Will always display a backtrace when raised in a debug build.
 102    *
 103    * @param[in] location  - the location of the assertion
 104    * @param[in] condition - The assertion condition
 105    */
 106   DaliException( const char* location, const char* condition );
 107
 108   const char* location;
 109   const char* condition;
 110 };
 111
 112 }// Dali
 113
 114 /**
 115  * @brief An invariant concurrent assertion to ensure its argument always evaluates TRUE.
 116  *
 117  * Use this for rules that must always be true regardless of build options.
 118  * For example, Actor must only ever have one parent.
 119  * To be clear, this test remains compiled into release builds that are deployed
 120  * on the platform.
 121  * Semantically, a failure of this test is signalling that dali is giving up and
 122  * quitting.
 123  * Since we don't catch the exception, a failure on any thread other than event
 124  * will propagate up the call stack and kill that thread.
 125  * A failure on the event thread may give the application an opportunity to
 126  * recover if there is an application-written exception handler on the call
 127  * stack between the throw site and the thread root and the application is built
 128  * with a compatible ABI.
 129  * Handle this macro with care at the level you would if it expanded to:
 130  *    if(!cond) { exit(EXIT_FAILURE); }
 131  * (which it is often equivalent to in effect).
 132  * It should not be used for simple parameter validation for instance.
 133  */
 134
 135 /**
 136  * Strip assert location for release builds, assert text is descriptive enough
 137  * This is to save space for low spec devices
 138  */
 139 #if defined(DEBUG_ENABLED)
 140 #define ASSERT_LOCATION __PRETTY_FUNCTION__
 141 #else
 142 #define ASSERT_LOCATION NULL
 143 #endif
 144
 145 #ifdef EMSCRIPTEN
 146
 147 #define DALI_ASSERT_ALWAYS(cond)                \
 148   if(!(cond)) \
 149   { \
 150     Dali::DaliAssertMessage( ASSERT_LOCATION, #cond );   \
 151     throw Dali::DaliException( ASSERT_LOCATION, #cond );  \
 152     EM_ASM(print(new Error().stack)); \
 153   }
 154 #else
 155
 156 #define DALI_ASSERT_ALWAYS(cond)                \
 157   if(!(cond)) \
 158   { \
 159     Dali::DaliAssertMessage( ASSERT_LOCATION, #cond );   \
 160     throw Dali::DaliException( ASSERT_LOCATION, #cond );  \
 161   }
 162 #endif
 163
 164 /**
 165  * @brief An invariant concurrent assertion to ensure its argument evaluates TRUE in debug builds.
 166  *
 167  * Use this to sanity check algorithms and prevent internal programming errors
 168  */
 169 #if defined(DEBUG_ENABLED)
 170 #define DALI_ASSERT_DEBUG(cond) DALI_ASSERT_ALWAYS(cond)
 171 #else
 172 #define DALI_ASSERT_DEBUG(cond)
 173 #endif
 174
 175 #endif // __DALI_COMMON_H__