Added codegen README.md and removed swizzlegen.

CHANGELOG.md

@@ -12,6 +12,15 @@ The format is based on [Keep a Changelog], and this project adheres to
 * Minimum Supported Version of Rust bumped to 1.57.0 to allow panicking in
   constant evaluation.
 
+* The `abs_diff_eq` method on `Mat2` and `DMat2` now takes `other` by value
+  instead of reference. This is consistent with the other matrix types.
+
+### Changed
+
+* Source code is now largely generated. This largely removes the usage of macros
+  internally to improve readability. There should be no change in API or
+  behavior.
+
 ### Removed
 
 * Deleted deprecated `TransformRT` and `TransformSRT` types.

codegen/LICENSE-APACHE

@@ -0,0 +1,201 @@
+                              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 2020 Cameron Hart
+
+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.

codegen/LICENSE-MIT

@@ -0,0 +1,23 @@
+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.

codegen/README.md

@@ -0,0 +1,137 @@
+# glam code generation
+
+A tool to generate glam's source code.
+
+## Overview
+
+`glam` is not a generic library, in part because some types are backed by SIMD
+when it is available and also to avoid code complexity. However to support a
+number of different number types combined with a number of different SIMD
+architectures there is a lot of duplicate code and comments. Previously macros
+were used to avoid a lot of the duplication. The down side of this was macros
+were also quite complext and `glam` users often needed to navigate the macros
+when viewing source or debugging. Contributors also had to find their way around
+the macros to fix bugs or add features to `glam`.
+
+This tool replaces the majority of macros in `glam` by instead generating all of
+the different containers and SIMD implementations offline. These generated files
+are committed to the `glam` repo and this is what is compiled, read and debugged
+by `glam` users.
+
+## Tera templates
+
+Source files are generated using [`Tera`] templates. These kinds of templates
+are typically used to generate static web pages, but here we are using them to
+generate Rust source. The main advantages are a lot of the template looks like
+Rust code. The templates are fairly declaritive and easier to follow than the
+macros (in my opinion). I try to stick to basic features of the [templating
+language] to keep things simple.
+
+[`Tera`]: https://tera.netlify.app/
+[templating language]: https://tera.netlify.app/docs/
+
+### Control variables
+
+There `codegen` program maps a template to an output file. There are a small
+number of variables that are usually set before the template is rendered to
+control output:
+
+* `scalar_t` - the container's scalar type, e.g. `f32`, `f64`, `i32`, `u32`
+* `dim` - the container's dimension, e.g. `2`, `3` or `4`
+* `is_scalar` - generate regular Rust code using arithmetic operators
+* `is_sse2` - generate code using sse2 instrinsics
+* `is_wasm32` - generate code using wasm32 simd128 instrinsics
+
+The templates for swizzles and vector masks behave slightly differently but
+otherwise this is the common setup.
+
+### Template files
+
+The following templates are used:
+
+* `affine.rs` - generates 2D and 3D affine transformation types
+* `mat.rs` - generates all matrix types
+* `quat.rs` - generates all quaternion types
+* `vec.rs` - generates all vector types
+* `vec_mask.rs` - generates all vector mask types
+* `swizzle_traits.rs` - generates swizzle traits
+* `swizzle_impl.rs` - generates impls of swizzle traitrs for all vector types
+
+### Output module structure
+
+Not all types have sse2 or wasm32 implementations, if a type does have these the
+scalar and simd types will be in their respective modules. For example the `f32`
+`Vec3` type has no SIMD implemtaton, but `Vec4` does, the generated source files
+are structured like so:
+
+* `src/f32/vec3.rs`
+* `src/f32/scalar/vec4.rs`
+* `src/f32/sse2/vec4.rs`
+* `src/f32/wasm32/vec4.rs`
+
+The appropriate implementation module will be included when `glam` is compiled.
+
+### Template prelude
+
+Each template starts with setting up a number of common variables based on the
+inputs from the `codegen` program. Commonly used variables are:
+
+* `self_t` - the name of the type being generated
+* `inner_t` - the inner storage type used by this type (e.g. `__m128` or
+  `core::storage::XYZ<f32>`)
+* `deref_t` - the type used by the `Deref` and `DerefMut` implementation - not
+  always the same as `inner_t`
+* `col_t` - the column type - used by matrix and affine transform templates
+* `quat_t` - the `scalar_t` quaternion type name
+* `affine2_t` - the `scalar_t` 2D affine transform type name
+* `affine3_t` - the `scalar_t` 3D affine transform type name
+* `vec2_t` - the `scalar_t` 2D vector type name
+* `vec3_t` - the `scalar_t` 3D vector type name
+* `vec4_t` - the `scalar_t` 4D vector type name
+* `mat2_t` - the `scalar_t` 2D matrix type name
+* `mat3_t` - the `scalar_t` 3D matrix type name
+* `mat4_t` - the `scalar_t` 4D matrix type name
+
+## Running `codegen`
+
+`codegen` will generate all files by default or if a glob pattern is specified,
+only output files that match the glob.
+
+The following steps will be performed for each output file:
+
+* Check `git` status to see if the output is already modifed. This is to avoid
+  overriding changes by accident. The `-f` flag can be used to force override.
+* Render the `Tera` template in memory
+* Rust format the template output
+* Write the formatted output to the output file path
+
+### Template errors
+
+The `Tera` error output leaves a little to be desired. If the template fails to
+render with no error it is ususally because a variable that doesn't exist is
+being referenced somewhere in the template.
+
+### Rust format errors
+
+If the Rust format step fails it is usally because the template generated
+invalid Rust. The `-n` flag can be used to skip the Rust format step so that the
+file may be compiled which typically shows what the problem is.
+
+### Workflow
+
+When working on a template it is often easiest to generate one or two output
+files using a glob pattern to check that template changes are working as
+expected. When finished editing generate everything (most files should not
+change unexpectedly) and run the test suite using `build_and_test_features.sh`
+and `build_and_test_wasm32_chrome.sh`.
+
+## License
+
+Licensed under either of
+
+* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE)
+  or [http://www.apache.org/licenses/LICENSE-2.0])
+* MIT license ([LICENSE-MIT](LICENSE-MIT)
+  or [http://opensource.org/licenses/MIT])
+
+at your option.

codegen/src/main.rs

@@ -570,14 +570,16 @@ fn main() -> anyhow::Result<()> {
         }
     };
 
+    output_paths.sort();
+
     for output_path in output_paths {
         println!("generating {}", output_path);
         let context = output_pairs.get(output_path).unwrap();
         let template_path = context.get("template_path").unwrap().as_str().unwrap();
 
         if !(force || stdout) && is_modified(&repo, output_path)? {
             bail!(
-                "{} is already modified, revert or stash your changes.",
+                "{} is already modified, use  `-f` to force overwrite or revert local changes.",
                 output_path
             );
         }