1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
//! # pbni-rs //! [![github](https://img.shields.io/badge/github-8da0cb?style=for-the-badge&labelColor=555555&logo=github)](https://github.com/gaoqiangz/pbni-rs) <br> //! [![crates.io](https://meritbadge.herokuapp.com/pbni-rs)](https://crates.io/crates/pbni-rs) //! [![docs.rs](https://docs.rs/pbni-rs/badge.svg)](https://docs.rs/pbni-rs) //! ![BSD-2-Clause licensed](https://img.shields.io/crates/l/pbni-rs.svg) //! //! pbni-rs是[`PBNI`]的Rust绑定,使开发者可以使用Rust语言进行PowerBuilder扩展开发.<br> //! **注意** pbni-rs只支持PowerBuilder 10及以上版本. //! //! # Feature flags //! //! | Flag | Description | Default | //! |-------------------|-------------------------------------------------------------|------------| //! | `global_function` | 全局函数导出 | `enabled` | //! | `nonvisualobject` | 不可视对象导出 | `enabled` | //! | `visualobject` | 可视对象导出 | `enabled` | //! | `decimal` | `Decimal`类型处理,将引入[`rust_decimal`]库依赖 | `enabled` | //! | `datetime` | 日期类型处理,将引入[`chrono`]库依赖 | `enabled` | //! | `vm` | 加载虚拟机以及创建[`Session`]等功能,将引入[`libloading`]库依赖 | `disabled` | //! //! [`rust_decimal`]: https://crates.io/crates/rust_decimal //! [`chrono`]: https://crates.io/crates/chrono //! [`libloading`]: https://crates.io/crates/libloading //! //! # 什么是PBNI? //! //! [`PBNI`]是PowerBuilder虚拟机的C++扩展接口(PowerBuilder Native Interface). //! //! ![Figure] //! //! 通过[`PBNI`]接口我们可以使用底层语言与PBVM进行集成交互,极大的扩展了PowerBuilder的能力. //! //! 其他托管语言类似的技术有[`JNI`],[`C++/CLI`]等. //! //! [`PBNI`]: https://docs.appeon.com/pb2019/native_interface_programmers_guide_and_reference/ch01s01.html //! [`JNI`]: https://docs.oracle.com/javase/8/docs/technotes/guides/jni/spec/intro.html //! [`C++/CLI`]: https://docs.microsoft.com/en-us/cpp/dotnet/native-and-dotnet-interoperability?view=msvc-160 //! [Figure]: http://infocenter.sybase.com/help/topic/com.sybase.infocenter.dc37794.1250/html/pbnigref/pbni03.gif //! //! # 环境要求 //! //! - rustc: 最低1.51 **(支持stable)** //! - toolchain: stable-x86_64-pc-windows-msvc //! - target: i686-pc-windows-msvc //! //! # 开始使用 //! //! 1. 添加32位目标平台 //! //! ```bash //! > rustup target add i686-pc-windows-msvc //! ``` //! //! 2. 添加`pbni-rs`到`Cargo.toml` //! //! ```toml //! [lib] //! crate-type = ["cdylib"] //! //! [dependencies] //! pbni-rs = "0.1.0" //! ``` //! //! > 注意[`crate-type`]需要为[`cdylib`] //! //! [`crate-type`]: https://doc.rust-lang.org/reference/linkage.html //! [`cdylib`]: https://rust-lang.github.io/rfcs/1510-cdylib.html //! //! 3. 编译 //! //! ```bash //! > cargo build --target i686-pc-windows-msvc //! ``` //! //! > 你也可以在工程目录下创建`.cargo/config`文件 //! > //! > - 配置默认编译目标,免去输入`--target i686-pc-windows-msvc`参数 //! > //! > ```toml //! > [build] //! > target = "i686-pc-windows-msvc" //! > ``` //! > //! > - 配置静态链接CRT //! > //! > ```toml //! > [target.i686-pc-windows-msvc] //! > rustflags = ["-C", "target-feature=+crt-static"] //! > ``` //! //! # 数据类型映射 //! //! |PowerBuilder|Rust| //! |---|---| //! |`int`|`pbint`,`i16`| //! |`uint`|`pbuint`,`u16`| //! |`long`|`pblong`,`i32`| //! |`ulong`|`pbulong`,`u32`| //! |`longlong`|`pblonglong`,`i64`| //! |`real`|`pbreal`,`f32`| //! |`double`|`pbdouble`,`f64`| //! |`decimal`|[`Decimal`] (需要开启`decimal`特性)| //! |`byte`|`pbbyte`,`u8`| //! |`boolean`|`bool`| //! |`char`|`PBChar`| //! |`string`|`&PBStr`,`PBString`,`String`| //! |`blob`|`&[u8]`,`Vec<u8>`| //! |`date`|[`NaiveDate`] (需要开启`datetime`特性)| //! |`time`|[`NaiveTime`] (需要开启`datetime`特性)| //! |`datetime`|[`NaiveDateTime`] (需要开启`datetime`特性)| //! |`any`|`Value`| //! |任意对象|`Object`| //! |任意数组|`Array`| //! //! > PowerBuilder的所有类型都是Nullable的,Rust里使用`Option<T>`表示.<br> //! //! # 字符串 //! //! PowerBuilder字符编码是[UTF-16LE],而Rust字符串编码采用的是[UTF-8]编码,这使得字符串操作时可能会有一点的性能损失.如果对性能有较高要求,请使用`&PBStr`进行交互,避免发生内存拷贝和编码转换. //! //! pbni-rs提供了[`pbstr!`]宏在编译时生成`&'static PBStr`: //! //! ```rust //! let rstr: &'static str = "hell world!"; //! let pstr: &'static PBStr = pbstr!("hell world!"); //! ``` //! //! > pbni-rs使用[`widestring`]进行UTF-16编码转换. //! //! [UTF-16LE]: https://en.wikipedia.org/wiki/UTF-16 //! [UTF-8]: https://en.wikipedia.org/wiki/UTF-8 //! [`widestring`]: https://crates.io/crates/widestring //! //! # 内存安全 //! //! pbni-rs的Safe代码提供100%类型和内存安全保证,对于无法提供100%的内存安全保证的接口都使用了`unsafe`标记.最常见的就是获取引用,比如`&PBStr`. //! //! ```rust //! impl<'obj> Object<'obj> { //! pub unsafe fn get_var_str(&self, fid: impl VarId) -> Option<&'obj PBStr> { ... } //! pub fn get_var_string(&self, fid: impl VarId) -> Option<PBString> { ... } //! pub fn set_var_str(&mut self, fid: impl VarId, value: impl AsPBStr) -> Result<()> { ... } //! } //! ``` //! //! 可以看到`Object`的`get_var_str`是`unsafe`方法,而`get_var_string`则是Safe的,这是因为像`set_var_str`这样的方法可能会修改`get_var_str`返回引用的内存,导致垂悬引用([Dangling Reference]).<br> //! pbni-rs无法避免这种情况,因为对象的内部状态不完全由Rust维护,有很多途径会导致内存被修改,所以pbni-rs中所有返回引用的方法都将是[Unsafe]的,需要开发者自己保证对其正确使用. //! //! [Unsafe]: https://doc.rust-lang.org/book/ch19-01-unsafe-rust.html //! [Dangling Reference]: https://doc.rust-lang.org/book/ch04-02-references-and-borrowing.html#dangling-references //! //! # 线程安全 //! //! `Session`及其所有分配的资源都不能跨线程访问(包括`Object`/`Array`),因此它们都不是`Send`和`Sync`的,跨线程访问建议结合消息队列实现. //! //! # 代码生成 //! //! pbni-rs可以非常方便将Rust对象或函数与PowerBuilder建立映射,全部由pbni-rs生成代码,省去手写繁琐的样板代码的同时保证了类型安全. //! //! #### 映射PowerBuilder全局函数 //! //! - PowerBuilder //! //! ```vbscript //! global type gf_bit_or from function_object native "pbrs.dll" //! end type //! //! forward prototypes //! global function long gf_bit_or (readonly long a,readonly long b) //! end prototypes //! ``` //! //! - C++ //! //! ```cpp //! #include <pbext.h> //! //! PBXRESULT bit_or(PBCallInfo *ci) //! { //! pblong a = ci->pArgs->GetAt(0)->GetLong(); //! pblong b = ci->pArgs->GetAt(1)->GetLong(); //! return ci->returnValue->SetLong(a|b); //! } //! PBXRESULT PBXCALL PBX_InvokeGlobalFunction( //! IPB_Session *pbsession, //! LPCWSTR functionName, //! PBCallInfo *ci) //! { //! if(::wcscmp(functionName,L"gf_bit_or") == 0) //! return bit_or(ci); //! return PBX_E_NO_REGISTER_FUNCTION; //! } //! ``` //! //! - Rust(pbni-rs) //! //! ```rust //! use pbni::*; //! //! #[global_function(name="gf_bit_or")] //! fn bit_or(a: pblong, b: pblong) -> pblong { //! a | b //! } //! ``` //! //! #### 映射PowerBuilder对象 //! //! - PowerBuilder //! //! ```vbscript //! forward //! global type n_pbni from nonvisualobject //! end type //! end forward //! global type n_pbni from nonvisualobject native "pbrs.dll" //! public function string of_hello (string world) //! end type //! global n_pbni n_pbni //! //! on n_pbni.create //! call super::create //! TriggerEvent( this, "constructor" ) //! end on //! //! on n_pbni.destroy //! TriggerEvent( this, "destructor" ) //! call super::destroy //! end on //! ``` //! //! - C++ //! //! ```cpp //! #include <pbext.h> //! //! class CppObject: public IPBX_NonVisualObject //! { //! IPB_Session *session; //! pbobject ctx; //! //! PBXRESULT handle_hello(PBCallInfo *ci) //! { //! LPCWSTR lpcsWorld = this->session->GetString(ci->pArgs->GetAt(0)->GetString()); //! std::wostringstream ss; //! ss << L"hello " << lpcsWorld << L"!"; //! return ci->returnValue->SetString(ss.str().c_str()); //! } //! //! public: //! CppObject(IPB_Session *pbsession,pbobject pbobj) //! :session(pbsession), //! ctx(pbobj) //! {} //! virtual ~CppObject() override {}; //! //! virtual void Destroy() override { delete this; } //! //! virtual PBXRESULT Invoke( //! IPB_Session *session, //! pbobject obj, //! pbmethodID mid, //! PBCallInfo *ci) override //! { //! if(mid == 0) //! return this->handle_hello(ci); //! return PBX_E_NO_REGISTER_FUNCTION; //! } //! }; //! //! PBXRESULT PBXCALL PBX_CreateNonVisualObject( //! IPB_Session *pbsession, //! pbobject pbobj, //! LPCWSTR className, //! IPBX_NonVisualObject **obj) //! { //! if(::wcscmp(className,L"n_pbni") == 0) //! { //! *obj = new CppObject(pbsession,pbobj); //! return PBX_OK; //! } //! return PBX_E_NO_SUCH_CLASS; //! } //! ``` //! //! - Rust(pbni-rs) //! //! ```rust //! use pbni::*; //! //! struct RustObject { //! session: Session, //! ctx: ContextObject //! } //! //! #[nonvisualobject(name = "n_pbni")] //! impl RustObject { //! #[constructor] //! fn new(session: Session, ctx: ContextObject) -> RustObject { //! RustObject { //! session, //! ctx //! } //! } //! #[method(name="of_Hello")] //! fn hello(&self, world: String) -> String { //! format!("hello {}!",world) //! } //! } //! ``` //! #### 参数提取 //! //! pbni-rs代码生成宏会自动提取PB参数为Rust映射的[数据类型],参数的提取顺序与PB端定义的顺序保持一致.其中有几个特殊的参数: [`Session`]/[`CallInfoRef`]/[`ArgumentsRef`],这几个参数对位置没有要求并且数量任意. //! //! [数据类型]: #数据类型映射 //! //! ```rust //! use pbni::*; //! //! #[global_function(name="gf_bit_or")] //! fn bit_or(session: Session,a: pblong, b: pblong) -> pblong { //! a | b //! } //! //! //等同于 //! //! #[global_function(name="gf_bit_or")] //! fn bit_or(session: Session,args: ArgumentsRef,a: pblong) -> pblong { //! a | args.get(1).get_long().unwrap() //! } //! ``` //! //! **注意** Rust端参数列表须与PB端定义的类型数量以及顺序一致,任何不匹配的情况都会在运行时触发异常. <br> //! - Rust端参数如果为非空类型(`Option`),而PB端提供的参数为NULL,那么框架自动返回NULL给PB调用端,兼容PB标准库的做法,也就是说任何参数传递为NULL那么返回值就为NULL,除非Rust端显式用`Option<T>`接收. <br> //! - 当参数列表通过`CallInfoRef`/`ArgumentsRef`接收后,将不再匹配参数数量,因为这两个参数已经隐式表示接收了所有的参数.`CallInfoRef`/`ArgumentsRef`一般用于处理引用传递参数以及变长参数列表. //! //! #### 可选参数列表匹配 //! //! 以下示例为重载可选参数列表的匹配映射 //! //! - PowerBuilder //! //! ```vbscript //! global type gf_test from function_object native "pbrs.dll" //! end type //! //! forward prototypes //! global function long gf_test (readonly long a,readonly long b) //! global function long gf_test (readonly long a,readonly long b,readonly long c) //! global function long gf_test (readonly long a,readonly long b,readonly long c,readonly long d) //! end prototypes //! ``` //! //! - Rust(pbni-rs) //! //! ```rust //! use pbni::*; //! //! #[global_function(name="gf_test")] //! fn test(a: pblong, b: pblong, c: Option<long>, d: Option<long>) -> pblong { //! a | b //! } //! ``` #![allow(non_snake_case)] #![allow(non_camel_case_types)] #![allow(non_upper_case_globals)] #![allow(dead_code)] mod bindings; #[cfg(feature = "vm")] mod vm; mod session; mod callinfo; mod value; mod object; mod invoker; mod arguments; #[cfg(any(feature = "global_function", feature = "nonvisualobject", feature = "visualobject"))] mod export; #[doc(hidden)] mod codegen; pub use arguments::{Arguments, ArgumentsRef}; pub use bindings::{ pbbyte, pbdouble, pbint, pblong, pblonglong, pbreal, pbuint, pbulong, AsPBStr, FieldId, MethodId, PBStr, PBString, ValueType, PBXRESULT }; pub use callinfo::{CallInfo, CallInfoRef}; pub use invoker::Invoker; pub use object::{ContextObject, Object, SharedObject}; pub use session::{LocalFrame, OwnedSession, Session}; pub use value::{Array, OwnedValue, Value}; #[cfg(feature = "vm")] pub use vm::VM; #[cfg(any(feature = "nonvisualobject", feature = "visualobject"))] pub use object::UserObject; #[cfg(feature = "nonvisualobject")] pub use object::NonVisualObject; #[cfg(feature = "visualobject")] pub use object::VisualObject; #[cfg(feature = "datetime")] #[doc(no_inline)] pub use chrono::{Datelike, NaiveDate, NaiveDateTime, NaiveTime, Timelike}; #[cfg(feature = "decimal")] #[doc(no_inline)] pub use rust_decimal::prelude::*; #[cfg(any(feature = "global_function", feature = "nonvisualobject", feature = "visualobject"))] pub use pbni_codegen::*; #[doc(hidden)] pub mod __private { pub use crate::codegen::__private as codegen; } pub type Result<T> = ::std::result::Result<T, PBXRESULT>;