Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refine function names and type signatures #886

Merged
merged 23 commits into from
May 30, 2019

Conversation

Osspial
Copy link
Contributor

@Osspial Osspial commented May 26, 2019

  • Tested on all platforms changed
    • Test on iOS
  • Added an entry to CHANGELOG.md if knowledge of this change could be valuable to users
    • Add multitouch changelog entry.
  • Updated documentation to reflect any user-facing changes, including notes of platform-specific behavior

This PR addresses the function naming and type signature issues brought up in #728 and #794. It also improves the typing for our error types (namely, by introducing types in the first place) and makes our getter APIs follow the Rust naming conventions.

Closes #728, closes #794.

@Osspial Osspial added this to the EventLoop 2.0 milestone May 26, 2019
Copy link
Contributor

@goddessfreya goddessfreya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nits and questions.

src/error.rs Show resolved Hide resolved
src/lib.rs Show resolved Hide resolved
src/platform/ios.rs Outdated Show resolved Hide resolved
src/platform_impl/ios/mod.rs Outdated Show resolved Hide resolved
src/platform_impl/ios/mod.rs Outdated Show resolved Hide resolved
src/platform_impl/windows/window.rs Show resolved Hide resolved
src/error.rs Outdated Show resolved Hide resolved
src/platform_impl/linux/x11/window.rs Show resolved Hide resolved
src/platform_impl/linux/x11/window.rs Show resolved Hide resolved
src/platform_impl/windows/window.rs Show resolved Hide resolved
src/error.rs Show resolved Hide resolved
@Osspial
Copy link
Contributor Author

Osspial commented May 29, 2019

This PR should be ready to merge. I'll give it a day or so to get any final feedback, though.

@Osspial Osspial merged commit 0df4369 into rust-windowing:eventloop-2.0 May 30, 2019
@felixrabe
Copy link
Contributor

Good stuff!

Btw there is a preference to switch off squashing (or enable other merge strategies) if you prefer: https://help.github.com/en/articles/configuring-commit-squashing-for-pull-requests

felixrabe pushed a commit to felixrabe/winit that referenced this pull request Jun 30, 2019
* First name consistency pass. More to come!

* Remove multitouch variable (hopefully this compiles!)

* Remove CreationError::NotSupported

* Add new error handling types

* Remove `get_` prefix from getters.

This is as per the Rust naming conventions recommended in
https://rust-lang-nursery.github.io/api-guidelines/naming.html#getter-names-follow-rust-convention-c-getter

* Make changes to Window position and size function signatures

* Remove CreationError in favor of OsError

* Begin updating iOS backend

* Change MonitorHandle::outer_position to just position

* Fix build on Windows and Linux

* Add Display and Error implementations to Error types

* Attempt to fix iOS build.

I can't actually check that this works since I can't cross-compile to
iOS on a Windows machine (thanks apple :/) but this should be one of
several commits to get it working.

* Attempt to fix iOS errors, and muck up Travis to make debugging easier

* More iOS fixins

* Add Debug and Display impls to OsError

* Fix Display impl

* Fix unused code warnings and travis

* Rename set_ime_spot to set_ime_position

* Add CHANGELOG entry

* Rename set_cursor to set_cursor_icon and MouseCursor to CursorIcon

* Organize Window functions into multiple, categorized impls

* Improve clarity of function ordering and docs in EventLoop
kosyak pushed a commit to kosyak/winit that referenced this pull request Jul 10, 2019
* First name consistency pass. More to come!

* Remove multitouch variable (hopefully this compiles!)

* Remove CreationError::NotSupported

* Add new error handling types

* Remove `get_` prefix from getters.

This is as per the Rust naming conventions recommended in
https://rust-lang-nursery.github.io/api-guidelines/naming.html#getter-names-follow-rust-convention-c-getter

* Make changes to Window position and size function signatures

* Remove CreationError in favor of OsError

* Begin updating iOS backend

* Change MonitorHandle::outer_position to just position

* Fix build on Windows and Linux

* Add Display and Error implementations to Error types

* Attempt to fix iOS build.

I can't actually check that this works since I can't cross-compile to
iOS on a Windows machine (thanks apple :/) but this should be one of
several commits to get it working.

* Attempt to fix iOS errors, and muck up Travis to make debugging easier

* More iOS fixins

* Add Debug and Display impls to OsError

* Fix Display impl

* Fix unused code warnings and travis

* Rename set_ime_spot to set_ime_position

* Add CHANGELOG entry

* Rename set_cursor to set_cursor_icon and MouseCursor to CursorIcon

* Organize Window functions into multiple, categorized impls

* Improve clarity of function ordering and docs in EventLoop
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants