Merge pull request #129 from BastiaanOlij/clang_format_ci

Add clang format to CI

Author: BastiaanOlij

.github/workflows/scripts/clang_format.sh

@@ -0,0 +1,47 @@
+#!/usr/bin/env bash
+
+# This script runs clang-format and fixes copyright headers on all relevant files in the repo.
+# This is the primary script responsible for fixing style violations.
+
+set -uo pipefail
+IFS=$'\n\t'
+
+CLANG_FORMAT_FILE_EXTS=(".c" ".h" ".cpp" ".hpp" ".cc" ".hh" ".cxx" ".m" ".mm" ".inc" ".java" ".glsl")
+
+# Loops through all text files tracked by Git.
+git grep -zIl '' |
+while IFS= read -rd '' f; do
+    # Exclude 3rd party files.
+    if [[ "$f" == "openvr"* ]]; then
+        continue
+    elif [[ "$f" == "godot-cpp"* ]]; then
+        continue
+    elif [[ "$f" == "demo/addons/godot-xr-tools"* ]]; then
+        continue
+    elif [[ "$f" == ".github"* ]]; then
+        continue
+    fi
+    for extension in ${CLANG_FORMAT_FILE_EXTS[@]}; do
+        if [[ "$f" == *"$extension" ]]; then
+            # Run clang-format.
+            clang-format -i "$f"
+        fi
+    done
+done
+
+git diff > patch.patch
+
+# If no patch has been generated all is OK, clean up, and exit.
+if [ ! -s patch.patch ] ; then
+    printf "Files in this commit comply with the clang-format style rules.\n"
+    rm -f patch.patch
+    exit 0
+fi
+
+# A patch has been created, notify the user, clean up, and exit.
+printf "\n*** The following differences were found between the code "
+printf "and the formatting rules:\n\n"
+cat patch.patch
+printf "\n*** Aborting, please fix your commit(s) with 'git commit --amend' or 'git rebase -i <hash>'\n"
+rm -f patch.patch
+exit 1

.github/workflows/scripts/file_format.sh

@@ -0,0 +1,63 @@
+#!/usr/bin/env bash
+
+# This script ensures proper POSIX text file formatting and a few other things.
+# This is supplementary to clang_format.sh, but should be run before it.
+
+# We need dos2unix and recode.
+if [ ! -x "$(command -v dos2unix)" -o ! -x "$(command -v recode)" ]; then
+    printf "Install 'dos2unix' and 'recode' to use this script.\n"
+fi
+
+set -uo pipefail
+IFS=$'\n\t'
+
+# Loops through all text files tracked by Git.
+git grep -zIl '' |
+while IFS= read -rd '' f; do
+    # Exclude 3rd party files
+    if [[ "$f" == "openvr"* ]]; then
+        continue
+    elif [[ "$f" == "godot-cpp"* ]]; then
+        continue
+    elif [[ "$f" == "demo"* ]]; then
+        continue
+    elif [[ "$f" == ".github"* ]]; then
+        continue
+    fi
+    # Ensure that files are UTF-8 formatted.
+    recode UTF-8 "$f" 2> /dev/null
+    # Ensure that files have LF line endings and do not contain a BOM.
+    dos2unix "$f" 2> /dev/null
+    # Remove trailing space characters and ensures that files end
+    # with newline characters. -l option handles newlines conveniently.
+    perl -i -ple 's/\s*$//g' "$f"
+    # Remove the character sequence "== true" if it has a leading space.
+    perl -i -pe 's/\x20== true//g' "$f"
+    # We don't want to change lines around braces in godot/tscn files.
+    if [[ "$f" == *"godot" ]]; then
+        continue
+    elif [[ "$f" == *"tscn" ]]; then
+        continue
+    fi
+    # Disallow empty lines after the opening brace.
+    sed -z -i 's/\x7B\x0A\x0A/\x7B\x0A/g' "$f"
+    # Disallow some empty lines before the closing brace.
+    sed -z -i 's/\x0A\x0A\x7D/\x0A\x7D/g' "$f"
+done
+
+git diff > patch.patch
+
+# If no patch has been generated all is OK, clean up, and exit.
+if [ ! -s patch.patch ] ; then
+    printf "Files in this commit comply with the formatting rules.\n"
+    rm -f patch.patch
+    exit 0
+fi
+
+# A patch has been created, notify the user, clean up, and exit.
+printf "\n*** The following differences were found between the code "
+printf "and the formatting rules:\n\n"
+cat patch.patch
+printf "\n*** Aborting, please fix your commit(s) with 'git commit --amend' or 'git rebase -i <hash>'\n"
+rm -f patch.patch
+exit 1

