[Tizen] Add codes for Dali Windows Backend
[platform/core/uifw/dali-core.git] / dali / public-api / common / dali-common.h
old mode 100644 (file)
new mode 100755 (executable)
index e57b10e..cc73979
@@ -2,7 +2,7 @@
 #define __DALI_COMMON_H__
 
 /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2018 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
 
 // EXTERNAL INCLUDES
 
-#ifdef EMSCRIPTEN
-#include <emscripten/emscripten.h>
-#endif
-
 /*
- * Definitions for shared library support
+ * Definitions for shared library support.
  *
  * If a library is configured with --enable-exportall or --enable-debug
  * then HIDE_DALI_INTERNALS is not defined, and nothing is hidden.
  * If it is configured without these options (the default), then HIDE_INTERNALS
  * is defined when building the library, visibility is automatically hidden, and the explicit
  * defines below come into use.
- * When building a library that uses DALI, HIDE_DALI_INTERNALS
+ * When building a library that uses DALI, HIDE_DALI_INTERNALS.
  */
 #if __GNUC__ >= 4
 #  ifndef HIDE_DALI_INTERNALS
 #    define DALI_EXPORT_API
 #    define DALI_IMPORT_API
+#    define DALI_CORE_API
 #    define DALI_INTERNAL
 #  else
 #    define DALI_EXPORT_API __attribute__ ((visibility ("default")))
 #    define DALI_IMPORT_API __attribute__ ((visibility ("default")))
+#    define DALI_CORE_API   __attribute__ ((visibility ("default")))
 #    define DALI_INTERNAL   __attribute__ ((visibility ("hidden")))
 #  endif
 #else
-/** Visibility attribute to show method definitions */
+#ifdef WIN32
+ /** Visibility attribute to show declarations */
+#  define DALI_EXPORT_API __declspec(dllexport)
+
+#ifdef BUILDING_DALI_CORE
+ /** Visibility attribute to hide declarations */
+#  define DALI_CORE_API __declspec(dllexport)
+#else
+/** Visibility attribute to hide declarations */
+#  define DALI_CORE_API __declspec(dllimport)
+#endif
+
+#else
+ /** Visibility attribute to show declarations */
 #  define DALI_EXPORT_API
 /** Visibility attribute to show declarations */
 #  define DALI_IMPORT_API
+/** Visibility attribute to show declarations */
+#  define DALI_CORE_API
+#endif
 /** Visibility attribute to hide declarations */
 #  define DALI_INTERNAL
 #endif
 
+#ifdef DEPRECATION_WARNING
+#define DALI_DEPRECATED_API __attribute__((__visibility__("default"), deprecated))
+#else
+#define DALI_DEPRECATED_API
+#endif
+
 #if defined (__GXX_EXPERIMENTAL_CXX0X__) || (__cplusplus >= 201103L)
 // C++0x support
 #define _CPP11
 // C++0x not supported
 #endif
 
-#ifdef EMSCRIPTEN
-
-#ifndef __clang__
-# error not clang?
-#endif
-
-// clang cpp11 check is per feature
-#if !__has_feature(cxx_constexpr)
-# error constexpr needed for compile-time-math. Use -std=c+11
-#endif
-
-#define _CPP11
-
+/**
+ * @brief Two macros to provide branch predictor information.
+ * DALI_LIKELY should be used when a branch is taken in almost all cases so the
+ * branch predictor can avoid pre-fetching. The code for else branch
+ * DALI_UNLIKELY should be used when a branch is almost never taken.
+ * @SINCE_1_0.0
+ */
+#ifdef __GNUC
+#define DALI_LIKELY(expression)   __builtin_expect( !!(expression), 1 )
+#define DALI_UNLIKELY(expression) __builtin_expect( !!(expression), 0 )
+#else
+#define DALI_LIKELY(expression)   !!(expression)
+#define DALI_UNLIKELY(expression) !!(expression)
 #endif
 
 /**
- * @brief The DALi namespace
+ * @brief The DALi namespace.
+ * @SINCE_1_0.0
  */
 namespace Dali
 {
@@ -88,15 +109,17 @@ namespace Dali
 /**
  * @brief Method to log assertion message in DALI_ASSERT_ALWAYS macro below.
  *
+ * @SINCE_1_0.0
  * @param[in] location Where the assertion occurred
  * @param[in] condition The assertion condition
  */
-DALI_IMPORT_API void DaliAssertMessage( const char* location, const char* condition );
+DALI_CORE_API void DaliAssertMessage( const char* location, const char* condition );
 
 /**
  * @brief Exception class for Dali Core library - Raised by assertions in codebase.
+ * @SINCE_1_0.0
  */
-class DALI_IMPORT_API DaliException
+class DALI_CORE_API DaliException
 {
 public:
   /**
@@ -104,8 +127,9 @@ public:
    *
    * Will always display a backtrace when raised in a debug build.
    *
-   * @param[in] location  - the location of the assertion
-   * @param[in] condition - The assertion condition
+   * @SINCE_1_0.0
+   * @param[in] location The location of the assertion
+   * @param[in] condition The assertion condition
    */
   DaliException( const char* location, const char* condition );
 
@@ -140,8 +164,9 @@ public:
  */
 
 /**
- * Strip assert location for release builds, assert text is descriptive enough
- * This is to save space for low spec devices
+ * @brief Strip assert location for release builds, assert text is descriptive enough.
+ * This is to save space for low spec devices.
+ * @SINCE_1_0.0
  */
 #if defined(DEBUG_ENABLED)
 #define ASSERT_LOCATION __PRETTY_FUNCTION__
@@ -149,29 +174,24 @@ public:
 #define ASSERT_LOCATION NULL
 #endif
 
-#ifdef EMSCRIPTEN
-
 #define DALI_ASSERT_ALWAYS(cond)                \
-  if(!(cond)) \
+  if(DALI_UNLIKELY(!(cond))) \
   { \
     Dali::DaliAssertMessage( ASSERT_LOCATION, #cond );   \
     throw Dali::DaliException( ASSERT_LOCATION, #cond );  \
-    EM_ASM(print(new Error().stack)); \
   }
-#else
 
-#define DALI_ASSERT_ALWAYS(cond)                \
-  if(!(cond)) \
+#define DALI_ABORT(message)                \
   { \
-    Dali::DaliAssertMessage( ASSERT_LOCATION, #cond );   \
-    throw Dali::DaliException( ASSERT_LOCATION, #cond );  \
+    Dali::DaliAssertMessage( ASSERT_LOCATION, message );   \
+    throw Dali::DaliException( ASSERT_LOCATION, message );  \
   }
-#endif
 
 /**
  * @brief An invariant concurrent assertion to ensure its argument evaluates TRUE in debug builds.
  *
- * Use this to sanity check algorithms and prevent internal programming errors
+ * Use this to sanity check algorithms and prevent internal programming errors.
+ * @SINCE_1_0.0
  */
 #if defined(DEBUG_ENABLED)
 #define DALI_ASSERT_DEBUG(cond) DALI_ASSERT_ALWAYS(cond)