The wxrust2 from kenz-gelsoft

More builders for easy instantiation of classes with many default arguments in ctor

I made builders for some GUI classes used in porting sample code.

In #119, many new classes are generated, without builders. More builders may be required(or requested).

For a while, I'll make new builders per request (by users, mainly me)

Support wx resource related matters

#154
- Link wx/msw/wx.rc into result binary with https://github.com/nabijaczleweli/rust-embed-resource or by other mean
- as noted in https://www.wxwidgets.org/docs/faq/windows/#manifest
Support .xpm icon
- Make new crate #include-ing .xpm as C(++) source and provide its binary data
- Or search it in Rust ecosystem if already exists

Consider safety of almost all API calls

wx manages (almost all) wxWindows' pointers which is in widgets tree.

This means that any operation potentially makes any pointers invalid.

This should be expressed unsafe in Rust, how can we do this?

Steps for building on windows?

Hi
So I'm trying to build the hello sample on windows, Did set the wxwin env variable using a config.toml to the wx folder that comes with the repo that includes the dll's, Like this
config.toml:
``[env]
wxwin = { value = "../../wx", relative = true }

``
However

``error: failed to run custom build command for wx v0.1.0 (C:\Users\mohamed\projects\wxRust2\wx-core)

Caused by:
process didn't exit successfully: C:\Users\mohamed\projects\wxRust2\target\release\build\wx-52bbc0a6332a18a0\build-script-build (exit code: 1)
--- stdout
TARGET = Some("x86_64-pc-windows-msvc")
OPT_LEVEL = Some("3")
HOST = Some("x86_64-pc-windows-msvc")
CXX_x86_64-pc-windows-msvc = None
CXX_x86_64_pc_windows_msvc = None
HOST_CXX = None
CXX = None
CXXFLAGS_x86_64-pc-windows-msvc = None
CXXFLAGS_x86_64_pc_windows_msvc = None
HOST_CXXFLAGS = None
CXXFLAGS = None
CRATE_CC_NO_DEFAULTS = None
CARGO_CFG_TARGET_FEATURE = Some("fxsr,sse,sse2")
DEBUG = Some("false")
CXX_x86_64-pc-windows-msvc = None
CXX_x86_64_pc_windows_msvc = None
HOST_CXX = None
CXX = None
CXXFLAGS_x86_64-pc-windows-msvc = None
CXXFLAGS_x86_64_pc_windows_msvc = None
HOST_CXXFLAGS = None
CXXFLAGS = None
CRATE_CC_NO_DEFAULTS = None
CARGO_CFG_TARGET_FEATURE = Some("fxsr,sse,sse2")
CXX_x86_64-pc-windows-msvc = None
CXX_x86_64_pc_windows_msvc = None
HOST_CXX = None
CXX = None
CXXFLAGS_x86_64-pc-windows-msvc = None
CXXFLAGS_x86_64_pc_windows_msvc = None
HOST_CXXFLAGS = None
CXXFLAGS = None
CRATE_CC_NO_DEFAULTS = None
CARGO_CFG_TARGET_FEATURE = Some("fxsr,sse,sse2")
CXX_x86_64-pc-windows-msvc = None
CXX_x86_64_pc_windows_msvc = None
HOST_CXX = None
CXX = None
CXXFLAGS_x86_64-pc-windows-msvc = None
CXXFLAGS_x86_64_pc_windows_msvc = None
HOST_CXXFLAGS = None
CXXFLAGS = None
CRATE_CC_NO_DEFAULTS = None
CARGO_CFG_TARGET_FEATURE = Some("fxsr,sse,sse2")
CXX_x86_64-pc-windows-msvc = None
CXX_x86_64_pc_windows_msvc = None
HOST_CXX = None
CXX = None
CXXFLAGS_x86_64-pc-windows-msvc = None
CXXFLAGS_x86_64_pc_windows_msvc = None
HOST_CXXFLAGS = None
CXXFLAGS = None
CRATE_CC_NO_DEFAULTS = None
CARGO_CFG_TARGET_FEATURE = Some("fxsr,sse,sse2")
running: "C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Tools\MSVC\14.32.31326\bin\HostX64\x64\cl.exe" "-nologo" "-MD" "-O2" "-Brepro" "-I" "C:\Users\mohamed\projects\wxRust2\samples\hello\../../wx\include" "-I" "C:\Users\mohamed\projects\wxRust2\samples\hello\../../wx\lib\vc14x_x64_dll\mswu" "-I" "include" "-W4" "/EHsc" "-DWXUSINGDLL=" "-D__NO_VC_CRTDBG__=" "-DwxDEBUG_LEVEL=0" "-DNDEBUG=" "-FoC:\Users\mohamed\projects\wxRust2\target\release\build\wx-7d5de0ba4c8730f8\out\src/manual.o" "-c" "src/manual.cpp"
manual.cpp
src/manual.cpp(1): fatal error C1083: Cannot open include file: 'wx/ctrlsub.h': No such file or directory
exit code: 2

