Windows build support #7

DSchroer · 2022-11-11T13:40:07Z

Add the necessary build parameters in order to cross compile for windows.

Test with x86_64-pc-windows-gnu.

bschwind

Thanks for adding this! I can't immediately verify it on a windows machine myself, so I might wait until I try it out on a machine at work.

Side-note: I'd appreciate if you base your commits on my main branch so the commits tab in github only shows the new work you've done for this PR. Thanks!

crates/opencascade-sys/build.rs

bschwind · 2022-11-11T15:45:53Z

crates/opencascade-sys/build.rs

@@ -36,6 +37,8 @@ fn main() {
    cxx_build::bridge("src/lib.rs")
        .cpp(true)
        .flag_if_supported("-std=c++11")
+        .define("_USE_MATH_DEFINES", "TRUE")
+        .include(format!("{}", dst.join("inc").display()))


Is CMake generating this directory only for windows targets?

Seems to be. The structure is different in subtle ways.

One option is to add conditionals to enable/disable these different paths. I opted not to do that yet. Once a pattern emerges it might be a good idea.

Im not sure what OCCT does for macos or webassembly.

I tried for macos. It uses the lib directory.

Ah sorry, I should mention that I develop mainly on MacOS so that target should be well tested.

I'm currently not planning to target web assembly, though I may have plans in the future to have a model viewer that accepts web assembly blobs which generate instructions for generating an opencascade model.

Fair enough. I am primarily on Linux myself so that covers those two. I will probably need webassembly at some point but I am in no rush for it.

I'm working on a project similar to OpenSCAD. Last year I did the webassembly port of OpenSCAD and judging from the community reaction, I will probably need it for this project as well.

Haha I wanted fillets and chamfers as well. Got those in first thing.

I made an adapter for my cars cup holder so I can fit my favorite mug in it. So I can say its usable. However there is lots to do before its ready for real use. However I did get a little 3D editor in it so it really feels like working with OpenSCAD at this point.

I wouldnt have gotten so far if this crate didnt exist. I really appreciate the work you did here.

Feel free to leave issues and suggestions for things if you want. Especially syntax for the language since that needs lots of inspiration.

Really cool to get a usable, real-world object as a result of some Rust hacking :)

I did get a little 3D editor in it so it really feels like working with OpenSCAD at this point.

MacOS has a native STL viewer that I've been using as a crutch, otherwise I probably would have gotten frustrated and made a viewer as well.

I wouldnt have gotten so far if this crate didnt exist. I really appreciate the work you did here.

Thank the opencascade devs! And dtolnay for the cxx crate :) I'm just gluing things together here, though I did suffer through the initial work of getting build.rs working properly, I'll take credit for that haha

I'll clone it and give it a spin!

crates/opencascade-sys/build.rs

DSchroer · 2022-11-11T23:33:03Z

Side-note: I'd appreciate if you base your commits on my main branch so the commits tab in github only shows the new work you've done for this PR. Thanks!

Im trying. Maintaining a fork is not something I am used to. Especially where I need a main branch to work on my changes as well with potentially multiple of the PRs merged. Ill do my best to keep it simple in the future.

bschwind · 2022-11-12T02:16:33Z

@DSchroer let me know if you need any help with git operations.

My basic workflow for forks is to have two remotes. As an example, here's my local git repo for cameleon, a crate I've contributed to which I don't own:

cameleon $ git remote -v
bschwind	[email protected]:bschwind/cameleon.git (fetch)
bschwind	[email protected]:bschwind/cameleon.git (push)
origin	https://github.com/cameleon-rs/cameleon.git (fetch)
origin	https://github.com/cameleon-rs/cameleon.git (push)

You can add remotes with git remote add <REMOTE_NAME> <REMOTE_URL>. Example:

git remote add bschwind [email protected]:bschwind/cameleon.git

You can then fetch branches with git fetch bschwind.

To checkout my latest main branch, assuming your remote for my repo is called bschwind, you would run:

git fetch bschwind

