Merge pull request #22 from SunXofRTT/master

添加软件包说明

README.md

@@ -1,378 +1,57 @@
 # jerryscript on RT-Thread
 
-JerryScript is a lightweight JavaScript engine for resource-constrained devices such as microcontrollers. It can run on devices with less than 64 KB of RAM and less than 200 KB of flash memory.
+## 1、介绍
 
-API Reference ：http://jerryscript.net/api-reference/
-
-首先，不得不说明下JerryScript的基础类型：`jerry_value_t`。一个对象可以设定任意个属性，属性可以是`string`,`function`等，也可以是对象。但每个对象中，都有一个指针：`native_pointer`，这个指针就可用来存放或传递数据。
-
-    jerry_value_t obj
-        ├── 属性1
-        ├── 属性2
-        │   ...
-        │   ...
-        └── native_pointer    
-
-
-JerryScript中则提供了获取、设定native_pointer的API。
-```C
-bool
-jerry_get_object_native_pointer (const jerry_value_t obj_val,
-                                 void **out_native_pointer_p,
-                                 const jerry_object_native_info_t **out_native_info_p)
-
-bool
-jerry_set_object_native_pointer (const jerry_value_t obj_val,
-                                 void *native_p,
-                                 const jerry_object_native_info_t *info_p)
-```
+JerryScript是一个轻量级的JavaScript引擎，用于资源受限的设备，如微控制器。它可以运行在小于64 kb RAM和小于200 kb的闪存的设备上。由于这个特性，它被移植到了RT-Thread中。
 
-## 如何导入C++的API
-
-此Package中，我们一般使用以下的宏在JerryScript中创建一些接口，来使用C++的API：
+API Reference ：http://jerryscript.net/api-reference/
 
-```C
-#define REGISTER_HANDLER(NAME)      \
-    jerryx_handler_register_global ( (jerry_char_t *)# NAME, NAME ## _handler)
-#define REGISTER_HANDLER_ALIAS(NAME, HANDLER) \
-    jerryx_handler_register_global ( (jerry_char_t *)# NAME, HANDLER)
-#define REGISTER_METHOD(OBJ, NAME)  \
-    js_add_function (OBJ, # NAME, NAME ## _handler)
-#define REGISTER_METHOD_ALIAS(OBJ, NAME, HANDLER) \
-    js_add_function (OBJ, # NAME, HANDLER)
-#define REGISTER_METHOD_NAME(OBJ, NAME, HANDLER)  \
-    js_add_function (OBJ, NAME, HANDLER ## _handler)
+### 1.1 目录结构
 
-```
+Jerryscript on RT-Thread软件包目录如下所示：
 
-可以看到，前两个宏指向函数`jerryx_handler_register_global`,具体内容如下：
+|  名称 |  说明 |
+| - | - |
+| example | 示例代码，示范如何导入C++的API与添加builtin module |
+| jerryscript | jerryscript 官方库 |
+| rtthread-port | RT-Thread 移植代码目录 |
 
-```C
-jerry_value_t
-jerryx_handler_register_global (const jerry_char_t *name_p, /**< name of the function */
-                                jerry_external_handler_t handler_p) /**< function callback */
-{
-  jerry_value_t global_obj_val = jerry_get_global_object ();
-  jerry_value_t function_name_val = jerry_create_string (name_p);
-  jerry_value_t function_val = jerry_create_external_function (handler_p);
+### 1.2 许可证
 
-  jerry_value_t result_val = jerry_set_property (global_obj_val, function_name_val, function_val);
+Jerryscript on RT-Thread软件包遵循Apache-2.0 许可，详见 LICENSE 文件。
 
-  jerry_release_value (function_val);
-  jerry_release_value (function_name_val);
-  jerry_release_value (global_obj_val);
+### 1.3 依赖
 
-  return result_val;
-} 
-```
-后三个宏定义都指向了函数`js_add_function`,具体内容如下：
-```C
-void js_add_function(const jerry_value_t obj, const char *name,
-                     jerry_external_handler_t func)
-{
-    jerry_value_t str = jerry_create_string((const jerry_char_t *)name);
-    jerry_value_t jfunc = jerry_create_external_function(func);
+- RT-Thread 3.0+
+- finsh 软件包
 
-    jerry_set_property(obj, str, jfunc);
+## 2、 获取软件包
 
-    jerry_release_value(str);
-    jerry_release_value(jfunc);
-}
-```
+使用 Jerryscript on RT-Thread 软件包需要在 RT-Thread 的包管理中选中它，具体路径如下：
 
-从上述代码中可以看到`jerryx_handler_register_global`和`js_add_function`的实质操作就是在指定对象中加入一个名为`name`的`func`，这个`obj`可以指定为全局obj。而我们就只需要在这个func中添加C++的代码并使用API，并且可以把所需要的数据作为属性加入到指定JerryScript对象中或返回出来。如果想要在JS中传递C++对象，我们就可以利用文章开头所说的native_pointer
+    RT-Thread online packages
+        language packages  --->
+            [ ] Lua: A lightweight, embeddable scripting language.  --->
+            [*] JerryScript: Ultra-lightweight JavaScript engine for the Internet of Things.  --->
+            [ ] MicroPython: A lean and efficient Python implementation for microcontrollers and constrained systems.  --->
 
-此func类型为`jerry_external_handler_t`，具体定义如下。
-```C
-typedef jerry_value_t (*jerry_external_handler_t) (const jerry_value_t function_obj,
-                                                   const jerry_value_t this_val,
-                                                   const jerry_value_t args_p[],
-                                                   const jerry_length_t args_count);
-```
-为了方便书写代码，Package中添加了对应的宏定义。
-```C
-#define DECLARE_HANDLER(NAME)       \
-    static jerry_value_t            \
-    NAME ## _handler (const jerry_value_t func_value,   \
-                        const jerry_value_t this_value, \
-                        const jerry_value_t args[],     \
-                        const jerry_length_t args_cnt )
-```
+然后让 RT-Thread 的包管理器自动更新，或者使用 `pkgs --update` 命令更新包到 BSP 中。
 
-### 示例代码
+## 3、使用Jerryscript on RT-Thread软件包
 
-以添加`request`接口为例
-1. 创建一个初始化API：`js_request_init`，并设定入参变量`obj`。创建好初始化API后，我们就只要在API中执行`REGISTER_METHOD(obj, request)`，但此时函数`request`还未创建，那我们只需要创建它即可。而函数`request`内部，我们就可以添加C++的API，执行我们需要操作或把相关数据转换成JerryScript的数据类型返回出来。
+- 如何导入C++API，请参考[ImportCplusplus](examples/ImportCplusplus/README.md)
+- 如何添加builtin module，请参考[ImportModule](examples/ImportModule/README.md)
 
-    ```C
-    DECLARE_HANDLER(request)
-    {
-        //此处就能添加对应的C++的API，并执行具体内容。
-    }
+## 4、 注意事项
 
-    extern "C"
-    {
-        int js_request_init(jerry_value_t obj)
-        {
-            REGISTER_METHOD(obj, request);
-            return 0;
-        }
-    }
+- Jerryscript on RT-Thread软件包版本为`latest`，请勿选择版本`V1.0.0`。
+- Jerryscript on RT-Thread软件包依赖finsh软件包，请确认在 RT-Thread 的包管理中选中了`finsh`，具体路径如下：
     ```
-
-2. 譬如在此Package中，JerryScript的执行函数为`jerry_main`,那我们就还需要在`jerry_main`中执行下`js_request_init`。
-
-    ```C
-    extern int js_request_init(jerry_value_t obj);
-    int jerry_main(int argc, char** argv)
-    {
-        //...
-        jerry_value_t global_object = jerry_get_global_object();
-        js_request_init(global_object);
-        //...
-    }
+    RT-Thread Components
+        Command shell  --->
+            [*] finsh shell
     ```
+## 5、 联系方式 & 感谢
 
