1 #ifndef __DALI_V8PLUGIN_V8_UTILS_H__
2 #define __DALI_V8PLUGIN_V8_UTILS_H__
5 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
24 #include <dali/public-api/math/vector2.h>
25 #include <dali/public-api/math/vector3.h>
26 #include <dali/public-api/math/vector4.h>
27 #include <dali/public-api/math/rect.h>
28 #include <dali/public-api/actors/actor.h>
29 #include <dali/public-api/actors/layer.h>
30 #include <dali/public-api/render-tasks/render-task.h>
31 #include <dali/public-api/object/property-value.h>
32 #include <dali/public-api/object/property-map.h>
35 #include <shared/base-wrapped-object.h>
45 PARAMETER_0 = 0, ///< first parameter of a function call
46 PARAMETER_1 = 1, ///< second parameter of a function call
47 PARAMETER_2 = 2, ///< third parameter of a function call
48 PARAMETER_3 = 3, ///< forth parameter of a function call
49 PARAMETER_4 = 4, ///< fifth parameter of a function call
52 #define DALI_SCRIPT_EXCEPTION( isolate, message ) V8Utils::ScriptError( __FUNCTION__ , isolate, message );
57 * Print the list of arguments to std out
58 * @param[in] args v8 function args interpreted as (string, string,...)
60 void Log(const v8::FunctionCallbackInfo< v8::Value >& args) ;
63 * Print out using DALI_LOG_ERROR
64 * @param[in] args v8 function args interpreted as (string, string,...)
66 void LogError(const v8::FunctionCallbackInfo< v8::Value >& args) ;
69 * Read a files contents
71 * @param[in] filename The filename
72 * @param[out] contents string contents of the file
74 void GetFileContents( const std::string &filename, std::string& contents );
77 * Extract the directory path from a full path filename
78 * @param fileName file name
79 * @param directory directory name
81 void GetFileDirectory( const std::string& fileName, std::string& directory );
84 * Extract file name from a full path + file name
85 * @param[in] fullPathName full path + file name
86 * @param[out] fileName file name
88 void GetFileName( const std::string& fullPathName, std::string& fileName);
91 * Return the module name, e.g. if the module is
92 * my_module.js it will get 'my_module'
93 * @param[in] fileName full path module name
94 * @param[out] moduleName module name
96 void GetModuleName( const std::string& fileName, std::string& moduleName );
99 * Report an exception by writing as a warning to the Dali Log
101 * @param[in] try_catch The v8 TryCatch exception object
103 void ReportException( v8::Isolate* isolate, v8::TryCatch* try_catch) ;
106 * Depending on what coding standard used this can
107 * convert the first character to lower case,
108 * E.g. GetId becomes getId
110 std::string GetJavaScriptFunctionName( const char* functionName );
115 * @param[in] args v8 function args ignored
116 * @return a version string
118 void Version(const v8::FunctionCallbackInfo< v8::Value >& args) ;
121 * Convert v8 string as a std::string
122 * @param[in] value v8 function args interpreted as (v8_string)
125 std::string v8StringToStdString( const v8::Handle<v8::Value>& value) ;
128 * Convert hyphenated to camelCase (Dali property to wrapper property name)
130 * @param[in] hyphenatedName a hyphenated std::string to convert
131 * @return a camelCase'd std::string
133 std::string PropertyNameToJavaScriptName(const std::string& hyphenatedName);
136 * Script error, throws an exception
138 void ScriptError( const char* function, v8::Isolate* isolate, std::string errorString );
141 * @return in the value is a boolean primitive or a boolean object
143 bool IsBooleanPrimitiveOrObject( const v8::Local<v8::Value>& value );
146 * @return the value of boolean primitive or boolean object value
148 bool GetBooleanValue( v8::Isolate* isolate, const v8::Local<v8::Value>& value );
151 * @return true if the value is a number or a number object
153 bool IsNumberPrimitiveOrObject( const v8::Local<v8::Value>& value );
156 * @return the number of a number primitive or number object value
158 float GetNumberValue( v8::Isolate* isolate, const v8::Local<v8::Value>& value );
161 * @return if the value is a string primitve or a string object
163 bool IsStringPrimitiveOrObject( const v8::Local<v8::Value>& value );
166 * @return true if the value is a string or a string object
168 bool IsStringPrimitiveOrObject( const v8::Local<v8::Value>& value );
171 * @return the string from a string value or a string object
173 std::string GetStringValue( v8::Isolate* isolate, const v8::Local<v8::Value>& value );
175 /******************************************
176 * Helper functions for extracting a DALi object from a JavaScript object
177 *******************************************/
180 * Given a JavaScript object, either extract the embedded DALi property value or
181 * convert it to a property value
182 * @param[out] found whether the property was found
183 * @return property value
185 Property::Value GetPropertyValueFromObject( bool& found, v8::Isolate* isolate, const v8::Local<v8::Value >& value );
188 * Given a JavaScript object with
189 * @param [in] object JavaScrript object
190 * @return DALi ProperyMap from the JavaScript object
192 Property::Map GetPropertyMapFromObject( v8::Isolate* isolate, const v8::Local<v8::Object>& object);
195 * Extract a DALi wrapped object, from a JavaScript object held in a function argument
196 * @param[in] index argument index the object is held in
197 * @param[in] type type of wrapped object to extract
200 Actor GetActorFromObject( v8::Isolate* isolate, bool& found, v8::Local<v8::Object>& object);
203 /******************************************
204 * Helper functions to extract a C++ native type (int,float,string) or a DALi object
205 * ( handle, vector, actor, layer, property value, property map ) from a
206 * JavaScript function argument.
209 * myJavaScriptFunction( 23, 345, myActor );
214 * Actor myActor = v8Utils::GetActorParameter( PARAMETER_2, found, JavaScript Args );
215 ******************************************/
217 * @param [in] index parameter index, e.g. callMyFunc( index0, index1, index2).
218 * @param[out] found whether the parameter was found
219 * @return integer value from the JavaScript function arguments
221 int GetIntegerParameter( unsigned int index, bool& found, v8::Isolate* isolate, const v8::FunctionCallbackInfo< v8::Value >& args, int defaultValue );
224 * @param [in] index parameter index, e.g. callMyFunc( index0, index1, index2).
225 * @param[out] found whether the parameter was found
226 * @return float value from the JavaScript function arguments
228 float GetFloatParameter( unsigned int index, bool& found, v8::Isolate* isolate, const v8::FunctionCallbackInfo< v8::Value >& args, float defaultValue );
231 * @param [in] index parameter index, e.g. callMyFunc( index0, index1, index2).
232 * @param[out] found whether the parameter was found
233 * @return string value from the JavaScript function arguments
235 std::string GetStringParameter( unsigned int index, bool& found, v8::Isolate* isolate, const v8::FunctionCallbackInfo< v8::Value >& args );
238 * @param [in] index parameter index, e.g. callMyFunc( index0, index1, index2).
239 * @param[out] found whether the parameter was found
240 * @return boolean value from the JavaScript function arguments
242 bool GetBooleanParameter( unsigned int index, bool& found, v8::Isolate* isolate, const v8::FunctionCallbackInfo< v8::Value >& args );
245 * @param [in] index parameter index, e.g. callMyFunc( index0, index1, index2).
246 * @param[out] found whether the parameter was found
247 * @return ArrayBufferView from the JavaScript function arguments
249 void* GetArrayBufferViewParameter( unsigned int index, bool& found, v8::Isolate* isolate, const v8::FunctionCallbackInfo< v8::Value >& args );
252 * @param [in] index parameter index, e.g. callMyFunc( index0, index1, index2).
253 * @param[out] found whether the parameter was found
254 * @return DALi Handle value from the JavaScript function arguments
256 Handle GetHandleParameter( unsigned int index, bool& found, v8::Isolate* isolate, const v8::FunctionCallbackInfo< v8::Value >& args );
259 * @param [in] index parameter index, e.g. callMyFunc( index0, index1, index2).
260 * @param[out] found whether the parameter was found
261 * @return Vector2 from the JavaScript function arguments
263 Vector2 GetVector2Parameter( unsigned int index, bool& found, v8::Isolate* isolate, const v8::FunctionCallbackInfo< v8::Value >& args );
266 * @param [in] index parameter index, e.g. callMyFunc( index0, index1, index2).
267 * @param[out] found whether the parameter was found
268 * @return Vector3 from the JavaScript function arguments
270 Vector3 GetVector3Parameter( unsigned int index, bool& found, v8::Isolate* isolate, const v8::FunctionCallbackInfo< v8::Value >& args);
273 * @param [in] index parameter index, e.g. callMyFunc( index0, index1, index2).
274 * @param[out] found whether the parameter was found
275 * @return Vector4 from the JavaScript function arguments
277 Vector4 GetVector4Parameter( unsigned int index, bool& found, v8::Isolate* isolate, const v8::FunctionCallbackInfo< v8::Value >& args);
280 * @param [in] index parameter index, e.g. callMyFunc( index0, index1, index2).
281 * @param[out] found whether the parameter was found
282 * @return Rect<int> from the JavaScript function arguments
284 Rect<int> GetRectIntParameter( unsigned int index, bool& found, v8::Isolate* isolate, const v8::FunctionCallbackInfo< v8::Value >& args );
287 * @param [in] index parameter index, e.g. callMyFunc( index0, index1, index2).
288 * @param[out] found whether the parameter was found
289 * @return Actor from the JavaScript function arguments
291 Actor GetActorParameter( unsigned int index, bool& found, v8::Isolate* isolate, const v8::FunctionCallbackInfo< v8::Value >& args );
294 * @param [in] index parameter index, e.g. callMyFunc( index0, index1, index2).
295 * @param[out] found whether the parameter was found
296 * @return Layer from the JavaScript function arguments
298 Layer GetLayerParameter( unsigned int index, bool& found, v8::Isolate* isolate, const v8::FunctionCallbackInfo< v8::Value >& args );
301 * @param [in] index parameter index, e.g. callMyFunc( index0, index1, index2).
302 * @param[out] found whether the parameter was found
303 * @return Image from the JavaScript function arguments
305 Image GetImageParameter( unsigned int index, bool& found, v8::Isolate* isolate, const v8::FunctionCallbackInfo< v8::Value >& args );
308 * @param [in] index parameter index, e.g. callMyFunc( index0, index1, index2).
309 * @param[out] found whether the parameter was found
310 * @return RenderTask from the JavaScript function arguments
312 RenderTask GetRenderTaskParameter( unsigned int index, bool& found, v8::Isolate* isolate, const v8::FunctionCallbackInfo< v8::Value >& args );
315 * Extract a DALi wrapped object, from a JavaScript object held in a function argument
316 * @param[in] index argument index the object is held in
317 * @param[in] type type of wrapped object to extract
319 BaseWrappedObject* GetWrappedDaliObjectParameter( unsigned int index, BaseWrappedObject::Type type, v8::Isolate* isolate, const v8::FunctionCallbackInfo< v8::Value >& args );
322 * @param [in] index parameter index, e.g. callMyFunc( index0, index1, index2).
323 * @param[out] found whether the parameter was found
324 * @return ProperyValue from the JavaScript function arguments
326 Property::Value GetPropertyValueParameter( unsigned int index, bool& found, v8::Isolate* isolate, const v8::FunctionCallbackInfo< v8::Value >& args );
329 * @param [in] index parameter index, e.g. callMyFunc( index0, index1, index2).
330 * @param[out] found whether the parameter was found
331 * @return ProperyMap from the JavaScript function arguments
333 Property::Map GetPropertyMapParameter( unsigned int index, bool& found, v8::Isolate* isolate, const v8::FunctionCallbackInfo< v8::Value >& args );
336 * Generate a JavaScript property map, from a DALi property map
337 * @param [in] DALi map property map
338 * @param [in] JavaScript property map
340 void CreatePropertyMap( v8::Isolate* isolate, const Property::Map& map, v8::Local<v8::Object>& object );
344 * Read multiple float arguments from v8 args object
345 * e.g. myJavaFunc( 3.4, 7.6, 8.5 );
347 * @param[out] foundAllArguments flag to say all arguments are found
348 * @param[out] data pointer to a pre-allocated array of floats
349 * @param[in] dataSize the nunber of floats in the data parameter
350 * @param[in] defaultValue default value assigned to floats that don't exist in the arguments
352 void ReadFloatArguments( bool& foundAllArguments, float* data, unsigned int dataSize, const v8::FunctionCallbackInfo< v8::Value >& args, float defaultValue );
355 * Read multiple integer arguments from v8 args object
356 * e.g. myJavaFunc( 3, 7, 8 );
358 * @param[out] foundAllArguments flag to say all arguments are found
359 * @param[out] data pointer to a pre-allocated array of integers
360 * @param[in] dataSize the nunber of integers in the data parameter
361 * @param[in] defaultValue default value assigned to integers that don't exist in the arguments
363 void ReadIntegerArguments( bool& foundAllArguments, int* data, int dataSize, const v8::FunctionCallbackInfo< v8::Value >& args, int defaultValue );
365 } // namespace V8Utils
367 } // namespace V8Plugin
372 #endif // __DALI_V8PLUGIN_V8_UTILS_H__