@twip/web 0.0.0-stage → 0.1.0-alpha.1

package/LICENSE

@@ -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.

package/dist/AccessibleNode.d.ts

@@ -0,0 +1,51 @@
+// generated by diplomat-tool
+import type { Rect } from "./Rect"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * A node of the document's reading structure (headings, paragraphs, lists, tables, rows, cells), for screen
+ * readers and other assistive technology.
+ */
+export class AccessibleNode {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * The role: `document`, `heading`, `paragraph`, `list`, `listitem`, `table`, `row`, `cell`, ...
+     */
+    role(): string;
+
+    /**
+     * The heading level (0 when not a heading).
+     */
+    get level(): number;
+
+    /**
+     * The accessible name (a list item's label, a cell's position, ...), empty if none.
+     */
+    label(): string;
+
+    /**
+     * How many drawn lines the node's own text has.
+     */
+    get lineCount(): number;
+
+    /**
+     * A line's text.
+     */
+    lineText(index: number): string;
+
+    /**
+     * A line's box, content pixels.
+     */
+    lineRect(index: number): Rect;
+
+    get childCount(): number;
+
+    child(index: number): AccessibleNode | null;
+}

package/dist/AccessibleNode.mjs

@@ -0,0 +1,177 @@
+// generated by diplomat-tool
+import { Rect } from "./Rect.mjs"
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+const AccessibleNode_box_destroy_registry = new FinalizationRegistry((ptr) => {
+    wasm.AccessibleNode_destroy(ptr);
+});
+
+/**
+ * A node of the document's reading structure (headings, paragraphs, lists, tables, rows, cells), for screen
+ * readers and other assistive technology.
+ */
+export class AccessibleNode {
+    // Internal ptr reference:
+    #ptr = null;
+
+    // Lifetimes are only to keep dependencies alive.
+    // Since JS won't garbage collect until there are no incoming edges.
+    #selfEdge = [];
+
+    #internalConstructor(symbol, ptr, selfEdge) {
+        if (symbol !== diplomatRuntime.internalConstructor) {
+            console.error("AccessibleNode is an Opaque type. You cannot call its constructor.");
+            return;
+        }
+        this.#ptr = ptr;
+        this.#selfEdge = selfEdge;
+
+        // Are we being borrowed? If not, we can register.
+        if (this.#selfEdge.length === 0) {
+            AccessibleNode_box_destroy_registry.register(this, this.#ptr);
+        }
+
+        return this;
+    }
+    /** @internal */
+    get ffiValue() {
+        return this.#ptr;
+    }
+
+
+    /**
+     * The role: `document`, `heading`, `paragraph`, `list`, `listitem`, `table`, `row`, `cell`, ...
+     */
+    role() {
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+    wasm.AccessibleNode_role(this.ffiValue, write.buffer);
+
+        try {
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            write.free();
+        }
+    }
+
+    /**
+     * The heading level (0 when not a heading).
+     */
+    get level() {
+
+        const result = wasm.AccessibleNode_level(this.ffiValue);
+
+        try {
+            return result;
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * The accessible name (a list item's label, a cell's position, ...), empty if none.
+     */
+    label() {
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+    wasm.AccessibleNode_label(this.ffiValue, write.buffer);
+
+        try {
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            write.free();
+        }
+    }
+
+    /**
+     * How many drawn lines the node's own text has.
+     */
+    get lineCount() {
+
+        const result = wasm.AccessibleNode_line_count(this.ffiValue);
+
+        try {
+            return result;
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * A line's text.
+     */
+    lineText(index) {
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+    wasm.AccessibleNode_line_text(this.ffiValue, index, write.buffer);
+
+        try {
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            write.free();
+        }
+    }
+
+    /**
+     * A line's box, content pixels.
+     */
+    lineRect(index) {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 32, 8, false);
+
+
+        const result = wasm.AccessibleNode_line_rect(diplomatReceive.buffer, this.ffiValue, index);
+
+        try {
+            return Rect._fromFFI(diplomatRuntime.internalConstructor, diplomatReceive.buffer);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+        }
+    }
+
+    get childCount() {
+
+        const result = wasm.AccessibleNode_child_count(this.ffiValue);
+
+        try {
+            return result;
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    child(index) {
+
+        const result = wasm.AccessibleNode_child(this.ffiValue, index);
+
+        try {
+            return result === 0 ? null : new AccessibleNode(diplomatRuntime.internalConstructor, result, []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    constructor(symbol, ptr, selfEdge) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/dist/Alignment.d.ts

@@ -0,0 +1,38 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Paragraph alignment.
+ */
+export class Alignment {
+
+    /** @internal */
+    static fromValue(value: Alignment | string): Alignment;
+
+    get value(): string;
+
+    /** @internal */
+    get ffiValue(): number;
+
+    /**
+     * Lines start at the left margin.
+     */
+    static Left : Alignment;
+    /**
+     * Lines are centred.
+     */
+    static Center : Alignment;
+    /**
+     * Lines end at the right margin.
+     */
+    static Right : Alignment;
+    /**
+     * Lines fill the width, except a paragraph's last.
+     */
+    static Justify : Alignment;
+
+
+    constructor(value: Alignment | string );
+}

package/dist/Alignment.mjs

@@ -0,0 +1,90 @@
+// generated by diplomat-tool
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+
+
+/**
+ * Paragraph alignment.
+ */
+export class Alignment {
+    #value = undefined;
+
+    static #values = new Map([
+        ["Left", 0],
+        ["Center", 1],
+        ["Right", 2],
+        ["Justify", 3]
+    ]);
+
+    static getAllEntries() {
+        return Alignment.#values.entries();
+    }
+
+    #internalConstructor(value) {
+        if (arguments.length > 1 && arguments[0] === diplomatRuntime.internalConstructor) {
+            // We pass in two internalConstructor arguments to create *new*
+            // instances of this type, otherwise the enums are treated as singletons.
+            if (arguments[1] === diplomatRuntime.internalConstructor ) {
+                this.#value = arguments[2];
+                return this;
+            }
+            return Alignment.#objectValues[arguments[1]];
+        }
+
+        if (value instanceof Alignment) {
+            return value;
+        }
+
+        let intVal = Alignment.#values.get(value);
+
+        // Nullish check, checks for null or undefined
+        if (intVal != null) {
+            return Alignment.#objectValues[intVal];
+        }
+
+        throw TypeError(value + " is not a Alignment and does not correspond to any of its enumerator values.");
+    }
+
+    /** @internal */
+    static fromValue(value) {
+        return new Alignment(value);
+    }
+
+    get value(){
+        return [...Alignment.#values.keys()][this.#value];
+    }
+
+    /** @internal */
+    get ffiValue(){
+        return this.#value;
+    }
+    static #objectValues = [
+        new Alignment(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 0),
+        new Alignment(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 1),
+        new Alignment(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 2),
+        new Alignment(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 3),
+    ];
+
+    /**
+     * Lines start at the left margin.
+     */
+    static Left = Alignment.#objectValues[0];
+    /**
+     * Lines are centred.
+     */
+    static Center = Alignment.#objectValues[1];
+    /**
+     * Lines end at the right margin.
+     */
+    static Right = Alignment.#objectValues[2];
+    /**
+     * Lines fill the width, except a paragraph's last.
+     */
+    static Justify = Alignment.#objectValues[3];
+
+
+    constructor(value) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/dist/BorderEdges.d.ts

@@ -0,0 +1,50 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Which cell edges a border applies to.
+ */
+export class BorderEdges {
+
+    /** @internal */
+    static fromValue(value: BorderEdges | string): BorderEdges;
+
+    get value(): string;
+
+    /** @internal */
+    get ffiValue(): number;
+
+    /**
+     * Every edge.
+     */
+    static All : BorderEdges;
+    /**
+     * The outer edges of the selection.
+     */
+    static Outside : BorderEdges;
+    /**
+     * The inner edges, horizontal and vertical.
+     */
+    static Inside : BorderEdges;
+    /**
+     * The inner horizontal edges.
+     */
+    static InsideHorizontal : BorderEdges;
+    /**
+     * The inner vertical edges.
+     */
+    static InsideVertical : BorderEdges;
+    static Top : BorderEdges;
+    static Bottom : BorderEdges;
+    static Left : BorderEdges;
+    static Right : BorderEdges;
+    /**
+     * Removes the borders.
+     */
+    static Clear : BorderEdges;
+
+
+    constructor(value: BorderEdges | string );
+}