.github/workflows/static_checks.yml

@@ -0,0 +1,22 @@
+name: 📊 Static Checks
+on: [push, pull_request]
+
+jobs:
+  static-checks:
+    name: Formatting (clang-format, file format)
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get install -qq dos2unix recode clang-format
+
+      - name: File formatting checks (file_format.sh)
+        run: |
+          bash ./.github/workflows/scripts/file_format.sh
+
+      - name: Style checks via clang-format (clang_format.sh)
+        run: |
+          bash ./.github/workflows/scripts/clang_format.sh

CONTRIBUTORS.md

@@ -1,10 +1,13 @@
 Contributors
 ============
 
-This plugin has mostly been developed by [Bastiaan Olij](https://github.com/BastiaanOlij). 
+This plugin has mostly been developed by [Bastiaan Olij](https://github.com/BastiaanOlij).
 Special thanks to [Benedikt](https://github.com/beniwtv) for doing all the work on overlay support.
 
 Other people who have helped out by submitting fixes, enhancements, etc are:
 - [RMKD](https://github.com/RMKD)
 - [Bruvzg](https://github.com/bruvzg)
 - [Aaron Franke](https://github.com/aaronfranke)
+- [CrispyPin](https://github.com/CrispyPin)
+- [SaracenOne](https://github.com/SaracenOne)
+- [lyuma](https://github.com/lyuma)

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018-2020 Bastiaan Olij
+Copyright (c) 2018-2021 Bastiaan Olij and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -96,14 +96,14 @@ OpenVR from version 1.6 onwards is able to support the HDR render buffers Godot
 
 OpenVR however expects the color buffer to contain color values in linear color space, its build in sRGB support only works for 8bit color buffers. Godot performs all 3D color calculations in linear color space but will do a final conversion to sRGB during post processing. The result is that everything inside of the headset will look far too bright.
 
-You can work around this by turning `keep_3d_linear` on for our viewport, this will skip the sRGB conversion and result the display inside of the headset to be correct however the output to screen will be too dark. We'll be looking at an interim solution for this soon however a full solution will likely not become available until after Godots rewrite to Vulkan. 
+You can work around this by turning `keep_3d_linear` on for our viewport, this will skip the sRGB conversion and result the display inside of the headset to be correct however the output to screen will be too dark. We'll be looking at an interim solution for this soon however a full solution will likely not become available until after Godots rewrite to Vulkan.
 
 ```
 func _ready():
-    var interface = ARVRServer.find_interface("OpenVR")
-    if interface and interface.initialize():
-        get_viewport().arvr = true
-        get_viewport().keep_3d_linear = true
+	var interface = ARVRServer.find_interface("OpenVR")
+	if interface and interface.initialize():
+		get_viewport().arvr = true
+		get_viewport().keep_3d_linear = true
 ```
 
 Shader hickup
@@ -112,7 +112,7 @@ There are a few moment where OpenVR has a hickup.
 
 One is around the teleporter function which can be solved by adding the `VR_Common_Shader_Cache.tscn` as a child scene to our ARVRCamera. `ovr_first_person.tscn` does this.
 
-For the controllers they use a standard material. Adding a mesh instance with a standard material will ensure the shader is pre-compiled. Again we do this in `ovr_first_person.tscn`. 
+For the controllers they use a standard material. Adding a mesh instance with a standard material will ensure the shader is pre-compiled. Again we do this in `ovr_first_person.tscn`.
 
 However there is still an issue with loading the texture. We need to redo loading of the controller mesh by handing it off to a separate thread.
 
@@ -137,7 +137,7 @@ if interface and interface.initialize():
 
 	# make sure vsync is disabled or we'll be limited to 60fps
 	OS.vsync_enabled = false
-	
+
 	# up our physics to 90fps to get in sync with our rendering
 	Engine.iterations_per_second = 90
 ```
@@ -160,15 +160,15 @@ if interface:
 
 	# make sure vsync is disabled or we'll be limited to 60fps
 	OS.vsync_enabled = false
-	
+
 	# up our physics to 90fps to get in sync with our rendering
 	Engine.iterations_per_second = 90
 ```
 
 License
 -------
 Note that the source in this repository is licensed by the MIT license model.
-This covers only the source code in this repository. 
+This covers only the source code in this repository.
 
 Both Godot and OpenVR have their own license requirements.
 See their respective git repositories for more details.

SConstruct

@@ -65,7 +65,7 @@ if env['platform'] == 'windows':
             env.Append(CCFLAGS = ['-fPIC', '-g3','-Og', '-std=c++17'])
         else:
             env.Append(CCFLAGS = ['-fPIC', '-g','-O3', '-std=c++17'])
-    
+
     openvr_dll_target = env['target_path'] + "openvr_api.dll"
     openvr_dll_source = env['openvr_path'] + "bin/win" + str(env['bits']) + "/openvr_api.dll"
 
@@ -106,11 +106,11 @@ else:
 
 godot_cpp_library += '.' + str(env['bits'])
 
-# Update our include search path 
+# Update our include search path
 env.Append(CPPPATH=[
-    '.', 
-    'src/', 
-    'src/open_vr/', 
+    '.',
+    'src/',
+    'src/open_vr/',
     godot_headers_path,
     godot_cpp_path + 'include/',
     godot_cpp_path + 'include/core/',

demo/Construct.gd

@@ -4,15 +4,15 @@ extends Node2D
 # OpenVR wants a buffer without this conversion applied and leave the color in linear color space.
 # As a result we've turned off our sRGB conversion on our viewport.
 # To output with the correct colors to screen we output our VR preview using a TextureRect
-# with a linear to sRGB conversion shader. 
+# with a linear to sRGB conversion shader.
 
 func on_window_size_change():
 	$TextureRect.rect_size = OS.window_size
 
 # Called when the node enters the scene tree for the first time.
 func _ready():
 	$TextureRect.texture = $Viewport.get_texture()
-	
+
 	get_tree().get_root().connect("size_changed", self, "on_window_size_change")
 	on_window_size_change();
 

demo/addons/godot-openvr/CHANGES.md

@@ -4,15 +4,16 @@ Changes to the Godot OpenVR asset
 Note, version numbers listed here are the version number assigned to the asset. Each time a new version is uploaded to the asset store we will increase the version number.
 More frequent updates may be available on the source repository.
 
-1.1.0 - In progress
+1.1.0 - 9 July 2021
 -------------------
 - Build for Godot 3.3
 - Now using OpenVR 1.16.8 (drops MacOS support)
 - Added support for actions
 - Added support for request play area
 - Added skeleton support (finger tracking)
+- Added support for querying battery state of devices
 
-1.0.5 - 1 March 2019
+1.0.5 - 1 March 2020
 --------------------
 - Now using OpenVR 1.9.16
 - Added support for overlays

demo/addons/godot-openvr/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018-2020 Bastiaan Olij
+Copyright (c) 2018-2021 Bastiaan Olij and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal