From 0a7758625edc451bf9c8df4470b89335d2e09c3e Mon Sep 17 00:00:00 2001 From: xicilion Date: Fri, 1 Jun 2018 22:23:36 +0800 Subject: [PATCH 1/5] check build error. --- fibos_build | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/fibos_build b/fibos_build index cfc1647..cc71105 100644 --- a/fibos_build +++ b/fibos_build @@ -103,6 +103,9 @@ cd eos sed "s/\.git/docs/g;" eosio_build.sh | sh # sed "s/\.git/docs/g;s/=Release/=Debug/g" eosio_build.sh | sh +if [ $? != 0 ]; then + exit 1 +fi cd .. cd fibjs @@ -112,6 +115,9 @@ if [ ! "$BUILD_JOBS" = "" ]; then else sh build -j fi +if [ $? != 0 ]; then + exit 1 +fi if [ ! -e "${OUT_PATH}" ]; then mkdir "${OUT_PATH}" From 991f52e90614c2897e7ad6d3f5409905206b79d0 Mon Sep 17 00:00:00 2001 From: xicilion Date: Wed, 6 Jun 2018 03:09:41 +0800 Subject: [PATCH 2/5] add include path of eos module. --- CMakeLists.txt | 48 +++++++++++++++++++++++++++-------- eos | 2 +- fibjs | 2 +- fibos_build | 7 ++--- src/fibos.cpp | 69 +++++++++++++++++++------------------------------- 5 files changed, 68 insertions(+), 60 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 9fdf41b..4a13dfe 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -4,7 +4,8 @@ include(tools/arch.cmake) include(tools/os.cmake) include(tools/subdirs.cmake) -project(fibos) +set(appname fibos) +project(${appname}) find_program(CCACHE_FOUND ccache) if(CCACHE_FOUND) @@ -13,10 +14,11 @@ if(CCACHE_FOUND) endif(CCACHE_FOUND) file(GLOB_RECURSE src_list "src/*.c*") -add_executable(fibos ${src_list}) +add_executable(${appname} ${src_list}) set(BIN_DIR ${PROJECT_SOURCE_DIR}/bin/${OS}_${ARCH}_${BUILD_TYPE}) set(FIBJS_DIR ${PROJECT_SOURCE_DIR}/fibjs/bin/${OS}_${ARCH}_${BUILD_TYPE}) +set(EOS_DIR ${PROJECT_SOURCE_DIR}/eos) set(EXECUTABLE_OUTPUT_PATH ${BIN_DIR}) include(CheckIncludeFiles) @@ -33,23 +35,23 @@ check_c_source_compiles("void posix_spawnp(); __asm__(\".symver posix_spawnp,posix_spawnp@GLIBC_2.2\"); void main(void){posix_spawnp();}" HAVE_GLIB_C_22_H) -set(flags "-fsigned-char -fmessage-length=0 -fdata-sections -ffunction-sections -fno-exceptions -D_FILE_OFFSET_BITS=64") -set(ccflags "-std=c++11") +set(flags "-fsigned-char -fmessage-length=0 -fdata-sections -ffunction-sections -D_FILE_OFFSET_BITS=64") +set(ccflags "-std=c++14") set(link_flags " ") if(${OS} STREQUAL "Darwin") set(link_flags "${link_flags} -mmacosx-version-min=10.9 -framework Carbon -framework IOKit") set(flags "${flags} -mmacosx-version-min=10.9") - target_link_libraries(fibos dl iconv stdc++) + target_link_libraries(${appname} dl iconv stdc++) endif() if(${OS} STREQUAL "Linux") - target_link_libraries(fibos dl rt) + target_link_libraries(${appname} dl rt) endif() if(${OS} STREQUAL "FreeBSD") find_library(execinfo execinfo "/usr/local/lib" "/usr/lib") - target_link_libraries(fibos ${execinfo}) + target_link_libraries(${appname} ${execinfo}) endif() if(${BUILD_TYPE} STREQUAL "release") @@ -84,12 +86,38 @@ set(CMAKE_CXX_FLAGS "${flags} ${ccflags}") include_directories("${PROJECT_SOURCE_DIR}/include" "${PROJECT_SOURCE_DIR}/fibjs/fibjs/include" "${PROJECT_SOURCE_DIR}/fibjs/vender" "${PROJECT_SOURCE_DIR}/fibjs/vender/v8" "${PROJECT_SOURCE_DIR}/fibjs/vender/v8/include" "${PROJECT_SOURCE_DIR}/fibjs/vender/mbedtls" "${PROJECT_SOURCE_DIR}/fibjs/vender/zlib/include" "${CMAKE_CURRENT_BINARY_DIR}") +MACRO(EOSLIBS dir) + file(GLOB eos_libs "${dir}/*") + foreach(eos_lib ${eos_libs}) + if(IS_DIRECTORY "${eos_lib}/include") + include_directories("${eos_lib}/include") + endif() + endforeach() +ENDMACRO() + +EOSLIBS("${EOS_DIR}/plugins") +EOSLIBS("${EOS_DIR}/libraries") +EOSLIBS("${EOS_DIR}/build/libraries") +include_directories("${EOS_DIR}/libraries/softfloat/source/include") + +if (APPLE) + set(OPENSSL_ROOT_DIR "/usr/local/opt/openssl") + set(OPENSSL_INCLUDE_DIR "/usr/local/opt/openssl/include") +elseif(UNIX AND NOT APPLE) + set(OPENSSL_ROOT_DIR "/usr/include/openssl") + set(OPENSSL_INCLUDE_DIR "/usr/include/openssl/include") +else() + message(FATAL_ERROR "openssl not found and don't know where to look, please specify OPENSSL_ROOT_DIR") +endif() + +include_directories("${OPENSSL_INCLUDE_DIR}") + set(libs fibjs expat gumbo gd tiff jpeg png webp zlib leveldb snappy ev pcre sqlite mongo umysql uuid exif mbedtls v8 zmq unzip editline exlib) foreach(lib ${libs}) - target_link_libraries(fibos "${FIBJS_DIR}/lib${lib}.a") + target_link_libraries(${appname} "${FIBJS_DIR}/lib${lib}.a") endforeach() -target_link_libraries(fibos pthread) +target_link_libraries(${appname} pthread boost_system) -set_target_properties(fibos PROPERTIES LINK_FLAGS ${link_flags}) +set_target_properties(${appname} PROPERTIES LINK_FLAGS ${link_flags}) diff --git a/eos b/eos index e22c9bd..8432531 160000 --- a/eos +++ b/eos @@ -1 +1 @@ -Subproject commit e22c9bda6c4735cc6c6e8b2c8faf784d97117756 +Subproject commit 8432531941da605cf542d3efc602dd40880279e8 diff --git a/fibjs b/fibjs index 545c9be..85b3d19 160000 --- a/fibjs +++ b/fibjs @@ -1 +1 @@ -Subproject commit 545c9bed902ec037c5690c374b09fec26fd107a9 +Subproject commit 85b3d19d2adeeced17d4090251fe01b618291320 diff --git a/fibos_build b/fibos_build index cc71105..07c3d6b 100644 --- a/fibos_build +++ b/fibos_build @@ -100,16 +100,14 @@ if [ ${BUILD_TYPE} = 'clean' ]; then fi cd eos - sed "s/\.git/docs/g;" eosio_build.sh | sh # sed "s/\.git/docs/g;s/=Release/=Debug/g" eosio_build.sh | sh if [ $? != 0 ]; then exit 1 fi - cd .. -cd fibjs +cd fibjs if [ ! "$BUILD_JOBS" = "" ]; then sh build -j${BUILD_JOBS} else @@ -118,6 +116,7 @@ fi if [ $? != 0 ]; then exit 1 fi +cd .. if [ ! -e "${OUT_PATH}" ]; then mkdir "${OUT_PATH}" @@ -176,8 +175,6 @@ bldred=${txtbld}$(tput setaf 1) txtrst=$(tput sgr0) printf "\n\n${bldred}" - - printf "\t _______ _________ ______ _______ _______\n" printf "\t( ____ \\\\\\__ __/( ___ \\ ( ___ )( ____ \\\\\n" printf "\t| ( \\/ ) ( | ( ) )| ( ) || ( \\/\n" diff --git a/src/fibos.cpp b/src/fibos.cpp index 2da07b5..9003894 100644 --- a/src/fibos.cpp +++ b/src/fibos.cpp @@ -8,6 +8,30 @@ #include "fibjs.h" #include "object.h" +#include + +#include +#include +#include +#include +#include +#include + +#include +#include +#include + +#include +#include + +using namespace appbase; +using namespace eosio; +using namespace fibjs; + +namespace fc { +std::unordered_map& get_appender_map(); +} + namespace fibjs { void importModule() @@ -55,56 +79,15 @@ void importModule() IMPORT_MODULE(zip); IMPORT_MODULE(zlib); IMPORT_MODULE(zmq); - -#ifdef _WIN32 - IMPORT_MODULE(gui); - IMPORT_MODULE(registry); -#endif +} } -void main(int32_t argc, char** argv) +int32_t main(int32_t argc, char* argv[]) { importModule(); start(argc, argv, main_fiber); run_gui(); -} -} -#ifdef _WIN32 - -#ifdef _CONSOLE -int32_t main() -#else -int CALLBACK WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine, int nCmdShow) -#endif -{ - int32_t argc; - char** argv; - - LPWSTR* szArglist = CommandLineToArgvW(GetCommandLineW(), &argc); - std::vector strArgList; - std::vector ptrArgList; - int32_t i; - - strArgList.resize(argc); - ptrArgList.resize(argc); - for (i = 0; i < argc; i++) { - strArgList[i] = fibjs::utf16to8String(szArglist[i]); - ptrArgList[i] = strArgList[i].c_buffer(); - } - - argv = ptrArgList.data(); - - fibjs::main(argc, argv); - return 0; -} - -#else - -int32_t main(int32_t argc, char* argv[]) -{ - fibjs::main(argc, argv); return 0; } -#endif From 687bd418816724cbaca0aeba8fefb82320125a2a Mon Sep 17 00:00:00 2001 From: xicilion Date: Wed, 6 Jun 2018 17:52:39 +0800 Subject: [PATCH 3/5] link eos&fibjs libraries. --- CMakeLists.txt | 13 ++++++++++--- eos | 2 +- fibjs | 2 +- src/fibos.cpp | 10 +++++----- 4 files changed, 17 insertions(+), 10 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 4a13dfe..71723d7 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -102,15 +102,22 @@ include_directories("${EOS_DIR}/libraries/softfloat/source/include") if (APPLE) set(OPENSSL_ROOT_DIR "/usr/local/opt/openssl") - set(OPENSSL_INCLUDE_DIR "/usr/local/opt/openssl/include") elseif(UNIX AND NOT APPLE) set(OPENSSL_ROOT_DIR "/usr/include/openssl") - set(OPENSSL_INCLUDE_DIR "/usr/include/openssl/include") else() message(FATAL_ERROR "openssl not found and don't know where to look, please specify OPENSSL_ROOT_DIR") endif() -include_directories("${OPENSSL_INCLUDE_DIR}") +include_directories("${OPENSSL_ROOT_DIR}/include") + +file(GLOB_RECURSE eos_alist "eos/*.a") +target_link_libraries(${appname} ${eos_alist}) + +link_directories(${LLVM_LIBRARY_DIR}) +file(GLOB openssl_alist "${OPENSSL_ROOT_DIR}/lib/*.a") +target_link_libraries(${appname} ${openssl_alist}) + +target_link_libraries(${appname} llvm boost_iostreams boost_date_time boost_chrono boost_program_options boost_filesystem boost_system secp256k1) set(libs fibjs expat gumbo gd tiff jpeg png webp zlib leveldb snappy ev pcre sqlite mongo umysql uuid exif mbedtls v8 zmq unzip editline exlib) diff --git a/eos b/eos index 8432531..379cb1a 160000 --- a/eos +++ b/eos @@ -1 +1 @@ -Subproject commit 8432531941da605cf542d3efc602dd40880279e8 +Subproject commit 379cb1a9e2a6557221d946eef4c5c83ddd156799 diff --git a/fibjs b/fibjs index 85b3d19..4152310 160000 --- a/fibjs +++ b/fibjs @@ -1 +1 @@ -Subproject commit 85b3d19d2adeeced17d4090251fe01b618291320 +Subproject commit 415231013957ac1ad9b41c7711650d064979099d diff --git a/src/fibos.cpp b/src/fibos.cpp index 9003894..28dbf2f 100644 --- a/src/fibos.cpp +++ b/src/fibos.cpp @@ -26,14 +26,12 @@ using namespace appbase; using namespace eosio; -using namespace fibjs; namespace fc { std::unordered_map& get_appender_map(); } namespace fibjs { - void importModule() { IMPORT_MODULE(assert); @@ -84,10 +82,12 @@ void importModule() int32_t main(int32_t argc, char* argv[]) { - importModule(); + fibjs::importModule(); + + fibjs::start(argc, argv, fibjs::main_fiber); + fibjs::run_gui(); - start(argc, argv, main_fiber); - run_gui(); + app().register_plugin(); return 0; } From 98f0da62ecd5ceae8cb8342bc102396657d13664 Mon Sep 17 00:00:00 2001 From: xicilion Date: Sat, 9 Jun 2018 23:26:05 +0800 Subject: [PATCH 4/5] fix link error of llvm. --- CMakeLists.txt | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 71723d7..1ec0866 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -113,11 +113,14 @@ include_directories("${OPENSSL_ROOT_DIR}/include") file(GLOB_RECURSE eos_alist "eos/*.a") target_link_libraries(${appname} ${eos_alist}) -link_directories(${LLVM_LIBRARY_DIR}) +find_package(LLVM 4.0 REQUIRED CONFIG) +llvm_map_components_to_libnames(LLVM_LIBS support core passes mcjit native DebugInfoDWARF) +target_link_libraries(${appname} ${LLVM_LIBS}) + file(GLOB openssl_alist "${OPENSSL_ROOT_DIR}/lib/*.a") target_link_libraries(${appname} ${openssl_alist}) -target_link_libraries(${appname} llvm boost_iostreams boost_date_time boost_chrono boost_program_options boost_filesystem boost_system secp256k1) +target_link_libraries(${appname} boost_iostreams boost_date_time boost_chrono boost_program_options boost_filesystem boost_system secp256k1) set(libs fibjs expat gumbo gd tiff jpeg png webp zlib leveldb snappy ev pcre sqlite mongo umysql uuid exif mbedtls v8 zmq unzip editline exlib) From cd72509c1724060d8b8499f2b4fac957f964d0cc Mon Sep 17 00:00:00 2001 From: Yuanhang Date: Mon, 8 Apr 2019 10:51:14 +0800 Subject: [PATCH 5/5] idl: add zh-cn idl to this repo --- idl/zh-cn/DBIterator.idl | 86 +++++ idl/zh-cn/Table.idl | 110 ++++++ idl/zh-cn/action.idl | 131 ++++++++ idl/zh-cn/bc_buffer.idl | 702 +++++++++++++++++++++++++++++++++++++++ idl/zh-cn/bc_console.idl | 261 +++++++++++++++ idl/zh-cn/bc_crypto.idl | 76 +++++ idl/zh-cn/bc_db.idl | 91 +++++ idl/zh-cn/collect.json | 4 + idl/zh-cn/fibos.idl | 339 +++++++++++++++++++ idl/zh-cn/trans.idl | 63 ++++ 10 files changed, 1863 insertions(+) create mode 100644 idl/zh-cn/DBIterator.idl create mode 100644 idl/zh-cn/Table.idl create mode 100644 idl/zh-cn/action.idl create mode 100644 idl/zh-cn/bc_buffer.idl create mode 100644 idl/zh-cn/bc_console.idl create mode 100644 idl/zh-cn/bc_crypto.idl create mode 100644 idl/zh-cn/bc_db.idl create mode 100644 idl/zh-cn/collect.json create mode 100644 idl/zh-cn/fibos.idl create mode 100644 idl/zh-cn/trans.idl diff --git a/idl/zh-cn/DBIterator.idl b/idl/zh-cn/DBIterator.idl new file mode 100644 index 0000000..58cdfd3 --- /dev/null +++ b/idl/zh-cn/DBIterator.idl @@ -0,0 +1,86 @@ +/*! @brief + multi index DBIterator 对象 + */ + +interface DBIterator : object +{ + /*! @brief 判断数据是否为首数据 + 实例: + ```JavaScript + exports.hi1 = v => { + var players = db.players(action.account, action.account); + var itr = players.find(v); + console.log(itr.is_begin()); + }； + ``` + */ + Boolean is_begin(); + + /*! @brief 判断数据是否为尾数据 + 实例: + ```JavaScript + exports.hi1 = v => { + var players = db.players(action.account, action.account); + var itr = players.find(v); + console.log(itr.is_end()); + }； + ``` + */ + Boolean is_end(); + + /*! @brief 获取下一个数据 + 实例: + ```JavaScript + exports.hi1 = v => { + var players = db.players(action.account, action.account); + var itr = players.find(v); + var itr1 = itr.next(); + console.log(itr1.toJSON()); + }； + ``` + */ + DBIterator next(); + + /*! @brief 获取上一个数据 + 实例: + ```JavaScript + exports.hi1 = v => { + var players = db.players(action.account, action.account); + var itr = players.find(v); + var itr1 = itr.next(); + var itr2 = itr1.previous(); + console.log(itr2.toJSON()); + }； + ``` + */ + DBIterator previous(); + + /*! @brief 删除数据 + 实例: + ```JavaScript + exports.hi1 = v => { + var players = db.players(action.account, action.account); + var itr = players.find(v); + itr.remove(); + }； + ``` + */ + remove(); + + /*! @brief 更新数据 + 实例: + ```JavaScript + exports.hi1 = v => { + var players = db.players(action.account, action.account); + var itr = players.find(v); + itr.data.age = 18; + itr.update(action.account); + }； + ``` + @param payer 为此次操作支付 RAM 的账户 + */ + update(String payer); + + /*! @brief 查询当前数据，返回所有数据对象，每个数据是一个新的 DBIterator 对象 */ + readonly Object data; +}; \ No newline at end of file diff --git a/idl/zh-cn/Table.idl b/idl/zh-cn/Table.idl new file mode 100644 index 0000000..74a0f8e --- /dev/null +++ b/idl/zh-cn/Table.idl @@ -0,0 +1,110 @@ +/*! @brief + multi index table 对象 + */ + +interface Table : object +{ + /*! @brief table 名 + */ + readonly String name; + + /*! @brief 指向合约发布者的名称 + */ + readonly String code; + + /*! @brief table 中数据所属的 account_name + */ + readonly String scope; + + /*! @brief 向 table 存入新数据 + 实例： + ```JavaScript + exports.hi = v => { + var players = db.players(action.account, action.account); + players.emplace(action.account, { + title: "ceo", + age:48, + nickname:"lion1", + id:123 + }); + }; + ``` + @param payer 为此次操作付费的账户 + @param val 将要存入到 table 的值 + */ + emplace(String payer, Object val); + + /*! @brief 从 table 查找数据 + 实例: + ```JavaScript + exports.hi = v => { + var players = db.players(action.account, action.account); + console.log(players.find(v).data) + }; + ``` + @param id 查询的参数 + */ + DBIterator find(Value id); + + /*! @brief 生成自增主键 + 实例: + ```JavaScript + exports.hi = v => { + var players = db.players(action.account, action.account); + console.log(players.get_primary_key()) + }; + ``` + */ + Value get_primary_key(); + + /*! @brief 获取 Table 的 begin + 实例: + ```JavaScript + exports.hi = v => { + var players = db.players(action.account, action.account); + console.log(players.begin()) + }; + ``` + */ + DBIterator begin(); + + /*! @brief 获取 Table 的 end + 实例: + ```JavaScript + exports.hi = v => { + var players = db.players(action.account, action.account); + console.log(players.end().is_end(), players.end().previous().data); + }; + ``` + */ + DBIterator end(); + + /*! @brief 从 table 查找小于参数结果 + 实例: + ```JavaScript + exports.hi1 = v => { + var players = db.players1(action.account, action.account); + var data = players.lowerbound(123); + console.log(data.data, data1.data); + }; + ``` + @param id 查询的参数 + */ + DBIterator lowerbound(Value id); + + /*! @brief 从 table 查找大于参数结果 + 实例: + ```JavaScript + exports.hi1 = v => { + var players = db.players1(action.account, action.account); + var data1 = players.upperbound(123); + console.log(data.data, data1.data); + }; + ``` + @param id 查询的参数 + */ + DBIterator upperbound(Value id); + + /*! @brief 查询当前索引，返回所有索引对象，每个索引是一个新的 Table 对象 */ + readonly Object indexes; +}; \ No newline at end of file diff --git a/idl/zh-cn/action.idl b/idl/zh-cn/action.idl new file mode 100644 index 0000000..f02b964 --- /dev/null +++ b/idl/zh-cn/action.idl @@ -0,0 +1,131 @@ +/*! @brief action 对象 + 使用方法：在 fibos 的 js 合约中使用 + ```JavaScript + var js_code = `exports.hi = v => console.error(action.is_account(action.account), action.is_account("notexists"));`; + fibos.setcodeSync(name, 0, 0, fibos.compileCode(js_code)); + ``` + */ + +module action { + /*! @brief action 名称 + 实例： + ```JavaScript + exports.hi = v => { + console.log(action.name) + }; + ``` + */ + static readonly String name; + + /*! @brief action 发送者的账户名 + 实例： + ```JavaScript + exports.hi = v => { + console.log(action.account) + }; + ``` + */ + static readonly String account; + + /*! @brief action 接收者 + 实例： + ```JavaScript + exports.hi = v => { + console.log(action.receiver) + }; + ``` + */ + static readonly String receiver; + + /*! @brief 返回从1970年1月1日0时0分0秒（UTC，即协调世界时）距离出块时间的毫秒数。 + 实例： + ```JavaScript + exports.hi = v => { + console.log(action.publication_time) + }; + ``` + */ + static readonly Long publication_time; + + /*! @brief 执行该 action 需要得到数组中所有账户的授权 + 实例： + ```JavaScript + exports.hi = v => { + console.log(action.authorization) + }; + ``` + */ + static readonly Array authorization; + + /*! @brief 该 action 所在 transaction 的哈希 id + 实例： + ```JavaScript + exports.hi = v => { + console.log(action.id) + }; + ``` + */ + static readonly String id; + + /*! @brief 判断账户是否存在 + 实例： + ```JavaScript + exports.hi = v => { + if(action.is_account(account)) console.notice("account exists"); + else console.error("account notexists") + }; + ``` + @param name 账户名 + @return 账户存在则返回 true，不存在返回 false + */ + static Boolean is_account(String name); + + /*! @brief action 执行成后，名为 name 的账号是否会收到通知 + 实例： + ```JavaScript + exports.hi = v => { + if(action.has_recipient(receiver)) console.notice("action received") + else console.error("action not received"); + }; + ``` + @param name 账户名 + @return 若名为 name 的账户会收到通知则返回 true，否则返回 false + */ + static Boolean has_recipient(String name); + + + /*! @brief 向通知列表增加特定账号 + 实例： + ```JavaScript + exports.hi = v => { + action.require_recipient(action.receiver); + }; + ``` + @param name 账户名 + */ + static require_recipient(String name); + + /*! @brief 验证 action 是否需要特定账户的授权 + 实例： + ```JavaScript + exports.hi = v => { + if(action.has_auth(account)) console.notice("action be authed") + }; + ``` + @param name 待验证的账号名 + @return 需要该账户授权则返回 true，否则返回 false + */ + static Boolean has_auth(String name); + + /*! @brief 向 action 的授权列表中添加特定账户及对应的权限，若添加失败则会抛出异常 + 实例： + ```JavaScript + exports.hi = v => { + if(action.require_auth(account)) console.notice("auth success") + }; + ``` + @param name 待验证的账号名 + @param permission 需要该账户授权的权限 + */ + static require_auth(String name, String permission = ""); +}; \ No newline at end of file diff --git a/idl/zh-cn/bc_buffer.idl b/idl/zh-cn/bc_buffer.idl new file mode 100644 index 0000000..d852d2d --- /dev/null +++ b/idl/zh-cn/bc_buffer.idl @@ -0,0 +1,702 @@ +/*! @brief 二进制数据缓存对象，用于 io 读写的数据处理 + + Buffer 对象为全局基础类，在任何时候都可以直接以 new Buffer(...) 创建： + ```JavaScript + var buf = new Buffer(); + ``` + */ +interface bc_buffer +{ + /*! @brief 缓存对象构造函数 + ```JavaScript + exports.hi = v => { + var buf = new Buffer([0x31, 0x32, 0x33, 0x34]) + console.log(buf.toString()); + } + ``` + @param datas 初始化数据数组 + */ + Buffer(Array datas); + + /*! @brief 缓存对象构造函数 + ```JavaScript + exports.hi = v => { + var arr = new Uint16Array(2); + arr[0] = 5000; + arr[1] = 4000; + var buf = new Buffer(arr.buffer); + console.log(buf.hex()); + } + + ``` + @param datas 初始化数据数组 + */ + Buffer(ArrayBuffer datas); + + /*! @brief 缓存对象构造函数 + ```JavaScript + exports.hi = v => { + var arr = new Uint8Array(2); + arr[0] = 50; + arr[1] = 40; + var buf = new Buffer(arr); + console.log(buf.hex()); + + var arr = new Uint16Array(2); + arr[0] = 5000; + arr[1] = 4000; + var buf = new Buffer(arr); + console.log(buf.hex()); + + var arr = new Uint8Array([0x10, 0x20, 0x30]); + var arr1 = new Uint8Array(arr.buffer, 1, 2); + var buf = new Buffer(arr1); + console.log(buf.hex()); + } + ``` + @param datas 初始化数据数组 + */ + Buffer(TypedArray datas); + + /*! @brief 缓存对象构造函数 + ```JavaScript + exports.hi = v => { + var arr = new DataView(new ArrayBuffer(2)); + arr.setInt8(0, 0x10); + arr.setInt8(1, 0x20); + var buf = new Buffer(arr); + console.log(buf.hex()); + } + + ``` + @param datas 初始化数据数组 + */ + Buffer(ArrayBufferView datas); + + /*! @brief 缓存对象构造函数 + ```JavaScript + exports.hi = v => { + var buf = new Buffer(new Buffer("abcd")); + console.log(buf.toString()); + } + ``` + @param buffer 初始化Buffer对象 + */ + Buffer(Buffer buffer); + + /*! @brief 缓存对象构造函数 + ```JavaScript + exports.hi = v => { + var buf = new Buffer("abcd","utf8"); + console.log(buf.toString()); + } + ``` + @param str 初始化字符串，字符串将以 utf-8 格式写入，缺省则创建一个空对象 + @param codec 指定编码格式，允许值为："hex", "base64", "utf8", 或者系统支持的字符集 + */ + Buffer(String str, String codec = "utf8"); + + /*! @brief 缓存对象构造函数 + 实例: + ```JavaScript + exports.hi = v => { + var buf = new Buffer(100); + console.log(buf.length); + } + ``` + @param size 初始化缓冲区大小 + */ + Buffer(Integer size = 0); + + /*! @brief 检测给定的变量是否是 Buffer 对象 + 实例: + ```JavaScript + exports.hi = v => { + var buf = new Buffer("abcd"); + var str = "abcd" + console.log(Buffer.isBuffer(buf)); + console.log(Buffer.isBuffer(str)); + } + ``` + @param v 给定需要检测的变量 + @return 传入对象是否 Buffer 对象 + */ + static Boolean isBuffer(Value v); + + /*! @brief 通过其他 Buffer 创建 Buffer 对象 + 实例: + ```JavaScript + exports.hi = v => { + var buf = Buffer.from(new Buffer("abcd"), 1, 2); + console.log(buf.toString()); + } + ``` + @param buffer 给定 Buffer 类型变量用于创建 Buffer 对象 + @param byteOffset 指定数据起始位置，起始为 0 + @param length 指定数据长度，起始位 -1，表示剩余所有数据 + @return 返回 Buffer 实例 + */ + static Buffer from(Buffer buffer, Integer byteOffset = 0, Integer length = -1); + + /*! @brief 通过字符串创建 Buffer 对象 + 实例: + ```JavaScript + exports.hi = v => { + var buf = Buffer.from("abcd",0,2); + console.log(buf.toString()); + } + ``` + @param str 初始化字符串，字符串将以 utf-8 格式写入 + @param byteOffset 指定数据起始位置，起始为 0 + @param length 指定数据长度，起始位 -1，表示剩余所有数据 + @return 返回 Buffer 实例 + */ + static Buffer from(String str, Integer byteOffset = 0, Integer length = -1); + + /*! @brief 通过字符串创建 Buffer 对象 + 实例: + ```JavaScript + exports.hi = v => { + var buf = new Buffer("厉害！","utf8"); + console.log(buf.toString()); + } + ``` + @param str 初始化字符串，字符串将以 utf-8 格式写入，缺省则创建一个空对象 + @param codec 指定编码格式，允许值为："hex", "base64", "utf8", 或者系统支持的字符集 + @return 返回 Buffer 实例 + */ + static Buffer from(String str, String codec = "utf8"); + + /*! @brief 拼接多个缓存区中的数据 + 实例: + ```JavaScript + exports.hi = v => { + var buf1 = new Buffer("abcd"); + var buf2 = new Buffer("efg"); + var buf3 = new Buffer(); + var bufArray = [buf1]; + var bufRes = Buffer.concat(bufArray); + console.log(bufRes.toString()); + + bufArray = [buf1, buf2]; + bufRes = Buffer.concat(bufArray); + console.log(bufRes.toString()); + + bufRes = Buffer.concat(bufArray, 6); + console.log(bufRes.toString()); + + buf1 = new Buffer([0x31, 0x32, 0x33, 0x34]); + buf2 = new Buffer([0x35, 0x36, 0x37, 0x38]); + bufArray = [buf1, buf2]; + bufRes = Buffer.concat(bufArray); + console.log(bufRes.toString()); + + var buf2 = Buffer.concat([]); + console.log(buf2.length); + } + + ``` + @param buflist 待拼接的Buffer数组 + @param cutLength 截取多少个Buffer对象 + @return 拼接后产生的新 Buffer 对象 + */ + static Buffer concat(Array buflist, Integer cutLength = -1); + + /*! @brief 分配一个指定长度的新缓存区。如果大小为0，将创建一个零长度的缓存区。 + 实例: + ```JavaScript + exports.hi = v => { + var buf1 = Buffer.alloc(10, 0,"utf8"); + console.log(buf1.toString()); + } + + ``` + @param size 缓冲区的所需长度 + @param fill 预先填充新缓冲区的值，可使用 string/buffer/integer 值类型。 默认值：0 + @param codec 指定编码格式，允许值为："hex", "base64", "utf8", 或者系统支持的字符集 + @return 填充好的新 Buffer 对象 + */ + static Buffer alloc(Integer size, Integer fill = 0, String codec = "utf8"); + + /*! @brief 分配一个指定长度的新缓存区。如果大小为0，将创建一个零长度的缓存区。 + 实例: + ```JavaScript + exports.hi = v => { + var buf1 = Buffer.alloc(11, 'aGVsbG8gd29ybGQ=', 'base64'); + var buf2 = Buffer.alloc(16, 'aGVsbG8gd29ybGQ=', 'base64'); + console.log(buf1.toString()); + console.log(buf2.toString()); + } + + ``` + @param size 缓冲区的所需长度 + @param fill 预先填充新缓冲区的值，可使用 string/buffer/integer 值类型。 默认值：0 + @param codec 指定编码格式，允许值为："hex", "base64", "utf8", 或者系统支持的字符集 + @return 填充好的新 Buffer 对象 + */ + static Buffer alloc(Integer size, String fill = "", String codec = "utf8"); + + /*! @brief 分配一个指定长度的新缓存区。如果大小为0，将创建一个零长度的缓存区。 + 实例: + ```JavaScript + exports.hi = v => { + var buf1 = Buffer.alloc(11, new Buffer('aGVsbG8gd29ybGQ='), 'base64'); + var buf2 = Buffer.alloc(16, new Buffer('aGVsbG8gd29ybGQ='), 'base64'); + console.log(buf1.toString()); + console.log(buf2.toString()); + } + + ``` + @param size 缓冲区的所需长度 + @param fill 预先填充新缓冲区的值，可使用 string/buffer/integer 值类型。 默认值：0 + @param codec 指定编码格式，允许值为："hex", "base64", "utf8", 或者系统支持的字符集 + @return 填充好的新 Buffer 对象 + */ + static Buffer alloc(Integer size, Buffer fill, String codec = "utf8"); + + /*! @brief 分配一个指定长度的新缓存区。如果大小为0，将创建一个零长度的缓存区。 + 实例: + ```JavaScript + exports.hi = v => { + var buf1 = Buffer.allocUnsafe(10); + console.log(buf1.length); + } + ``` + @param size 缓冲区的所需长度 + @return 指定尺寸的新 Buffer 对象 + */ + static Buffer allocUnsafe(Integer size); + + /*! @brief 分配一个指定长度的新缓存区。如果大小为0，将创建一个零长度的缓存区。 + 实例: + ```JavaScript + exports.hi = v => { + var buf1 = Buffer.allocUnsafeSlow(10); + console.log(buf1.length); + } + ``` + @param size 缓冲区的所需长度 + @return 指定尺寸的新 Buffer 对象 + */ + static Buffer allocUnsafeSlow(Integer size); + + /*! @brief 检测编码格式是否被支持 + 实例: + ```JavaScript + exports.hi = v => { + console.log(Buffer.isEncoding('utf8')); // true + console.log(Buffer.isEncoding('utf-8')); // true + console.log(Buffer.isEncoding('gbk')); // false + console.log(Buffer.isEncoding('gb2312')); // false + console.log(Buffer.isEncoding('hex')); // true + console.log(Buffer.isEncoding('base64')); // true + console.log(Buffer.isEncoding('jis')); // false + console.log(Buffer.isEncoding('aaabbbccc')); // false + console.log(Buffer.isEncoding('binary')); // false + console.log(Buffer.isEncoding('latin1')); // false + console.log(Buffer.isEncoding('big5')); // false + } + + ``` + @param codec 待检测的编码格式 + @return 是否支持 + */ + static Boolean isEncoding(String codec); + + + /*! @brief 获取缓存对象的尺寸 */ + readonly Integer length; + + /*! @brief 修改缓存对象尺寸 + 实例: + ```JavaScript + exports.hi = v => { + var buf = new Buffer("abcded"); + buf.resize(10); + console.log(buf); + } + ``` + @param sz 指定新尺寸 + */ + resize(Integer sz); + + /*! @brief 在缓存对象尾部写入一组二进制数据 + 实例: + ```JavaScript + exports.hi = v => { + var buf = new Buffer([0x31, 0x32, 0x33, 0x34]); + buf.append("abcd"); + buf.append([0x31, 0x32, 0x33, 0x34]); + console.log(buf.toString()); + } + ``` + @param data 初始化二进制数据 + */ + append(Buffer data); + + /*! @brief 在缓存对象尾部写入字符串，字符串将以 utf-8 格式写入 + 实例: + ```JavaScript + exports.hi = v => { + var buf = new Buffer([0x31, 0x32, 0x33, 0x34]); + buf.append("3132", "hex"); + buf.append("MTIzNA==", "base64"); + console.log(buf.toString()); + } + ``` + @param str 要写入的字符串 + @param codec 指定编码格式，允许值为："hex", "base64", "utf8", 或者系统支持的字符集 + */ + append(String str, String codec = "utf8"); + + /*! @brief 向缓存对象写入指定字符串，字符串默认为utf-8，越界时只写入部分数据 + 实例: + ```JavaScript + exports.hi = v => { + var buf = new Buffer(10); + buf.write("abcd", 0, 4,'utf8') + console.log(buf.toString('utf8', 0, 4)); + } + ``` + @param str 待写入的字符串 + @param offset 写入起始位置 + @param length 写入长度（单位字节，默认值-1），未指定时为待写入字符串的长度 + @param codec 指定编码格式，允许值为："hex", "base64", "utf8", 或者系统支持的字符集 + @return 写入的数据字节长度 + */ + Integer write(String str, Integer offset = 0, Integer length = -1, String codec = "utf8"); + + /*! @brief 向缓存对象写入指定字符串，字符串默认为utf-8，越界时只写入部分数据 + 实例: + ```JavaScript + exports.hi = v => { + buf = new Buffer(10); + buf.write("MTIzNA==", 0, "base64"); + console.log(buf.toString("utf8", 0, 4)); + } + ``` + @param str 待写入的字符串 + @param offset 写入起始位置 + @param codec 指定编码格式，允许值为："hex", "base64", "utf8", 或者系统支持的字符集 + @return 写入的数据字节长度 + */ + Integer write(String str, Integer offset = 0, String codec = "utf8"); + + /*! @brief 向缓存对象写入指定字符串，字符串默认为utf-8，越界时只写入部分数据 + 实例: + ```JavaScript + exports.hi = v => { + buf = new Buffer(10); + buf.write("MTIzNA==", "base64"); + console.log(buf.toString("utf8")); + } + ``` + @param str 待写入的字符串 + @param codec 指定编码格式，允许值为："hex", "base64", "utf8", 或者系统支持的字符集 + @return 写入的数据字节长度 + */ + Integer write(String str, String codec = "utf8"); + + /*! @brief 为 Buffer 对象填充指定内容数据 + 实例: + ```JavaScript + exports.hi = v => { + var buf = new Buffer(10); + buf.fill(1); + console.log(buf.toString()); + } + + ``` + @param v 需要填充的数据，如果未指定 offset 和 end，将填充满整个 buffer + @param offset 填充起始位置 + @param end 填充终止位置 + @return 返回当前 Buffer 对象 + */ + Buffer fill(Integer v, Integer offset = 0, Integer end = -1); + + /*! @brief 为 Buffer 对象填充指定内容数据 + 实例: + ```JavaScript + exports.hi = v => { + var buf = new Buffer(10); + buf.fill(new Buffer("abc")); + console.log(buf.toString()); + } + + ``` + @param v 需要填充的数据，如果未指定 offset 和 end，将填充满整个 buffer + @param offset 填充起始位置 + @param end 填充终止位置 + @return 返回当前 Buffer 对象 + */ + Buffer fill(Buffer v, Integer offset = 0, Integer end = -1); + + /*! @brief 为 Buffer 对象填充指定内容数据 + 实例: + ```JavaScript + exports.hi = v => { + var buf = new Buffer(10); + buf.fill("abc"); + console.log(buf.toString()); + } + ``` + @param v 需要填充的数据，如果未指定 offset 和 end，将填充满整个 buffer + @param offset 填充起始位置 + @param end 填充终止位置 + @return 返回当前 Buffer 对象 + */ + Buffer fill(String v, Integer offset = 0, Integer end = -1); + + /*! @brief 返回某个指定数据在 Buffer 中首次出现的位置 + 实例: + ```JavaScript + exports.hi = v => { + var buf = new Buffer([0x31, 0x32, 0x33, 0x34, 0x00]); + console.log(buf.indexOf(0x33)); + console.log(buf.indexOf(0x00)); + } + + ``` + @param v 待查找数据，如果未指定 offset，默认从起始位开始 + @param offset 起始查找位置 + @return 返回查找到的位置，未找到返回 -1 + */ + Integer indexOf(Integer v, Integer offset = 0); + + /*! @brief 返回某个指定数据在 Buffer 中首次出现的位置 + 实例: + ```JavaScript + exports.hi = v => { + var buf = new Buffer("cacdbfcde"); + console.log(buf.indexOf("cd", 1)); + + } + + ``` + @param v 待查找数据，如果未指定 offset，默认从起始位开始 + @param offset 起始查找位置 + @return 返回查找到的位置，未找到返回 -1 + */ + Integer indexOf(String v, Integer offset = 0); + + /*! @brief 比较缓存区的内容 + 实例: + ```JavaScript + exports.hi = v => { + var buf = new Buffer("abcd"); + console.log(buf.compare(new Buffer("abcd"))); + console.log(buf.compare(new Buffer("abc"))); + console.log(buf.compare(new Buffer("abcde"))); + } + ``` + @param buf 待比较缓存对象 + @return 内容比较结果 + */ + Integer compare(Buffer buf); + + /*! @brief 从源缓存对象区域拷贝数据到目标缓存对象区域 + 实例: + ```JavaScript + exports.hi = v => { + var buf1 = new Buffer([0x31, 0x32, 0x33]); + var arr = [0x34, 0x35, 0x36]; + + var buf2 = new Buffer(arr); + var sz = buf1.copy(buf2); + console.log(sz); + console.log(buf2.toString()); + } + + ``` + @param targetBuffer 目标缓存对象 + @param targetStart 目标缓存对象开始拷贝字节位置，缺省为 0 + @param sourceStart 源缓存对象开始字节位置, 缺省为 0 + @param sourceEnd 源缓存对象结束字节位置, 缺省为 -1,表示源数据长度 + @return 拷贝的数据字节长度 + */ + Integer copy(Buffer targetBuffer, Integer targetStart = 0, Integer sourceStart = 0, Integer sourceEnd = -1); + + /*! @brief 返回一个新缓存对象，包含指定起始到缓存结尾的数据 + 实例: + ```JavaScript + exports.hi = v => { + var buf = new Buffer(10); + buf.write("abcdefghih"); + console.log(buf.slice(8).toString()); + } + ``` + @param start 指定范围的起始，缺省从头开始 + @return 返回新的缓存对象 + */ + Buffer slice(Integer start = 0); + + /*! @brief 返回一个新缓存对象，包含指定范围的数据，若范围超出缓存，则只返回有效部分数据 + 实例: + ```JavaScript + exports.hi = v => { + var buf = new Buffer(10); + buf.write("abcdefghih"); + console.log(buf.slice(0, 3).toString()); + console.log(buf.slice(0, 11).toString()); + } + ``` + @param start 指定范围的起始 + @param end 指定范围的结束 + @return 返回新的缓存对象 + */ + Buffer slice(Integer start, Integer end); + + /*! @brief 把当前对象中的所有元素放入一个字符串 + 实例: + ```JavaScript + exports.hi = v => { + var a = new Buffer([192, 168, 0, 1]); + console.log(a.join('.')); + } + ``` + @param separator 分割字符，缺省为 "," + @return 返回生成的字符串 + */ + String join(String separator = ","); + + /*! @brief 返回一个新缓存对象，包含当前对象数据的倒序 + 实例: + ```JavaScript + exports.hi = v => { + var a = new Buffer("abcd"); + console.log(a.reverse().toString()); + } + + ``` + @return 返回新的缓存对象 + */ + Buffer reverse(); + + /*! @brief 比较当前对象与给定的对象是否相等 + 实例: + ```JavaScript + exports.hi = v => { + var buf = new Buffer("abcd"); + console.log(buf.equals(new Buffer("abcd"))); + console.log(buf.equals(new Buffer("abc"))); + } + ``` + @param expected 制定比较的目标对象 + @return 返回对象比较的结果 + */ + Boolean equals(object expected); + + /*! @brief 使用 16 进制编码缓存对象内容 + @return 返回编码字符串 + */ + String hex(); + + /*! @brief 使用 base64 编码缓存对象内容 + @return 返回编码字符串 + */ + String base64(); + + /*! @brief 返回全部二进制数据的数组 + @return 返回包含对象数据索引的迭代器 + */ + Iterator keys(); + + /*! @brief 返回全部二进制数据的数组 + @return 返回包含对象数据值的迭代器 + */ + Iterator values(); + + /*! @brief 返回包含对象数据 [index, byte] 对的迭代器 + @return [index, byte] 对的迭代器 + 实例: + ```JavaScript + exports.hi = v => { + const buf = Buffer.from('buffer'); + + // Prints: + // [0, 98] + // [1, 117] + // [2, 102] + // [3, 102] + // [4, 101] + // [5, 114] + for (const pair of buf.entries()) { + console.log(pair); + } + } + ``` + */ + Iterator entries(); + + /*! @brief 返回全部二进制数据的数组 + 实例: + ```JavaScript + exports.hi = v => { + var buf = new Buffer("buffer"); + console.log(buf.toArray()); + } + ``` + @return 返回包含对象数据的数组 + */ + Array toArray(); + + /*! @brief 返回二进制数据的编码字符串 + 实例: + ```JavaScript + exports.hi = v => { + var buf = new Buffer([0x31, 0x32, 0x33, 0x34]); + console.log(buf.toString("utf8", 1, 3)); + } + + ``` + @param codec 指定编码格式，允许值为："hex", "base64", "utf8", 或者系统支持的字符集 + @param offset 读取起始位置 + @param end 读取终止位置 + @return 返回对象的字符串表示 + */ + String toString(String codec, Integer offset = 0, Integer end); + + /*! @brief 返回二进制数据的编码字符串 + 实例: + ```JavaScript + exports.hi = v => { + var buf = new Buffer([0x31, 0x32, 0x33, 0x34]); + console.log(buf.toString("utf8", 1)); + console.log(buf.toString("hex", 2)); + console.log(buf.toString("base64", 2)); + } + + ``` + @param codec 指定编码格式，允许值为："hex", "base64", "utf8", 或者系统支持的字符集 + @param offset 读取起始位置 + @return 返回对象的字符串表示 + */ + String toString(String codec, Integer offset = 0); + + /*! @brief 返回二进制数据的 utf8 编码字符串 + 实例: + ```JavaScript + exports.hi = v => { + var buf = new Buffer([0x31, 0x32, 0x33, 0x34]); + console.log(buf.toString()); + } + + ``` + @return 返回对象的字符串表示 + */ + String toString(); + + /*! @brief 返回对象的 JSON 格式表示，一般返回对象定义的可读属性集合 + 实例: + ```JavaScript + exports.hi = v => { + var buf = new Buffer("buffer"); + console.log(buf.toJSON()); + } + + + ``` + @return 返回对象的 JSON 格式表示 + */ + String toJSON(); +}; diff --git a/idl/zh-cn/bc_console.idl b/idl/zh-cn/bc_console.idl new file mode 100644 index 0000000..cbb32e1 --- /dev/null +++ b/idl/zh-cn/bc_console.idl @@ -0,0 +1,261 @@ +/*! @brief console 对象 +控制台访问对象 + +全局对象。可用于提示信息，警告和错误记录。通过启动配置文件，可将日志定位到不同的设备，以便于跟踪。 */ + +module bc_console { + /*! @brief loglevel 级别常量 */ + const FATAL = 0; + + /*! @brief loglevel 级别常量 */ + const ALERT = 1; + + /*! @brief loglevel 级别常量 */ + const CRIT = 2; + + /*! @brief loglevel 级别常量 */ + const ERROR = 3; + + /*! @brief loglevel 级别常量 */ + const WARN = 4; + + /*! @brief loglevel 级别常量 */ + const NOTICE = 5; + + /*! @brief loglevel 级别常量 */ + const INFO = 6; + + /*! @brief loglevel 级别常量 */ + const DEBUG = 7; + + /*! @brief loglevel 仅用于输出，信息输出后不换行，file 和 syslog 不保存此级别信息 */ + const PRINT = 9; + + /*! @brief loglevel 级别常量 */ + const NOTSET = 10; + + /*! @brief 记录普通日志信息，与 info 等同 + 实例： + ```JavaScript + exports.hi = v => { + console.log('hello :%s',"FIBOS") + }; + ``` + 记录一般等级的日志信息。通常用于输出非错误性提示信息。 + @param fmt 格式化字符串 + @param args 可选参数列表 + */ + static log(String fmt, ...args); + + /*! @brief 记录普通日志信息，与 info 等同 + ```JavaScript + exports.hi = v => { + console.log('hello FIBOS') + }; + ``` + + 记录一般等级的日志信息。通常用于输出非错误性提示信息。 + @param args 可选参数列表 + */ + static log(...args); + + /*! @brief 记录调试日志信息 + ```JavaScript + exports.hi = v => { + console.debug('warn %s','FIBOS') + }; + ``` + + 记录调试日志信息。通常用于输出调试信息。不重要。 + @param fmt 格式化字符串 + @param args 可选参数列表 + */ + static debug(String fmt, ...args); + + /*! @brief 记录调试日志信息 + ```JavaScript + exports.hi = v => { + console.debug('warn FIBOS') + }; + ``` + + 记录调试日志信息。通常用于输出调试信息。不重要。 + @param args 可选参数列表 + */ + static debug(...args); + + /*! @brief 记录普通日志信息，与 log 等同 + ```JavaScript + exports.hi = v => { + console.info('hello :%s','FIBOS') + }; + ``` + + 记录一般等级的日志信息。通常用于输出非错误性提示信息。 + @param fmt 格式化字符串 + @param args 可选参数列表 + */ + static info(String fmt, ...args); + + /*! @brief 记录普通日志信息，与 log 等同 + ```JavaScript + exports.hi = v => { + console.info('hello FIBOS') + }; + ``` + + 记录一般等级的日志信息。通常用于输出非错误性提示信息。 + @param args 可选参数列表 + */ + static info(...args); + + /*! @brief 记录警告日志信息 + ```JavaScript + exports.hi = v => { + console.notice('hello :%s','FIBOS') + }; + ``` + + 记录警告日志信息。通常用于输出提示性调试信息。一般重要。 + @param fmt 格式化字符串 + @param args 可选参数列表 + */ + static notice(String fmt, ...args); + + /*! @brief 记录警告日志信息 + ```JavaScript + exports.hi = v => { + console.notice('hello FIBOS') + }; + ``` + + 记录警告日志信息。通常用于输出提示性调试信息。一般重要。 + @param args 可选参数列表 + */ + static notice(...args); + + /*! @brief 记录警告日志信息 + ```JavaScript + exports.hi = v => { + console.warn('hello :%s','FIBOS') + }; + ``` + + 记录警告日志信息。通常用于输出警告性调试信息。重要。 + @param fmt 格式化字符串 + @param args 可选参数列表 + */ + static warn(String fmt, ...args); + + /*! @brief 记录警告日志信息 + ```JavaScript + exports.hi = v => { + console.warn('hello FIBOS') + }; + ``` + + 记录警告日志信息。通常用于输出警告性调试信息。重要。 + @param args 可选参数列表 + */ + static warn(...args); + + /*! @brief 记录错误日志信息 + ```JavaScript + exports.hi = v => { + console.error('hello %s','FIBOS') + }; + ``` + + 记录用于错误日志信息。通常用于输出错误信息。非常重要。系统的出错信息也会以此等级记录。 + @param fmt 格式化字符串 + @param args 可选参数列表 + */ + static error(String fmt, ...args); + + /*! @brief 记录错误日志信息 + ```JavaScript + exports.hi = v => { + console.error('hello FIBOS') + }; + ``` + + 记录用于错误日志信息。通常用于输出错误信息。非常重要。系统的出错信息也会以此等级记录。 + @param args 可选参数列表 + */ + static error(...args); + + /*! @brief 记录关键错误日志信息 + + ```JavaScript + exports.hi = v => { + console.crit('hello %s','FIBOS') + }; + ``` + 记录用于关键错误日志信息。通常用于输出关键错误信息。非常重要。 + @param fmt 格式化字符串 + @param args 可选参数列表 + */ + static crit(String fmt, ...args); + + /*! @brief 记录关键错误日志信息 + ```JavaScript + exports.hi = v => { + console.crit('hello FIBOS') + }; + ``` + + 记录用于关键错误日志信息。通常用于输出关键错误信息。非常重要。 + @param args 可选参数列表 + */ + static crit(...args); + + /*! @brief 记录警报错误日志信息 + ```JavaScript + exports.hi = v => { + console.alert('hello %s','FIBOS') + }; + ``` + + 记录用于警报错误日志信息。通常用于输出警报错误信息。非常重要。为最高级别信息。 + @param fmt 格式化字符串 + @param args 可选参数列表 + */ + static alert(String fmt, ...args); + + /*! @brief 记录警报错误日志信息 + ```JavaScript + exports.hi = v => { + console.alert('hello FIBOS') + }; + ``` + + 记录用于警报错误日志信息。通常用于输出警报错误信息。非常重要。为最高级别信息。 + @param args 可选参数列表 + */ + static alert(...args); + + /*! @brief 用 JSON 格式输出对象 + ```JavaScript + exports.hi = v => { + var a = {}; + console.dir(a); + }; + ``` + @param obj 给定要显示的对象 + */ + static dir(Value obj); + + /*! @brief 输出当前调用堆栈 + + 通过日志输出当前调用堆栈。 + @param label 标题，缺省为空字符串。 + */ + static trace(String label = "trace"); + + /*! @brief 断言测试，如果测试值为假，则报错 + + @param value 测试的数值 + @param msg 报错信息 + */ + static assert(Value value, String msg = ""); +}; diff --git a/idl/zh-cn/bc_crypto.idl b/idl/zh-cn/bc_crypto.idl new file mode 100644 index 0000000..a439fd4 --- /dev/null +++ b/idl/zh-cn/bc_crypto.idl @@ -0,0 +1,76 @@ +/*! @brief bc_crypto 模块 +加密算法模块 + +bc_crypto 是 FIBOS 中的加密模块，支持 SHA1 、SHA256 、SHA 512等加密算法，在 js 合约中可以直接使用。 +*/ +module bc_crypto +{ + /*! @brief 从给定的 hash 和签名中恢复公钥 + 实例: + ```JavaScript + exports.hi1 = sig => { + var r = crypto.sha256('I am alive'); + var s = crypto.recover_key(r, sig); + console.notice(s); + } + + ``` + @param digest 指定消息的 hash 结果 + @param signature 指定的签名 + @return 返回恢复的公钥 + */ + static String recover_key(String digest, String signature); + + /*! @brief 创建一个 SHA1 信息摘要运算对象 + + 实例: + ```JavaScript + exports.hi = v => { + var r = crypto.sha1("abcdefg"); + console.error(r); + } + ``` + @param data 创建同时更新的二进制数据 + @return 返回信息摘要结果的 hex 编码字符串 + */ + static String sha1(Buffer data); + + /*! @brief 创建一个 SHA256 信息摘要运算对象 + 实例: + ```JavaScript + exports.hi = v => { + var r = crypto.sha256("abcdefg"); + console.error(r); + } + ``` + @param data 创建同时更新的二进制数据 + @return 返回信息摘要结果的 hex 编码字符串 + */ + static String sha256(Buffer data); + + /*! @brief 创建一个 SHA512 信息摘要运算对象 + 实例: + ```JavaScript + exports.hi = v => { + var r = crypto.sha512("abcdefg"); + console.error(r); + } + ``` + @param data 创建同时更新的二进制数据 + @return 返回信息摘要结果的 hex 编码字符串 + */ + static String sha512(Buffer data); + + /*! @brief 创建一个 RIPEMD160 信息摘要运算对象 + 实例: + ```JavaScript + exports.hi = v => { + var r = crypto.ripemd160("abcdefg"); + console.error(r); + } + ``` + @param data 创建同时更新的二进制数据 + @return 返回信息摘要结果的 hex 编码字符串 + */ + static String ripemd160(Buffer data); +}; diff --git a/idl/zh-cn/bc_db.idl b/idl/zh-cn/bc_db.idl new file mode 100644 index 0000000..a7073aa --- /dev/null +++ b/idl/zh-cn/bc_db.idl @@ -0,0 +1,91 @@ +/*! @brief db 对象 +数据库访问对象 + +FIBOS 中 js 智能合约操作链数据库是很常见的应用场景，一个action在执行时会有上下文变量出现，包括事务机制的处理，这些内容会应用链上 +分配的内存资源，而如果没有持久化技术，执行超过作用域时就会丢失掉这些上下文数据。因此要使用持久化技术将关键内容记录在链数据库中，任何时候使用都不受影响。db 模块的作用就是为了将数据持久化到数据库中，并提供数据可查询的能力和服务。*/ +module bc_db { +/*! @brief 访问指定数据库表 + + +使用 db 模块首先我们需要在 abi 文件中定义数据表的表名、表结构和主键等信息，如下所示： +``` +var db_abi = { + "version": "eosio::abi/1.0", + "types": [{ + "new_type_name": "my_account_name", + "type": "name" + }], + "structs": [{ + "name": "player2", + "base": "", + "fields": [{ + "name": "title", + "type": "string" + }, { + "name": "age", + "type": "int32" + }, { + "name": "weight", + "type": "int32" + }, { + "name": "length", + "type": "int32" + }, { + "name": "width", + "type": "int32" + }] + }, { + "name": "hi", + "base": "", + "fields": [{ + "name": "user", + "type": "name" + }] + }], + "actions": [{ + "name": "hi", + "type": "hi", + "ricardian_contract": "" + }], + "tables": [{ + "name": "players", + "type": "player2", + "index_type": "i64", + "key_names": ["id"], + "key_types": ["int64"] + }] + }; +``` +在 db_abi 中定义了一个 players 表，表的类型为 player2 ，主键为 id。 + +那在 js 合约中如何访问某个具体的表呢？例如访问 players 表，只需要 `db.players(scope,code)` 即可。 + +同样给表建立索引也很简单，以 players 表为例，在 js 合约中作如下定义: +``` + const indexes = { + age: [64, o => [o.age]] + }; + + exports.hi = v => { + var players = db.players(action.account, action.account, indexes); + } +``` +上述代码定义了一个名为 age 的索引，并在访问表的时候加上 indexes 这个参数，这样在对表操作的时候就可以使用索引了。 + +db 模块还支持多索引，只需要在 indexes 加上其它索引，如下所示: +``` +const indexes = { + age:[64, o=>[o.age]], + detail1:[128, o => [o.age,o.weight]], + detail2:[192, o => [o.age,o.weight,o.length]], + detail3:[256, o => [o.age,o.weight,o.length,o.width]] +}; + +``` +具体如何对表进行增删改查操作请查看 DBIterator 和 Table 两篇技术手册 +@param scope 指向合约发布者的名称 +@param code table 中数据所属的 account_name +@param indexes 索引 +*/ +static table(String scope, String code,String indexes); +}; diff --git a/idl/zh-cn/collect.json b/idl/zh-cn/collect.json new file mode 100644 index 0000000..dfaf949 --- /dev/null +++ b/idl/zh-cn/collect.json @@ -0,0 +1,4 @@ +{ + "FIBOS": ["fibos"], + "Contract": ["action", "bc_console", "bc_crypto", "bc_db", "trans"] +} \ No newline at end of file diff --git a/idl/zh-cn/fibos.idl b/idl/zh-cn/fibos.idl new file mode 100644 index 0000000..347f887 --- /dev/null +++ b/idl/zh-cn/fibos.idl @@ -0,0 +1,339 @@ +/*! @brief fibos 实例对象 + + 使用方法： + ```JavaScript + var fibos = require('fibos') + ``` + */ + +module fibos : EventEmitter +{ + /*! @brief fibos 的数据存放目录 + */ + static String data_dir; + + /*! @brief fibos 的配置存放目录 + */ + static String config_dir; + + /*! @brief fibos 主 token 名称 + */ + static String core_symbol; + + /*! @brief fibos 公钥前缀 + */ + static String pubkey_prefix; + + /*! @brief 加载系统 plugin + @param name 系统 plugin 名 + @param cfg 提供给系统 plugin 的配置，[可选] + */ + static load(String name, Object cfg = {}); + + /*! @brief 加载配置 + +------ + +**参数详解** + +### http 插件 + +| 配置名称 | 配置含义 | 默认值 | 参考值 | +| --------------------------- | ----------------------------------------------- | ---------------- | ------ | +| http-server-address | 本地http服务地址 | 127.0.0.1:8888 | | +| https-server-address | 本地https服务地址 | - | | +| max-body-size | RPC请求允许最大字节 | 1024*1024(bytes) | | +| verbose-http-errors | 显示Http返回的错误日志 | false | | +| http-validate-host | 验证Http请求host | true | | +| access-control-allow-origin | 对每个请求返回特殊的Access-Control-Allow-Origin | - | * | + +------ + +### chain 插件 + +| 配置名称 | 配置含义 | 默认值 | 参考值 | +| ---------------------- | --------------------------------------------------- | ------ | ------------------------------------------------------------ | +| genesis-json | 指定创世块数据路径 | - | 文件路径 参考文件:[EOS TestNet](https://github.com/CryptoLions/EOS-Jungle-Testnet/blob/aa499583d5e7f19799d93ab569e29b39741d1bb4/genesis.json) [EOS MainNet](https://github.com/EOS-Mainnet/eos/blob/mainnet-1.1.3/mainnet-genesis.json) | +| genesis-timestamp | 覆盖创世块中的初试时间戳 | - | - | +| print-genesis-json | 是否打印创世数据 | false | - | +| fix-reversible-blocks | 是否将数据恢复到不可逆高度 | false | -(无法使用) | +| replay-blockchain | 是否清除状态数据然后回滚所有数据 | false | -(无法使用,猜测为命令行使用?) | +| hard-replay-blockchain | 是否清除状态数据,然后从区块日志中回滚尽可能多的数据 | false | - | +| delete-all-blocks | 是否删除所有的状态数据和区块数据 | false | - | +| truncate-at-block | 停止出块,并在该区块高度回滚 | 0 | -(无法使用) | + +| 配置名称 | 配置含义 | 默认值 | 参考值 | +| ---------------------------- | ------------------------------------------------------------ | ----------- | ------ | +| blocks-dir | 区块数据存放地址 | blocks | - | +| abi-serializer-max-time-ms | 覆盖默认 ABI 序列化允许的最大时间 | 15*1000(ms) | - | +| chain-state-db-size-mb | 区块数据库中允许的最大容量 | 1024 (MB) | - | +| chain-state-db-guard-size-mb | 当区块数据库中剩余的数据小于此大小时可以安全地关闭节点 | 128(MB) | - | +| reversible-blocks-db-size-mb | 最大能够回滚的数据量 | 340(MB) | - | +| contracts-console | 是否打印合约输出 | false | - | +| read-mode | mode database contains changes done up to the head block plus changes made by transactions not yet included to the blockchain mode database contains changes done up to the current head block. | speculative | - | + +------ + +### net 插件 + +| 配置名称 | 配置含义 | 默认值 | 参考值 | +| ------------------------- | -------------------------------- | --------------------------- | ------------------------------------------------------------ | +| p2p-listen-endpoint | 监听 p2p 连接的地址和端口 | 0.0.0.0:9876 | - | +| p2p-server-addrsss | 提供给其它节点 p2p 服务地址 | p2p-listen-endpoint | - | +| p2p-peer-address | 公共的p2p 对等节点地址 | - | FIBOS TestNet [ 103.80.170.107:9876] | +| p2p-max-nodes-per-host | 单个 IP 能够连接的最大客户端数量 | 1 | - | +| allowed-connection | 允许连接 | any | 'any'/'producers'/'specified'/'none'。如果'specified'，则必须至少指定一次对等密钥。如果只有'producers'，则不需要对等密钥。 | +| peer-private-key | 一个 公钥、私钥组成的数组 | | | +| max-clients | 允许连接客户端的最大数量 | 25 | 0: 无限制 | +| connection-cleanup-period | 清除不可用链接周期 | 30(s) | - | +| network-version-match | 是否需要相同版本的网络 | false | - | +| peer-log-format | 节点日志格式化 | ["${name}" ${_ip}:${_port}] | - | + +------ + +### chain_api 插件 + +> 提供 RPC 请求 + +| api | 请求 | 含义 | 参数 | 参考请求 | +| --------------------- | ---- | ------------------------ | ----------------------------- | ------------------------------------------------------------ | +| get_info | GET | 获取与节点相关的最新信息 | - | curl | +| get_block | POST | 获取一个块的信息 | block_num_or_id: 区块高度或id | curl -X POST -d '{"block_num_or_id":1}' | +| get_account | POST | 获取账户的信息 | account_name:账户名称 | curl -X POST -d '{"account_name":"eosio"}' | +| get_code | POST | 获取智能合约代码 | account_name:合约名称 | curl -X POST -d | + +------ + +### producer 插件 + +| 配置名称 | 配置含义 | 默认值 | 参考值 | +| -------------------------- | ----------------------------- | ------ | ------------- | +| max-transaction-time | 事务最大超时时间 | 30(s) | - | +| greylist-account | 无法使用 CPU 和 NET 的账号 | - | - | +| enable-stale-production | 启用产生区块,即使区块是静止的 | | | +| max-irreversible-block-age | 最大的不可逆块时间 | -1 | >1 | +| producer-name | 控制节点出块的账户名 | | eosio(可多参) | +| private-key | 签名程序的公钥、私钥 | | (可多参数) | + +------ + +### bnet 插件 + +| 配置名称 | 配置含义 | 默认值 | 参考值 | +| ------------------------ | ------------------------------------------------------------ | ------------ | ------ | +| bnet-endpoint: | 所监听的传入链接的端点 | 0.0.0.0:4321 | | +| bnet-follow-irreversible | 是否只接受从其他端点的不可逆的块 | false | | +| bnet-threads | 用于处理网络消息的线程数 | | | +| bnet-connect | 其他节点的远程端点连接; 根据需要使用多个bnet-connect选项来组成网络 | | | +| bnet-no-trx | 这个peer请求其他节点没有pending的transactions | false | false | + + @param cfgs 配置对象 + */ + static load(Object cfgs); + + /*! @brief 启动 fibos + ### 实例 + +#### bp节点 + +```JavaScript +var fibos = require('fibos'); +var fs = require("fs"); +var isInit = false; + +var producername = ''; +var p2p_peer_address =["p2p-mainnet.fibos123.com:9977", + "seed.fibos.rocks:10100", + "p2p.foshenzhenbp:9877", + "p2p.eoschina.me:10300", + "p2p.mainnet.fibos.me:80", + "fibos-node.slowmist.io:9870", +"se-p2p.fibos.io:9870", + "sl-p2p.fibos.io:9870", + "to-p2p.fibos.io:9870", + "ca-p2p.fibos.io:9870", + "ln-p2p.fibos.io:9870", + "va-p2p.fibos.io:9870"]; + +console.notice("start FIBOS producer nodes"); + + +fibos.config_dir = "./"; +fibos.data_dir = "/blockData"; + +console.notice("config_dir:", fibos.config_dir); +console.notice("data_dir:", fibos.data_dir); + + +fibos.load("net", { + "p2p-peer-address": p2p_peer_address, + "p2p-listen-endpoint": "0.0.0.0:9870" +}); + +fibos.load("producer", { + 'producer-name': producername, + 'enable-stale-production': true, + 'private-key': [active_publickey, active_privateKey] +}); +fibos.load("chain",{ + // "contracts-console": true, + 'chain-state-db-size-mb': 8 * 1024, + 'genesis-json': 'genesis.json' +}); +//禁止js合约 +fibos.enableJSContract = false; + +fibos.start(); +``` + + + +#### 同步节点 + +```JavaScript +var fibos = require('fibos'); +var fs = require("fs"); + +var producername = ''; +var p2p_peer_address = ["p2p-mainnet.fibos123.com:9977", + "seed.fibos.rocks:10100", + "p2p.foshenzhenbp:9877", + "p2p.eoschina.me:10300", + "p2p.mainnet.fibos.me:80", + "fibos-node.slowmist.io:9870", +"se-p2p.fibos.io:9870", + "sl-p2p.fibos.io:9870", + "to-p2p.fibos.io:9870", + "ca-p2p.fibos.io:9870", + "ln-p2p.fibos.io:9870", + "va-p2p.fibos.io:9870"]; + +console.notice("start FIBOS ABI nodes"); + +fibos.config_dir = "./"; +fibos.data_dir = "/blockData"; + +console.notice("config_dir:", fibos.config_dir); +console.notice("data_dir:", fibos.data_dir); + + +fibos.load("http", { + "http-server-address": "0.0.0.0:8870", + "access-control-allow-origin": "*" +}); + +fibos.load("net", { + "p2p-peer-address": p2p_peer_address, + "p2p-listen-endpoint": "0.0.0.0:9870" +}); + +fibos.load("producer"); + +fibos.load("chain", { + 'chain-state-db-size-mb': 8 * 1024, + 'genesis-json': 'genesis.json' +}); +fibos.load("chain_api"); +fibos.load("history"); +fibos.load("history_api"); +//禁止js合约 +fibos.enableJSContract = false; + +fibos.start(); +``` + +##### 支持mangodb + +```JavaScript +var fibos = require('fibos'); +var fs = require("fs"); + +var producername = ''; +var p2p_peer_address = ["p2p-mainnet.fibos123.com:9977", + "seed.fibos.rocks:10100", + "p2p.foshenzhenbp:9877", + "p2p.eoschina.me:10300", + "p2p.mainnet.fibos.me:80", + "fibos-node.slowmist.io:9870", +"se-p2p.fibos.io:9870", + "sl-p2p.fibos.io:9870", + "to-p2p.fibos.io:9870", + "ca-p2p.fibos.io:9870", + "ln-p2p.fibos.io:9870", + "va-p2p.fibos.io:9870"]; + +console.notice("start FIBOS ABI nodes"); + +fibos.config_dir = "./"; +fibos.data_dir = "/blockData"; + +console.notice("config_dir:", fibos.config_dir); +console.notice("data_dir:", fibos.data_dir); + + +fibos.load("http", { + "http-server-address": "0.0.0.0:8870", + "access-control-allow-origin": "*" +}); + +fibos.load("net", { + "p2p-peer-address": p2p_peer_address, + "p2p-listen-endpoint": "0.0.0.0:9870" +}); + +fibos.load("producer"); + +fibos.load("chain", { + 'chain-state-db-size-mb': 8 * 1024, + 'genesis-json': 'genesis.json' +}); +fibos.load("chain_api"); +fibos.load("history"); +fibos.load("history_api"); +//禁止js合约 +fibos.enableJSContract = false; +fibos.load("mongo_db", { + "mongodb-uri": "mongodb://localhost:27017/eosmain" +}); +fibos.start(); +``` + +#### genesis.json 文件 + +```JavaScript +{ + "initial_timestamp": "2018-08-28T00:00:00.000", + "initial_key": "FO6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV", + "initial_configuration": { + "max_block_net_usage": 1048576, + "target_block_net_usage_pct": 1000, + "max_transaction_net_usage": 524288, + "base_per_transaction_net_usage": 12, + "net_usage_leeway": 500, + "context_free_discount_net_usage_num": 20, + "context_free_discount_net_usage_den": 100, + "max_block_cpu_usage": 200000, + "target_block_cpu_usage_pct": 1000, + "max_transaction_cpu_usage": 150000, + "min_transaction_cpu_usage": 100, + "max_transaction_lifetime": 3600, + "deferred_trx_expiration_window": 600, + "max_transaction_delay": 3888000, + "max_inline_action_size": 4096, + "max_inline_action_depth": 4, + "max_authority_depth": 6 + }, + "initial_chain_id": "6aa7bd33b6b45192465afa3553dedb531acaaff8928cf64b70bd4c5e49b7ec6a" +} +``` + */ + static start(); + + /*! @brief 停止 fibos + */ + static stop(); + + /*! @brief 查询和设置 JavaScript 智能合约状态，为 True 时支持 JavaScript 智能合约 + */ + static Boolean enableJSContract; +}; diff --git a/idl/zh-cn/trans.idl b/idl/zh-cn/trans.idl new file mode 100644 index 0000000..697227a --- /dev/null +++ b/idl/zh-cn/trans.idl @@ -0,0 +1,63 @@ +/*! @brief + trans 模块 + */ + +module trans { + /*! @brief 向特定帐号发送 inline action + 实例： + ```JavaScript + // hi acction + exports.hi => (user) { + // 触发hi2 action + trans.send_inline( + "test", + "hi2", + { + user:"user1", + friend:"user2" + }, + [{ + "actor": "${name}", + "permission": "active" + }]) + }; + + // hi2 action + exports.hi2 = (user, friend) => { + console.log(user, friend); + } + ``` + @param account action 发送者的帐号名称 + @param name action 名称 + @param args action 附带的数据 + @param authorization action 的权限 + */ + static send_inline(String account, String name, Object args, Array authorization = []); + + /*! @brief 向特定帐号发送 context_free inline action +实例： + ```JavaScript + // hi acction + exports.hi => (user) { + // 触发hi2 action + trans.send_context_free_inline( + "test", + "hi2", + { + user:"user1", + friend:"user2" + } + ); + }; + + // hi2 action + exports.hi2 = (user, friend) => { + console.log(user, friend); + } + ``` + @param account action 发送者的帐号名称 + @param name action 名称 + @param args action 附带的数据 + */ + static send_context_free_inline(String account, String name, Object args); +}; \ No newline at end of file