-## 如何添加builtin module
-
-由于JerryScript是一款轻量级的JavaScript的引擎，因此它没有直接提供常见的module。但是开发者可以根据自身需求，去添加相应module。
-
-那如何添加builtin module呢？当相应module的入口建立好后，只需要使用以下finsh命令即可
-```
-//NAME ： module的名称
-//MODULE_INIT ： module的入口函数
-JS_MODULE(NAME, MODULE_INIT)
-```
-
-示例代码：
-```C
-jerry_value_t myModule_init(void)
-{
-
-    jerry_value_t obj = jerry_create_object();
-    // ...
-    // do something
-    // ...
-    return obj;
-}
-
-JS_MODULE(myModule,myModule_init);
-```
-以上代码就在JerryScript中创建里一个名为`myModule`的module，其返回值为`obj`。
-在JS脚本中，我们都是通过以下方式调用module的。
-```C
-var mqtt = require('myModule')
-```
-
-## Sample
-
-### C++ 导入示例
-
-```C++
-#include <rtthread.h>
-#include <jerry_util.h>
-
-/*自定义C++类*/
-class Rectangle
-{
-   private:
-        int length;
-        int width;
-   
-   public:
-        Rectangle(int length,int width);
-        int getSize();
-        int getLength();
-        int getWidth();
-};
-
-Rectangle::Rectangle(int length,int width)
-{
-    this->length = length;
-    this->width = width;
-}
-
-int Rectangle::getSize()
-{
-    return (this->length * this->width);
-}
-
-int Rectangle::getLength()
-{
-    return this->length;
-}
-
-int Rectangle::getWidth()
-{
-    return this->width;
-}
-/**********/
-
-void rectangle_free_callback(void *native_p)
-{
-    Rectangle* rect = (Rectangle*)native_p;
-    delete(rect);
-}
-
-const static jerry_object_native_info_t rectangle_info =
-{
-    rectangle_free_callback //当js_rect对象释放后，调用该回调
-};
-
-DECLARE_HANDLER(getSize)
-{
-    void *native_pointer = RT_NULL;
-    jerry_get_object_native_pointer(this_value,&native_pointer,RT_NULL);    //获取当前对象中的native_pointer
-    
-    if(native_pointer)
-    {
-        /*调用C++对象的API，并将其返回值转换成JS对象*/
-        Rectangle* rectangle = (Rectangle*)native_pointer;
-        jerry_value_t js_size = jerry_create_number(rectangle->getSize());
-        return js_size;
-    }
-    return jerry_create_undefined();
-}
-
-DECLARE_HANDLER(getLength)
-{
-    void *native_pointer = RT_NULL;
-    jerry_get_object_native_pointer(this_value,&native_pointer,RT_NULL);
-    
-    if(native_pointer)
-    {
-        Rectangle* rectangle = (Rectangle*)native_pointer;
-        jerry_value_t js_length = jerry_create_number(rectangle->getLength());
-        return js_length;
-    }
-    return jerry_create_undefined();
-}
-
-DECLARE_HANDLER(getWidth)
-{
-    void *native_pointer = RT_NULL;
-    jerry_get_object_native_pointer(this_value,&native_pointer,RT_NULL);
-    
-    if(native_pointer)
-    {
-        Rectangle* rectangle = (Rectangle*)native_pointer;
-        jerry_value_t js_width = jerry_create_number(rectangle->getWidth());
-        return js_width;
-    }
-    return jerry_create_undefined();
-}
-
-DECLARE_HANDLER(rectangle)
-{
-    /*入参判断*/
-    if(args_cnt !=2 || !jerry_value_is_number(args[0]) || !jerry_value_is_number(args[1]))
-        return jerry_create_undefined();
-    
-    jerry_value_t js_rect = jerry_create_object(); //创建JS对象 js_rect
-    
-    Rectangle* rectangle = new Rectangle(jerry_get_number_value(args[0]),jerry_get_number_value(args[1]));      //创建C++对象 rectangle
-
-    jerry_set_object_native_pointer(js_rect, rectangle,&rectangle_info);    //把js_rect的native_pointer指向rectangle
-    
-    /*调用rectangle的API，并把其返回值转换成JS对象*/
-    jerry_value_t js_length = jerry_create_number(rectangle->getLength());      
-    jerry_value_t js_width = jerry_create_number(rectangle->getWidth());
-    
-    /*把js_length 和 js_width设置成js_rect的属性，类Rectangle中lenght与width为私有变量，如要JS对象与C++对象保持对应，此处代码可注释掉*/
-    js_set_property(js_rect,"length",js_length);
-    js_set_property(js_rect,"width",js_width);
-    
-    jerry_release_value(js_length);
-    jerry_release_value(js_width);
-    
-    REGISTER_METHOD(js_rect,getSize);       //为js_retc注册一个方法getSize
-    REGISTER_METHOD(js_rect,getLength);     //为js_retc注册一个方法getLength
-    REGISTER_METHOD(js_rect,getWidth);      //为js_retc注册一个方法getWidth
-    return js_rect;
-}
-
-extern "C"
-{
-    int js_example_rect_init(jerry_value_t obj)
-    {
-        REGISTER_METHOD(obj, rectangle); //为指定对象obj注册一个方法rectangle_init，这个对象可以是global_obj
-        return 0;
-    }
-}
-
-```
-
-### builtin module示例
-
-```C++
-
-#include <rtthread.h>
-#include <jerry_util.h>
-
-/*自定义的C++类*/
-class Circle 
-{
-    private:
-        int radius ;
-    public:
-        Circle(int radius);
-        int getRadius();
-        float getCircumference();
-};
-
-Circle::Circle(int radius)
-{
-    this->radius = radius;
-}
-
-int Circle::getRadius()
-{
-    return this->radius;
-}
-
-float Circle::getCircumference()
-{
-    return (2 * 3.1415 *this->radius);
-}
-
-void circle_free_callback(void *native_p)
-{
-    Circle* rect = (Circle*)native_p;
-    delete(rect);
-}
-/**********/
-
-const static jerry_object_native_info_t circle_info =
-{
-    circle_free_callback //当js_circle对象释放后，调用该回调
-};
-
-DECLARE_HANDLER(getCircumference)
-{
-    /*函数内部具体实现*/
-    void* native_pointer = RT_NULL;
-    jerry_get_object_native_pointer(this_value,&native_pointer,RT_NULL);    //获取当前对象中的native_pointer
-    if(native_pointer)
-    {
-        /*调用C++对象的API，并将其返回值转换成JS对象*/
-        Circle* circle = (Circle*)native_pointer;
-        jerry_value_t js_circumference = jerry_create_number(circle->getCircumference());
-        return js_circumference;
-    }
-    return jerry_create_undefined();
-};
-
-jerry_value_t Circle_init()
-{
-    jerry_value_t js_circle = jerry_create_object();   // 创建JerryScript对象js_circle
-    Circle* circle = new Circle(5);     //创建C++对象 Circle
-    jerry_set_object_native_pointer(js_circle,circle,&circle_info);     //把js_circle的native_pointer指向circle
-    jerry_value_t js_radius = jerry_create_number(circle->getRadius());     //调用Circle的API，并把它转换成JS对象。
-    js_set_property(js_circle,strdup("radius"),js_radius);  //把js_radius设置成js_circle的一个属性
-    jerry_release_value(js_radius);
-    REGISTER_METHOD(js_circle,getCircumference);    //为js_circle注册一个方法 getCircumference
-    return js_circle;
-}
-
-JS_MODULE(Circle,Circle_init); //注册builtin module，名称：Circle,入口函数：Circle_init
-```
+- 维护: RT-Thread 开发团队
+- 主页: https://github.com/RT-Thread-packages/jerryscript

SConscript

@@ -1,3 +1,4 @@
+import os
 from building import *
 
 # get current directory
@@ -80,4 +81,10 @@ LOCAL_CPPDEFINES = ['JERRY_JS_PARSER', 'JERRY_ENABLE_ERROR_MESSAGES']
 group = DefineGroup('JerryScript', src, depend = ['PKG_USING_JERRYSCRIPT'], CPPPATH = path, 
     LOCAL_CPPDEFINES = LOCAL_CPPDEFINES, LOCAL_CCFLAGS = LOCAL_CCFLAGS)
 
+list = os.listdir(cwd)
+
+for item in list:
+	if os.path.isfile(os.path.join(cwd, item, 'SConscript')):
+		group = group + SConscript(os.path.join(item, 'SConscript'))
+
 Return('group')

examples/ImportCplusplus/README.md

@@ -0,0 +1,273 @@
+# 如何导入C++API
+
+## JerryScript基础类型
+
+首先，不得不说明下JerryScript的基础类型：`jerry_value_t`。一个对象可以设定任意个属性，属性可以是`number`,`string`,`function`等，也可以是对象。但每个对象中，都有一个指针：`native_pointer`，这个指针就可用来存放或传递数据。
+
+    jerry_value_t obj
+        ├── 属性1
+        ├── 属性2
+        │   ...
+        │   ...
+        └── native_pointer    
+
+
+JerryScript中则提供了获取、设定native_pointer的API。
+```C
+bool
+jerry_get_object_native_pointer (const jerry_value_t obj_val,
+                                 void **out_native_pointer_p,
+                                 const jerry_object_native_info_t **out_native_info_p)
+
+bool
+jerry_set_object_native_pointer (const jerry_value_t obj_val,
+                                 void *native_p,
+                                 const jerry_object_native_info_t *info_p)
+```
+
+## 如何导入C++的API
+
+此Package中，我们一般使用以下的宏在JerryScript中创建一些接口，来使用C++的API：
+
+```C
+#define REGISTER_HANDLER(NAME)      \
+    jerryx_handler_register_global ( (jerry_char_t *)# NAME, NAME ## _handler)
+#define REGISTER_HANDLER_ALIAS(NAME, HANDLER) \
+    jerryx_handler_register_global ( (jerry_char_t *)# NAME, HANDLER)
+#define REGISTER_METHOD(OBJ, NAME)  \
+    js_add_function (OBJ, # NAME, NAME ## _handler)
+#define REGISTER_METHOD_ALIAS(OBJ, NAME, HANDLER) \
+    js_add_function (OBJ, # NAME, HANDLER)
+#define REGISTER_METHOD_NAME(OBJ, NAME, HANDLER)  \
+    js_add_function (OBJ, NAME, HANDLER ## _handler)
+
+```
+
+可以看到，前两个宏指向函数`jerryx_handler_register_global`,具体内容如下：
+
+```C
+jerry_value_t
+jerryx_handler_register_global (const jerry_char_t *name_p, /**< name of the function */
+                                jerry_external_handler_t handler_p) /**< function callback */
+{
+  jerry_value_t global_obj_val = jerry_get_global_object ();
+  jerry_value_t function_name_val = jerry_create_string (name_p);
+  jerry_value_t function_val = jerry_create_external_function (handler_p);
+
+  jerry_value_t result_val = jerry_set_property (global_obj_val, function_name_val, function_val);
+
+  jerry_release_value (function_val);
+  jerry_release_value (function_name_val);
+  jerry_release_value (global_obj_val);
+
+  return result_val;
+} 
+```
+后三个宏定义都指向了函数`js_add_function`,具体内容如下：
+```C
+void js_add_function(const jerry_value_t obj, const char *name,
+                     jerry_external_handler_t func)
+{
+    jerry_value_t str = jerry_create_string((const jerry_char_t *)name);
+    jerry_value_t jfunc = jerry_create_external_function(func);
+
+    jerry_set_property(obj, str, jfunc);
+
+    jerry_release_value(str);
+    jerry_release_value(jfunc);
+}
+```
+
+从上述代码中可以看到`jerryx_handler_register_global`和`js_add_function`的实质操作就是在指定对象中加入一个名为`name`的`func`，这个`obj`可以指定为全局obj。而我们就只需要在这个func中添加C++的代码并使用API，并且可以把所需要的数据作为属性加入到指定JerryScript对象中或返回出来。如果想要在JS中传递C++对象，我们就可以利用文章开头所说的native_pointer
+
+此func类型为`jerry_external_handler_t`，具体定义如下。
+```C
+typedef jerry_value_t (*jerry_external_handler_t) (const jerry_value_t function_obj,
+                                                   const jerry_value_t this_val,
+                                                   const jerry_value_t args_p[],
+                                                   const jerry_length_t args_count);
+```
+为了方便书写代码，Package中添加了对应的宏定义。
+```C
+#define DECLARE_HANDLER(NAME)       \
+    static jerry_value_t            \
+    NAME ## _handler (const jerry_value_t func_value,   \
+                        const jerry_value_t this_value, \
+                        const jerry_value_t args[],     \
+                        const jerry_length_t args_cnt )
+```
+
+### 示例代码
+
+以添加`request`接口为例
+1. 创建一个初始化API：`js_request_init`，并设定入参变量`obj`。创建好初始化API后，我们就只要在API中执行`REGISTER_METHOD(obj, request)`，但此时函数`request`还未创建，那我们只需要创建它即可。而函数`request`内部，我们就可以添加C++的API，执行我们需要操作或把相关数据转换成JerryScript的数据类型返回出来。
+
+    ```C
+    DECLARE_HANDLER(request)
+    {
+        //此处就能添加对应的C++的API，并执行具体内容。
+    }
+
+    extern "C"
+    {
+        int js_request_init(jerry_value_t obj)
+        {
+            REGISTER_METHOD(obj, request);
+            return 0;
+        }
+    }
+    ```
+
+2. 譬如在此Package中，JerryScript的执行函数为`jerry_main`,那我们就还需要在`jerry_main`中执行下`js_request_init`。
+
+    ```C
+    extern int js_request_init(jerry_value_t obj);
+    int jerry_main(int argc, char** argv)
+    {
+        //...
+        jerry_value_t global_object = jerry_get_global_object();
+        js_request_init(global_object);
+        //...
+    }
+    ```
+
+
+## 示例说明
+
+本示例示仅范了如何导入C++的API，并在创建出一个与C++对象对应的JS对象，还需要在执行函数中执行`js_example_rect_init`
+
+```C++
+#include <rtthread.h>
+#include <jerry_util.h>
+
+/*自定义C++类*/
+class Rectangle
+{
+   private:
+        int length;
+        int width;
+   
+   public:
+        Rectangle(int length,int width);
+        int getSize();
+        int getLength();
+        int getWidth();
+};
+
+Rectangle::Rectangle(int length,int width)
+{
+    this->length = length;
+    this->width = width;
+}
+
+int Rectangle::getSize()
+{
+    return (this->length * this->width);
+}
+
+int Rectangle::getLength()
+{
+    return this->length;
+}
+
+int Rectangle::getWidth()
+{
+    return this->width;
+}
+/**********/
+
+void rectangle_free_callback(void *native_p)
+{
+    Rectangle* rect = (Rectangle*)native_p;
+    delete(rect);
+}
+
+const static jerry_object_native_info_t rectangle_info =
+{
+    rectangle_free_callback //当js_rect对象释放后，调用该回调函数
+};
+
+DECLARE_HANDLER(getSize)
+{
+    void *native_pointer = RT_NULL;
+    jerry_get_object_native_pointer(this_value,&native_pointer,RT_NULL);    //获取当前对象中的native_pointer
+    
+    if(native_pointer)
+    {
+        /*调用C++对象的API，并将其返回值转换成JS对象*/
+        Rectangle* rectangle = (Rectangle*)native_pointer;
+        jerry_value_t js_size = jerry_create_number(rectangle->getSize());
+        return js_size;
+    }
+    return jerry_create_undefined();
+}
+
+DECLARE_HANDLER(getLength)
+{
+    void *native_pointer = RT_NULL;
+    jerry_get_object_native_pointer(this_value,&native_pointer,RT_NULL);    //获取当前对象中的native_pointer
+    
+    if(native_pointer)
+    {
+        /*调用C++对象的API，并将其返回值转换成JS对象*/
+        Rectangle* rectangle = (Rectangle*)native_pointer;
+        jerry_value_t js_length = jerry_create_number(rectangle->getLength());
+        return js_length;
+    }
+    return jerry_create_undefined();
+}
+
+DECLARE_HANDLER(getWidth)
+{
+    void *native_pointer = RT_NULL;
+    jerry_get_object_native_pointer(this_value,&native_pointer,RT_NULL);     //获取当前对象中的native_pointer
+    
+    if(native_pointer)
+    {
+        /*调用C++对象的API，并将其返回值转换成JS对象*/
+        Rectangle* rectangle = (Rectangle*)native_pointer;
+        jerry_value_t js_width = jerry_create_number(rectangle->getWidth());
+        return js_width;
+    }
+    return jerry_create_undefined();
+}
+
+DECLARE_HANDLER(rectangle)
+{
+    /*入参判断*/
+    if(args_cnt !=2 || !jerry_value_is_number(args[0]) || !jerry_value_is_number(args[1]))
+        return jerry_create_undefined();
+    
+    jerry_value_t js_rect = jerry_create_object(); //创建JS对象 js_rect
+    
+    Rectangle* rectangle = new Rectangle(jerry_get_number_value(args[0]),jerry_get_number_value(args[1]));      //创建C++对象 rectangle
+
+    jerry_set_object_native_pointer(js_rect, rectangle,&rectangle_info);    //把js_rect的native_pointer指向rectangle
+    
+    /*调用rectangle的API，并把其返回值转换成JS对象*/
+    jerry_value_t js_length = jerry_create_number(rectangle->getLength());      
+    jerry_value_t js_width = jerry_create_number(rectangle->getWidth());
+    
+    /*把js_length 和 js_width设置成js_rect的属性，类Rectangle中lenght与width为私有变量，如要JS对象与C++对象保持对应，此处代码可注释掉*/
+    js_set_property(js_rect,"length",js_length);
+    js_set_property(js_rect,"width",js_width);
+    
+    jerry_release_value(js_length);
+    jerry_release_value(js_width);
+    
+    REGISTER_METHOD(js_rect,getSize);       //为js_retc注册一个方法getSize
+    REGISTER_METHOD(js_rect,getLength);     //为js_retc注册一个方法getLength
+    REGISTER_METHOD(js_rect,getWidth);      //为js_retc注册一个方法getWidth
+    return js_rect;
+}
+
+extern "C"
+{
+    int js_example_rect_init(jerry_value_t obj)
+    {
+        REGISTER_METHOD(obj, rectangle); //为指定对象obj注册一个方法rectangle_init，这个对象可以是global_obj
+        return 0;
+    }
+}
+
+```

