1 #ifndef DALI_SCENE_LOADER_UTILS_H_
2 #define DALI_SCENE_LOADER_UTILS_H_
4 * Copyright (c) 2020 Samsung Electronics Co., Ltd.
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
10 * http://www.apache.org/licenses/LICENSE-2.0
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.
21 #include "dali-scene-loader/public-api/api.h"
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"
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.
41 class DALI_SCENE_LOADER_API StreamBuffer : public std::basic_streambuf<char>
44 StreamBuffer(char* buffer, size_t size) noexcept(true)
46 setp(buffer, buffer + size);
51 * @brief Wraps an ostream with a pre-allocated, fixed size backing buffer
52 * which a message can be formatted into. Upon destruction, it throws a
53 * DaliException with the message.
55 class DALI_SCENE_LOADER_API ExceptionFlinger
58 enum { MESSAGE_BUFFER_SIZE = 512 };
60 ExceptionFlinger(const char* location) noexcept(true)
61 : mLocation(location),
62 mStreamBuffer(GetMessageBuffer(), MESSAGE_BUFFER_SIZE - 1),
63 mStream(&mStreamBuffer)
67 ~ExceptionFlinger() noexcept(false)
70 throw DaliException(mLocation, GetMessageBuffer());
74 ExceptionFlinger& operator<<(const T& rhs) noexcept(true)
81 static char* GetMessageBuffer() noexcept(true);
83 const char* mLocation;
84 StreamBuffer mStreamBuffer;
89 * @brief Formats the given printf-style varargs into a std::string.
91 DALI_SCENE_LOADER_API std::string FormatString(const char* format, ...);
94 * @return The @n th bit in a bitmask.
96 DALI_SCENE_LOADER_API constexpr size_t NthBit(size_t n) { return 1 << n; }
99 * @return Whether all of @a mask 's bits are set on @a value.
102 DALI_SCENE_LOADER_API bool MaskMatch(uint32_t value, uint32_t mask)
104 return (value & mask) == mask;
108 * @brief Convert a four-letter(, null-terminated) string literal into a uint32_t.
111 DALI_SCENE_LOADER_API constexpr uint32_t FourCC(const char(&fourCC)[5])
113 return (fourCC[3] << 24) | (fourCC[2] << 16) | (fourCC[1] << 8) | fourCC[0];
117 * @brief Insensitive case compare function.
118 * @param[in] a, compare string
119 * @param[in] b, compare string
120 * @return true if strings are equal
123 DALI_SCENE_LOADER_API bool CaseInsensitiveCharacterCompare( unsigned char a, unsigned char b )
125 // Converts to lower case in the current locale.
126 return std::tolower( a ) == std::tolower( b );
130 * @return true if the lower cased ASCII strings are equal.
131 * @param[in] a, compare string
132 * @param[in] b, compare string
135 DALI_SCENE_LOADER_API bool CaseInsensitiveStringCompare( const std::string& a, const std::string& b )
138 if( a.length() == b.length() )
140 result = std::equal( a.begin(), a.end(), b.begin(), &CaseInsensitiveCharacterCompare );
146 * @brief Attempts to load the contents of a text file; returns empty string on
147 * failure. A pointer to a boolean may be passed in @a fail; this will be set
148 * to true in case of failure (should only be checked if the returned string
151 DALI_SCENE_LOADER_API std::string LoadTextFile(const char* path, bool* fail = nullptr);
154 * @brief Makes a number of calls to @a fn, passing to each one the given
155 * @a actor then each of its children, in depth-first traversal.
156 * @note @a fn must not change the actor hierarchy during traversal.
157 * @note Use of a @a fn that is itself recursing in @a is also discouraged
158 * for performance and stability reasons.
160 template <typename Func>
162 DALI_SCENE_LOADER_API void VisitActor(Actor a, Func fn)
166 unsigned int numChildren = a.GetChildCount();
167 for(unsigned int i = 0; i < numChildren; ++i)
169 VisitActor(a.GetChildAt(i), fn);
174 * @brief Convenience function to set the given actor @a 's anchor point
175 * and parent origin to center.
178 DALI_SCENE_LOADER_API void SetActorCentered(Actor a)
180 a.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER);
181 a.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER);
184 namespace TexturedQuadOptions
186 using Type = uint32_t;
188 enum DALI_SCENE_LOADER_API Values : Type
191 FLIP_VERTICAL = 0x01,
196 * @brief Makes... geometry for a textured quad.
198 DALI_SCENE_LOADER_API Geometry MakeTexturedQuadGeometry(TexturedQuadOptions::Type options = TexturedQuadOptions::NONE);
201 * @brief Fixes the path of a file. Replaces the '\\' separator by the '/' one.
202 * @param[in,out] path The path to be fixed.
204 DALI_SCENE_LOADER_API void ToUnixFileSeparators( std::string& path );
209 #endif /* DALI_SCENE_LOADER_UTILS_H_ */