# checks out a local branch named "bschwind/main"
git switch -c bschwind/main

You can then create a new branch based on bschwind/main with:

git checkout -b your-feature-name

When done with your work, push to your remote and make a PR:

git push origin your-feature-name

When you want to update bschwind/main with the latest changes:

git checkout bschwind/main
git pull bschwind main

DSchroer · 2022-11-12T03:21:06Z

Thanks! Ill use that for future PRs. I appreciate the detailed response.

DSchroer · 2022-11-12T03:26:03Z

Just a note. You can test this on linux if you do the following:

rustup toolchain install nightly-x86_64-pc-windows-gnu
rustup target add x86_64-pc-windows-gnu
cargo build --release --target x86_64-pc-windows-gnu

Just make sure that you have mingw-w64 installed as well.

bschwind · 2022-11-15T13:15:23Z

Still waiting to test this on a windows machine, sorry! Work is busy this week until Thursday, I'll try to test it then.

bschwind · 2022-11-17T11:22:22Z

On the msvc toolchain, after adding the correct linker path, I get this output:

  = note:    Creating library C:\Users\Maker\projects\opencascade-rs\target\release\examples\bottle.lib and object C:\Users\Maker\projects\opencascade-rs\target\release\examples\bottle.exp
          libopencascade_sys-b15f482ef2568063.rlib(OSD_signal.obj) : error LNK2019: unresolved external symbol __imp_MessageBoxA referenced in function "long __cdecl CallHandler(unsigned long,struct _EXCEPTION_POINTERS *)" (?CallHandler@@YAJKPEAU_EXCEPTION_POINTERS@@@Z)
          libopencascade_sys-b15f482ef2568063.rlib(OSD_signal.obj) : error LNK2019: unresolved external symbol __imp_MessageBeep referenced in function "long __cdecl CallHandler(unsigned long,struct _EXCEPTION_POINTERS *)" (?CallHandler@@YAJKPEAU_EXCEPTION_POINTERS@@@Z)
          C:\Users\Maker\projects\opencascade-rs\target\release\examples\bottle.exe : fatal error LNK1120: 2 unresolved externals

I'll investigate this more later but I have to leave this machine for now.

bschwind · 2022-11-23T05:51:41Z

Hi @DSchroer,

I have a PR on your branch here (a bit confusing, I know) to get the build working on the native windows rust toolchain. If it looks good, we can merge that into your branch, then I think the PR here will be good to go!

Make the build work on windows msvc targets

DSchroer · 2022-11-24T03:12:55Z

Hey. I built your changes against my project and it worked just fine. So I merged them. Now I run into a weird error with the examples though. My project gives no errors but the examples give me:

ustlib/x86_64-pc-windows-gnu/lib" "-o" "/home/dschroer/Projects/opencascade-rs/target/x86_64-pc-windows-gnu/debug/examples/simple-82e2bede0d1a71a5.exe" "-Wl,--gc-sections" "-no-pie" "-nodefaultlibs" "/home/dschroer/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/x86_64-pc-windows-gnu/lib/rsend.o"
  = note: /usr/lib/gcc/x86_64-w64-mingw32/12.2.0/../../../../x86_64-w64-mingw32/bin/ld: /home/dschroer/Projects/opencascade-rs/target/x86_64-pc-windows-gnu/debug/deps/libopencascade_sys-9ec0e326a19c17a9.rlib(Standard_ErrorHandler.cxx.obj): in function `Standard_ErrorHandler::Callback::RegisterCallback()':
          /home/dschroer/Projects/opencascade-rs/crates/opencascade-sys/OCCT/src/Standard/Standard_ErrorHandler.cxx:289: multiple definition of `Standard_ErrorHandler::Callback::RegisterCallback()'; /home/dschroer/Projects/opencascade-rs/target/x86_64-pc-windows-gnu/debug/deps/libopencascade_sys-9ec0e326a19c17a9.rlib(wrapper.o):/home/dschroer/Projects/opencascade-rs/target/x86_64-pc-windows-gnu/debug/build/opencascade-sys-ff866f5ac74453b6/out/inc/Standard_ErrorHandler.hxx:221: first defined here
          /usr/lib/gcc/x86_64-w64-mingw32/12.2.0/../../../../x86_64-w64-mingw32/bin/ld: /home/dschroer/Projects/opencascade-rs/target/x86_64-pc-windows-gnu/debug/deps/libopencascade_sys-9ec0e326a19c17a9.rlib(Standard_ErrorHandler.cxx.obj): in function `Standard_ErrorHandler::Callback::UnregisterCallback()':
          /home/dschroer/Projects/opencascade-rs/crates/opencascade-sys/OCCT/src/Standard/Standard_ErrorHandler.cxx:306: multiple definition of `Standard_ErrorHandler::Callback::UnregisterCallback()'; /home/dschroer/Projects/opencascade-rs/target/x86_64-pc-windows-gnu/debug/deps/libopencascade_sys-9ec0e326a19c17a9.rlib(wrapper.o):/home/dschroer/Projects/opencascade-rs/target/x86_64-pc-windows-gnu/debug/build/opencascade-sys-ff866f5ac74453b6/out/inc/Standard_ErrorHandler.hxx:224: first defined here
          collect2: error: ld returned 1 exit status

