Upload release 1.0.0 of OpenXR loader, layers, and samples

Author: rpavlik

.gitattributes

@@ -19,6 +19,7 @@
 *.sh      eol=lf
 
 *.png     binary
+*.pdf     binary
 
 # Shell scripts that don't end in .sh
 specification/makeAllExts           eol=lf
@@ -27,4 +28,4 @@ specification/makeKHR               eol=lf
 specification/makeKHRAndKHX         eol=lf
 specification/makeReleaseArtifacts  eol=lf
 specification/checkMarkup           eol=lf
-specification/checkSpecLinks        eol=lf
+specification/checkSpecLinks        eol=lf

.gitignore

@@ -1,10 +1,14 @@
-/build
-/build*
+/build/
+/build*/
 CMakeLists.txt.user
 *.orig
 .*
 *~
+*.tar
 *.tar.gz
+*.log
+pregen/
+doc/
 
 # Cached python scripts in bytecode form
 *.pyc
@@ -19,6 +23,9 @@ specification/examples.mk
 # Files related to pytest
 specification/scripts/.cache
 
+# VS 2019 CMake artifacts
+out/build/
+
 # VS misc
 *.sln
 *.pyproj

BUILDING.md

@@ -4,7 +4,10 @@
 
 Certain source files are generated at build time from the `xr.xml` file, utilizing 
 python scripts. The scripts make use of the python `pathlib` module, which is 
-fully supported in python version 3.6 or later. 
+fully supported in python version 3.6 or later.
+
+You will also need the python `jinja2` package, available from your package
+manager or with something like `pip3 install jinja2`.
 
 ## Windows
 

CHANGELOG.SDK.md

@@ -1,15 +1,56 @@
-# Changelog for OpenXR-SDK Repo
+# Changelog for OpenXR-SDK-Source and OpenXR-SDK Repo
 
-Update log for the OpenXR-SDK repo on GitHub.
+Update log for the OpenXR-SDK-Source and OpenXR-SDK repo on GitHub.
 Updates are in reverse chronological order starting with the latest public release.
 
+Note that only changes relating to the loader and some of the build changes will affect the OpenXR-SDK repository.
+
 This summarizes the periodic public updates, not individual commits. Updates
 on GitHub are generally done as single large patches at the release point,
 collecting together the resolution of many Khronos internal issues,
 along with any public pull requests that have been accepted.
 In this repository in particular, since it is primarily software,
 pull requests may be integrated as they are accepted even between periodic updates.
 
+## OpenXR 1.0.0 release (29-July-2019)
+
+Incorporates spec changes from OpenXR 1.0,
+all public pull requests incorporated in the 0.90 series,
+and additional fixes and improvements not previously published.
+
+## Change log for OpenXR 0.90 provisional spec updates post-0.90.1
+
+### GitHub Pull Requests
+
+These had been integrated into the public repo incrementally.
+
+- General, Build, Other
+  - #40 - Update BUILDING.md with some Linux pre-requisites
+  - #43 - Make manifest file more compatible
+  - #44 - Remove pkg-config dependency from xlib backend
+  - #46 - Support building with "embedded" Python
+  - #48 - Install layers and pkg-config file on Linux
+  - #66 - Install the layers libraries on Linux
+  - #71 - Validation layer: fix logic error
+- hello_xr
+  - #49 - Fix hello_xr to properly use two call idiom
+- Loader
+  - #38 - Remove dead file-locking code
+  - #51 - Idiomatic Linux active_runtime.json search logic
+  - #55, #58, #68 - Purge std::map bracket operations that might do inadvertent insertions
+  - #56 - Make `filesystem_util.cc` `#define UNICODE`-compatible
+  - #57 - Make it possible to bypass macro that checks which `filesystem` to use
+  - #60 - Fix build error with shlwapi function
+  - #62 - Don't limit contents of `XristanceCreateInfo` next chain
+  - #65 - Fix minor substr error
+  - #69 - Simplify loader
+  - #70, #76 - Make loader exception free
+  - #72 - filesystem: fix theoretical bug on Linux
+  - #73 - Loader proper UNICODE support
+  - #75 - Clang tidy
+  - #80 - Switchable exceptions
+  - #82 - Add folder properties to all CMake targets.
+
 ## Change log for OpenXR 0.90.1 provisional spec update (8-May-2019)
 
 No API changes, and only minimal consistency changes to the spec/registry.

CMakeLists.txt

@@ -22,6 +22,8 @@
 cmake_minimum_required(VERSION 3.0)
 project(OPENXR)
 