--- stderr

error occurred: Command "C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Tools\MSVC\14.32.31326\bin\HostX64\x64\cl.exe" "-nologo" "-MD" "-O2" "-Brepro" "-I" "C:\Users\mohamed\projects\wxRust2\samples\hello\../../wx\include" "-I" "C:\Users\mohamed\projects\wxRust2\samples\hello\../../wx\lib\vc14x_x64_dll\mswu" "-I" "include" "-W4" "/EHsc" "-DWXUSINGDLL=" "-D__NO_VC_CRTDBG__=" "-DwxDEBUG_LEVEL=0" "-DNDEBUG=" "-FoC:\Users\mohamed\projects\wxRust2\target\release\build\wx-7d5de0ba4c8730f8\out\src/manual.o" "-c" "src/manual.cpp" with args "cl.exe" did not execute successfully (status code exit code: 2).

warning: build failed, waiting for other jobs to finish...
error: build failed

``
I'm probably missing a bunch of configuration steps, But it's hard to figure them out, So is there a configuration manual somewhere?

Methods return ownership should return its Binding instead of WeakRef<Binding>

after #51 fix this.

should mark them in doxybinding.toml and generate other code for them.

Target wxWidgets 3.2.0

Today, it is released!

https://www.wxwidgets.org/news/2022/07/wxwidgets-3.2.0-final-release/

Target it for development. For a while keep buildable for

3.0(last stable version),
- ~~I gave up supporting this as noted in #92 (comment)~~
- will support wx3.0 GTK+3 build again in #96
~~3.1.7(until homebrew and some linux distros packages 3.2 series),~~ Dropped rolling releases catch up it
3.1.6(until prebuilt crates update)

Work items:

update wxml/ doxygen xml output
- kenz-gelsoft/wxml#1
re-gen binding for it and fix build errors
update my prebuilt msvc crate packaging official binary

Support up/down cast

upcasting is safe and should succeed.
downcasting can fail, but should be safe.
- try_ somthing naming is desired.

More automatic codegen

Items noticed in #119

Treatment on these should reduce lines of https://github.com/kenz-gelsoft/wxRust2/blob/main/doxybindgen.toml (and result fewer work to generate more/new classes/APIs)