examples/ImportCplusplus/SConscript

@@ -0,0 +1,11 @@
+from building import *
+
+cwd = GetCurrentDir()
+
+src = Glob('*.cpp')
+
+CPPPATH = [cwd]
+
+group = DefineGroup('JerryScript', src, depend = ['PKG_USING_JERRYSCRIPT'], CPPPATH = CPPPATH)
+
+Return('group')

examples/ImportModule/README.md

@@ -0,0 +1,115 @@
+# 如何添加builtin module
+
+由于JerryScript是一款轻量级的JavaScript的引擎，因此它没有直接提供常见的builtin module。但是开发者可以根据自身需求，去添加相应module。
+
+阅读本文档前，请先阅读[ImportCplusplus](../ImportCplusplus/README.md)。
+
+## 添加builtin module
+
+当相应module的入口建立好后，只需要使用以下finsh命令即可:
+
+```
+JS_MODULE(NAME, MODULE_INIT)    //NAME ： module的名称 , MODULE_INIT ： module的入口函数
+```
+
+示例代码：
+```C
+jerry_value_t myModule_init(void)
+{
+
+    jerry_value_t obj = jerry_create_object();
+    // ...
+    // do something
+    // ...
+    return obj;
+}
+
+JS_MODULE(myModule,myModule_init);
+```
+以上代码就在JerryScript中创建里一个名为`myModule`的module，其返回值为`obj`。
+
+在JS脚本中，我们都是通过以下方式调用module的。
+
+```JavaScript
+var mqtt = require('myModule')
+```
+
+## 示例说明
+
+本示例示范了如何添加builtin module。
+
+```C
+#include <rtthread.h>
+#include <jerry_util.h>
+
+struct circle_t
+{
+    double radius;
+};
+
+void circle_free_callback(void *native_p)
+{
+    struct circle_t* circle = (struct circle_t*)native_p;   
+    free(circle);
+}
+
+const static jerry_object_native_info_t circle_info =
+{
+    circle_free_callback    //当js_circle对象释放后，调用该回调函数
+};
+
+DECLARE_HANDLER(setRadius)
+{
+    /*入参判断*/
+    if(args_cnt!=1 || !jerry_value_is_number(args[0]))
+        return jerry_create_undefined();
+    
+    void* native_pointer = RT_NULL;
+    jerry_get_object_native_pointer(this_value,&native_pointer,RT_NULL);    //获取当前对象中的native_pointer
+    
+    if(native_pointer)
+    {
+        circle_t* circle = (circle_t*)native_pointer;
+        
+        double r = jerry_get_number_value(args[0]);
+        circle->radius = r;
+    }
+    
+    return jerry_create_undefined();
+};
+
+DECLARE_HANDLER(getRadius)
+{
+    if(args_cnt != 0)
+        return jerry_create_undefined();
+    
+    void* native_pointer = RT_NULL;
+    jerry_get_object_native_pointer(this_value,&native_pointer,RT_NULL);
+    
+    if(native_pointer)
+    {
+        circle_t* circle = (circle_t*)native_pointer;
+        
+        jerry_value_t js_radius = jerry_create_number(circle->radius);  //获取circle->radius，并将其返回值转换成JS对象
+        return js_radius;
+    }
+    
+    return jerry_create_undefined();
+};
+
+jerry_value_t Circle_init()
+{
+    jerry_value_t js_circle = jerry_create_object();
+    
+    circle_t* circle = (circle_t*)malloc(sizeof(circle_t));
+    memset(circle,0,sizeof(circle_t));
+    
+    jerry_set_object_native_pointer(js_circle,circle,&circle_info);     //把js_circle的native_pointer指向circle
+
+    REGISTER_METHOD(js_circle,setRadius);   //为js_circle注册一个方法 setRadius
+    REGISTER_METHOD(js_circle,getRadius);   //为js_circle注册一个方法 getRadius
+    return js_circle;
+}
+
+JS_MODULE(Circle,Circle_init); //注册builtin module，名称：Circle,入口函数：Circle_init
+```