+find_package(PythonInterp 3)
+
 # Enable IDE GUI folders.  "Helper targets" that don't have interesting source code should set their FOLDER property to this
 set_property(GLOBAL PROPERTY USE_FOLDERS ON)
 set_property(GLOBAL PROPERTY PREDEFINED_TARGETS_FOLDER "CMake predefined targets")
@@ -32,6 +34,12 @@ set(TESTS_FOLDER "Tests")
 set(API_LAYERS_FOLDER "Layers")
 set(SAMPLES_FOLDER "Samples")
 
+option(BUILD_FORCE_GENERATION "Force re-generation of files even in the presence of pre-generated copies, replacing those copies." OFF)
+
+if(BUILD_FORCE_GENERATION AND NOT PYTHON_EXECUTABLE)
+    message(FATAL_ERROR "BUILD_FORCE_GENERATION requires Python")
+endif()
+
 add_subdirectory(include)
 add_subdirectory(src)
 

README.md

@@ -1,38 +1,36 @@
-# OpenXR ® Software Development Kit (SDK) Project
+# OpenXR™ Software Development Kit (SDK) Sources Project
 
-**_NOTE: This repository contains components that will eventually be assembled 
-into an OpenXR SDK, but are currently not organized nor packaged as a distributable SDK._**  
-
-This repository contains source code and build scripts for implementations 
+This repository contains source code and build scripts for implementations
 of the OpenXR loader, validation layers, and code samples.
 
 The authoritative public repository is located at
-https://github.com/KhronosGroup/OpenXR-SDK/.
+<https://github.com/KhronosGroup/OpenXR-SDK-Source/>.
 It hosts the public Issue tracker, and accepts patches (Pull Requests) from the
 general public.
 
+If you want to simply write an application using OpenXR (the headers and loader),
+with minimum dependencies,
+see <https://github.com/KhronosGroup/OpenXR-SDK/>.
+That project is based on this one, but contains all generated files pre-generated,
+removing the requirement for Python or build-time file generation,
+and omits the samples, tests, and API layers, as they are not typically built as a part of an application.
+
 ## Directory Structure
-```
-BUILDING.md           Instructions for building the projects
-README.md             This file
-COPYING.md            Copyright and licensing information
-CODE_OF_CONDUCT.md    Code of Conduct
-external/             External code for projects in the repo
-include/              OpenXR platform include file
-specification/        xr.xml file
-src/                  Source code for various projects
-src/api_layer         Sample code for developing API layers
-src/loader            OpenXR loader code
-src/tests/            various test code (if looking for sample code start with hello_xr/)
-```
-
-Currently the best sample code is in [src/tests/hello_xr/](https://github.com/KhronosGroup/OpenXR-SDK/tree/master/src/tests/hello_xr).  More will be added in the future.  
-
-This structure is for the provisional specification.  Things are 
-incomplete at launch but will be added to going forward.
 
+- `BUILDING.md` - Instructions for building the projects
+- `README.md` - This file
+- `COPYING.md` - Copyright and licensing information
+- `CODE_OF_CONDUCT.md` - Code of Conduct
+- `external/` - External code for projects in the repo
+- `include/` - OpenXR platform include file
+- `specification/` - xr.xml file
+- `src/` - Source code for various projects
+- `src/api_layer` - Sample code for developing API layers
+- `src/loader` - OpenXR loader code
+- `src/tests` - various test code (if looking for sample code start with `hello_xr/`)
 
-## Building
+Currently the best sample code is in [src/tests/hello_xr/](https://github.com/KhronosGroup/OpenXR-SDK-Source/tree/master/src/tests/hello_xr).  More will be added in the future.
 
-See [BUILDING.md](https://github.com/KhronosGroup/OpenXR-SDK/blob/master/BUILDING.md)
+## Building
 
+See [BUILDING.md](https://github.com/KhronosGroup/OpenXR-SDK-Source/blob/master/BUILDING.md)

checkCodespell

@@ -44,7 +44,7 @@ IGNORE_WORDS="lod,LOD"
 # Add to this to exclude individual files or directories (comma-delimited)
 # - Skipping external code.
 # - Skipping binary files.
-SKIP="${ROOT}/src/external,*.pyc,*.png"
+SKIP="${ROOT}/src/external,${ROOT}/src/conformance/framework/catch2,*.pyc,*.png,*.jpg,*.svg"
 
 # Args that get passed if no args are provided to this script.
 # -q4 to silence "UINT  ==> UNIT  | disabled due to being a data type"