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

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