examples/ImportModule/SConscript

@@ -0,0 +1,11 @@
+from building import *
+
+cwd = GetCurrentDir()
+
+src = Glob('*.c')
+
+CPPPATH = [cwd]
+
+group = DefineGroup('JerryScript', src, depend = ['PKG_USING_JERRYSCRIPT'], CPPPATH = CPPPATH)
+
+Return('group')

examples/ImportModule/example_addModule.c

@@ -0,0 +1,72 @@
+#include <rtthread.h>
+#include <jerry_util.h>
+
+struct circle_t
+{
+    double radius;
+};
+
+void circle_free_callback(void *native_p)
+{
+    struct circle_t* circle = (struct circle_t*)native_p;
+    free(circle);
+}
+
+const static jerry_object_native_info_t circle_info =
+{
+    circle_free_callback
+};
+
+DECLARE_HANDLER(setRadius)
+{
+    if(args_cnt!=1 || !jerry_value_is_number(args[0]))
+        return jerry_create_undefined();
+    
+    void* native_pointer = RT_NULL;
+    jerry_get_object_native_pointer(this_value,&native_pointer,RT_NULL);
+    
+    if(native_pointer)
+    {
+        struct circle_t* circle = (struct circle_t*)native_pointer;
+        
+        double r = jerry_get_number_value(args[0]);
+        circle->radius = r;
+    }
+    
+    return jerry_create_undefined();
+};
+
+DECLARE_HANDLER(getRadius)
+{
+    if(args_cnt != 0)
+        return jerry_create_undefined();
+    
+    void* native_pointer = RT_NULL;
+    jerry_get_object_native_pointer(this_value,&native_pointer,RT_NULL);
+    
+    if(native_pointer)
+    {
+        struct circle_t* circle = (struct circle_t*)native_pointer;
+       
+        jerry_value_t js_radius = jerry_create_number(circle->radius);
+        return js_radius;
+    }
+    
+    return jerry_create_undefined();
+};
+
+jerry_value_t Circle_init()
+{
+    jerry_value_t js_circle = jerry_create_object();
+    
+    struct circle_t* circle = (struct circle_t*)malloc(sizeof(struct circle_t));
+    memset(circle,0,sizeof(struct circle_t));
+    
+    jerry_set_object_native_pointer(js_circle,circle,&circle_info);
+
+    REGISTER_METHOD(js_circle,setRadius);
+    REGISTER_METHOD(js_circle,getRadius);
+    return js_circle;
+}
+
+JS_MODULE(Circle,Circle_init);