Block ctor on abstract class
Block methods using template in args
- This may be handled wiith hand-written binding, should place comment in generated code?
Block operator overloads (which isn't supported yet)
- Register an issue with this if block this automatically
Block using wx-value types without pointer/ref (which isn't supported yet, or cannot be done automatically)
- Register an issue with this if block this automatically

Make builders for widget constructors

Current binding requires many boilerplate code with constructor's default arguments.

https://github.com/kenz-gelsoft/wxRust2/blob/main/samples/wrapsizer/src/main.rs

is example.

Write manually builder pattern constructor.

Support modern looks on wxMSW by embedding application manifest

Link wx/msw/wx.rc into result binary with https://github.com/nabijaczleweli/rust-embed-resource or by other mean
as noted in https://www.wxwidgets.org/docs/faq/windows/#manifest

Support multiple inheritance in codegen

This is not a rare case:

TextEntry #69
ItemContainerImmutable 6d6bed5
ItemContainer 746e51a...4add4bb

And needs to be regenerated like this　(ffbfc32...d4a7a39) after codegen change.

So codegen should support this scenario.

Document wxCore library coverage (not test coverage, but binding coverage)

Subsequent action of #119

example app crash when clicked button on wxMSW debug build

Windows specific tasks

copy DLLs on cargo build
fix crash on returning wxString as rust String
- found on win32 debug build run, but it may be common problem on all platforms.
- work in #36
setup github build action
- considering to install wxwidgets dependency with vcpkg
- will achieved in #91

Support wx::EvtHandler.call_after()

To support deferred event handling.

Rename TypeIsOwned<bool> to TypeInRust<>

As this represents the concept clearer and can be distinguished from Rust's owned type.

also rename Unowned -> InCxx/InCpp/FromCpp

Clean up sample code

Remove/reduce unsafe code
Stop wx classes deriving Clone trait
- It should be replaced with wx::WeakRef
- as_weak_ref() or such on wx::Trackable needed

Generate rest of wxCore library classes

Steps:

(First) publish as alpha on crates.io

Items:

wxrust-config
- 0.0.1-alpha is published on https://crates.io/crates/wxrust-config but void for #162
- 0.0.1-alpha2
wxrust-base
- 0.0.1-alpha
  - https://crates.io/crates/wxrust-base
wxrust-core
- 0.0.1-alpha
  - https://crates.io/crates/wxrust

Generate generic type parameter names from their type names

for better documentation and user ergonomics

Add memory management tests

Some mechanisms implemented in the bining generator should have test. e.g.

String parameter marshalling
Value types dropped correctly
Windows to be deallocated when their parent destroyed (especially when top level window closed)
Windows leak if they are created but not added to parent (This is intentional for now)
WeakRef to(wx)Trackables works correctly

To check memory leak, run this test with valgrind (or MSVC feature for leak check)

ideally integrate this in CI
at least document how to run leak check as a manual step to release this library

Autogen Event type support code

Maybe by specifying Event types at Event class entry in toml

Handle specially wxSearchCtrl which isn't wxTextCtrl on MSW

This class is documented as it is-a wxTextCtrl,

https://docs.wxwidgets.org/3.2/classwx_search_ctrl.html

but it isn't.

https://github.com/wxWidgets/wxWidgets/blob/v3.2.0/include/wx/srchctrl.h#L26

it actually mimic the wxTextCtrl API through wxTextCtrlIface. so can't static_cast<wxTextCtrl*>().

This result the generated code fails to compile:

// Mix-in(s) to wxSearchCtrl
wxTextEntry *wxSearchCtrl_AsTextEntry(wxSearchCtrl* obj) {
    return static_cast<wxTextEntry*>(obj);
}

wx::message_box() should return the answer

as https://docs.wxwidgets.org/stable/group__group__funcmacro__dialog.html#ga193c64ed4802e379799cdb42de252647

Dependency on vendored repo blocks publishing

kenz@KENZnoMacBook-Air wx-base % cargo publish
    Updating crates.io index
error: all dependencies must have a version specified when publishing.
dependency `wx-universal-apple-darwin` does not specify a version
Note: The published dependency will use the version from crates.io,
the `git` specification will be removed from the dependency declaration.

Turn wxSOME_IDENTIFIER into wx::SOME_IDENTIFIER

In the same fashion that wxPython creates a wx namespace, use a more Rust-typical naming convention.

Port more examples and generate more wx-core classes

Small samples

Sample with variety widgets

https://github.com/kenz-gelsoft/wxRust2/tree/main/samples/widgets
- #70, #71 Base
- #68 Button Page
- #73 CheckBox Page
- #76 Choice Page
- #79 ColourPicker Page
- #81 ComboBox Page
- #84 DatePicker page
- #97 DirCtrl page
- #93 DirPickerCtrl page
- #98 EditableListBox page
- #99 FileCtrl page
- #117 FilePicker page
- #100 FontPicker page
- #101 Gauge page
- #102 HeaderCtrl page
- #105 Hyperlink page
- #106 Listbox page
- #112 SearchCtrl page
- #111 Slider page
- #113 Spin page
- #114 TimePicker page
- #115 Toggle page

Fix docs.rs build error

https://docs.rs/crate/wxrust-base/0.0.1-alpha

Consult their doc:

https://docs.rs/about/builds

Minimal example fails to compile under Linux

The following compilation errors are shown:

src/generated.cpp:823:18: error: ‘class wxWindow’ has no member named ‘RegisterHotKey’
src/generated.cpp:826:18: error: ‘class wxWindow’ has no member named ‘UnregisterHotKey’

I think this happens because those methods are only available on Windows.

Fix CI build errors

macOS CI build error
- workaround
  - #188 (comment)
- fix
wxgtk30 CI build error
- fix

Help getting samples going with MSYS2 installation of wxWidgets

I'm new to rust and have installed rust and wxwidgets 3.2 using MSYS2 (for ucrt64, clang64, and mingw64 environments)

pacboy sync rust:u
pacboy sync rust:x
pacboy sync rust:c

pacboy sync wxwidgets3.2-msw:u
pacboy sync wxwidgets3.2-msw:x
pacboy sync wxwidgets3.2-msw:c

I get errors about setting the wxwin environment variable.

I've tried setting them to many things in the MSYS2 environments, and even tried downloading the binary and development files from wxWidgets and pointing to them, but no luck.

Surely the wx-config --cflags and wx-conig --libs is all that is needed for the wxRust2 build system to find the headers and libraries. Yes/No?

Does wx-core/build.rs need to be modified to support native MSYS2 installations of wxwidgets?

What should I set wxwin to - if anything at all?

$ find /mingw64 -type d -name "wx*"
/mingw64/include/wx-3.2
/mingw64/include/wx-3.2/wx
/mingw64/lib/wx
/mingw64/lib/wx/include/msw-unicode-3.2/wx
/mingw64/lib/wx/include/msw-unicode-static-3.2/wx
/mingw64/share/licenses/wxWidgets3.2

NOTE: I have wxRust2 running ok on macOS with brew installations of rust and wxwidgets.
i.e. I can build and run the samples.
I want to be able to do the same thing on Windows using MSYS2 installations of rust and wxwidgets.

--

Here is the output with wxwin undefined.

$ cargo build -v
   Compiling cc v1.0.72
   Compiling wxrust-config v0.0.1-alpha2 (https://github.com/kenz-gelsoft/wxrust-vendored-config#245f52f7)
     Running `rustc --crate-name cc --edition=2018 'C:\Users\BrendanSimon\.cargo\registry\src\index.crates.io-6f17d22bba15001f\cc-1.0.72\src\lib.rs' --error-format=json --json=diagnostic-rendered-ansi,artifacts,future-incompat --diagnostic-width=197 --crate-type lib --emit=dep-info,metadata,link -C embed-bitcode=no -C metadata=789810fd6a5d8038 -C extra-filename=-789810fd6a5d8038 --out-dir 'C:\Users\BrendanSimon\SW\wxRust2\target\debug\deps' -L 'dependency=C:\Users\BrendanSimon\SW\wxRust2\target\debug\deps' --cap-lints allow -C link-arg=-lstdc++`
     Running `rustc --crate-name wxrust_config --edition=2021 'C:\Users\BrendanSimon\.cargo\git\checkouts\wxrust-vendored-config-2459bb25f7f509b9\245f52f\src\lib.rs' --error-format=json --json=diagnostic-rendered-ansi,artifacts,future-incompat --diagnostic-width=197 --crate-type lib --emit=dep-info,metadata,link -C embed-bitcode=no -C metadata=a285a9de2a3a48ea -C extra-filename=-a285a9de2a3a48ea --out-dir 'C:\Users\BrendanSimon\SW\wxRust2\target\debug\deps' -L 'dependency=C:\Users\BrendanSimon\SW\wxRust2\target\debug\deps' --cap-lints allow -C link-arg=-lstdc++`
   Compiling wxrust-base v0.0.1-alpha (C:\Users\BrendanSimon\SW\wxRust2\wx-base)
   Compiling wxrust v0.0.1-alpha (C:\Users\BrendanSimon\SW\wxRust2\wx-core)
     Running `rustc --crate-name build_script_build --edition=2021 'wx-base\build.rs' --error-format=json --json=diagnostic-rendered-ansi,artifacts,future-incompat --diagnostic-width=197 --crate-type bin --emit=dep-info,link -C embed-bitcode=no -C metadata=0eb8b6abd162f688 -C extra-filename=-0eb8b6abd162f688 --out-dir 'C:\Users\BrendanSimon\SW\wxRust2\target\debug\build\wxrust-base-0eb8b6abd162f688' -C 'incremental=C:\Users\BrendanSimon\SW\wxRust2\target\debug\incremental' -L 'dependency=C:\Users\BrendanSimon\SW\wxRust2\target\debug\deps' --extern 'cc=C:\Users\BrendanSimon\SW\wxRust2\target\debug\deps\libcc-789810fd6a5d8038.rlib' --extern 'wxrust_config=C:\Users\BrendanSimon\SW\wxRust2\target\debug\deps\libwxrust_config-a285a9de2a3a48ea.rlib' -C link-arg=-lstdc++`
     Running `rustc --crate-name build_script_build --edition=2021 'wx-core\build.rs' --error-format=json --json=diagnostic-rendered-ansi,artifacts,future-incompat --diagnostic-width=197 --crate-type bin --emit=dep-info,link -C embed-bitcode=no -C metadata=e95e3129d44371d8 -C extra-filename=-e95e3129d44371d8 --out-dir 'C:\Users\BrendanSimon\SW\wxRust2\target\debug\build\wxrust-e95e3129d44371d8' -C 'incremental=C:\Users\BrendanSimon\SW\wxRust2\target\debug\incremental' -L 'dependency=C:\Users\BrendanSimon\SW\wxRust2\target\debug\deps' --extern 'cc=C:\Users\BrendanSimon\SW\wxRust2\target\debug\deps\libcc-789810fd6a5d8038.rlib' --extern 'wxrust_config=C:\Users\BrendanSimon\SW\wxRust2\target\debug\deps\libwxrust_config-a285a9de2a3a48ea.rlib' -C link-arg=-lstdc++`
     Running `C:\Users\BrendanSimon\SW\wxRust2\target\debug\build\wxrust-base-0eb8b6abd162f688\build-script-build`
     Running `C:\Users\BrendanSimon\SW\wxRust2\target\debug\build\wxrust-e95e3129d44371d8\build-script-build`
error: failed to run custom build command for `wxrust-base v0.0.1-alpha (C:\Users\BrendanSimon\SW\wxRust2\wx-base)`

Caused by:
  process didn't exit successfully: `C:\Users\BrendanSimon\SW\wxRust2\target\debug\build\wxrust-base-0eb8b6abd162f688\build-script-build` (exit code: 101)
  --- stderr
  thread 'main' panicked at 'Set 'wxwin' environment variable to point the wxMSW binaries dir.: NotPresent', C:\Users\BrendanSimon\.cargo\git\checkouts\wxrust-vendored-config-2459bb25f7f509b9\245f52f\src\lib.rs:54:10
  note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
warning: build failed, waiting for other jobs to finish...
error: failed to run custom build command for `wxrust v0.0.1-alpha (C:\Users\BrendanSimon\SW\wxRust2\wx-core)`

Caused by:
  process didn't exit successfully: `C:\Users\BrendanSimon\SW\wxRust2\target\debug\build\wxrust-e95e3129d44371d8\build-script-build` (exit code: 101)
  --- stderr
  thread 'main' panicked at 'Set 'wxwin' environment variable to point the wxMSW binaries dir.: NotPresent', C:\Users\BrendanSimon\.cargo\git\checkouts\wxrust-vendored-config-2459bb25f7f509b9\245f52f\src\lib.rs:54:10
  note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

Thanks :)

(Maybe) all allocated wxStrings are leaked

Other value types use struct with Drop, but for string directly returns new-ed pointers but wont be deleted...

We should have some type of tests for memory management like this.

size_t parameter type not supported

like this

separate cloned wx samples to another repo with sane licensing

I didn't and won't copy and paste directly, but it result resemble enough by original authors' work.
Once some samples cloned and wxRust2 become somewhat stable, move them to another repo and license with wx license and credit original authors

Generate class member constants associated with each class rather than module root

Make wxWeakRef-like for wx managed pointers

wxObjects in widget tree are managed its lifetime by the toolkit.

Pointers returned from API other than constructors or methods explicitly passes ownership may be dangling pointer.

Those pointers should have safer interface.

Use examples dir for ported wx samples

examples dir is conventional place easy to run in cargo

Make platform-specific API binding conditionally compiled

like this

fixes #41

API shortage found in my dogfooding

#173
- wxLaunchDefaultBrowser()
- Builder for wx::FileDialog
#172
- wxEVT_UPDATE_UI with wxUpdateUIEvent
- wxEVT_TEXT

Consider using a "vendored" wxWidgets dependency

First of all very nice project, thanks!

I have a suggestion on simplifying the external dependency on wxWidgets installation by having pre-built crates for popular architectures and platforms, as an optional feature dependency.

This will give an advantage of much easier CI/CD setup and cross-platform builds. For those who need a system-specific library the wx-config can still be used.

We are currently using this in our Rust project where wxWidgets is integrated via a custom C++ bridge and a few external crates which include wxWidgets binaries, examples:

https://github.com/ancwrd1/wx-universal-apple-darwin (macOS Intel + M1)
https://github.com/ancwrd1/wx-x86_64-pc-windows-gnu (Windows GNU toolchain)

Those binary crates can then be used via links and DEP_xxx cargo features in the build.rs:

use std::{env, error};

type BuildResult<T> = Result<T, Box<dyn error::Error>>;

fn dep_links() -> BuildResult<String> {
    let target = env::var("TARGET")?.replace('-', "_").to_uppercase();
    if target.contains("APPLE") {
        Ok("UNIVERSAL_APPLE_DARWIN".to_owned())
    } else {
        Ok(target)
    }
}
fn get_wx_cflags() -> BuildResult<Vec<String>> {
    Ok(env::var(format!("DEP_WX_{}_CFLAGS", dep_links()?))?
        .split_whitespace()
        .map(ToOwned::to_owned)
        .collect())
}

fn main() -> BuildResult<()> {
    let (link_flags, build_flags): (Vec<_>, Vec<_>) = get_wx_cflags()?
        .into_iter()
        .partition(|f| f.starts_with("-l") || f.starts_with("-L"));

    let mut build = cc::Build::new();

    let target = env::var("TARGET")?;

    build_flags
        .iter()
        .fold(&mut build, |build, f| build.flag(f))
        .flag("-DNDEBUG")
        .flag("-std=c++14")
        .cpp(true)
        .files(&[
            "cxx/app.cpp",
        ]);

    build.compile("libwxgui-cxx.a");

    for f in link_flags {
        println!("cargo:rustc-flags={}", f);
    }

    Ok(())
}

Change crate name and versioning

For crates.io publish:

Crate names
- Since wx crate name is already popular for wechat(weixin?) SDK
- Candidates:
  - wxwidgets
  - wxwidgets-base
Versioning
- 0.0.x
- Since there's no API stability as we map C++ overload to method name
- Compatible C++ API change may be break compatiblity in this lib

Make ffi modules wx*-sys crates

To follow the *-sys crate/package convention.

Blocks #72

Although it is a byproduct of the current least level abstraction.

Update README for current status (alpha stage)

Approaching alpha stage of this library, I'll update README of this project.

#145

kenz-gelsoft / wxrust2 Goto Github PK

wxrust2's People

Contributors

Stargazers

Watchers

Forkers

wxrust2's Issues

Recommend Projects

Recommend Topics

Recommend Org