diff --git a/glfw/.gitattributes b/glfw/.gitattributes new file mode 100644 index 00000000..2b9b79e2 --- /dev/null +++ b/glfw/.gitattributes @@ -0,0 +1,2 @@ +* text=auto eol=lf + diff --git a/glfw/.github/FUNDING.yml b/glfw/.github/FUNDING.yml new file mode 100644 index 00000000..99fd1066 --- /dev/null +++ b/glfw/.github/FUNDING.yml @@ -0,0 +1 @@ +github: slimsag diff --git a/glfw/.github/pull_request_template.md b/glfw/.github/pull_request_template.md new file mode 100644 index 00000000..91b1ef3e --- /dev/null +++ b/glfw/.github/pull_request_template.md @@ -0,0 +1,3 @@ + + +- [ ] By selecting this checkbox, I agree to license my contributions to this project under the license(s) described in the LICENSE file, and I have the right to do so or have received permission to do so by an employer or client I am producing work for whom has this right. \ No newline at end of file diff --git a/glfw/.github/workflows/ci.yml b/glfw/.github/workflows/ci.yml new file mode 100644 index 00000000..063f4c9d --- /dev/null +++ b/glfw/.github/workflows/ci.yml @@ -0,0 +1,95 @@ +name: CI +on: + - push + - pull_request +jobs: + x86_64-linux: + runs-on: ubuntu-latest + # We want to run on external PRs, but not on our own internal PRs as they'll be run by the push + # to the branch. + if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository + env: + DISPLAY: ':99.0' + steps: + - name: Checkout + uses: actions/checkout@v2 + - name: Setup Zig + run: | + sudo apt install xz-utils + sudo sh -c 'wget -c https://ziglang.org/builds/zig-linux-x86_64-0.9.0-dev.959+f011f1393.tar.xz -O - | tar -xJ --strip-components=1 -C /usr/local/bin' + - name: x86_64-linux -> x86_64-macos + run: zig build test -Dtarget=x86_64-macos + env: + AGREE: true + - name: x86_64-linux -> aarch64-macos + run: zig build test -Dtarget=aarch64-macos + env: + AGREE: true + - name: x86_64-linux -> x86_64-windows + run: zig build test -Dtarget=x86_64-windows + - name: launch xvfb + run: Xvfb :99 -screen 0 1680x720x24 > /dev/null 2>&1 & + - name: mach::test + run: | + sudo add-apt-repository -y ppa:kisak/kisak-mesa + sudo apt-get update + sudo apt-get install mesa-utils mesa-utils-extra mesa-va-drivers mesa-vdpau-drivers mesa-vulkan-drivers xvfb + zig build test + - name: webgpu::test + run: cd webgpu && zig build test + x86_64-windows: + runs-on: windows-latest + # We want to run on external PRs, but not on our own internal PRs as they'll be run by the push + # to the branch. + if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository + steps: + - name: Checkout + uses: actions/checkout@v2 + - name: Install Git + run: choco install git + - name: Setup Zig + run: | + Invoke-WebRequest -Uri "https://ziglang.org/builds/zig-windows-x86_64-0.9.0-dev.959+f011f1393.zip" -OutFile "C:\zig.zip" + cd C:\ + 7z x zig.zip + Add-Content $env:GITHUB_PATH "C:\zig-windows-x86_64-0.9.0-dev.959+f011f1393\" + - name: x86_64-windows -> x86_64-macos + run: zig build test -Dtarget=x86_64-macos + env: + AGREE: true + - name: x86_64-windows -> aarch64-macos + run: zig build test -Dtarget=aarch64-macos + env: + AGREE: true + - name: x86_64-windows -> x86_64-linux + run: zig build test -Dtarget=x86_64-linux + - name: mach::test + run: zig build test + - name: webgpu::test + run: cd webgpu && zig build test + x86_64-macos: + runs-on: macos-latest + # We want to run on external PRs, but not on our own internal PRs as they'll be run by the push + # to the branch. + if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository + steps: + - name: Checkout + uses: actions/checkout@v2 + - name: Setup Zig + run: | + brew install xz + sudo sh -c 'wget -c https://ziglang.org/builds/zig-macos-x86_64-0.9.0-dev.959+f011f1393.tar.xz -O - | tar -xJ --strip-components=1 -C /usr/local/bin' + - name: mach::test + run: zig build test + env: + AGREE: true + - name: x86_64-macos -> aarch64-macos + run: zig build test -Dtarget=aarch64-macos + env: + AGREE: true + - name: x86_64-macos -> x86_64-windows + run: zig build test -Dtarget=x86_64-windows + - name: x86_64-macos -> x86_64-linux + run: zig build test -Dtarget=x86_64-linux + - name: webgpu::test + run: cd webgpu && zig build test diff --git a/glfw/.github/workflows/m1_ci.yml b/glfw/.github/workflows/m1_ci.yml new file mode 100644 index 00000000..5b09cd83 --- /dev/null +++ b/glfw/.github/workflows/m1_ci.yml @@ -0,0 +1,35 @@ +name: CI +on: + # SECURITY: This must be a push event only, otherwise our M1 mac runner would be compromised by + # third-party pull requests which could run arbitrary code. This way, we can restrict it to + # collaborators of the repository only. + # + # Whenever GitHub Actions gets official M1 support, we can use that for PRs and get rid of this + # self-hosted runner: https://github.com/actions/virtual-environments/issues/2187 + - push +jobs: + aarch64-macos: + runs-on: [self-hosted, macOS, ARM64] + defaults: + run: + shell: "/usr/bin/arch -arch arm64e /bin/bash --noprofile --norc -eo pipefail {0}" + steps: + - name: Checkout + uses: actions/checkout@v2 + - name: Setup Zig + run: | + zig version + - name: mach::test + run: zig build test + env: + AGREE: true + - name: aarch64-macos -> x86_64-macos + run: zig build test -Dtarget=x86_64-macos + env: + AGREE: true + - name: aarch64-macos -> x86_64-windows + run: zig build test -Dtarget=x86_64-windows + - name: aarch64-macos -> x86_64-linux + run: zig build test -Dtarget=x86_64-linux + - name: webgpu::test + run: cd webgpu && zig build test diff --git a/glfw/.gitignore b/glfw/.gitignore new file mode 100644 index 00000000..0b4957c5 --- /dev/null +++ b/glfw/.gitignore @@ -0,0 +1,18 @@ +# This file is for zig-specific build artifacts. +# If you have OS-specific or editor-specific files to ignore, +# such as *.swp or .DS_Store, put those in your global +# ~/.gitignore and put this in your ~/.gitconfig: +# +# [core] +# excludesfile = ~/.gitignore +# +# Cheers! +# -andrewrk + +zig-cache/ +zig-out/ +/release/ +/debug/ +/build/ +/build-*/ +/docgen_tmp/ \ No newline at end of file diff --git a/glfw/LICENSE b/glfw/LICENSE new file mode 100644 index 00000000..ba6099da --- /dev/null +++ b/glfw/LICENSE @@ -0,0 +1,13 @@ +Copyright 2021, Hexops Contributors (given via the Git commit history). + +All documentation, image, sound, font, and 2D/3D model files are CC-BY-4.0 licensed unless +otherwise noted. You may get a copy of this license at https://creativecommons.org/licenses/by/4.0 + +Files in a directory with a separate LICENSE file may contain files under different license terms, +described within that LICENSE file. + +All other files are licensed under the Apache License, Version 2.0 (see LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0) +or the MIT license (see LICENSE-MIT or http://opensource.org/licenses/MIT), at your option. + +All files in the project without exclusions may not be copied, modified, or distributed except +according to the terms above. \ No newline at end of file diff --git a/glfw/LICENSE-APACHE b/glfw/LICENSE-APACHE new file mode 100644 index 00000000..d6456956 --- /dev/null +++ b/glfw/LICENSE-APACHE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/glfw/LICENSE-MIT b/glfw/LICENSE-MIT new file mode 100644 index 00000000..14cd7973 --- /dev/null +++ b/glfw/LICENSE-MIT @@ -0,0 +1,25 @@ +Copyright (c) 2021 Hexops Contributors (given via the Git commit history). + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. diff --git a/glfw/README.md b/glfw/README.md new file mode 100644 index 00000000..68c0496b --- /dev/null +++ b/glfw/README.md @@ -0,0 +1,38 @@ +# mach/glfw - Ziggified GLFW bindings [![CI](https://github.com/hexops/engine/workflows/CI/badge.svg)](https://github.com/hexops/engine/actions) Hexops logo + +Ziggified GLFW bindings that [Mach engine](https://github.com/hexops/mach) uses, with 100% API coverage & zero-fuss installation, cross compilation, and more. + +The main Mach repository includes this one as a `git subtree`. This is a separate repo so that anyone can use this library in their own project / engine if they like! + +## Zero fuss installation, cross compilation, and more + +[Just as with Mach](https://github.com/hexops/mach#zero-fuss-installation--cross-compilation), you get zero fuss installation & cross compilation using these GLFW bindings. **only `zig` and `git` are needed to build from any OS and produce binaries for every OS.** No system dependencies at all. + +See also: [platform support table](https://github.com/hexops/mach#supported-platforms) + +## 100% API coverage + +These bindings recently achieved 100% API coverage of GLFW v3.3.4. Every function, type, etc. has been wrapped in a ziggified API. + +## What does a ziggified GLFW API offer? + +You could just `@cImport` GLFW with Zig - the main reasons to use a ziggified wrapper though are because you get: + +* `true` and `false` booleans instead of `c.GLFW_TRUE` and `c.GLFW_FALSE` integers +* Methods, so you can write e.g. `window.hint` instead of `glfwWindowHint` +* Generics, so you can just use `window.hint` instead of `glfwWindowHint`, `glfwWindowHintString`, etc. +* Enums, so you can write `window.getKey(.escape)` instead of `c.glfwGetKey(window, c.GLFW_KEY_ESCAPE)` +* Slices instead of C pointers and lengths. +* [`packed struct`](https://ziglang.org/documentation/master/#packed-struct) to represent bit masks, so you can interact with each bit the same way you'd interact with a `bool` if you like, instead of remembering the `&` `|` `^` incantation (although you're free to do that too.) + +## Issues + +Issues are tracked in the [main Mach repository](https://github.com/hexops/mach/issues?q=is%3Aissue+is%3Aopen+label%3Aglfw). + +## Contributing + +Contributions are very welcome. Just send a PR to this repository. + +We track the latest stable release of GLFW, if you need a newer version we can start a development branch / figure that out - just open an issue. + +Once your PR is merged, if you're using Mach engine and wanting the changes there, it will be sync'd to the main repo via `git subtree`. diff --git a/glfw/update-upstream.sh b/glfw/update-upstream.sh index c6f21ea5..e6779449 100755 --- a/glfw/update-upstream.sh +++ b/glfw/update-upstream.sh @@ -21,3 +21,4 @@ git clone https://github.com/KhronosGroup/Vulkan-Headers vulkan_headers/ cd vulkan_headers rm -rf .git registry/ *.gn *.txt *.md cmake/ rm -rf include/vk_video +rm .cmake-format.py .gitattributes .gitignore diff --git a/glfw/upstream/vulkan_headers/.cmake-format.py b/glfw/upstream/vulkan_headers/.cmake-format.py deleted file mode 100644 index 07d2f99d..00000000 --- a/glfw/upstream/vulkan_headers/.cmake-format.py +++ /dev/null @@ -1,34 +0,0 @@ -# Configuration for cmake-format (v0.4.1, circa Jul 2018) -# https://github.com/cheshirekow/cmake_format - -# How wide to allow formatted cmake files -line_width = 132 - -# How many spaces to tab for indent -tab_size = 4 - -# If arglists are longer than this, break them always -max_subargs_per_line = 3 - -# If true, separate flow control names from their parentheses with a space -separate_ctrl_name_with_space = False - -# If true, separate function names from parentheses with a space -separate_fn_name_with_space = False - -# If a statement is wrapped to more than one line, than dangle the closing -# parenthesis on it's own line -dangle_parens = False - -# What character to use for bulleted lists -bullet_char = u'*' - -# What character to use as punctuation after numerals in an enumerated list -enum_char = u'.' - -# What style line endings to use in the output. -line_ending = u'unix' - -# Format command names consistently as 'lower' or 'upper' case -command_case = u'lower' - diff --git a/glfw/upstream/vulkan_headers/.gitattributes b/glfw/upstream/vulkan_headers/.gitattributes deleted file mode 100644 index ca85b461..00000000 --- a/glfw/upstream/vulkan_headers/.gitattributes +++ /dev/null @@ -1,16 +0,0 @@ -# See https://git-scm.com/docs/gitattributes -# See https://help.github.com/articles/dealing-with-line-endings/ - -# Default behavior, if core.autocrlf is unset. -* text=auto - -# Files to be converted to native line endings on checkout. -*.cpp text -*.h text - -# Text files to always have CRLF (dos) line endings on checkout. -*.bat text eol=crlf - -# Text files to always have LF (unix) line endings on checkout. -*.sh text eol=lf - diff --git a/glfw/upstream/vulkan_headers/.gitignore b/glfw/upstream/vulkan_headers/.gitignore deleted file mode 100644 index 61df0010..00000000 --- a/glfw/upstream/vulkan_headers/.gitignore +++ /dev/null @@ -1,6 +0,0 @@ -# Python cache -__pycache__ -*.pyc -build -.vscode/ -**/.*.swp