dali-scene-loader/public-api/utils.h

   1 #ifndef DALI_SCENE_LOADER_UTILS_H_
   2 #define DALI_SCENE_LOADER_UTILS_H_
   3 /*
   4  * Copyright (c) 2020 Samsung Electronics Co., Ltd.
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  * http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  */
  19
  20 // INTERNAL INCLUDES
  21 #include "dali-scene-loader/public-api/api.h"
  22
  23 // EXTERNAL INCLUDES
  24 #include "dali/public-api/actors/actor.h"
  25 #include "dali/public-api/rendering/renderer.h"
  26 #include "dali/public-api/common/dali-common.h"
  27 #include <sstream>
  28 #include <cctype>
  29
  30 namespace Dali
  31 {
  32 namespace SceneLoader
  33 {
  34
  35 /*
  36  * @brief Fixed size backing buffer to use with std::ostreams where control over
  37  *  allocations (which this does not make), is required.
  38  * @note All stream insertions that would overflow the buffer that StreamBuffer
  39  *  was created with, will fail.
  40  */
  41 class DALI_SCENE_LOADER_API StreamBuffer : public std::basic_streambuf<char>
  42 {
  43 public:
  44   StreamBuffer(char* buffer, size_t size) noexcept(true);
  45 };
  46
  47 /*
  48  * @brief Wraps an ostream with a pre-allocated, fixed size backing buffer
  49  *  which a message can be formatted into. Upon destruction, it throws a
  50  *  DaliException with the message.
  51  */
  52 class DALI_SCENE_LOADER_API ExceptionFlinger
  53 {
  54 public:
  55   enum { MESSAGE_BUFFER_SIZE = 512 };
  56
  57   ExceptionFlinger(const char* location) noexcept(true);
  58
  59   [[noreturn]]
  60   ~ExceptionFlinger() noexcept(false);
  61
  62   template <typename T>
  63   ExceptionFlinger& operator<<(const T& rhs) noexcept(true)
  64   {
  65     mStream << rhs;
  66     return *this;
  67   }
  68
  69 private:
  70   struct Impl
  71   {
  72     const char* mLocation;
  73
  74     [[noreturn]]
  75     ~Impl() noexcept(false);
  76   };
  77
  78   static char* GetMessageBuffer() noexcept(true);
  79
  80   Impl mImpl;
  81   StreamBuffer mStreamBuffer;
  82   std::ostream mStream;
  83 };
  84
  85 /*
  86  * @brief Formats the given printf-style varargs into a std::string.
  87  */
  88 DALI_SCENE_LOADER_API std::string FormatString(const char* format, ...);
  89
  90 /*
  91  * @return The @n th bit in a bitmask.
  92  */
  93 DALI_SCENE_LOADER_API constexpr size_t NthBit(size_t n) { return 1 << n; }
  94
  95 /*
  96  * @return Whether all of @a mask 's bits are set on @a value.
  97  */
  98 inline
  99 DALI_SCENE_LOADER_API bool MaskMatch(uint32_t value, uint32_t mask)
 100 {
 101   return (value & mask) == mask;
 102 }
 103
 104 /*
 105  * @brief Convert a four-letter(, null-terminated) string literal into a uint32_t.
 106  */
 107 inline
 108 DALI_SCENE_LOADER_API constexpr uint32_t FourCC(const char(&fourCC)[5])
 109 {
 110   return (fourCC[3] << 24) | (fourCC[2] << 16) | (fourCC[1] << 8) | fourCC[0];
 111 }
 112
 113 /*
 114  * @brief Insensitive case compare function.
 115  * @param[in] a, compare string
 116  * @param[in] b, compare string
 117  * @return true if strings are equal
 118  */
 119 inline
 120 DALI_SCENE_LOADER_API bool CaseInsensitiveCharacterCompare( unsigned char a, unsigned char b )
 121 {
 122   // Converts to lower case in the current locale.
 123   return std::tolower( a ) == std::tolower( b );
 124 }
 125
 126 /*
 127  * @return true if the lower cased ASCII strings are equal.
 128  * @param[in] a, compare string
 129  * @param[in] b, compare string
 130  */
 131 inline
 132 DALI_SCENE_LOADER_API bool CaseInsensitiveStringCompare( const std::string& a, const std::string& b )
 133 {
 134   bool result = false;
 135   if( a.length() == b.length() )
 136   {
 137     result = std::equal( a.begin(), a.end(), b.begin(), &CaseInsensitiveCharacterCompare );
 138   }
 139   return result;
 140 }
 141
 142 /*
 143  * @brief Attempts to load the contents of a text file; returns empty string on
 144  *  failure. A pointer to a boolean may be passed in @a fail; this will be set
 145  *  to true in case of failure (should only be checked if the returned string
 146  *  was empty()).
 147  */
 148 DALI_SCENE_LOADER_API std::string LoadTextFile(const char* path, bool* fail = nullptr);
 149
 150 /*
 151  * @brief Makes a number of calls to @a fn, passing to each one the given
 152  *  @a actor then each of its children, in depth-first traversal.
 153  * @note @a fn must not change the actor hierarchy during traversal.
 154  * @note Use of a @a fn that is itself recursing in @a is also discouraged
 155  *  for performance and stability reasons.
 156  */
 157 template <typename Func>
 158 inline
 159 DALI_SCENE_LOADER_API void VisitActor(Actor a, Func fn)
 160 {
 161   fn(a);
 162
 163   unsigned int numChildren = a.GetChildCount();
 164   for(unsigned int i = 0; i < numChildren; ++i)
 165   {
 166     VisitActor(a.GetChildAt(i), fn);
 167   }
 168 }
 169
 170 /*
 171  * @brief Convenience function to set the given actor @a 's anchor point
 172  *  and parent origin to center.
 173  */
 174 inline
 175 DALI_SCENE_LOADER_API void SetActorCentered(Actor a)
 176 {
 177   a.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER);
 178   a.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER);
 179 }
 180
 181 namespace TexturedQuadOptions
 182 {
 183 using Type = uint32_t;
 184
 185 enum DALI_SCENE_LOADER_API Values : Type
 186 {
 187   NONE = 0x00,
 188   FLIP_VERTICAL = 0x01,
 189 };
 190 }
 191
 192 /*
 193  * @brief Makes... geometry for a textured quad.
 194  */
 195 DALI_SCENE_LOADER_API Geometry MakeTexturedQuadGeometry(TexturedQuadOptions::Type options = TexturedQuadOptions::NONE);
 196
 197 /*
 198  * @brief Fixes the path of a file. Replaces the '\\' separator by the '/' one.
 199  * @param[in,out] path The path to be fixed.
 200  */
 201 DALI_SCENE_LOADER_API void ToUnixFileSeparators( std::string& path );
 202
 203 }
 204 }
 205
 206 #endif /* DALI_SCENE_LOADER_UTILS_H_ */