From fd084bfd59adc2482a84ec11247db1cc027fad71 Mon Sep 17 00:00:00 2001 From: Karsten Schmidt Date: Thu, 13 Feb 2020 02:04:42 +0000 Subject: [PATCH] feat(text-canvas): initial import as new pkg --- packages/text-canvas/.npmignore | 22 +++ packages/text-canvas/LICENSE | 201 +++++++++++++++++++++++ packages/text-canvas/README.tpl.md | 50 ++++++ packages/text-canvas/api-extractor.json | 3 + packages/text-canvas/package.json | 64 ++++++++ packages/text-canvas/src/api.ts | 61 +++++++ packages/text-canvas/src/canvas.ts | 202 ++++++++++++++++++++++++ packages/text-canvas/src/index.ts | 2 + packages/text-canvas/test/index.ts | 6 + packages/text-canvas/test/tsconfig.json | 11 ++ packages/text-canvas/tsconfig.json | 11 ++ 11 files changed, 633 insertions(+) create mode 100644 packages/text-canvas/.npmignore create mode 100644 packages/text-canvas/LICENSE create mode 100644 packages/text-canvas/README.tpl.md create mode 100644 packages/text-canvas/api-extractor.json create mode 100644 packages/text-canvas/package.json create mode 100644 packages/text-canvas/src/api.ts create mode 100644 packages/text-canvas/src/canvas.ts create mode 100644 packages/text-canvas/src/index.ts create mode 100644 packages/text-canvas/test/index.ts create mode 100644 packages/text-canvas/test/tsconfig.json create mode 100644 packages/text-canvas/tsconfig.json diff --git a/packages/text-canvas/.npmignore b/packages/text-canvas/.npmignore new file mode 100644 index 0000000000..c6f44618c9 --- /dev/null +++ b/packages/text-canvas/.npmignore @@ -0,0 +1,22 @@ +.ae +.cache +.meta +.nyc_output +*.gz +*.html +*.svg +*.tgz +*.h +*.o +*.wasm +*.tpl.md +bench +build +coverage +dev +doc +export +src* +test +tools +tsconfig.json diff --git a/packages/text-canvas/LICENSE b/packages/text-canvas/LICENSE new file mode 100644 index 0000000000..8dada3edaf --- /dev/null +++ b/packages/text-canvas/LICENSE @@ -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 {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. diff --git a/packages/text-canvas/README.tpl.md b/packages/text-canvas/README.tpl.md new file mode 100644 index 0000000000..f631d9f55a --- /dev/null +++ b/packages/text-canvas/README.tpl.md @@ -0,0 +1,50 @@ +# ${pkg.banner} + +[![npm version](https://img.shields.io/npm/v/${pkg.name}.svg)](https://www.npmjs.com/package/${pkg.name}) +![npm downloads](https://img.shields.io/npm/dm/${pkg.name}.svg) +[![Twitter Follow](https://img.shields.io/twitter/follow/thing_umbrella.svg?style=flat-square&label=twitter)](https://twitter.com/thing_umbrella) + +This project is part of the +[@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo. + + + +## About + +${pkg.description} + +${status} + +${supportPackages} + +${relatedPackages} + +${blogPosts} + +## Installation + +```bash +yarn add ${pkg.name} +``` + +${pkg.size} + +## Dependencies + +${pkg.deps} + +${examples} + +## API + +${docLink} + +TODO + +## Authors + +${authors} + +## License + +© ${copyright} // ${license} diff --git a/packages/text-canvas/api-extractor.json b/packages/text-canvas/api-extractor.json new file mode 100644 index 0000000000..94972e6bed --- /dev/null +++ b/packages/text-canvas/api-extractor.json @@ -0,0 +1,3 @@ +{ + "extends": "../../api-extractor.json" +} diff --git a/packages/text-canvas/package.json b/packages/text-canvas/package.json new file mode 100644 index 0000000000..e77849a287 --- /dev/null +++ b/packages/text-canvas/package.json @@ -0,0 +1,64 @@ +{ + "name": "@thi.ng/text-canvas", + "version": "0.0.1", + "description": "TODO", + "module": "./index.js", + "main": "./lib/index.js", + "umd:main": "./lib/index.umd.js", + "typings": "./index.d.ts", + "repository": { + "type": "git", + "url": "https://github.com/thi-ng/umbrella.git" + }, + "homepage": "https://github.com/thi-ng/umbrella/tree/master/packages/text-canvas", + "author": "Karsten Schmidt ", + "license": "Apache-2.0", + "scripts": { + "build": "yarn clean && yarn build:es6 && node ../../scripts/bundle-module", + "build:release": "yarn clean && yarn build:es6 && node ../../scripts/bundle-module all", + "build:es6": "tsc --declaration", + "build:test": "rimraf build && tsc -p test/tsconfig.json", + "test": "mocha test", + "cover": "nyc mocha test && nyc report --reporter=lcov", + "clean": "rimraf *.js *.d.ts *.map .nyc_output build coverage doc lib", + "doc:readme": "../../scripts/generate-readme", + "doc:ae": "mkdir -p .ae/doc .ae/temp && node_modules/.bin/api-extractor run --local --verbose", + "doc": "node_modules/.bin/typedoc --mode modules --out doc src", + "pub": "yarn build:release && yarn publish --access public" + }, + "devDependencies": { + "@istanbuljs/nyc-config-typescript": "^1.0.1", + "@microsoft/api-extractor": "^7.7.7", + "@thi.ng/transducers": "^6.2.1", + "@types/mocha": "^5.2.7", + "@types/node": "^13.5.0", + "mocha": "^7.0.0", + "nyc": "^15.0.0", + "ts-node": "^8.6.2", + "typedoc": "^0.16.8", + "typescript": "^3.7.5" + }, + "dependencies": { + "@thi.ng/api": "^6.7.1", + "@thi.ng/arrays": "^0.5.1", + "@thi.ng/math": "^1.6.0" + }, + "keywords": [ + "ascii", + "canvas", + "drawing", + "line", + "ES6", + "rect", + "text", + "typescript" + ], + "publishConfig": { + "access": "public" + }, + "sideEffects": false, + "thi.ng": { + "status": "alpha", + "year": 2020 + } +} diff --git a/packages/text-canvas/src/api.ts b/packages/text-canvas/src/api.ts new file mode 100644 index 0000000000..10c86f820c --- /dev/null +++ b/packages/text-canvas/src/api.ts @@ -0,0 +1,61 @@ +import { IObjectOf } from "@thi.ng/api"; + +export const ENDINGS = "▶◀▲▼•●"; + +export interface StrokeStyle { + hl: string; + vl: string; + tl: string; + tr: string; + bl: string; + br: string; + tjl: string; + tjr: string; + tjt: string; + tjb: string; + jct: string; +} + +// https://en.wikipedia.org/wiki/Box-drawing_character + +export const STROKE_STYLES: IObjectOf = { + ascii: { + hl: "-", + vl: "|", + tl: "+", + tr: "+", + bl: "+", + br: "+", + tjl: "+", + tjr: "+", + tjt: "+", + tjb: "+", + jct: "+" + }, + thin: { + hl: "─", + vl: "│", + tl: "┌", + tr: "┐", + bl: "└", + br: "┘", + tjl: "├", + tjr: "┤", + tjt: "┬", + tjb: "┴", + jct: "┼" + }, + double: { + hl: "═", + vl: "║", + tl: "╔", + tr: "╗", + bl: "╚", + br: "╝", + tjl: "╠", + tjr: "╣", + tjt: "╦", + tjb: "╩", + jct: "╬" + } +}; diff --git a/packages/text-canvas/src/canvas.ts b/packages/text-canvas/src/canvas.ts new file mode 100644 index 0000000000..f04c5b6609 --- /dev/null +++ b/packages/text-canvas/src/canvas.ts @@ -0,0 +1,202 @@ +import { peek } from "@thi.ng/arrays"; +import { clamp } from "@thi.ng/math"; +import { STROKE_STYLES, StrokeStyle } from "./api"; + +interface ClipRect { + x1: number; + y1: number; + x2: number; + y2: number; + w: number; + h: number; +} + +export class Canvas { + buf: string[]; + width: number; + height: number; + styles: StrokeStyle[]; + clipRects: ClipRect[]; + + constructor(width: number, height: number) { + this.width = width; + this.height = height; + this.buf = new Array(width * height).fill(" "); + this.styles = [STROKE_STYLES.thin]; + this.clipRects = []; + beginClip(this, 0, 0, width, height); + } + + toString() { + const { buf, width, height } = this; + const res: string[] = []; + for (let i = 0, y = 0; y < height; y++, i += width) { + res.push(buf.slice(i, i + width).join("")); + } + return res.join("\n"); + } +} + +export const clear = (canvas: Canvas, char = " ") => canvas.buf.fill(char); + +export const beginClip = ( + canvas: Canvas, + x: number, + y: number, + w: number, + h: number +) => { + const { width, height } = canvas; + const x2 = clamp(x + w, 0, width); + const y2 = clamp(y + h, 0, height); + const x1 = clamp(x, 0, width); + const y1 = clamp(y, 0, height); + canvas.clipRects.push({ x1, y1, x2, y2, w: x2 - x1, h: y2 - y1 }); +}; + +export const endClip = (canvas: Canvas) => { + if (canvas.clipRects.length > 1) { + canvas.clipRects.pop(); + } +}; + +export const beginStyle = (canvas: Canvas, style: StrokeStyle) => { + canvas.styles.push(style); +}; + +export const endStyle = (canvas: Canvas) => { + if (canvas.styles.length > 1) { + canvas.styles.pop(); + } +}; + +export const writeLine = ( + canvas: Canvas, + x: number, + y: number, + line: string +) => { + const { x1, y1, x2, y2 } = peek(canvas.clipRects); + if (y < y1 || y >= y2 || x >= x2) return; + let i = 0; + if (x < x1) { + i = x1 - x; + x = x1; + } + const { buf, width } = canvas; + for ( + let n = line.length, idx = x + y * width; + i < n && x < x2; + i++, x++, idx++ + ) { + buf[idx] = line.charAt(i); + } +}; + +export const fillRect = ( + canvas: Canvas, + x: number, + y: number, + w: number, + h: number, + char: string +) => { + if (x < 0) { + w += x; + x = 0; + } + if (y < 0) { + h += y; + y = 0; + } + const { buf, width, height } = canvas; + if (w < 1 || h < 1 || x >= width || y >= height) return; + w = Math.min(w, width - x); + h = Math.min(h, height - y); + for (; --h >= 0; y++) { + const idx = x + y * width; + buf.fill(char, idx, idx + w); + } +}; + +export const strokeRect = ( + canvas: Canvas, + x: number, + y: number, + w: number, + h: number +) => { + if (w < 2 || h < 2) return; + const style = peek(canvas.styles); + hline(canvas, x, y, w, style.tl, style.tr); + hline(canvas, x, y + h - 1, w, style.bl, style.br); + vline(canvas, x, y + 1, h - 2); + vline(canvas, x + w - 1, y + 1, h - 2); +}; + +export const hline = ( + canvas: Canvas, + x: number, + y: number, + len: number, + s?: string, + e?: string, + m?: string +) => { + const { buf, width, height } = canvas; + if (len < 1 || y < 0 || y >= height || x >= width) return; + const style = peek(canvas.styles); + let idx: number; + if (x < 0) { + len += x; + x = 0; + idx = y * width; + } else { + idx = x + y * width; + buf[idx++] = s !== undefined && len > 1 ? s : style.hl; + x++; + len--; + } + len--; + m = m != undefined ? m : style.hl; + for (let i = 0; i < len && x < width; i++, x++, idx++) { + buf[idx] = m; + } + if (len >= 0 && x < width) { + buf[idx] = e !== undefined ? e : style.vl; + } +}; + +export const vline = ( + canvas: Canvas, + x: number, + y: number, + len: number, + s?: string, + e?: string, + m?: string +) => { + const { buf, width, height } = canvas; + if (len < 1 || x < 0 || x >= width || y >= height) return; + const style = peek(canvas.styles); + let idx: number; + if (y < 0) { + len += y; + y = 0; + idx = x; + } else { + idx = x + y * width; + buf[idx] = s !== undefined && len > 1 ? s : style.vl; + idx += width; + y++; + len--; + } + len--; + m = m != undefined ? m : style.vl; + for (let i = 0; i < len && y < height; i++, y++, idx += width) { + buf[idx] = m; + } + if (len >= 0 && y < height) { + buf[idx] = e !== undefined ? e : style.vl; + } +}; diff --git a/packages/text-canvas/src/index.ts b/packages/text-canvas/src/index.ts new file mode 100644 index 0000000000..1bf3587014 --- /dev/null +++ b/packages/text-canvas/src/index.ts @@ -0,0 +1,2 @@ +export * from "./api"; +export * from "./canvas"; diff --git a/packages/text-canvas/test/index.ts b/packages/text-canvas/test/index.ts new file mode 100644 index 0000000000..f66dea0ac1 --- /dev/null +++ b/packages/text-canvas/test/index.ts @@ -0,0 +1,6 @@ +// import * as assert from "assert"; +// import { } from "../src"; + +describe("text-canvas", () => { + it("tests pending"); +}); diff --git a/packages/text-canvas/test/tsconfig.json b/packages/text-canvas/test/tsconfig.json new file mode 100644 index 0000000000..f6e63560dd --- /dev/null +++ b/packages/text-canvas/test/tsconfig.json @@ -0,0 +1,11 @@ +{ + "extends": "../../../tsconfig.json", + "compilerOptions": { + "outDir": "../build", + "module": "commonjs" + }, + "include": [ + "./**/*.ts", + "../src/**/*.ts" + ] +} diff --git a/packages/text-canvas/tsconfig.json b/packages/text-canvas/tsconfig.json new file mode 100644 index 0000000000..893b9979c5 --- /dev/null +++ b/packages/text-canvas/tsconfig.json @@ -0,0 +1,11 @@ +{ + "extends": "../../tsconfig.json", + "compilerOptions": { + "outDir": ".", + "module": "es6", + "target": "es6" + }, + "include": [ + "./src/**/*.ts" + ] +}