Ive got no idea where those are coming from at this point. Any ideas? I probably wont have time to look deep for a few weeks right now. However we can let this sit on ice until then.

Can you build the examples with MSVC?

bschwind · 2022-12-09T02:18:46Z

Hi @DSchroer sorry to get back to you so late on this!

I am able to build and run the bottle example on the MSVC toolchain. I'll try reproducing your error with x86_64-pc-windows-gnu.

bschwind · 2022-12-09T02:26:29Z

@DSchroer actually I haven't used mingw in forever on windows, do you have a list of steps I can follow to reproduce the issue you're seeing, on a windows machine specifically? That'll probably be faster than me struggling with windows for hours 😅

DSchroer · 2022-12-11T17:06:03Z

@bschwind I have some time to look into it now.

For repro steps on linux (I am corss compiling):

Install the mingw toolset
Run cargo build --target x86_64-pc-windows-gnu --example simple

DSchroer · 2022-12-11T18:05:31Z

Got it fixed. We need to set the OCC_CONVERT_SIGNALS define on windows builds. https://dev.opencascade.org/doc/overview/html/occt_user_guides__foundation_classes.html

bschwind · 2022-12-12T08:04:02Z

crates/opencascade-sys/build.rs

    cxx_build::bridge("src/lib.rs")
        .cpp(true)
        .flag_if_supported("-std=c++11")
-        .include(format!("{}", dst.join("include").join("opencascade").display()))
+        .define("_USE_MATH_DEFINES", "TRUE")
+        .define("OCC_CONVERT_SIGNALS", occ_convert_define)


From this page

On Windows with MSVC compiler, exceptions can be thrown directly from signal handler, this OCC_CONVERT_SIGNALS is not needed. Note however that this requires that compiler option /EHa is used.

Not sure if we need /EHa here or not. I built this on the default MSVC toolchain you get with a windows Rust installation and I get two linking errors:

unresolved external symbol "public: void __cdec1 Standard_ErrorHandler::Callback::RegisterCallback(void)" unresolved external symbol "public: void __cdec1 Standard_ErrorHandler::Callback::UnregisterCallback(void)"

Currently still working this out.

Ive limited the flag to only *-windows-gnu builds. It should fix the error for you now.

@DSchroer I think if it's not *-windows-gnu you don't want to define OCC_CONVERT_SIGNALS at all. On MSVC, if you set occ_convert_define to None, you're still defining OCC_CONVERT_SIGNALS and I still get the issue I mentioned above.

Oh shoot. I assumed based on the interface .define("thing", None) would disable it. Ill look into it soon.

Ive done another pass. This time its only ever set for windows-gnu. Hopefully this works.

…indows-build