examples/SConscript

@@ -0,0 +1,12 @@
+import os
+from building import *
+
+objs = []
+cwd  = GetCurrentDir()
+list = os.listdir(cwd)
+
+for item in list:
+    if os.path.isfile(os.path.join(cwd, item, 'SConscript')):
+        objs = objs + SConscript(os.path.join(item, 'SConscript'))
+
+Return('objs')

examples/jerry_example_addModule.cpp

@@ -1,65 +0,0 @@
-#include <rtthread.h>
-#include <jerry_util.h>
-
-class Circle
-{
-    private:
-        int radius ;
-    public:
-        Circle(int radius);
-        int getRadius();
-        float getCircumference();
-};
-
-Circle::Circle(int radius)
-{
-    this->radius = radius;
-}
-
-int Circle::getRadius()
-{
-    return this->radius;
-}
-
-float Circle::getCircumference()
-{
-    return (2 * 3.1415 *this->radius);
-}
-
-void circle_free_callback(void *native_p)
-{
-    Circle* rect = (Circle*)native_p;
-    delete(rect);
-}
-
-const static jerry_object_native_info_t circle_info =
-{
-    circle_free_callback
-};
-
-DECLARE_HANDLER(getCircumference)
-{
-    void* native_pointer = RT_NULL;
-    jerry_get_object_native_pointer(this_value,&native_pointer,RT_NULL);
-    if(native_pointer)
-    {
-        Circle* circle = (Circle*)native_pointer;
-        jerry_value_t js_circumference = jerry_create_number(circle->getCircumference());
-        return js_circumference;
-    }
-    return jerry_create_undefined();
-};
-
-jerry_value_t Circle_init()
-{
-    jerry_value_t js_circle = jerry_create_object();
-    Circle* circle = new Circle(5);
-    jerry_set_object_native_pointer(js_circle,circle,&circle_info);
-    jerry_value_t js_radius = jerry_create_number(circle->getRadius());
-    js_set_property(js_circle,strdup("radius"),js_radius);
-    jerry_release_value(js_radius);
-    REGISTER_METHOD(js_circle,getCircumference);
-    return js_circle;
-}
-
-JS_MODULE(Circle,Circle_init);