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

   1 #ifndef __DALI_COMMON_H__
   2 #define __DALI_COMMON_H__
   3
   4 /*
   5  * Copyright (c) 2015 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
  23 #ifdef EMSCRIPTEN
  24 #include <emscripten/emscripten.h>
  25 #endif
  26
  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 #ifdef DEPRECATION_WARNING
  57 #define DALI_DEPRECATED_API __attribute__((__visibility__("default"), deprecated))
  58 #else
  59 #define DALI_DEPRECATED_API
  60 #endif
  61
  62 #if defined (__GXX_EXPERIMENTAL_CXX0X__) || (__cplusplus >= 201103L)
  63 // C++0x support
  64 #define _CPP11
  65 #else
  66 // C++0x not supported
  67 #endif
  68
  69 #ifdef EMSCRIPTEN
  70
  71 #ifndef __clang__
  72 # error not clang?
  73 #endif
  74
  75 // clang cpp11 check is per feature
  76 #if !__has_feature(cxx_constexpr)
  77 # error constexpr needed for compile-time-math. Use -std=c+11
  78 #endif
  79
  80 #define _CPP11
  81
  82 #endif
  83
  84 /**
  85  * @brief Two macros to provide branch predictor information.
  86  * DALI_LIKELY should be used when a branch is taken in almost all cases so the
  87  * branch predictor can avoid pre-fetching. The code for else branch
  88  * DALI_UNLIKELY should be used when a branch is almost never taken.
  89  * @SINCE_1_0.0
  90  */
  91 #define DALI_LIKELY(expression)   __builtin_expect( !!(expression), 1 )
  92 #define DALI_UNLIKELY(expression) __builtin_expect( !!(expression), 0 )
  93
  94 /**
  95  * @brief The DALi namespace.
  96  * @SINCE_1_0.0
  97  */
  98 namespace Dali
  99 {
 100 /**
 101  * @addtogroup dali_core_common
 102  * @{
 103  */
 104
 105 /**
 106  * @brief Method to log assertion message in DALI_ASSERT_ALWAYS macro below.
 107  *
 108  * @SINCE_1_0.0
 109  * @param[in] location Where the assertion occurred
 110  * @param[in] condition The assertion condition
 111  */
 112 DALI_IMPORT_API void DaliAssertMessage( const char* location, const char* condition );
 113
 114 /**
 115  * @brief Exception class for Dali Core library - Raised by assertions in codebase.
 116  * @SINCE_1_0.0
 117  */
 118 class DALI_IMPORT_API DaliException
 119 {
 120 public:
 121   /**
 122    * @brief Constructor.
 123    *
 124    * Will always display a backtrace when raised in a debug build.
 125    *
 126    * @SINCE_1_0.0
 127    * @param[in] location The location of the assertion
 128    * @param[in] condition The assertion condition
 129    */
 130   DaliException( const char* location, const char* condition );
 131
 132   const char* location;
 133   const char* condition;
 134 };
 135
 136 /**
 137  * @}
 138  */
 139 }// Dali
 140
 141 /**
 142  * @brief An invariant concurrent assertion to ensure its argument always evaluates TRUE.
 143  *
 144  * Use this for rules that must always be true regardless of build options.
 145  * For example, Actor must only ever have one parent.
 146  * To be clear, this test remains compiled into release builds that are deployed
 147  * on the platform.
 148  * Semantically, a failure of this test is signalling that dali is giving up and
 149  * quitting.
 150  * Since we don't catch the exception, a failure on any thread other than event
 151  * will propagate up the call stack and kill that thread.
 152  * A failure on the event thread may give the application an opportunity to
 153  * recover if there is an application-written exception handler on the call
 154  * stack between the throw site and the thread root and the application is built
 155  * with a compatible ABI.
 156  * Handle this macro with care at the level you would if it expanded to:
 157  *    if(!cond) { exit(EXIT_FAILURE); }
 158  * (which it is often equivalent to in effect).
 159  * It should not be used for simple parameter validation for instance.
 160  */
 161
 162 /**
 163  * @brief Strip assert location for release builds, assert text is descriptive enough.
 164  * This is to save space for low spec devices.
 165  * @SINCE_1_0.0
 166  */
 167 #if defined(DEBUG_ENABLED)
 168 #define ASSERT_LOCATION __PRETTY_FUNCTION__
 169 #else
 170 #define ASSERT_LOCATION NULL
 171 #endif
 172
 173 #ifdef EMSCRIPTEN
 174
 175 #define DALI_ASSERT_ALWAYS(cond)                \
 176   if(DALI_UNLIKELY(!(cond))) \
 177   { \
 178     Dali::DaliAssertMessage( ASSERT_LOCATION, #cond );   \
 179     throw Dali::DaliException( ASSERT_LOCATION, #cond );  \
 180     EM_ASM(print(new Error().stack)); \
 181   }
 182 #else
 183
 184 #define DALI_ASSERT_ALWAYS(cond)                \
 185   if(DALI_UNLIKELY(!(cond))) \
 186   { \
 187     Dali::DaliAssertMessage( ASSERT_LOCATION, #cond );   \
 188     throw Dali::DaliException( ASSERT_LOCATION, #cond );  \
 189   }
 190 #endif
 191
 192 #define DALI_ABORT(message)                \
 193   { \
 194     Dali::DaliAssertMessage( ASSERT_LOCATION, message );   \
 195     throw Dali::DaliException( ASSERT_LOCATION, message );  \
 196   }
 197
 198 /**
 199  * @brief An invariant concurrent assertion to ensure its argument evaluates TRUE in debug builds.
 200  *
 201  * Use this to sanity check algorithms and prevent internal programming errors.
 202  * @SINCE_1_0.0
 203  */
 204 #if defined(DEBUG_ENABLED)
 205 #define DALI_ASSERT_DEBUG(cond) DALI_ASSERT_ALWAYS(cond)
 206 #else
 207 #define DALI_ASSERT_DEBUG(cond)
 208 #endif
 209
 210 #endif // __DALI_COMMON_H__