bschwind

LGTM!

Tested and working on the MSVC toolchain, sorry for all the back-and-forth on this but glad we finally got it working!

DSchroer · 2022-12-19T15:50:00Z

Awesome! Want to merge the PR?

bschwind · 2022-12-19T15:51:44Z

Haha yep, got distracted right after I commented that, sorry!

Thanks for the PR and patience :)

DSchroer added 4 commits November 4, 2022 20:32

Remove unused rerun-if causing rebuild

7bbadda

Add rerun-if-changed=include/wrapper.hxx

5bac35f

Merge remote-tracking branch 'bschwind/main'

550e993

Add Windows build support

78fbb08

bschwind reviewed Nov 11, 2022

View reviewed changes

DSchroer and others added 2 commits November 20, 2022 10:04

Use INSTALL_DIR_LIB and INSTALL_DIR_INCLUDE

31ba543

Make the build work on windows msvc targets

91d0042

Merge pull request #1 from bschwind/feat/windows-build

bc31437

Make the build work on windows msvc targets

Add OCC_CONVERT_SIGNALS flag

47f2ae3

DSchroer added 2 commits December 11, 2022 11:05

Format

e01d870

Use FALSE for windows

0173c4b

bschwind reviewed Dec 12, 2022

View reviewed changes

DSchroer added 3 commits December 12, 2022 15:29

Enalbe OCC_CONVERT_SIGNALS only for windows-gnu

717edb5

Merge branch 'main' of github.com:bschwind/opencascade-rs into feat/w…

f1822a0

…indows-build

Only define OCC_CONVERT_SIGNALS for windows-gnu

f358722

bschwind approved these changes Dec 19, 2022

View reviewed changes

bschwind merged commit 0e4696e into bschwind:main Dec 19, 2022

bschwind mentioned this pull request Feb 7, 2023

Topic as will.topic bschwind/mqtt-broker#52

Closed

bschwind mentioned this pull request Jun 1, 2023

compile error #27

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Windows build support #7

Windows build support #7

DSchroer commented Nov 11, 2022

bschwind left a comment

bschwind Nov 11, 2022

DSchroer Nov 12, 2022

DSchroer Nov 15, 2022

bschwind Nov 15, 2022

DSchroer Nov 15, 2022

DSchroer Nov 15, 2022

DSchroer Nov 15, 2022

DSchroer Nov 15, 2022

bschwind Nov 15, 2022

bschwind Nov 15, 2022

DSchroer commented Nov 11, 2022

bschwind commented Nov 12, 2022

DSchroer commented Nov 12, 2022

DSchroer commented Nov 12, 2022

bschwind commented Nov 15, 2022

bschwind commented Nov 17, 2022

bschwind commented Nov 23, 2022

DSchroer commented Nov 24, 2022

bschwind commented Dec 9, 2022

bschwind commented Dec 9, 2022

DSchroer commented Dec 11, 2022

DSchroer commented Dec 11, 2022

bschwind Dec 12, 2022

DSchroer Dec 12, 2022

bschwind Dec 15, 2022

DSchroer Dec 16, 2022

DSchroer Dec 17, 2022

bschwind left a comment

DSchroer commented Dec 19, 2022

bschwind commented Dec 19, 2022

Windows build support #7

Windows build support #7

Conversation

DSchroer commented Nov 11, 2022

bschwind left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DSchroer commented Nov 11, 2022

bschwind commented Nov 12, 2022

DSchroer commented Nov 12, 2022

DSchroer commented Nov 12, 2022

bschwind commented Nov 15, 2022

bschwind commented Nov 17, 2022

bschwind commented Nov 23, 2022

DSchroer commented Nov 24, 2022

bschwind commented Dec 9, 2022

bschwind commented Dec 9, 2022

DSchroer commented Dec 11, 2022

DSchroer commented Dec 11, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bschwind left a comment

Choose a reason for hiding this comment

DSchroer commented Dec 19, 2022

bschwind commented Dec 19, 2022