Productionize PathKit
- Remove some old API with VerbArgs that we didn't really like.
- move from experimental/wasm -> experimental/pathkit and rename
wasm_main.cpp to pathkit_wasm_bindings (more descriptive).
- Make compile.sh nicer to use (with some form of command line args).
- Use MODULARIZE=1 to make this play nicer with other WASM libraries
and easier to import.
- Add seperate ToCanvas() API
- Move Region stuff behind the PATHKIT_TESTING flag (saves 100k on
binary size).
- Add npm package for wasm version. asm.js version should also be
supported for older browsers.
- Remove shell.html, which was largely too complicated. Replace it with
example.html, which is more succinct and demos the more relevant APIs.
See https://www.npmjs.com/package/experimental-pathkit-wasm
Bug: skia:8216
Change-Id: I15f14dd8acd77331729998ae3e30d73e4b006761
Reviewed-on: https://skia-review.googlesource.com/144790
Reviewed-by: Joe Gregorio <jcgregorio@google.com>
Reviewed-by: Florin Malita <fmalita@chromium.org>
Commit-Queue: Kevin Lubick <kjlubick@google.com>
diff --git a/experimental/pathkit/npm-wasm/LICENSE b/experimental/pathkit/npm-wasm/LICENSE
new file mode 100644
index 0000000..20c685b
--- /dev/null
+++ b/experimental/pathkit/npm-wasm/LICENSE
@@ -0,0 +1,190 @@
+ Copyright 2018 Google LLC
+
+ 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.
+
+ 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
diff --git a/experimental/pathkit/npm-wasm/README.md b/experimental/pathkit/npm-wasm/README.md
new file mode 100644
index 0000000..2f02e51
--- /dev/null
+++ b/experimental/pathkit/npm-wasm/README.md
@@ -0,0 +1,54 @@
+A WASM version of Skia's PathOps toolkit.
+
+To use the library, run `npm install experimental-pathkit-wasm` and then simply include it:
+
+ <script src="/node_modules/experimental-pathkit-wasm/bin/pathkit.js"></script>
+ PathKitInit({
+ locateFile: (file) => '/node_modules/experimental-pathkit-wasm/bin/'+file,
+ }).then((PathKit) => {
+ // Code goes here using PathKit
+ });
+
+PathKit comes in two parts, a JS loader and the actual WASM code. The JS loader creates
+a global `PathKitInit` that can be called to load the WASM code. The `locateFile` function
+is used to tell the JS loader where to find the .wasm file. By default, it will
+look for /pathkit.wasm, so if this is not the case, use `locateFile` to configure
+this properly.
+The `PathKit` object returned through the .then() callback is fully loaded and ready to use.
+
+See example.html for a fuller example of how to use the library.
+
+Using PathKit and WebPack
+-------------------------
+
+WebPack's support for WASM is still somewhat experimental, but PathKit can be
+used with a few configuration changes.
+
+In the JS code, use require():
+
+ const PathKitInit = require('experimental-pathkit-wasm/bin/pathkit.js')
+ PathKitInit().then((PathKit) => {
+ // Code goes here using PathKit
+ })
+
+Since WebPack does not expose the entire `/node_modules/` directory, but instead
+packages only the needed pieces, we have to copy pathkit.wasm into the build directory.
+One such solution is to use [CopyWebpackPlugin](https://github.com/webpack-contrib/copy-webpack-plugin)
+For example, add the following plugin:
+
+ config.plugins.push(
+ new CopyWebpackPlugin([
+ { from: 'node_modules/experimental-pathkit-wasm/bin/pathkit.wasm' }
+ ])
+ );
+
+If webpack gives an error similar to:
+
+ ERROR in ./node_modules/experimental-pathkit-wasm/bin/pathkit.js
+ Module not found: Error: Can't resolve 'fs' in '...'
+
+Then, add the following configuration change to the node section of the config:
+
+ config.node = {
+ fs: 'empty'
+ };
\ No newline at end of file
diff --git a/experimental/pathkit/npm-wasm/example.html b/experimental/pathkit/npm-wasm/example.html
new file mode 100644
index 0000000..d31e8b4
--- /dev/null
+++ b/experimental/pathkit/npm-wasm/example.html
@@ -0,0 +1,77 @@
+<!DOCTYPE html>
+<title>PathKit (Skia + WASM)</title>
+<meta charset="utf-8" />
+<meta http-equiv="X-UA-Compatible" content="IE=edge">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+<style>
+ svg, canvas {
+ border: 1px dashed #AAA;
+ }
+
+ canvas {
+ width: 200px;
+ height: 200px;
+ }
+
+</style>
+
+<svg id=svg xmlns='http://www.w3.org/2000/svg' width=200 height=200></svg>
+
+<canvas id="canvas1"></canvas>
+
+<canvas id="canvas2"></canvas>
+
+<script type="text/javascript" src="/node_modules/experimental-pathkit-wasm/bin/pathkit.js"></script>
+
+<script type="text/javascript" charset="utf-8">
+
+ PathKitInit({
+ locateFile: (file) => '/node_modules/experimental-pathkit-wasm/bin/'+file,
+ }).then((PathKit) => {
+
+ let firstPath = PathKit.FromSVGString('M11.99 2C6.47 2 2 6.48 2 12s4.47 10 9.99 10C17.52 22 22 17.52 22 12S17.52 2 11.99 2zM12 20c-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8-3.58 8-8 8zm.5-13H11v6l5.25 3.15.75-1.23-4.5-2.67z');
+
+ let secondPath = PathKit.NewPath();
+ // Acts somewhat like the Canvas API
+ secondPath.moveTo(1, 1);
+ secondPath.lineTo(20, 1);
+ secondPath.lineTo(10, 30);
+ secondPath.close();
+
+ let combinedPath = PathKit.ApplyPathOp(firstPath, secondPath, PathKit.PathOp.INTERSECT);
+ let simpleStr = PathKit.ToSVGString(combinedPath);
+
+ let newSVG = document.createElementNS('http://www.w3.org/2000/svg', 'path');
+ newSVG.setAttribute('stroke', 'rgb(0,0,200)');
+ newSVG.setAttribute('fill', 'white');
+ newSVG.setAttribute('transform', 'scale(5,5)');
+ newSVG.setAttribute('d', simpleStr);
+ document.getElementById('svg').appendChild(newSVG);
+
+ // Draw directly to Canvas
+ let ctx = document.getElementById('canvas1').getContext('2d');
+ ctx.strokeStyle = 'green';
+ ctx.fillStyle = 'white';
+ ctx.scale(8, 4);
+ ctx.beginPath();
+ PathKit.ToCanvas(combinedPath, ctx);
+ ctx.stroke();
+
+ // create Path2D object and use it in a Canvas.
+ let path2D = PathKit.ToPath2D(combinedPath);
+ ctx = document.getElementById('canvas2').getContext('2d');
+ ctx.scale(8, 4);
+ ctx.fillStyle = 'purple';
+ ctx.strokeStyle = 'orange';
+ ctx.fill(path2D);
+ ctx.stroke(path2D);
+
+ // clean up WASM memory
+ // See http://kripken.github.io/emscripten-site/docs/porting/connecting_cpp_and_javascript/embind.html?highlight=memory#memory-management
+ firstPath.delete();
+ secondPath.delete();
+ combinedPath.delete();
+ });
+
+</script>
diff --git a/experimental/pathkit/npm-wasm/package.json b/experimental/pathkit/npm-wasm/package.json
new file mode 100644
index 0000000..cb7fec1
--- /dev/null
+++ b/experimental/pathkit/npm-wasm/package.json
@@ -0,0 +1,11 @@
+{
+ "name": "experimental-pathkit-wasm",
+ "version": "0.0.4",
+ "description": "A WASM version of Skia's PathOps toolkit",
+ "main": "bin/pathkit.js",
+ "homepage": "https://github.com/google/skia/tree/master/experimental/pathkit",
+ "scripts": {
+ "test": "echo \"Error: no test specified\" && exit 1"
+ },
+ "license": "Apache-2.0"
+}